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
|
<!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: Java Plugin (H5PL) Interface</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___j_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">Java Plugin (H5PL) Interface</div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_p_l.html">Dynamically-loaded Plugins (H5PL)</a>, C-API</dd>
<dd>
<a class="el" href="_h5_p_l__u_g.html">The HDF5 Plugins</a>, User Guide </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:gac915e1a0dadcb33ae907fce5138a67b4" id="r_gac915e1a0dadcb33ae907fce5138a67b4"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gac915e1a0dadcb33ae907fce5138a67b4">H5PLset_loading_state</a> (int plugin_flags) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:gac915e1a0dadcb33ae907fce5138a67b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabc5575d30abd0e12fc384d2a72e0d77d" id="r_gabc5575d30abd0e12fc384d2a72e0d77d"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="#gabc5575d30abd0e12fc384d2a72e0d77d">H5PLget_loading_state</a> () throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:gabc5575d30abd0e12fc384d2a72e0d77d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1c81591d0f7f74f6addf22fe1b26a724" id="r_ga1c81591d0f7f74f6addf22fe1b26a724"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1c81591d0f7f74f6addf22fe1b26a724">H5PLappend</a> (String plugin_path) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:ga1c81591d0f7f74f6addf22fe1b26a724"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga877ff026cf5a3be493c71e06b543c1f6" id="r_ga877ff026cf5a3be493c71e06b543c1f6"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga877ff026cf5a3be493c71e06b543c1f6">H5PLprepend</a> (String plugin_path) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:ga877ff026cf5a3be493c71e06b543c1f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1cd24b01797d556dacf66d04dc068499" id="r_ga1cd24b01797d556dacf66d04dc068499"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1cd24b01797d556dacf66d04dc068499">H5PLreplace</a> (String plugin_path, int index) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:ga1cd24b01797d556dacf66d04dc068499"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf05018428cac6b3de1f769687aefbd6c" id="r_gaf05018428cac6b3de1f769687aefbd6c"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf05018428cac6b3de1f769687aefbd6c">H5PLinsert</a> (String plugin_path, int index) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:gaf05018428cac6b3de1f769687aefbd6c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5cb98e6c7b99fe31e1d84d1404de5a53" id="r_ga5cb98e6c7b99fe31e1d84d1404de5a53"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5cb98e6c7b99fe31e1d84d1404de5a53">H5PLremove</a> (int index) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:ga5cb98e6c7b99fe31e1d84d1404de5a53"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8ba0158e2050ad5a4c673dee97648670" id="r_ga8ba0158e2050ad5a4c673dee97648670"><td class="memItemLeft" align="right" valign="top">static synchronized native String </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8ba0158e2050ad5a4c673dee97648670">H5PLget</a> (int index) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:ga8ba0158e2050ad5a4c673dee97648670"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga142d7d39d2ed2f5ff06997701980d29c" id="r_ga142d7d39d2ed2f5ff06997701980d29c"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga142d7d39d2ed2f5ff06997701980d29c">H5PLsize</a> () throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:ga142d7d39d2ed2f5ff06997701980d29c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga1c81591d0f7f74f6addf22fe1b26a724" name="ga1c81591d0f7f74f6addf22fe1b26a724"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1c81591d0f7f74f6addf22fe1b26a724">◆ </a></span>H5PLappend()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static synchronized native void H5PLappend </td>
<td>(</td>
<td class="paramtype">String</td> <td class="paramname"><span class="paramname"><em>plugin_path</em></span></td><td>)</td>
<td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>H5PLappend inserts the plugin path at the end of the table.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">plugin_path</td><td>IN: Path for location of filter plugin libraries.</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga8ba0158e2050ad5a4c673dee97648670" name="ga8ba0158e2050ad5a4c673dee97648670"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8ba0158e2050ad5a4c673dee97648670">◆ </a></span>H5PLget()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static synchronized native String H5PLget </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>index</em></span></td><td>)</td>
<td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>H5PLget retrieves the plugin path at the specified index.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>IN: The table index (0-based).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the current path at the index in plugin path table</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gabc5575d30abd0e12fc384d2a72e0d77d" name="gabc5575d30abd0e12fc384d2a72e0d77d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabc5575d30abd0e12fc384d2a72e0d77d">◆ </a></span>H5PLget_loading_state()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static synchronized native int H5PLget_loading_state </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>H5PLget_loading_state retrieves the state of the dynamic plugins flag, plugin_flags..</p>
<dl class="section return"><dt>Returns</dt><dd>the list of dynamic plugin types that are enabled or disabled. A plugin bit set to 0 (zero) indicates that that dynamic plugin is disabled. A plugin bit set to 1 (one) indicates that that dynamic plugin is enabled. If the value of plugin_flags is negative, all dynamic plugins are enabled. If the value of plugin_flags is 0 (zero), all dynamic plugins are disabled.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaf05018428cac6b3de1f769687aefbd6c" name="gaf05018428cac6b3de1f769687aefbd6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf05018428cac6b3de1f769687aefbd6c">◆ </a></span>H5PLinsert()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static synchronized native void H5PLinsert </td>
<td>(</td>
<td class="paramtype">String</td> <td class="paramname"><span class="paramname"><em>plugin_path</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>index</em></span> ) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>H5PLinsert inserts the plugin path at the specified index.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">plugin_path</td><td>IN: Path for location of filter plugin libraries. </td></tr>
<tr><td class="paramname">index</td><td>IN: The table index (0-based).</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga877ff026cf5a3be493c71e06b543c1f6" name="ga877ff026cf5a3be493c71e06b543c1f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga877ff026cf5a3be493c71e06b543c1f6">◆ </a></span>H5PLprepend()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static synchronized native void H5PLprepend </td>
<td>(</td>
<td class="paramtype">String</td> <td class="paramname"><span class="paramname"><em>plugin_path</em></span></td><td>)</td>
<td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>H5PLprepend inserts the plugin path at the beginning of the table.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">plugin_path</td><td>IN: Path for location of filter plugin libraries.</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga5cb98e6c7b99fe31e1d84d1404de5a53" name="ga5cb98e6c7b99fe31e1d84d1404de5a53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5cb98e6c7b99fe31e1d84d1404de5a53">◆ </a></span>H5PLremove()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static synchronized native void H5PLremove </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>index</em></span></td><td>)</td>
<td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>H5PLremove removes the plugin path at the specified index.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>IN: The table index (0-based).</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga1cd24b01797d556dacf66d04dc068499" name="ga1cd24b01797d556dacf66d04dc068499"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1cd24b01797d556dacf66d04dc068499">◆ </a></span>H5PLreplace()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static synchronized native void H5PLreplace </td>
<td>(</td>
<td class="paramtype">String</td> <td class="paramname"><span class="paramname"><em>plugin_path</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>index</em></span> ) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>H5PLreplace replaces the plugin path at the specified index.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">plugin_path</td><td>IN: Path for location of filter plugin libraries. </td></tr>
<tr><td class="paramname">index</td><td>IN: The table index (0-based).</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gac915e1a0dadcb33ae907fce5138a67b4" name="gac915e1a0dadcb33ae907fce5138a67b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac915e1a0dadcb33ae907fce5138a67b4">◆ </a></span>H5PLset_loading_state()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static synchronized native void H5PLset_loading_state </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>plugin_flags</em></span></td><td>)</td>
<td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>H5PLset_loading_state uses one argument to enable or disable individual plugins. The plugin_flags parameter is an encoded integer in which each bit controls a specific plugin or class of plugins. A plugin bit set to 0 (zero) prevents the use of the dynamic plugin corresponding to that bit position. A plugin bit set to 1 (one) allows the use of that dynamic plugin. All dynamic plugins can be enabled by setting plugin_flags to a negative value. A value of 0 (zero) will disable all dynamic plugins.</p>
<p>H5PLset_loading_state inspects the HDF5_PLUGIN_PRELOAD environment variable every time it is called. If the environment variable is set to the special :: string, all dynamic plugins will be disabled.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">plugin_flags</td><td>IN: The list of dynamic plugin types to enable or disable. A plugin bit set to 0 (zero) prevents use of that dynamic plugin. A plugin bit set to 1 (one) enables use of that dynamic plugin. Setting plugin_flags to a negative value enables all dynamic plugins. Setting plugin_flags to 0 (zero) disables all dynamic plugins.</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga142d7d39d2ed2f5ff06997701980d29c" name="ga142d7d39d2ed2f5ff06997701980d29c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga142d7d39d2ed2f5ff06997701980d29c">◆ </a></span>H5PLsize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static synchronized native int H5PLsize </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>H5PLsize retrieves the size of the current list of plugin paths.</p>
<dl class="section return"><dt>Returns</dt><dd>the current number of paths in the plugin path table</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr>
</table>
</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>
|
