diff options
| author | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-11-16 13:49:28 (GMT) |
|---|---|---|
| committer | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-11-16 13:49:28 (GMT) |
| commit | 4f20d880c97be1249f8d89ced95f72836dbf3ee0 (patch) | |
| tree | 30d8dcb282134b7126b092796f2be00d2d97bd3c /develop/namespaceh5vl.html | |
| parent | 4e7e457497c948b41c8b0065225875bf10cdf9d4 (diff) | |
| download | hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.zip hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.tar.gz hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.tar.bz2 | |
deploy: ef39882fa1e13740d2530c7a0637bd1f1a822b68
Diffstat (limited to 'develop/namespaceh5vl.html')
| -rw-r--r-- | develop/namespaceh5vl.html | 165 |
1 files changed, 165 insertions, 0 deletions
diff --git a/develop/namespaceh5vl.html b/develop/namespaceh5vl.html new file mode 100644 index 0000000..7feebf8 --- /dev/null +++ b/develop/namespaceh5vl.html @@ -0,0 +1,165 @@ +<!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: h5vl Module Reference</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.ef39882</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('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"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</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> </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 name="func-members"></a> +Functions/Subroutines</h2></td></tr> +<tr class="memitem:ga693784c51c2a8dea2048bb0271143de5"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#ga693784c51c2a8dea2048bb0271143de5">h5vlregister_connector_by_name_f</a> (name, vol_id, hdferr, vipl_id)</td></tr> +<tr class="memdesc:ga693784c51c2a8dea2048bb0271143de5"><td class="mdescLeft"> </td><td class="mdescRight">Registers a new VOL connector as a member of the virtual object layer class by name. <a href="group___f_h5_v_l.html#ga693784c51c2a8dea2048bb0271143de5">More...</a><br /></td></tr> +<tr class="separator:ga693784c51c2a8dea2048bb0271143de5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7f200611a734ebc16f1bbc196675b037"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#ga7f200611a734ebc16f1bbc196675b037">h5vlregister_connector_by_value_f</a> (connector_value, vol_id, hdferr, vipl_id)</td></tr> +<tr class="memdesc:ga7f200611a734ebc16f1bbc196675b037"><td class="mdescLeft"> </td><td class="mdescRight">Registers a new VOL connector by value. <a href="group___f_h5_v_l.html#ga7f200611a734ebc16f1bbc196675b037">More...</a><br /></td></tr> +<tr class="separator:ga7f200611a734ebc16f1bbc196675b037"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga805068f9fb516de93aa4b3f7e0bc75cb"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#ga805068f9fb516de93aa4b3f7e0bc75cb">h5vlis_connector_registered_by_name_f</a> (name, registered, hdferr)</td></tr> +<tr class="memdesc:ga805068f9fb516de93aa4b3f7e0bc75cb"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether a VOL class has been registered or not ccording to a specified connector name. <a href="group___f_h5_v_l.html#ga805068f9fb516de93aa4b3f7e0bc75cb">More...</a><br /></td></tr> +<tr class="separator:ga805068f9fb516de93aa4b3f7e0bc75cb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gac6165d852f275c751777280c5539b76a"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#gac6165d852f275c751777280c5539b76a">h5vlis_connector_registered_by_value_f</a> (value, registered, hdferr)</td></tr> +<tr class="memdesc:gac6165d852f275c751777280c5539b76a"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether a VOL class has been registered or not according to a specified connector value (ID). <a href="group___f_h5_v_l.html#gac6165d852f275c751777280c5539b76a">More...</a><br /></td></tr> +<tr class="separator:gac6165d852f275c751777280c5539b76a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga67c9f1d1331b39f8dccad180310d6295"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#ga67c9f1d1331b39f8dccad180310d6295">h5vlget_connector_id_f</a> (obj_id, vol_id, hdferr)</td></tr> +<tr class="memdesc:ga67c9f1d1331b39f8dccad180310d6295"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the ID for a registered VOL connector. <a href="group___f_h5_v_l.html#ga67c9f1d1331b39f8dccad180310d6295">More...</a><br /></td></tr> +<tr class="separator:ga67c9f1d1331b39f8dccad180310d6295"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab19a0dfe97fbf1d4cd9d49ace9aba0bd"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#gab19a0dfe97fbf1d4cd9d49ace9aba0bd">h5vlget_connector_id_by_name_f</a> (name, vol_id, hdferr)</td></tr> +<tr class="memdesc:gab19a0dfe97fbf1d4cd9d49ace9aba0bd"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the ID for a registered VOL connector. <a href="group___f_h5_v_l.html#gab19a0dfe97fbf1d4cd9d49ace9aba0bd">More...</a><br /></td></tr> +<tr class="separator:gab19a0dfe97fbf1d4cd9d49ace9aba0bd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga451217565aad9bf5bd6999a4ae0bc24c"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#ga451217565aad9bf5bd6999a4ae0bc24c">h5vlget_connector_id_by_value_f</a> (value, vol_id, hdferr)</td></tr> +<tr class="memdesc:ga451217565aad9bf5bd6999a4ae0bc24c"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the ID for a registered VOL connector. <a href="group___f_h5_v_l.html#ga451217565aad9bf5bd6999a4ae0bc24c">More...</a><br /></td></tr> +<tr class="separator:ga451217565aad9bf5bd6999a4ae0bc24c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga131b30396ed7e3c0da21b15c61884877"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#ga131b30396ed7e3c0da21b15c61884877">h5vlget_connector_name_f</a> (obj_id, name, hdferr, name_len)</td></tr> +<tr class="memdesc:ga131b30396ed7e3c0da21b15c61884877"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a connector name for a VOL. <a href="group___f_h5_v_l.html#ga131b30396ed7e3c0da21b15c61884877">More...</a><br /></td></tr> +<tr class="separator:ga131b30396ed7e3c0da21b15c61884877"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5a99a3cd8186d9d659d219fdae1d6a51"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#ga5a99a3cd8186d9d659d219fdae1d6a51">h5vlclose_f</a> (vol_id, hdferr)</td></tr> +<tr class="memdesc:ga5a99a3cd8186d9d659d219fdae1d6a51"><td class="mdescLeft"> </td><td class="mdescRight">Closes a VOL connector ID. <a href="group___f_h5_v_l.html#ga5a99a3cd8186d9d659d219fdae1d6a51">More...</a><br /></td></tr> +<tr class="separator:ga5a99a3cd8186d9d659d219fdae1d6a51"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga72912d28971789e5f6264129dfcfc395"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#ga72912d28971789e5f6264129dfcfc395">h5vlunregister_connector_f</a> (plugin_id, hdferr)</td></tr> +<tr class="memdesc:ga72912d28971789e5f6264129dfcfc395"><td class="mdescLeft"> </td><td class="mdescRight">Removes a VOL connector ID from the library. <a href="group___f_h5_v_l.html#ga72912d28971789e5f6264129dfcfc395">More...</a><br /></td></tr> +<tr class="separator:ga72912d28971789e5f6264129dfcfc395"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga46e6e7ea94f1f2af8bf89802a8834eea"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#ga46e6e7ea94f1f2af8bf89802a8834eea">h5vlnative_addr_to_token_f</a> (loc_id, addr, token, hdferr)</td></tr> +<tr class="memdesc:ga46e6e7ea94f1f2af8bf89802a8834eea"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the token representation from an address for a location identifier. <a href="group___f_h5_v_l.html#ga46e6e7ea94f1f2af8bf89802a8834eea">More...</a><br /></td></tr> +<tr class="separator:ga46e6e7ea94f1f2af8bf89802a8834eea"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga78c70182a1e00d734026daa176759c6a"><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_h5_v_l.html#ga78c70182a1e00d734026daa176759c6a">h5vlnative_token_to_addr_f</a> (loc_id, token, addr, hdferr)</td></tr> +<tr class="memdesc:ga78c70182a1e00d734026daa176759c6a"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the object address from a token representation for a location identifier. <a href="group___f_h5_v_l.html#ga78c70182a1e00d734026daa176759c6a">More...</a><br /></td></tr> +<tr class="separator:ga78c70182a1e00d734026daa176759c6a"><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.1 </li> + </ul> +</div> +</body> +</html> |