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
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
|
<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: Java VOL Connector (H5VL) 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>
<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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(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</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="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.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group___j_h5_v_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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Java VOL Connector (H5VL) 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_v_l.html">VOL connector (H5VL)</a>, C-API</dd>
<dd>
<a class="el" href="_h5_v_l__u_g.html">The HDF5 Virtual Object Layer (VOL)</a>, User Guide </dd></dl>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga501c72a5ce21c79f4803600965789b9f"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_v_l.html#ga501c72a5ce21c79f4803600965789b9f">H5VLregister_connector_by_name</a> (String connector_name, long vipl_id) throws HDF5LibraryException</td></tr>
<tr class="separator:ga501c72a5ce21c79f4803600965789b9f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga47a607e0d5770b1c79591f9c9c594fad"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_v_l.html#ga47a607e0d5770b1c79591f9c9c594fad">H5VLregister_connector_by_value</a> (int connector_value, long vipl_id) throws HDF5LibraryException</td></tr>
<tr class="separator:ga47a607e0d5770b1c79591f9c9c594fad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga54d7cb0f2b8c9ad464b010c4ccad6df4"><td class="memItemLeft" align="right" valign="top">static synchronized native boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_v_l.html#ga54d7cb0f2b8c9ad464b010c4ccad6df4">H5VLis_connector_registered_by_name</a> (String name) throws HDF5LibraryException</td></tr>
<tr class="separator:ga54d7cb0f2b8c9ad464b010c4ccad6df4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga05c5ba20915d9a493474b47c5d49832e"><td class="memItemLeft" align="right" valign="top">static synchronized native boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_v_l.html#ga05c5ba20915d9a493474b47c5d49832e">H5VLis_connector_registered_by_value</a> (int connector_value) throws HDF5LibraryException</td></tr>
<tr class="separator:ga05c5ba20915d9a493474b47c5d49832e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga24d2122ae620f948e576430a2e6adec0"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_v_l.html#ga24d2122ae620f948e576430a2e6adec0">H5VLget_connector_id</a> (long object_id) throws HDF5LibraryException</td></tr>
<tr class="separator:ga24d2122ae620f948e576430a2e6adec0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga192901b47f43b4dc00f7bbef0f308a2f"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_v_l.html#ga192901b47f43b4dc00f7bbef0f308a2f">H5VLget_connector_id_by_name</a> (String name) throws HDF5LibraryException</td></tr>
<tr class="separator:ga192901b47f43b4dc00f7bbef0f308a2f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5a90545b82cc2551d32eaae12059197e"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_v_l.html#ga5a90545b82cc2551d32eaae12059197e">H5VLget_connector_id_by_value</a> (int connector_value) throws HDF5LibraryException</td></tr>
<tr class="separator:ga5a90545b82cc2551d32eaae12059197e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8130a8e4974f9bb3e8491cd30581cf93"><td class="memItemLeft" align="right" valign="top">static synchronized native String </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_v_l.html#ga8130a8e4974f9bb3e8491cd30581cf93">H5VLget_connector_name</a> (long object_id) throws HDF5LibraryException</td></tr>
<tr class="separator:ga8130a8e4974f9bb3e8491cd30581cf93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7eb33aa9608a32287769a5d797c62b54"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_v_l.html#ga7eb33aa9608a32287769a5d797c62b54">H5VLclose</a> (long connector_id) throws HDF5LibraryException</td></tr>
<tr class="separator:ga7eb33aa9608a32287769a5d797c62b54"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaec02be3715f1a4d71ba1a5d78524cbb3"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5_v_l.html#gaec02be3715f1a4d71ba1a5d78524cbb3">H5VLunregister_connector</a> (long connector_id) throws HDF5LibraryException</td></tr>
<tr class="separator:gaec02be3715f1a4d71ba1a5d78524cbb3"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga7eb33aa9608a32287769a5d797c62b54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7eb33aa9608a32287769a5d797c62b54">◆ </a></span>H5VLclose()</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 H5VLclose </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>connector_id</em></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>H5VLclose closes a VOL connector ID.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">connector_id</td><td>IN: Identifier of the connector.</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="ga24d2122ae620f948e576430a2e6adec0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga24d2122ae620f948e576430a2e6adec0">◆ </a></span>H5VLget_connector_id()</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 long H5VLget_connector_id </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>object_id</em></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>H5VLget_connector_id retrieves the ID for a registered VOL connector for a given object.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">object_id</td><td>IN: Identifier of the object.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a VOL connector ID</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="ga192901b47f43b4dc00f7bbef0f308a2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga192901b47f43b4dc00f7bbef0f308a2f">◆ </a></span>H5VLget_connector_id_by_name()</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 long H5VLget_connector_id_by_name </td>
<td>(</td>
<td class="paramtype">String </td>
<td class="paramname"><em>name</em></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>H5VLget_connector_id_by_name retrieves the ID for a registered VOL connector.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>IN: name of the connector.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a VOL connector ID</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="ga5a90545b82cc2551d32eaae12059197e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5a90545b82cc2551d32eaae12059197e">◆ </a></span>H5VLget_connector_id_by_value()</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 long H5VLget_connector_id_by_value </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>connector_value</em></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>H5VLget_connector_id_by_value retrieves the ID for a registered VOL connector.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">connector_value</td><td>IN: value of the connector.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a VOL connector ID</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="ga8130a8e4974f9bb3e8491cd30581cf93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8130a8e4974f9bb3e8491cd30581cf93">◆ </a></span>H5VLget_connector_name()</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 H5VLget_connector_name </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>object_id</em></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>H5VLget_connector_name returns the connector name for the VOL associated with the object or file ID.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">object_id</td><td>IN: Identifier of the object.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the connector name</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="ga54d7cb0f2b8c9ad464b010c4ccad6df4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga54d7cb0f2b8c9ad464b010c4ccad6df4">◆ </a></span>H5VLis_connector_registered_by_name()</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 boolean H5VLis_connector_registered_by_name </td>
<td>(</td>
<td class="paramtype">String </td>
<td class="paramname"><em>name</em></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>H5VLis_connector_registered_by_name tests whether a VOL class has been registered.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>IN: name of the connector.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if a VOL connector with that name has been registered</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="ga05c5ba20915d9a493474b47c5d49832e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga05c5ba20915d9a493474b47c5d49832e">◆ </a></span>H5VLis_connector_registered_by_value()</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 boolean H5VLis_connector_registered_by_value </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>connector_value</em></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>H5VLis_connector_registered_by_value tests whether a VOL class has been registered.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">connector_value</td><td>IN: value of the connector.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if a VOL connector with that value has been registered</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="ga501c72a5ce21c79f4803600965789b9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga501c72a5ce21c79f4803600965789b9f">◆ </a></span>H5VLregister_connector_by_name()</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 long H5VLregister_connector_by_name </td>
<td>(</td>
<td class="paramtype">String </td>
<td class="paramname"><em>connector_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>vipl_id</em> </td>
</tr>
<tr>
<td></td>
<td>)</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>H5VLregister_connector_by_name registers a new VOL connector as a member of the virtual object layer class.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">connector_name</td><td>IN: name of the connector. </td></tr>
<tr><td class="paramname">vipl_id</td><td>IN: VOL initialization property list which must be created with H5Pcreate(H5P_VOL_INITIALIZE) (or H5P_DEFAULT).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a VOL connector ID</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="ga47a607e0d5770b1c79591f9c9c594fad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga47a607e0d5770b1c79591f9c9c594fad">◆ </a></span>H5VLregister_connector_by_value()</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 long H5VLregister_connector_by_value </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>connector_value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>vipl_id</em> </td>
</tr>
<tr>
<td></td>
<td>)</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>H5VLregister_connector_by_value registers a new VOL connector as a member of the virtual object layer class.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">connector_value</td><td>IN: value of the connector. </td></tr>
<tr><td class="paramname">vipl_id</td><td>IN: VOL initialization property list which must be created with H5Pcreate(H5P_VOL_INITIALIZE) (or H5P_DEFAULT).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a VOL connector ID</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="gaec02be3715f1a4d71ba1a5d78524cbb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaec02be3715f1a4d71ba1a5d78524cbb3">◆ </a></span>H5VLunregister_connector()</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 H5VLunregister_connector </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>connector_id</em></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>H5VLunregister_connector removes a VOL connector ID from the library.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">connector_id</td><td>IN: Identifier of the connector.</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>
</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.9.1 </li>
</ul>
</div>
</body>
</html>
|
