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
535
536
537
538
539
540
541
542
543
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: Dynamically-loaded Plugins (H5PL)</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="hdf5doxy.css" rel="stylesheet" type="text/css">
<!-- <link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
-->
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
</head>
<body>
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a>
 <span id="projectnumber">1.15.0.2908dd1</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){initNavTree('group___h5_p_l.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">Dynamically-loaded Plugins (H5PL)</div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Use the functions in this module to manage the loading behavior of HDF5 plugins.</p>
<table class="doxtable">
<tr>
<th>Create</th><th>Read </th></tr>
<tr valign="top">
<td><div class="fragment"><div class="line"> {</div>
<div class="line"> __label__ fail_set;</div>
<div class="line"> <span class="comment">// enable ONLY filter plugins</span></div>
<div class="line"> <span class="keywordflow">if</span> (<a class="code hl_function" href="#ga3ee7276ca1168b175661db3866f8db0e">H5PLset_loading_state</a>(<a class="code hl_define" href="_h5_p_lpublic_8h.html#a57bfc592408089da6983c92013d5c25c">H5PL_FILTER_PLUGIN</a>) < 0) {</div>
<div class="line"> ret_val = EXIT_FAILURE;</div>
<div class="line"> <span class="keywordflow">goto</span> fail_set;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// ensure that "/tmp" is at the front of the search path list</span></div>
<div class="line"> <span class="keywordflow">if</span> (<a class="code hl_function" href="#ga1f2300ef2de6e430af330de7d194576f">H5PLprepend</a>(<span class="stringliteral">"/tmp"</span>) < 0) {</div>
<div class="line"> ret_val = EXIT_FAILURE;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line">fail_set:;</div>
<div class="line"> }</div>
</div><!-- fragment --> </td><td><div class="fragment"><div class="line"> {</div>
<div class="line"> __label__ fail_read;</div>
<div class="line"> <span class="keywordtype">unsigned</span> size, mask;</div>
<div class="line"> <span class="keywordtype">char</span> buf[255];</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// retrieve the number of entries in the plugin path list</span></div>
<div class="line"> <span class="keywordflow">if</span> (<a class="code hl_function" href="#ga30b799ad7e9645312ef8975a610b4b18">H5PLsize</a>(&size) < 0) {</div>
<div class="line"> ret_val = EXIT_FAILURE;</div>
<div class="line"> <span class="keywordflow">goto</span> fail_read;</div>
<div class="line"> }</div>
<div class="line"> printf(<span class="stringliteral">"Number of stored plugin paths: %d\n"</span>, size);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// check the plugin state mask</span></div>
<div class="line"> <span class="keywordflow">if</span> (<a class="code hl_function" href="#gadde42938cf1cc41fa392e8719050b52a">H5PLget_loading_state</a>(&mask) < 0) {</div>
<div class="line"> ret_val = EXIT_FAILURE;</div>
<div class="line"> <span class="keywordflow">goto</span> fail_read;</div>
<div class="line"> }</div>
<div class="line"> printf(<span class="stringliteral">"Filter plugins %s be loaded.\n"</span>, (mask & <a class="code hl_define" href="_h5_p_lpublic_8h.html#a57bfc592408089da6983c92013d5c25c">H5PL_FILTER_PLUGIN</a>) == 1 ? <span class="stringliteral">"can"</span> : <span class="stringliteral">"can't"</span>);</div>
<div class="line"> printf(<span class="stringliteral">"VOL plugins %s be loaded.\n"</span>, (mask & <a class="code hl_define" href="_h5_p_lpublic_8h.html#a79a226bdf906c17c41a5d9269b12fcfa">H5PL_VOL_PLUGIN</a>) == 2 ? <span class="stringliteral">"can"</span> : <span class="stringliteral">"can't"</span>);</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// print the paths in the plugin path list</span></div>
<div class="line"> <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> i = 0; i < size; ++i) {</div>
<div class="line"> <span class="keywordflow">if</span> (<a class="code hl_function" href="#ga64a3c5450d91455624ecba582553d905">H5PLget</a>(i, buf, 255) < 0) {</div>
<div class="line"> ret_val = EXIT_FAILURE;</div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> }</div>
<div class="line"> printf(<span class="stringliteral">"%s\n"</span>, buf);</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line">fail_read:;</div>
<div class="line"> }</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Update</th><th>Delete </th></tr>
<tr valign="top">
<td><div class="fragment"><div class="line"> {</div>
<div class="line"> <span class="comment">// replace "/tmp" with something more sensible</span></div>
<div class="line"> <span class="keywordflow">if</span> (<a class="code hl_function" href="#gab0f8d4e8d0b81cb55cf8b9de5095dc0b">H5PLreplace</a>(<span class="stringliteral">"/foo/bar"</span>, 0) < 0) {</div>
<div class="line"> ret_val = EXIT_FAILURE;</div>
<div class="line"> }</div>
<div class="line"> }</div>
</div><!-- fragment --> </td><td><div class="fragment"><div class="line"> {</div>
<div class="line"> __label__ fail_delete;</div>
<div class="line"> <span class="keywordtype">unsigned</span> size;</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (<a class="code hl_function" href="#ga30b799ad7e9645312ef8975a610b4b18">H5PLsize</a>(&size) < 0) {</div>
<div class="line"> ret_val = EXIT_FAILURE;</div>
<div class="line"> <span class="keywordflow">goto</span> fail_delete;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// clean out the list of plugin paths</span></div>
<div class="line"> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = size - 1; i >= 0; --i) {</div>
<div class="line"> <span class="keywordflow">if</span> (<a class="code hl_function" href="#gaa566196b7c6970c255feac4cf9f3bf40">H5PLremove</a>(i) < 0) {</div>
<div class="line"> ret_val = EXIT_FAILURE;</div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line">fail_delete:;</div>
<div class="line"> }</div>
</div><!-- fragment --> </td></tr>
</table>
<dl class="section attention"><dt>Attention</dt><dd>The loading behavior of HDF5 plugins can be controlled via the functions described below and certain environment variables, such as <code>HDF5_PLUGIN_PRELOAD</code> and <code>HDF5_PLUGIN_PATH</code>. </dd></dl>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga3ee7276ca1168b175661db3866f8db0e" id="r_ga3ee7276ca1168b175661db3866f8db0e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga3ee7276ca1168b175661db3866f8db0e">H5PLset_loading_state</a> (unsigned int plugin_control_mask)</td></tr>
<tr class="memdesc:ga3ee7276ca1168b175661db3866f8db0e"><td class="mdescLeft"> </td><td class="mdescRight">Controls the loadability of dynamic plugin types. <br /></td></tr>
<tr class="separator:ga3ee7276ca1168b175661db3866f8db0e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadde42938cf1cc41fa392e8719050b52a" id="r_gadde42938cf1cc41fa392e8719050b52a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gadde42938cf1cc41fa392e8719050b52a">H5PLget_loading_state</a> (unsigned int *plugin_control_mask)</td></tr>
<tr class="memdesc:gadde42938cf1cc41fa392e8719050b52a"><td class="mdescLeft"> </td><td class="mdescRight">Queries the loadability of dynamic plugin types. <br /></td></tr>
<tr class="separator:gadde42938cf1cc41fa392e8719050b52a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac74200fdc02f794f3fae753fe8b850b0" id="r_gac74200fdc02f794f3fae753fe8b850b0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gac74200fdc02f794f3fae753fe8b850b0">H5PLappend</a> (const char *search_path)</td></tr>
<tr class="memdesc:gac74200fdc02f794f3fae753fe8b850b0"><td class="mdescLeft"> </td><td class="mdescRight">Inserts a plugin path at the end of the plugin search path list. <br /></td></tr>
<tr class="separator:gac74200fdc02f794f3fae753fe8b850b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1f2300ef2de6e430af330de7d194576f" id="r_ga1f2300ef2de6e430af330de7d194576f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1f2300ef2de6e430af330de7d194576f">H5PLprepend</a> (const char *search_path)</td></tr>
<tr class="memdesc:ga1f2300ef2de6e430af330de7d194576f"><td class="mdescLeft"> </td><td class="mdescRight">Inserts a plugin path at the beginning of the plugin search path list. <br /></td></tr>
<tr class="separator:ga1f2300ef2de6e430af330de7d194576f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab0f8d4e8d0b81cb55cf8b9de5095dc0b" id="r_gab0f8d4e8d0b81cb55cf8b9de5095dc0b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gab0f8d4e8d0b81cb55cf8b9de5095dc0b">H5PLreplace</a> (const char *search_path, unsigned int index)</td></tr>
<tr class="memdesc:gab0f8d4e8d0b81cb55cf8b9de5095dc0b"><td class="mdescLeft"> </td><td class="mdescRight">Replaces the path at the specified index in the plugin search path list. <br /></td></tr>
<tr class="separator:gab0f8d4e8d0b81cb55cf8b9de5095dc0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacc5153b0db6b3f876c3980bf34f931fc" id="r_gacc5153b0db6b3f876c3980bf34f931fc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gacc5153b0db6b3f876c3980bf34f931fc">H5PLinsert</a> (const char *search_path, unsigned int index)</td></tr>
<tr class="memdesc:gacc5153b0db6b3f876c3980bf34f931fc"><td class="mdescLeft"> </td><td class="mdescRight">Inserts a path at the specified index in the plugin search path list. <br /></td></tr>
<tr class="separator:gacc5153b0db6b3f876c3980bf34f931fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa566196b7c6970c255feac4cf9f3bf40" id="r_gaa566196b7c6970c255feac4cf9f3bf40"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa566196b7c6970c255feac4cf9f3bf40">H5PLremove</a> (unsigned int index)</td></tr>
<tr class="memdesc:gaa566196b7c6970c255feac4cf9f3bf40"><td class="mdescLeft"> </td><td class="mdescRight">Removes a plugin path at a specified index from the plugin search path list. <br /></td></tr>
<tr class="separator:gaa566196b7c6970c255feac4cf9f3bf40"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga64a3c5450d91455624ecba582553d905" id="r_ga64a3c5450d91455624ecba582553d905"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga64a3c5450d91455624ecba582553d905">H5PLget</a> (unsigned int index, char *path_buf, size_t buf_size)</td></tr>
<tr class="memdesc:ga64a3c5450d91455624ecba582553d905"><td class="mdescLeft"> </td><td class="mdescRight">Queries the plugin search path list at the specified index. <br /></td></tr>
<tr class="separator:ga64a3c5450d91455624ecba582553d905"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga30b799ad7e9645312ef8975a610b4b18" id="r_ga30b799ad7e9645312ef8975a610b4b18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga30b799ad7e9645312ef8975a610b4b18">H5PLsize</a> (unsigned int *num_paths)</td></tr>
<tr class="memdesc:ga30b799ad7e9645312ef8975a610b4b18"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the number of stored plugin paths. <br /></td></tr>
<tr class="separator:ga30b799ad7e9645312ef8975a610b4b18"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gac74200fdc02f794f3fae753fe8b850b0" name="gac74200fdc02f794f3fae753fe8b850b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac74200fdc02f794f3fae753fe8b850b0">◆ </a></span>H5PLappend()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5PLappend </td>
<td>(</td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>search_path</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Inserts a plugin path at the end of the plugin search path list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">search_path</td><td>A plugin path </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gac74200fdc02f794f3fae753fe8b850b0" title="Inserts a plugin path at the end of the plugin search path list.">H5PLappend()</a> inserts a plugin path at the end of the plugin search path list.</p>
<dl class="section since"><dt>Since</dt><dd>1.10.1 </dd></dl>
</div>
</div>
<a id="ga64a3c5450d91455624ecba582553d905" name="ga64a3c5450d91455624ecba582553d905"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga64a3c5450d91455624ecba582553d905">◆ </a></span>H5PLget()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> H5PLget </td>
<td>(</td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>index</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>path_buf</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>buf_size</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Queries the plugin search path list at the specified index. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">path_buf</td><td>Pathname </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">buf_size</td><td>Size of <code>path_buf</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the length of the path, a non-negative value, if successful; otherwise returns a negative value.</dd></dl>
<p><a class="el" href="#ga64a3c5450d91455624ecba582553d905" title="Queries the plugin search path list at the specified index.">H5PLget()</a> queries the plugin path at a specified index. If <code>path_buf</code> is non-NULL then it writes up to <code>buf_size</code> bytes into that buffer and always returns the length of the path name.</p>
<p>If <code>path_buf</code> is NULL, this function will simply return the number of characters required to store the path name, ignoring <code>path_buf</code> and <code>buf_size</code>.</p>
<p>If an error occurs then the buffer pointed to by <code>path_buf</code> (NULL or non-NULL) is unchanged and the function returns a negative value. If a zero is returned for the name's length, then there is no path name associated with the index. and the <code>path_buf</code> buffer will be unchanged.</p>
<dl class="section since"><dt>Since</dt><dd>1.10.1 </dd></dl>
</div>
</div>
<a id="gadde42938cf1cc41fa392e8719050b52a" name="gadde42938cf1cc41fa392e8719050b52a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadde42938cf1cc41fa392e8719050b52a">◆ </a></span>H5PLget_loading_state()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5PLget_loading_state </td>
<td>(</td>
<td class="paramtype">unsigned int *</td> <td class="paramname"><span class="paramname"><em>plugin_control_mask</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Queries the loadability of dynamic plugin types. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">plugin_control_mask</td><td>List of dynamic plugin types that are enabled or disabled.<br />
A plugin bit set to 0 (zero) indicates that the dynamic plugin type is disabled.<br />
A plugin bit set to 1 (one) indicates that the dynamic plugin type is enabled.<br />
If the value of <code>plugin_control_mask</code> is negative, all dynamic plugin types are enabled.<br />
If the value of <code>plugin_control_mask</code> is 0 (zero), all dynamic plugins are disabled. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gadde42938cf1cc41fa392e8719050b52a" title="Queries the loadability of dynamic plugin types.">H5PLget_loading_state()</a> retrieves the bitmask that controls whether a certain type of plugin (e.g.: filters, VOL drivers) will be loaded by the HDF5 library.</p>
<p>Bit positions allocated to date are specified in <a class="el" href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86f">H5PL_type_t</a> as follows: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86f">H5PL_type_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86fae335485e955aa13e2fa68e07db2e3849">H5PL_TYPE_ERROR</a> = -1, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86fa07a9b7f82eadd1f4c70ec6e67d8a3f00">H5PL_TYPE_FILTER</a> = 0, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86fab01b3951d7e978b43e505590a6431bf0">H5PL_TYPE_VOL</a> = 1, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86fa6df516700d4cb82915d6fe276cf70629">H5PL_TYPE_VFD</a> = 2, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86fa90f9d05bec563c3854960a245a27d36e">H5PL_TYPE_NONE</a> = 3 </div>
<div class="line">} <a class="code hl_enumeration" href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86f">H5PL_type_t</a>;</div>
</div><!-- fragment --><dl class="section since"><dt>Since</dt><dd>1.8.15 </dd></dl>
</div>
</div>
<a id="gacc5153b0db6b3f876c3980bf34f931fc" name="gacc5153b0db6b3f876c3980bf34f931fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacc5153b0db6b3f876c3980bf34f931fc">◆ </a></span>H5PLinsert()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5PLinsert </td>
<td>(</td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>search_path</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>index</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Inserts a path at the specified index in the plugin search path list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">search_path</td><td>A plugin path </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gacc5153b0db6b3f876c3980bf34f931fc" title="Inserts a path at the specified index in the plugin search path list.">H5PLinsert()</a> inserts a plugin path at the specified index in the plugin search path list, moving other paths after <code>index</code>.</p>
<dl class="section since"><dt>Since</dt><dd>1.10.1 </dd></dl>
</div>
</div>
<a id="ga1f2300ef2de6e430af330de7d194576f" name="ga1f2300ef2de6e430af330de7d194576f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1f2300ef2de6e430af330de7d194576f">◆ </a></span>H5PLprepend()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5PLprepend </td>
<td>(</td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>search_path</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Inserts a plugin path at the beginning of the plugin search path list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">search_path</td><td>A plugin path </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga1f2300ef2de6e430af330de7d194576f" title="Inserts a plugin path at the beginning of the plugin search path list.">H5PLprepend()</a> inserts a plugin path at the end of the plugin search path list.</p>
<dl class="section since"><dt>Since</dt><dd>1.10.1 </dd></dl>
</div>
</div>
<a id="gaa566196b7c6970c255feac4cf9f3bf40" name="gaa566196b7c6970c255feac4cf9f3bf40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa566196b7c6970c255feac4cf9f3bf40">◆ </a></span>H5PLremove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5PLremove </td>
<td>(</td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>index</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes a plugin path at a specified index from the plugin search path list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gaa566196b7c6970c255feac4cf9f3bf40" title="Removes a plugin path at a specified index from the plugin search path list.">H5PLremove()</a> removes a plugin path at the specified <code>index</code> and compacts the plugin search path list.</p>
<dl class="section since"><dt>Since</dt><dd>1.10.1 </dd></dl>
</div>
</div>
<a id="gab0f8d4e8d0b81cb55cf8b9de5095dc0b" name="gab0f8d4e8d0b81cb55cf8b9de5095dc0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab0f8d4e8d0b81cb55cf8b9de5095dc0b">◆ </a></span>H5PLreplace()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5PLreplace </td>
<td>(</td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>search_path</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>index</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Replaces the path at the specified index in the plugin search path list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">search_path</td><td>A plugin path </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Index </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gab0f8d4e8d0b81cb55cf8b9de5095dc0b" title="Replaces the path at the specified index in the plugin search path list.">H5PLreplace()</a> replaces a plugin path at the specified index in the plugin search path list.</p>
<dl class="section since"><dt>Since</dt><dd>1.10.1 </dd></dl>
</div>
</div>
<a id="ga3ee7276ca1168b175661db3866f8db0e" name="ga3ee7276ca1168b175661db3866f8db0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3ee7276ca1168b175661db3866f8db0e">◆ </a></span>H5PLset_loading_state()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5PLset_loading_state </td>
<td>(</td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>plugin_control_mask</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Controls the loadability of dynamic plugin types. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plugin_control_mask</td><td>The list of dynamic plugin types to enable or disable.<br />
A plugin bit set to 0 (zero) prevents use of that dynamic plugin.<br />
A plugin bit set to 1 (one) enables use of that dynamic plugin.<br />
Setting <code>plugin_control_mask</code> to a negative value enables all dynamic plugin types.<br />
Setting <code>plugin_control_mask</code> to 0 (zero) disables all dynamic plugin<br />
types. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga3ee7276ca1168b175661db3866f8db0e" title="Controls the loadability of dynamic plugin types.">H5PLset_loading_state()</a> uses one argument to enable or disable individual plugin types.</p>
<p>The <code>plugin_control_mask</code> parameter is an encoded integer in which each bit controls a specific plugin type. Bit positions allocated to date are specified in <a class="el" href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86f">H5PL_type_t</a> as follows: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86f">H5PL_type_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86fae335485e955aa13e2fa68e07db2e3849">H5PL_TYPE_ERROR</a> = -1, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86fa07a9b7f82eadd1f4c70ec6e67d8a3f00">H5PL_TYPE_FILTER</a> = 0, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86fab01b3951d7e978b43e505590a6431bf0">H5PL_TYPE_VOL</a> = 1, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86fa6df516700d4cb82915d6fe276cf70629">H5PL_TYPE_VFD</a> = 2, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86fa90f9d05bec563c3854960a245a27d36e">H5PL_TYPE_NONE</a> = 3 </div>
<div class="line">} <a class="code hl_enumeration" href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86f">H5PL_type_t</a>;</div>
</div><!-- fragment --><p>A plugin bit set to 0 (zero) prevents the use of the dynamic plugin type corresponding to that bit position. A plugin bit set to 1 (one) allows the use of that dynamic plugin type.</p>
<p>All dynamic plugin types can be enabled by setting <code>plugin_control_mask</code> to a negative value. A value of 0 (zero) will disable all dynamic plugin types.</p>
<p>The loading of external dynamic plugins can be controlled during runtime with an environment variable, <code>HDF5_PLUGIN_PRELOAD</code>. <a class="el" href="#ga3ee7276ca1168b175661db3866f8db0e" title="Controls the loadability of dynamic plugin types.">H5PLset_loading_state()</a> inspects the <code>HDF5_PLUGIN_PRELOAD</code> environment variable every time it is called. If the environment variable is set to the special <code>::</code> string, all dynamic plugins are disabled.</p>
<dl class="section warning"><dt>Warning</dt><dd>The environment variable <code>HDF5_PLUGIN_PRELOAD</code> controls the loading of dynamic plugin types at runtime. If it is set to disable all plugin types, then it will disable them for <em>all</em> running programs that access the same variable instance.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.15 </dd></dl>
</div>
</div>
<a id="ga30b799ad7e9645312ef8975a610b4b18" name="ga30b799ad7e9645312ef8975a610b4b18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga30b799ad7e9645312ef8975a610b4b18">◆ </a></span>H5PLsize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5PLsize </td>
<td>(</td>
<td class="paramtype">unsigned int *</td> <td class="paramname"><span class="paramname"><em>num_paths</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the number of stored plugin paths. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">num_paths</td><td>Current length of the plugin search path list </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga30b799ad7e9645312ef8975a610b4b18" title="Retrieves the number of stored plugin paths.">H5PLsize()</a> retrieves the number of paths stored in the plugin search path list.</p>
<dl class="section since"><dt>Since</dt><dd>1.10.1 </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.10.0 </li>
</ul>
</div>
</body>
</html>
|
