mirror of
https://github.com/HDFGroup/hdf5.git
synced 2026-10-01 04:03:33 +03:00
184 lines
14 KiB
HTML
184 lines
14 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.7"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>HDF5: h5vl Module Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript">var page_layout=1;</script>
|
|
<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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(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="doxygen-awesome.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>
|
|
<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>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
|
|
<td id="projectalign">
|
|
<div id="projectname">HDF5<span id="projectnumber"> 1.15.0.405d1b9</span>
|
|
</div>
|
|
<div id="projectbrief">API Reference</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.7 -->
|
|
<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 id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="_getting_started.html"><span>Getting started</span></a></li>
|
|
<li><a href="_u_g.html"><span>User Guide</span></a></li>
|
|
<li><a href="_r_m.html"><span>Reference Manual</span></a></li>
|
|
<li><a href="_cookbook.html"><span>Cookbook</span></a></li>
|
|
<li><a href="_t_n.html"><span>Technical Notes</span></a></li>
|
|
<li><a href="_r_f_c.html"><span>RFCs</span></a></li>
|
|
<li><a href="_s_p_e_c.html"><span>Specifications</span></a></li>
|
|
<li><a href="_g_l_s.html"><span>Glossary</span></a></li>
|
|
<li><a href="_about.html"><span>About</span></a></li>
|
|
<li>
|
|
<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>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</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 */
|
|
$(document).ready(function(){initNavTree('namespaceh5vl.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/Subroutines</a> </div>
|
|
<div class="headertitle"><div class="title">h5vl Module Reference<div class="ingroups"><a class="el" href="group___f_h5_v_l.html">Fortran VOL (H5VL) Interface</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>This module contains Fortran interfaces for H5VL (VOL) functions.
|
|
<a href="namespaceh5vl.html#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions/Subroutines</h2></td></tr>
|
|
<tr class="memitem:gae1026e9f61464afaa7b9e70c0ee8aff1"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#gae1026e9f61464afaa7b9e70c0ee8aff1">h5vlregister_connector_by_name_f</a> (name, vol_id, hdferr, vipl_id)</td></tr>
|
|
<tr class="memdesc:gae1026e9f61464afaa7b9e70c0ee8aff1"><td class="mdescLeft"> </td><td class="mdescRight">Registers a new VOL connector as a member of the virtual object layer class by name. <br /></td></tr>
|
|
<tr class="separator:gae1026e9f61464afaa7b9e70c0ee8aff1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1e816fd8b5abd125fd35c43bb328b922"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#ga1e816fd8b5abd125fd35c43bb328b922">h5vlregister_connector_by_value_f</a> (connector_value, vol_id, hdferr, vipl_id)</td></tr>
|
|
<tr class="memdesc:ga1e816fd8b5abd125fd35c43bb328b922"><td class="mdescLeft"> </td><td class="mdescRight">Registers a new VOL connector by value. <br /></td></tr>
|
|
<tr class="separator:ga1e816fd8b5abd125fd35c43bb328b922"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga76f9920f5babdf76cfa931832667b212"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#ga76f9920f5babdf76cfa931832667b212">h5vlis_connector_registered_by_name_f</a> (name, registered, hdferr)</td></tr>
|
|
<tr class="memdesc:ga76f9920f5babdf76cfa931832667b212"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether a VOL class has been registered or not ccording to a specified connector name. <br /></td></tr>
|
|
<tr class="separator:ga76f9920f5babdf76cfa931832667b212"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa1e4806b94ca9f5e6d4f714b83c9dda9"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#gaa1e4806b94ca9f5e6d4f714b83c9dda9">h5vlis_connector_registered_by_value_f</a> (value, registered, hdferr)</td></tr>
|
|
<tr class="memdesc:gaa1e4806b94ca9f5e6d4f714b83c9dda9"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether a VOL class has been registered or not according to a specified connector value (ID). <br /></td></tr>
|
|
<tr class="separator:gaa1e4806b94ca9f5e6d4f714b83c9dda9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga39618f7f555e75cc7174931085b0dcd1"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#ga39618f7f555e75cc7174931085b0dcd1">h5vlget_connector_id_f</a> (obj_id, vol_id, hdferr)</td></tr>
|
|
<tr class="memdesc:ga39618f7f555e75cc7174931085b0dcd1"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the ID for a registered VOL connector. <br /></td></tr>
|
|
<tr class="separator:ga39618f7f555e75cc7174931085b0dcd1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga89c080746f422a3a046ea3f196cce6fa"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#ga89c080746f422a3a046ea3f196cce6fa">h5vlget_connector_id_by_name_f</a> (name, vol_id, hdferr)</td></tr>
|
|
<tr class="memdesc:ga89c080746f422a3a046ea3f196cce6fa"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the ID for a registered VOL connector. <br /></td></tr>
|
|
<tr class="separator:ga89c080746f422a3a046ea3f196cce6fa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac95c5ad4ff2fd0dbc8b2459fd370f6e6"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#gac95c5ad4ff2fd0dbc8b2459fd370f6e6">h5vlget_connector_id_by_value_f</a> (value, vol_id, hdferr)</td></tr>
|
|
<tr class="memdesc:gac95c5ad4ff2fd0dbc8b2459fd370f6e6"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the ID for a registered VOL connector. <br /></td></tr>
|
|
<tr class="separator:gac95c5ad4ff2fd0dbc8b2459fd370f6e6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6ff828c4094ce6aea90add840102c433"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#ga6ff828c4094ce6aea90add840102c433">h5vlget_connector_name_f</a> (obj_id, name, hdferr, name_len)</td></tr>
|
|
<tr class="memdesc:ga6ff828c4094ce6aea90add840102c433"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a connector name for a VOL. <br /></td></tr>
|
|
<tr class="separator:ga6ff828c4094ce6aea90add840102c433"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8a437cde7583cdcc32b894ee602d4002"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#ga8a437cde7583cdcc32b894ee602d4002">h5vlclose_f</a> (vol_id, hdferr)</td></tr>
|
|
<tr class="memdesc:ga8a437cde7583cdcc32b894ee602d4002"><td class="mdescLeft"> </td><td class="mdescRight">Closes a VOL connector ID. <br /></td></tr>
|
|
<tr class="separator:ga8a437cde7583cdcc32b894ee602d4002"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae8b51f85b767e562299e590032b4f07b"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#gae8b51f85b767e562299e590032b4f07b">h5vlunregister_connector_f</a> (plugin_id, hdferr)</td></tr>
|
|
<tr class="memdesc:gae8b51f85b767e562299e590032b4f07b"><td class="mdescLeft"> </td><td class="mdescRight">Removes a VOL connector ID from the library. <br /></td></tr>
|
|
<tr class="separator:gae8b51f85b767e562299e590032b4f07b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2db86442b96e3aecad0030bf5fdf568d"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#ga2db86442b96e3aecad0030bf5fdf568d">h5vlnative_addr_to_token_f</a> (loc_id, addr, token, hdferr)</td></tr>
|
|
<tr class="memdesc:ga2db86442b96e3aecad0030bf5fdf568d"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the token representation from an address for a location identifier. <br /></td></tr>
|
|
<tr class="separator:ga2db86442b96e3aecad0030bf5fdf568d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8795d5e88090f95347c349b530b181c7"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#ga8795d5e88090f95347c349b530b181c7">h5vlnative_token_to_addr_f</a> (loc_id, token, addr, hdferr)</td></tr>
|
|
<tr class="memdesc:ga8795d5e88090f95347c349b530b181c7"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the object address from a token representation for a location identifier. <br /></td></tr>
|
|
<tr class="separator:ga8795d5e88090f95347c349b530b181c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>This module contains Fortran interfaces for H5VL (VOL) functions. </p>
|
|
</div></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceh5vl.html">h5vl</a></li>
|
|
<li class="footer">Generated by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.7 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|