diff options
| author | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-06-26 19:22:17 (GMT) |
|---|---|---|
| committer | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-06-26 19:22:17 (GMT) |
| commit | d12e43bc201e15edffcdf94fe820aeae6ab44882 (patch) | |
| tree | 90aa12006b20849b65b7bc8e3d4fe60a488f7247 /group___h5_v_l.html | |
| parent | 4d49d1ee001bd4dff6b01e1830902bee22a19f3e (diff) | |
| download | hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.zip hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.gz hdf5-d12e43bc201e15edffcdf94fe820aeae6ab44882.tar.bz2 | |
deploy: ab4d2aec9779b7a37747c95bd7b514417b299f73
Diffstat (limited to 'group___h5_v_l.html')
| -rw-r--r-- | group___h5_v_l.html | 671 |
1 files changed, 671 insertions, 0 deletions
diff --git a/group___h5_v_l.html b/group___h5_v_l.html new file mode 100644 index 0000000..c7013e6 --- /dev/null +++ b/group___h5_v_l.html @@ -0,0 +1,671 @@ +<!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: VOL connector (H5VL)</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.ab4d2ae</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___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="#groups">Modules</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">VOL connector (H5VL)</div> </div> +</div><!--header--> +<div class="contents"> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000033">Todo:</a></b></dt><dd>Describe the VOL plugin life cycle.</dd></dl> +<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> + <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for VOL connector (H5VL):</div> +<div id="dynsection-0-summary" class="dynsummary" style="display:block;"> +</div> +<div id="dynsection-0-content" class="dyncontent" style="display:none;"> +<div class="center"><img src="group___h5_v_l.png" border="0" usemap="#agroup______h5__v__l" alt=""/></div> +<map name="agroup______h5__v__l" id="agroup______h5__v__l"> +<area shape="rect" title=" " alt="" coords="5,80,169,105"/> +<area shape="rect" href="group___h5_v_l_d_e_f.html" title=" " alt="" coords="239,5,331,31"/> +<area shape="rect" href="group___h5_v_l_d_e_v.html" title=" " alt="" coords="226,55,345,80"/> +<area shape="rect" href="group___h5_v_l_p_t.html" title=" " alt="" coords="217,104,353,129"/> +<area shape="rect" href="group___h5_v_l_n_a_t.html" title=" " alt="" coords="238,153,333,179"/> +</map> +</div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a> +Modules</h2></td></tr> +<tr class="memitem:group___h5_v_l_d_e_f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_v_l_d_e_f.html">Definitions</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:group___h5_v_l_n_a_t"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_v_l_n_a_t.html">Native VOL</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:group___h5_v_l_p_t"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_v_l_p_t.html">Pass-through VOL</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:group___h5_v_l_d_e_v"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_v_l_d_e_v.html">VOL Developer</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:ga9873d50b395911b609621c22c2fa554b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_v_l.html#ga9873d50b395911b609621c22c2fa554b">H5VLwrap_register</a> (void *obj, <a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a> type)</td></tr> +<tr class="memdesc:ga9873d50b395911b609621c22c2fa554b"><td class="mdescLeft"> </td><td class="mdescRight">Wrap an internal object with a "wrap context" and register an hid_t for the resulting object. <a href="group___h5_v_l.html#ga9873d50b395911b609621c22c2fa554b">More...</a><br /></td></tr> +<tr class="separator:ga9873d50b395911b609621c22c2fa554b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf48d1225927e1e701656346b832ee6b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_v_l.html#gaf48d1225927e1e701656346b832ee6b1">H5VLregister_connector_by_name</a> (const char *connector_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> vipl_id)</td></tr> +<tr class="memdesc:gaf48d1225927e1e701656346b832ee6b1"><td class="mdescLeft"> </td><td class="mdescRight">Registers a new VOL connector by name. <a href="group___h5_v_l.html#gaf48d1225927e1e701656346b832ee6b1">More...</a><br /></td></tr> +<tr class="separator:gaf48d1225927e1e701656346b832ee6b1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga11e69930e47f654805a265f417412ea8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_v_l.html#ga11e69930e47f654805a265f417412ea8">H5VLregister_connector_by_value</a> (<a class="el" href="group___h5_v_l_d_e_f.html#ga81b40d59b53c498f8aa9d92d0afdde2c">H5VL_class_value_t</a> connector_value, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> vipl_id)</td></tr> +<tr class="memdesc:ga11e69930e47f654805a265f417412ea8"><td class="mdescLeft"> </td><td class="mdescRight">Registers a new VOL connector by value. <a href="group___h5_v_l.html#ga11e69930e47f654805a265f417412ea8">More...</a><br /></td></tr> +<tr class="separator:ga11e69930e47f654805a265f417412ea8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga9be3c92e4430b9cf42a376534a47fcca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_v_l.html#ga9be3c92e4430b9cf42a376534a47fcca">H5VLis_connector_registered_by_name</a> (const char *name)</td></tr> +<tr class="memdesc:ga9be3c92e4430b9cf42a376534a47fcca"><td class="mdescLeft"> </td><td class="mdescRight">Tests whether a VOL class has been registered under a certain name. <a href="group___h5_v_l.html#ga9be3c92e4430b9cf42a376534a47fcca">More...</a><br /></td></tr> +<tr class="separator:ga9be3c92e4430b9cf42a376534a47fcca"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga83ba8986ed68f67c41b492dfd273804b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_v_l.html#ga83ba8986ed68f67c41b492dfd273804b">H5VLis_connector_registered_by_value</a> (<a class="el" href="group___h5_v_l_d_e_f.html#ga81b40d59b53c498f8aa9d92d0afdde2c">H5VL_class_value_t</a> connector_value)</td></tr> +<tr class="memdesc:ga83ba8986ed68f67c41b492dfd273804b"><td class="mdescLeft"> </td><td class="mdescRight">Tests whether a VOL class has been registered for a given value. <a href="group___h5_v_l.html#ga83ba8986ed68f67c41b492dfd273804b">More...</a><br /></td></tr> +<tr class="separator:ga83ba8986ed68f67c41b492dfd273804b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5b69c29931e55208517c598ac3039f77"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_v_l.html#ga5b69c29931e55208517c598ac3039f77">H5VLget_connector_id</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id)</td></tr> +<tr class="memdesc:ga5b69c29931e55208517c598ac3039f77"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the VOL connector identifier for a given object identifier. <a href="group___h5_v_l.html#ga5b69c29931e55208517c598ac3039f77">More...</a><br /></td></tr> +<tr class="separator:ga5b69c29931e55208517c598ac3039f77"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gabcbf9b9b07a6b60e17ff9681684f944d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_v_l.html#gabcbf9b9b07a6b60e17ff9681684f944d">H5VLget_connector_id_by_name</a> (const char *name)</td></tr> +<tr class="memdesc:gabcbf9b9b07a6b60e17ff9681684f944d"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the identifier for a registered VOL connector name. <a href="group___h5_v_l.html#gabcbf9b9b07a6b60e17ff9681684f944d">More...</a><br /></td></tr> +<tr class="separator:gabcbf9b9b07a6b60e17ff9681684f944d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8f6d366bc6b8323bbffe1e5a5ba18bee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_v_l.html#ga8f6d366bc6b8323bbffe1e5a5ba18bee">H5VLget_connector_id_by_value</a> (<a class="el" href="group___h5_v_l_d_e_f.html#ga81b40d59b53c498f8aa9d92d0afdde2c">H5VL_class_value_t</a> connector_value)</td></tr> +<tr class="memdesc:ga8f6d366bc6b8323bbffe1e5a5ba18bee"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the identifier for a registered VOL connector value. <a href="group___h5_v_l.html#ga8f6d366bc6b8323bbffe1e5a5ba18bee">More...</a><br /></td></tr> +<tr class="separator:ga8f6d366bc6b8323bbffe1e5a5ba18bee"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf326406d7733c0ab8d12118c13c78dfa"><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="group___h5_v_l.html#gaf326406d7733c0ab8d12118c13c78dfa">H5VLget_connector_name</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> id, char *name, size_t size)</td></tr> +<tr class="memdesc:gaf326406d7733c0ab8d12118c13c78dfa"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a connector name for a VOL. <a href="group___h5_v_l.html#gaf326406d7733c0ab8d12118c13c78dfa">More...</a><br /></td></tr> +<tr class="separator:gaf326406d7733c0ab8d12118c13c78dfa"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa3324ac7aedf9362b498226903288094"><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="group___h5_v_l.html#gaa3324ac7aedf9362b498226903288094">H5VLclose</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id)</td></tr> +<tr class="memdesc:gaa3324ac7aedf9362b498226903288094"><td class="mdescLeft"> </td><td class="mdescRight">Closes a VOL connector identifier. <a href="group___h5_v_l.html#gaa3324ac7aedf9362b498226903288094">More...</a><br /></td></tr> +<tr class="separator:gaa3324ac7aedf9362b498226903288094"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaffbdc22f724c2c818f3be3845145d73e"><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="group___h5_v_l.html#gaffbdc22f724c2c818f3be3845145d73e">H5VLunregister_connector</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id)</td></tr> +<tr class="memdesc:gaffbdc22f724c2c818f3be3845145d73e"><td class="mdescLeft"> </td><td class="mdescRight">Removes a VOL connector identifier from the library. <a href="group___h5_v_l.html#gaffbdc22f724c2c818f3be3845145d73e">More...</a><br /></td></tr> +<tr class="separator:gaffbdc22f724c2c818f3be3845145d73e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga17ef00e528d99eda5879d749c2a12043"><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="group___h5_v_l.html#ga17ef00e528d99eda5879d749c2a12043">H5VLquery_optional</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, <a class="el" href="group___h5_v_l_d_e_f.html#ga14175ca7d867657e3e5c2f79a154a599">H5VL_subclass_t</a> subcls, int opt_type, uint64_t *flags)</td></tr> +<tr class="memdesc:ga17ef00e528d99eda5879d749c2a12043"><td class="mdescLeft"> </td><td class="mdescRight">Determine if a VOL connector supports a particular optional callback operation. <a href="group___h5_v_l.html#ga17ef00e528d99eda5879d749c2a12043">More...</a><br /></td></tr> +<tr class="separator:ga17ef00e528d99eda5879d749c2a12043"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad7fa2adf3bb8a834169ef2fa50c76827"><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="group___h5_v_l.html#gad7fa2adf3bb8a834169ef2fa50c76827">H5VLobject_is_native</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, <a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> *is_native)</td></tr> +<tr class="memdesc:gad7fa2adf3bb8a834169ef2fa50c76827"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether an object ID represents a native VOL connector object. <a href="group___h5_v_l.html#gad7fa2adf3bb8a834169ef2fa50c76827">More...</a><br /></td></tr> +<tr class="separator:gad7fa2adf3bb8a834169ef2fa50c76827"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Function Documentation</h2> +<a id="gaa3324ac7aedf9362b498226903288094"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaa3324ac7aedf9362b498226903288094">◆ </a></span>H5VLclose()</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> H5VLclose </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>connector_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Closes a VOL connector identifier. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connector_id</td><td>Connector identifier </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="group___h5_v_l.html#gaa3324ac7aedf9362b498226903288094" title="Closes a VOL connector identifier.">H5VLclose()</a> closes a VOL connector identifier. This does not affect the file access property lists which have been defined to use this VOL connector or files which are already opened under this connector.</p> +<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl> + +</div> +</div> +<a id="ga5b69c29931e55208517c598ac3039f77"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga5b69c29931e55208517c598ac3039f77">◆ </a></span>H5VLget_connector_id()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5VLget_connector_id </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>obj_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Retrieves the VOL connector identifier for a given object identifier. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">obj_id</td><td>Object identifier </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a VOL connector identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl> +<p><a class="el" href="group___h5_v_l.html#ga5b69c29931e55208517c598ac3039f77" title="Retrieves the VOL connector identifier for a given object identifier.">H5VLget_connector_id()</a> retrieves the registered VOL connector identifier for the specified object identifier <code>obj_id</code>. The VOL connector identifier must be closed with <a class="el" href="group___h5_v_l.html#gaa3324ac7aedf9362b498226903288094" title="Closes a VOL connector identifier.">H5VLclose()</a> when no longer in use.</p> +<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl> + +</div> +</div> +<a id="gabcbf9b9b07a6b60e17ff9681684f944d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gabcbf9b9b07a6b60e17ff9681684f944d">◆ </a></span>H5VLget_connector_id_by_name()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5VLget_connector_id_by_name </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>name</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Retrieves the identifier for a registered VOL connector name. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Connector name </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a VOL connector identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl> +<p><a class="el" href="group___h5_v_l.html#gabcbf9b9b07a6b60e17ff9681684f944d" title="Retrieves the identifier for a registered VOL connector name.">H5VLget_connector_id_by_name()</a> retrieves the identifier for a registered VOL connector with the name <code>name</code>. The identifier must be closed with <a class="el" href="group___h5_v_l.html#gaa3324ac7aedf9362b498226903288094" title="Closes a VOL connector identifier.">H5VLclose()</a> when no longer in use.</p> +<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl> + +</div> +</div> +<a id="ga8f6d366bc6b8323bbffe1e5a5ba18bee"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga8f6d366bc6b8323bbffe1e5a5ba18bee">◆ </a></span>H5VLget_connector_id_by_value()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5VLget_connector_id_by_value </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group___h5_v_l_d_e_f.html#ga81b40d59b53c498f8aa9d92d0afdde2c">H5VL_class_value_t</a> </td> + <td class="paramname"><em>connector_value</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Retrieves the identifier for a registered VOL connector value. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connector_value</td><td>Connector value </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a VOL connector identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl> +<p><a class="el" href="group___h5_v_l.html#ga8f6d366bc6b8323bbffe1e5a5ba18bee" title="Retrieves the identifier for a registered VOL connector value.">H5VLget_connector_id_by_value()</a> retrieves the identifier for a registered VOL connector with the value <code>connector_value</code>. The identifier will need to be closed by <a class="el" href="group___h5_v_l.html#gaa3324ac7aedf9362b498226903288094" title="Closes a VOL connector identifier.">H5VLclose()</a>.</p> +<p><code>connector_value</code> has a type of H5VL_class_value_t, which is defined in <a class="el" href="_h5_v_lpublic_8h.html">H5VLpublic.h</a> as follows: </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="group___h5_v_l_d_e_f.html#ga81b40d59b53c498f8aa9d92d0afdde2c">H5VL_class_value_t</a>;</div> +<div class="ttc" id="agroup___h5_v_l_d_e_f_html_ga81b40d59b53c498f8aa9d92d0afdde2c"><div class="ttname"><a href="group___h5_v_l_d_e_f.html#ga81b40d59b53c498f8aa9d92d0afdde2c">H5VL_class_value_t</a></div><div class="ttdeci">int H5VL_class_value_t</div><div class="ttdoc">VOL connector identifiers.</div><div class="ttdef"><b>Definition:</b> H5VLpublic.h:144</div></div> +</div><!-- fragment --><p> Valid VOL connector identifiers can have values from 0 through 255 for connectors defined by the HDF5 library. Values 256 through 511 are available for testing new connectors. Subsequent values should be obtained by contacting the The HDF Help Desk.</p> +<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl> + +</div> +</div> +<a id="gaf326406d7733c0ab8d12118c13c78dfa"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaf326406d7733c0ab8d12118c13c78dfa">◆ </a></span>H5VLget_connector_name()</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> H5VLget_connector_name </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>size</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Retrieves a connector name for a VOL. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>Object identifier or file identifier </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>Connector name </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Maximum length of the name to retrieve </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns the length of the connector name on success, and a negative value on failure.</dd></dl> +<p><a class="el" href="group___h5_v_l.html#gaf326406d7733c0ab8d12118c13c78dfa" title="Retrieves a connector name for a VOL.">H5VLget_connector_name()</a> retrieves up to <code>size</code> elements of the VOL name <code>name</code> associated with the object or file identifier <code>id</code>.</p> +<p>Passing in a NULL pointer for size will return the size of the connector name. This can be used to determine the size of the buffer to allocate for the name.</p> +<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl> + +</div> +</div> +<a id="ga9be3c92e4430b9cf42a376534a47fcca"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga9be3c92e4430b9cf42a376534a47fcca">◆ </a></span>H5VLis_connector_registered_by_name()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5VLis_connector_registered_by_name </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>name</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Tests whether a VOL class has been registered under a certain name. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Alleged name of connector </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl> +<p><a class="el" href="group___h5_v_l.html#ga9be3c92e4430b9cf42a376534a47fcca" title="Tests whether a VOL class has been registered under a certain name.">H5VLis_connector_registered_by_name()</a> tests whether a VOL class has been registered or not, according to the supplied connector name <code>name</code>.</p> +<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl> + +</div> +</div> +<a id="ga83ba8986ed68f67c41b492dfd273804b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga83ba8986ed68f67c41b492dfd273804b">◆ </a></span>H5VLis_connector_registered_by_value()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5VLis_connector_registered_by_value </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group___h5_v_l_d_e_f.html#ga81b40d59b53c498f8aa9d92d0afdde2c">H5VL_class_value_t</a> </td> + <td class="paramname"><em>connector_value</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Tests whether a VOL class has been registered for a given value. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connector_value</td><td>Connector value </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl> +<p><a class="el" href="group___h5_v_l.html#ga83ba8986ed68f67c41b492dfd273804b" title="Tests whether a VOL class has been registered for a given value.">H5VLis_connector_registered_by_value()</a> tests whether a VOL class has been registered, according to the supplied connector value <code>connector_value</code>.</p> +<p><code>connector_value</code> has a type of H5VL_class_value_t, which is defined in <a class="el" href="_h5_v_lpublic_8h.html">H5VLpublic.h</a> as follows: </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="group___h5_v_l_d_e_f.html#ga81b40d59b53c498f8aa9d92d0afdde2c">H5VL_class_value_t</a>;</div> +</div><!-- fragment --><p> Valid VOL connector identifiers can have values from 0 through 255 for connectors defined by the HDF5 library. Values 256 through 511 are available for testing new connectors. Subsequent values should be obtained by contacting the The HDF Help Desk.</p> +<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl> + +</div> +</div> +<a id="gad7fa2adf3bb8a834169ef2fa50c76827"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gad7fa2adf3bb8a834169ef2fa50c76827">◆ </a></span>H5VLobject_is_native()</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> H5VLobject_is_native </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>obj_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> * </td> + <td class="paramname"><em>is_native</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Determines whether an object ID represents a native VOL connector object. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">obj_id</td><td>Object identifier </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">is_native</td><td>Boolean determining whether object is a native VOL connector object </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> +<dl class="section since"><dt>Since</dt><dd>1.12.2 </dd></dl> + +</div> +</div> +<a id="ga17ef00e528d99eda5879d749c2a12043"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga17ef00e528d99eda5879d749c2a12043">◆ </a></span>H5VLquery_optional()</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> H5VLquery_optional </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>obj_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group___h5_v_l_d_e_f.html#ga14175ca7d867657e3e5c2f79a154a599">H5VL_subclass_t</a> </td> + <td class="paramname"><em>subcls</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>opt_type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint64_t * </td> + <td class="paramname"><em>flags</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Determine if a VOL connector supports a particular optional callback operation. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">obj_id</td><td>Object identifier </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">subcls</td><td>VOL subclass </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">opt_type</td><td>Option type </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">flags</td><td>Operation flags </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> +<dl class="section since"><dt>Since</dt><dd>1.12.1 </dd></dl> + +</div> +</div> +<a id="gaf48d1225927e1e701656346b832ee6b1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaf48d1225927e1e701656346b832ee6b1">◆ </a></span>H5VLregister_connector_by_name()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5VLregister_connector_by_name </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>connector_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>vipl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Registers a new VOL connector by name. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connector_name</td><td>Connector name </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">vipl_id</td><td>VOL initialization property list identifier </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a VOL connector identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl> +<p><a class="el" href="group___h5_v_l.html#gaf48d1225927e1e701656346b832ee6b1" title="Registers a new VOL connector by name.">H5VLregister_connector_by_name()</a> registers a new VOL connector with the name <code>connector_name</code> as a member of the virtual object layer class. This VOL connector identifier is good until the library is closed or the connector is unregistered.</p> +<p><code>vipl_id</code> is either <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a> or the identifier of a VOL initialization property list of class <a class="el" href="_h5_ppublic_8h.html#afebc2bfbcba7288957a33837b6a070a5">H5P_VOL_INITIALIZE</a> created with <a class="el" href="group___p_l_c_r.html#gaf1b11da01d4d45d788c45f8bc5f0cbfa" title="Creates a new property list as an instance of a property list class.">H5Pcreate()</a>. When created, this property list contains no library properties. If a VOL connector author decides that initialization-specific data are needed, they can be added to the empty list and retrieved by the connector in the VOL connector's initialize callback. Use of the VOL initialization property list is uncommon, as most VOL-specific properties are added to the file access property list via the connector's API calls which set the VOL connector for the file open/create. For more information, see VOL documentation.</p> +<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl> + +</div> +</div> +<a id="ga11e69930e47f654805a265f417412ea8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga11e69930e47f654805a265f417412ea8">◆ </a></span>H5VLregister_connector_by_value()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5VLregister_connector_by_value </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group___h5_v_l_d_e_f.html#ga81b40d59b53c498f8aa9d92d0afdde2c">H5VL_class_value_t</a> </td> + <td class="paramname"><em>connector_value</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>vipl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Registers a new VOL connector by value. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connector_value</td><td>Connector value </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">vipl_id</td><td>VOL initialization property list identifier </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a VOL connector identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl> +<p><a class="el" href="group___h5_v_l.html#ga11e69930e47f654805a265f417412ea8" title="Registers a new VOL connector by value.">H5VLregister_connector_by_value()</a> registers a new VOL connector with value connector_value as a member of the virtual object layer class. This VOL connector identifier is good until the library is closed or the connector is unregistered.</p> +<p><code>connector_value</code> has a type of H5VL_class_value_t, which is defined in <a class="el" href="_h5_v_lpublic_8h.html">H5VLpublic.h</a> as follows: </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="group___h5_v_l_d_e_f.html#ga81b40d59b53c498f8aa9d92d0afdde2c">H5VL_class_value_t</a>;</div> +</div><!-- fragment --><p> Valid VOL connector identifiers can have values from 0 through 255 for connectors defined by the HDF5 library. Values 256 through 511 are available for testing new connectors. Subsequent values should be obtained by contacting the The HDF Help Desk.</p> +<p><code>vipl_id</code> is either <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a> or the identifier of a VOL initialization property list of class <a class="el" href="_h5_ppublic_8h.html#afebc2bfbcba7288957a33837b6a070a5">H5P_VOL_INITIALIZE</a> created with <a class="el" href="group___p_l_c_r.html#gaf1b11da01d4d45d788c45f8bc5f0cbfa" title="Creates a new property list as an instance of a property list class.">H5Pcreate()</a>. When created, this property list contains no library properties. If a VOL connector author decides that initialization-specific data are needed, they can be added to the empty list and retrieved by the connector in the VOL connector's initialize callback. Use of the VOL initialization property list is uncommon, as most VOL-specific properties are added to the file access property list via the connector's API calls which set the VOL connector for the file open/create. For more information, see the VOL documentation.</p> +<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl> + +</div> +</div> +<a id="gaffbdc22f724c2c818f3be3845145d73e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaffbdc22f724c2c818f3be3845145d73e">◆ </a></span>H5VLunregister_connector()</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> H5VLunregister_connector </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>connector_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Removes a VOL connector identifier from the library. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">connector_id</td><td>Connector identifier </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="group___h5_v_l.html#gaffbdc22f724c2c818f3be3845145d73e" title="Removes a VOL connector identifier from the library.">H5VLunregister_connector()</a> removes a VOL connector identifier from the library. This does not affect the file access property lists which have been defined to use the VOL connector or any files which are already opened with this connector.</p> +<dl class="section attention"><dt>Attention</dt><dd><a class="el" href="group___h5_v_l.html#gaffbdc22f724c2c818f3be3845145d73e" title="Removes a VOL connector identifier from the library.">H5VLunregister_connector()</a> will fail if attempting to unregister the native VOL connector.</dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl> + +</div> +</div> +<a id="ga9873d50b395911b609621c22c2fa554b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga9873d50b395911b609621c22c2fa554b">◆ </a></span>H5VLwrap_register()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5VLwrap_register </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"><em>obj</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a> </td> + <td class="paramname"><em>type</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Wrap an internal object with a "wrap context" and register an hid_t for the resulting object. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">obj</td><td>VOL object. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>VOL-managed object class. Allowable values are:<ul> +<li><a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832bacc572b5478629d17dd4fa708c3508f22">H5I_FILE</a></li> +<li><a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baa839c547a95f216c36697065422162d6">H5I_GROUP</a></li> +<li><a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baf881cdc68cc4082e66091f0b4bfb9e64">H5I_DATATYPE</a></li> +<li><a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baa9f2e1d8a2db4f302d81603217b83987">H5I_DATASET</a></li> +<li><a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baf61d30fecc42d847825922bc97de1b0d">H5I_MAP</a></li> +<li><a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832ba5bdc68e9f466027aeac5f8b11205e51f">H5I_ATTR</a></li> +</ul> +</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a VOL connector identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl> +<dl class="section note"><dt>Note</dt><dd>This routine is mainly targeted toward wrapping objects for iteration routine callbacks (i.e. the callbacks from H5Aiterate*, H5Literate* / H5Lvisit*, and H5Ovisit* ). Using it in an application will return an error indicating the API context isn't available or can't be retrieved. </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 on Mon Jun 26 2023 19:01:39 for HDF5 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> |