libblockdev-dev 2.16-2 / usr / share / gtk-doc / html / libblockdev / libblockdev-blockdev-library.html

This file is indexed.

/usr/share/gtk-doc/html/libblockdev/libblockdev-blockdev-library.html is in libblockdev-dev 2.16-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>blockdev library: libblockdev Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libblockdev Reference Manual">
<link rel="up" href="ch01.html" title="libblockdev Reference Manual">
<link rel="prev" href="ch01.html" title="libblockdev Reference Manual">
<link rel="next" href="libblockdev-BTRFS.html" title="BTRFS">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libblockdev-blockdev-library.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libblockdev-BTRFS.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libblockdev-blockdev-library"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libblockdev-blockdev-library.top_of_page"></a>blockdev library</span></h2>
<p>blockdev library — a library for doing low-level operations with block devices</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libblockdev-blockdev-library.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libblockdev-blockdev-library.html#bd-init" title="bd_init ()">bd_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libblockdev-blockdev-library.html#bd-ensure-init" title="bd_ensure_init ()">bd_ensure_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libblockdev-blockdev-library.html#bd-try-init" title="bd_try_init ()">bd_try_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libblockdev-blockdev-library.html#bd-reinit" title="bd_reinit ()">bd_reinit</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libblockdev-blockdev-library.html#bd-try-reinit" title="bd_try_reinit ()">bd_try_reinit</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libblockdev-blockdev-library.html#bd-is-initialized" title="bd_is_initialized ()">bd_is_initialized</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libblockdev-blockdev-library.html#bd-switch-init-checks" title="bd_switch_init_checks ()">bd_switch_init_checks</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GQuark</span>
</td>
<td class="function_name">
<a class="link" href="libblockdev-blockdev-library.html#bd-init-error-quark" title="bd_init_error_quark ()">bd_init_error_quark</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libblockdev-blockdev-library.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libblockdev-blockdev-library.html#BD-INIT-ERROR:CAPS" title="BD_INIT_ERROR">BD_INIT_ERROR</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="libblockdev-blockdev-library.html#BDInitError" title="enum BDInitError">BDInitError</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libblockdev-blockdev-library.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;blockdev.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="libblockdev-blockdev-library.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libblockdev-blockdev-library.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="bd-init"></a><h3>bd_init ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
bd_init (<em class="parameter"><code><span class="type">BDPluginSpec</span> **require_plugins</code></em>,
         <em class="parameter"><code><a class="link" href="libblockdev-Utils.html#BDUtilsLogFunc" title="BDUtilsLogFunc ()"><span class="type">BDUtilsLogFunc</span></a> log_func</code></em>,
         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="refsect3">
<a name="bd-init.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>require_plugins</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list
of plugins that should be loaded (if no so_name is specified
for the plugin, the default is used) or <code class="literal">NULL</code> to load all
plugins. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>log_func</p></td>
<td class="parameter_description"><p>logging function to use. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>place to store error (if any). </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="bd-init.returns"></a><h4>Returns</h4>
<p> whether the library was successfully initialized with all the
required or default (see <em class="parameter"><code>require_plugins</code></em>
) plugins or not</p>
<p>Example of libblockdev initialization with 'fs' and 'lvm' plugins. Specific
version of the lvm plugin is required:</p>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4
5
6</pre></td>
        <td class="listing_code"><pre class="programlisting">GError <span class="gtkdoc opt">*</span>error <span class="gtkdoc opt">=</span> NULL<span class="gtkdoc opt">;</span>
gboolean ret <span class="gtkdoc opt">=</span> FALSE<span class="gtkdoc opt">;</span>
BDPluginSpec fs_plugin <span class="gtkdoc opt">= {</span>BD_PLUGIN_FS<span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">};</span>
BDPluginSpec lvm_plugin <span class="gtkdoc opt">= {</span>BD_PLUGIN_LVM<span class="gtkdoc opt">,</span> <span class="string">&quot;libbd_lvm.so.2&quot;</span><span class="gtkdoc opt">};</span>
BDPluginSpec <span class="gtkdoc opt">*</span>plugins<span class="gtkdoc opt">[] = {&amp;</span>fs_plugin<span class="gtkdoc opt">, &amp;</span>lvm_plugin<span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">};</span>
ret <span class="gtkdoc opt">=</span> <span class="function"><a href="libblockdev-blockdev-library.html#bd-init">bd_init</a></span> <span class="gtkdoc opt">(</span>plugins<span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">, &amp;</span>error<span class="gtkdoc opt">);</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="bd-ensure-init"></a><h3>bd_ensure_init ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
bd_ensure_init (<em class="parameter"><code><span class="type">BDPluginSpec</span> **require_plugins</code></em>,
                <em class="parameter"><code><a class="link" href="libblockdev-Utils.html#BDUtilsLogFunc" title="BDUtilsLogFunc ()"><span class="type">BDUtilsLogFunc</span></a> log_func</code></em>,
                <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Checks the state of the library and if it is uninitialized or not all the
<em class="parameter"><code>require_plugins</code></em>
 plugins are available, tries to (re)initialize it. Otherwise
just returns early. The difference between:</p>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="keyword">if</span> <span class="gtkdoc opt">(!</span><span class="function"><a href="libblockdev-blockdev-library.html#bd-is-initialized">bd_is_initialized</a></span><span class="gtkdoc opt">())</span>
    <span class="function"><a href="libblockdev-blockdev-library.html#bd-init">bd_init</a></span><span class="gtkdoc opt">(</span>None<span class="gtkdoc opt">,</span> None<span class="gtkdoc opt">, &amp;</span>error<span class="gtkdoc opt">);</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p></p>
<p>and this function is that this function does the check and init in an atomic
way (holding the lock preventing other threads from doing changes in
between).</p>
<div class="refsect3">
<a name="bd-ensure-init.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>require_plugins</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list
of plugins that should be loaded (if no so_name is specified
for the plugin, the default is used) or <code class="literal">NULL</code> to load all
plugins. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>log_func</p></td>
<td class="parameter_description"><p>logging function to use. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>place to store error (if any). </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="bd-ensure-init.returns"></a><h4>Returns</h4>
<p> whether the library was successfully initialized with all the
required or default (see <em class="parameter"><code>require_plugins</code></em>
) plugins or not either
before or by this call</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="bd-try-init"></a><h3>bd_try_init ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
bd_try_init (<em class="parameter"><code><span class="type">BDPluginSpec</span> **request_plugins</code></em>,
             <em class="parameter"><code><a class="link" href="libblockdev-Utils.html#BDUtilsLogFunc" title="BDUtilsLogFunc ()"><span class="type">BDUtilsLogFunc</span></a> log_func</code></em>,
             <em class="parameter"><code><span class="type">gchar</span> ***loaded_plugin_names</code></em>,
             <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="refsect3">
<a name="bd-try-init.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>request_plugins</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list
of plugins that should be loaded (if no so_name is specified
for the plugin, the default is used) or <code class="literal">NULL</code> to load all
plugins. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>log_func</p></td>
<td class="parameter_description"><p>logging function to use. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>loaded_plugin_names</p></td>
<td class="parameter_description"><p>names
of the successfully loaded plugins. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>place to store error (if any). </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="bd-try-init.returns"></a><h4>Returns</h4>
<p> whether the library was successfully initialized with all the
required or default (see <em class="parameter"><code>require_plugins</code></em>
) plugins or not</p>
<p>*UNLIKE IN CASE OF <a class="link" href="libblockdev-blockdev-library.html#bd-init" title="bd_init ()"><code class="function">bd_init()</code></a> AND <a class="link" href="libblockdev-blockdev-library.html#bd-ensure-init" title="bd_ensure_init ()"><code class="function">bd_ensure_init()</code></a>, FAILURE TO LOAD A PLUGIN
IS NOT CONSIDERED ERROR*</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="bd-reinit"></a><h3>bd_reinit ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
bd_reinit (<em class="parameter"><code><span class="type">BDPluginSpec</span> **require_plugins</code></em>,
           <em class="parameter"><code><span class="type">gboolean</span> reload</code></em>,
           <em class="parameter"><code><a class="link" href="libblockdev-Utils.html#BDUtilsLogFunc" title="BDUtilsLogFunc ()"><span class="type">BDUtilsLogFunc</span></a> log_func</code></em>,
           <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="refsect3">
<a name="bd-reinit.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>require_plugins</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list
of plugins that should be loaded (if no so_name is specified
for the plugin, the default is used) or <code class="literal">NULL</code> to load all
plugins. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>reload</p></td>
<td class="parameter_description"><p>whether to reload the already loaded plugins or not</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>log_func</p></td>
<td class="parameter_description"><p>logging function to use or <code class="literal">NULL</code>
to keep the old one. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>place to store error (if any). </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="bd-reinit.returns"></a><h4>Returns</h4>
<p> whether the library was successfully initialized or not</p>
<p>If <em class="parameter"><code>reload</code></em>
is <code class="literal">TRUE</code> all the plugins are closed and reloaded otherwise only
the missing plugins are loaded.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="bd-try-reinit"></a><h3>bd_try_reinit ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
bd_try_reinit (<em class="parameter"><code><span class="type">BDPluginSpec</span> **require_plugins</code></em>,
               <em class="parameter"><code><span class="type">gboolean</span> reload</code></em>,
               <em class="parameter"><code><a class="link" href="libblockdev-Utils.html#BDUtilsLogFunc" title="BDUtilsLogFunc ()"><span class="type">BDUtilsLogFunc</span></a> log_func</code></em>,
               <em class="parameter"><code><span class="type">gchar</span> ***loaded_plugin_names</code></em>,
               <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="refsect3">
<a name="bd-try-reinit.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>require_plugins</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code>-terminated list
of plugins that should be loaded (if no so_name is specified
for the plugin, the default is used) or <code class="literal">NULL</code> to load all
plugins. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>reload</p></td>
<td class="parameter_description"><p>whether to reload the already loaded plugins or not</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>log_func</p></td>
<td class="parameter_description"><p>logging function to use or <code class="literal">NULL</code>
to keep the old one. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>loaded_plugin_names</p></td>
<td class="parameter_description"><p>names of the successfully
loaded plugins. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>place to store error (if any). </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="bd-try-reinit.returns"></a><h4>Returns</h4>
<p> whether the library was successfully initialized or not</p>
<p>If <em class="parameter"><code>reload</code></em>
is <code class="literal">TRUE</code> all the plugins are closed and reloaded otherwise only
the missing plugins are loaded.</p>
<p>*UNLIKE IN CASE OF <a class="link" href="libblockdev-blockdev-library.html#bd-init" title="bd_init ()"><code class="function">bd_init()</code></a> AND <a class="link" href="libblockdev-blockdev-library.html#bd-ensure-init" title="bd_ensure_init ()"><code class="function">bd_ensure_init()</code></a>, FAILURE TO LOAD A PLUGIN
IS NOT CONSIDERED ERROR*</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="bd-is-initialized"></a><h3>bd_is_initialized ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
bd_is_initialized ();</pre>
<div class="refsect3">
<a name="bd-is-initialized.returns"></a><h4>Returns</h4>
<p> whether the library is initialized or not</p>
<p>The library is considered initialized if some of the *init*() functions
was/were called and either at least one plugin is loaded or 0 plugins are
loaded after an explicit call that requested 0 plugins to be loaded.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="bd-switch-init-checks"></a><h3>bd_switch_init_checks ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
bd_switch_init_checks (<em class="parameter"><code><span class="type">gboolean</span> enable</code></em>,
                       <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Enables or disables plugins' init checks based on <em class="parameter"><code>enable</code></em>
.</p>
<p>Note: The current implementation (un)sets the LIBBLOCKDEV_SKIP_DEP_CHECKS
      environment variable.</p>
<div class="refsect3">
<a name="bd-switch-init-checks.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>enable</p></td>
<td class="parameter_description"><p>whether to enable init checks (<code class="literal">TRUE</code>) or not (<code class="literal">FALSE</code>)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>place to store error (if any). </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="bd-init-error-quark"></a><h3>bd_init_error_quark ()</h3>
<pre class="programlisting"><span class="returnvalue">GQuark</span>
bd_init_error_quark ();</pre>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
</div>
</div>
<div class="refsect1">
<a name="libblockdev-blockdev-library.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="BD-INIT-ERROR:CAPS"></a><h3>BD_INIT_ERROR</h3>
<pre class="programlisting">#define BD_INIT_ERROR bd_init_error_quark ()
</pre>
</div>
<hr>
<div class="refsect2">
<a name="BDInitError"></a><h3>enum BDInitError</h3>
<div class="refsect3">
<a name="BDInitError.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="BD-INIT-ERROR-PLUGINS-FAILED:CAPS"></a>BD_INIT_ERROR_PLUGINS_FAILED</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="BD-INIT-ERROR-NOT-IMPLEMENTED:CAPS"></a>BD_INIT_ERROR_NOT_IMPLEMENTED</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="BD-INIT-ERROR-FAILED:CAPS"></a>BD_INIT_ERROR_FAILED</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.