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/group___l_a_p_l.html | |
| parent | 4e7e457497c948b41c8b0065225875bf10cdf9d4 (diff) | |
| download | hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.zip hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.tar.gz hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.tar.bz2 | |
deploy: ef39882fa1e13740d2530c7a0637bd1f1a822b68
Diffstat (limited to 'develop/group___l_a_p_l.html')
| -rw-r--r-- | develop/group___l_a_p_l.html | 656 |
1 files changed, 656 insertions, 0 deletions
diff --git a/develop/group___l_a_p_l.html b/develop/group___l_a_p_l.html new file mode 100644 index 0000000..b5ab7df --- /dev/null +++ b/develop/group___l_a_p_l.html @@ -0,0 +1,656 @@ +<!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: Link Access Properties</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('group___l_a_p_l.html',''); initResizable(); }); +/* @license-end */ +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<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">Link Access Properties<div class="ingroups"><a class="el" href="group___h5_p.html">Property Lists (H5P)</a></div></div> </div> +</div><!--header--> +<div class="contents"> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<p><a class="anchor" id="table_lapl_id"></a> +<table class="doxtable"> +<caption border="1" style="background-color:whitesmoke;">Link access property list functions (H5P)</caption> +<tr> +<th>Function </th><th>Purpose </th></tr> +<tr> +<td><a class="el" href="group___l_a_p_l.html#ga8850042eed51777866d7bd0d050cfdc2" title="Sets the external link traversal callback function in a link access property list.">H5Pset_elink_cb</a>/<a class="el" href="group___l_a_p_l.html#gacbf576bd8f7e63f3a91134b12d6b2d12" title="Retrieves the external link traversal callback function from the specified link access property list.">H5Pget_elink_cb</a> </td><td>Sets/gets the external link traversal callback function. </td></tr> +<tr> +<td><a class="el" href="group___l_a_p_l.html#ga020f7eb2eae01043286af50db0a76d82" title="Sets the external link traversal file access flag in a link access property list.">H5Pset_elink_acc_flags</a>/<a class="el" href="group___l_a_p_l.html#gaf1357eb0940f171efecae06a9ed6155b" title="Retrieves the external link traversal file access flag from the specified link access property list.">H5Pget_elink_acc_flags</a> </td><td>Sets/gets the external link traversal file access flag. </td></tr> +<tr> +<td><a class="el" href="group___l_a_p_l.html#ga3895e8e60ce8f0b6f32ab7a22c715d1a" title="Sets a file access property list for use in accessing a file pointed to by an external link.">H5Pset_elink_fapl</a>/<a class="el" href="group___l_a_p_l.html#ga2c2fe0a0396b9a0a02b28402e4ee108a" title="Retrieves the file access property list identifier associated with the link access property list.">H5Pget_elink_fapl</a> </td><td>Sets/gets a file access property list for use in accessing a file pointed to by an external link </td></tr> +<tr> +<td><a class="el" href="group___l_a_p_l.html#gafa5eced13ba3a00cdd65669626dc7294" title="Sets prefix to be applied to external link paths.">H5Pset_elink_prefix</a>/<a class="el" href="group___l_a_p_l.html#ga7960f746797bcf35f70746cd644f8b5a" title="Retrieves prefix applied to external link paths.">H5Pget_elink_prefix</a> </td><td>Sets/gets prefix to be applied to external link paths. </td></tr> +<tr> +<td><a class="el" href="group___l_a_p_l.html#gaa46c63c196a0cf5cd94dede039c030f4" title="Sets maximum number of soft or user-defined link traversals.">H5Pset_nlinks</a>/<a class="el" href="group___l_a_p_l.html#ga6bfa33fa9a77011cbdc06d0fbc907177" title="Retrieves the maximum number of link traversals.">H5Pget_nlinks</a> </td><td>Sets/gets maximum number of soft or user-defined link traversals. </td></tr> +</table> +</p> +<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 Link Access Properties:</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___l_a_p_l.png" border="0" usemap="#agroup______l__a__p__l" alt=""/></div> +<map name="agroup______l__a__p__l" id="agroup______l__a__p__l"> +<area shape="rect" href="group___g_a_p_l.html" title=" " alt="" coords="431,5,611,31"/> +<area shape="rect" href="group___h5_p.html" title=" " alt="" coords="5,55,156,80"/> +<area shape="rect" title=" " alt="" coords="204,55,372,80"/> +<area shape="rect" href="group___t_a_p_l.html" title=" " alt="" coords="420,55,621,80"/> +<area shape="rect" href="group___d_a_p_l.html" title=" " alt="" coords="425,104,617,129"/> +</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___d_a_p_l"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___d_a_p_l.html">Dataset Access Properties</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:group___t_a_p_l"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_a_p_l.html">Datatype Access Properties</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:group___g_a_p_l"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_a_p_l.html">Group Access Properties</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:gaf1357eb0940f171efecae06a9ed6155b"><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___l_a_p_l.html#gaf1357eb0940f171efecae06a9ed6155b">H5Pget_elink_acc_flags</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id, unsigned *flags)</td></tr> +<tr class="memdesc:gaf1357eb0940f171efecae06a9ed6155b"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the external link traversal file access flag from the specified link access property list. <a href="group___l_a_p_l.html#gaf1357eb0940f171efecae06a9ed6155b">More...</a><br /></td></tr> +<tr class="separator:gaf1357eb0940f171efecae06a9ed6155b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gacbf576bd8f7e63f3a91134b12d6b2d12"><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___l_a_p_l.html#gacbf576bd8f7e63f3a91134b12d6b2d12">H5Pget_elink_cb</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id, <a class="el" href="_h5_lpublic_8h.html#a96345937d04b66a13baec1ef1a6cff76">H5L_elink_traverse_t</a> *func, void **op_data)</td></tr> +<tr class="memdesc:gacbf576bd8f7e63f3a91134b12d6b2d12"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the external link traversal callback function from the specified link access property list. <a href="group___l_a_p_l.html#gacbf576bd8f7e63f3a91134b12d6b2d12">More...</a><br /></td></tr> +<tr class="separator:gacbf576bd8f7e63f3a91134b12d6b2d12"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2c2fe0a0396b9a0a02b28402e4ee108a"><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___l_a_p_l.html#ga2c2fe0a0396b9a0a02b28402e4ee108a">H5Pget_elink_fapl</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr> +<tr class="memdesc:ga2c2fe0a0396b9a0a02b28402e4ee108a"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the file access property list identifier associated with the link access property list. <a href="group___l_a_p_l.html#ga2c2fe0a0396b9a0a02b28402e4ee108a">More...</a><br /></td></tr> +<tr class="separator:ga2c2fe0a0396b9a0a02b28402e4ee108a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7960f746797bcf35f70746cd644f8b5a"><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___l_a_p_l.html#ga7960f746797bcf35f70746cd644f8b5a">H5Pget_elink_prefix</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, char *prefix, size_t size)</td></tr> +<tr class="memdesc:ga7960f746797bcf35f70746cd644f8b5a"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves prefix applied to external link paths. <a href="group___l_a_p_l.html#ga7960f746797bcf35f70746cd644f8b5a">More...</a><br /></td></tr> +<tr class="separator:ga7960f746797bcf35f70746cd644f8b5a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6bfa33fa9a77011cbdc06d0fbc907177"><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___l_a_p_l.html#ga6bfa33fa9a77011cbdc06d0fbc907177">H5Pget_nlinks</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, size_t *nlinks)</td></tr> +<tr class="memdesc:ga6bfa33fa9a77011cbdc06d0fbc907177"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the maximum number of link traversals. <a href="group___l_a_p_l.html#ga6bfa33fa9a77011cbdc06d0fbc907177">More...</a><br /></td></tr> +<tr class="separator:ga6bfa33fa9a77011cbdc06d0fbc907177"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga020f7eb2eae01043286af50db0a76d82"><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___l_a_p_l.html#ga020f7eb2eae01043286af50db0a76d82">H5Pset_elink_acc_flags</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id, unsigned flags)</td></tr> +<tr class="memdesc:ga020f7eb2eae01043286af50db0a76d82"><td class="mdescLeft"> </td><td class="mdescRight">Sets the external link traversal file access flag in a link access property list. <a href="group___l_a_p_l.html#ga020f7eb2eae01043286af50db0a76d82">More...</a><br /></td></tr> +<tr class="separator:ga020f7eb2eae01043286af50db0a76d82"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8850042eed51777866d7bd0d050cfdc2"><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___l_a_p_l.html#ga8850042eed51777866d7bd0d050cfdc2">H5Pset_elink_cb</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id, <a class="el" href="_h5_lpublic_8h.html#a96345937d04b66a13baec1ef1a6cff76">H5L_elink_traverse_t</a> func, void *op_data)</td></tr> +<tr class="memdesc:ga8850042eed51777866d7bd0d050cfdc2"><td class="mdescLeft"> </td><td class="mdescRight">Sets the external link traversal callback function in a link access property list. <a href="group___l_a_p_l.html#ga8850042eed51777866d7bd0d050cfdc2">More...</a><br /></td></tr> +<tr class="separator:ga8850042eed51777866d7bd0d050cfdc2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3895e8e60ce8f0b6f32ab7a22c715d1a"><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___l_a_p_l.html#ga3895e8e60ce8f0b6f32ab7a22c715d1a">H5Pset_elink_fapl</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id)</td></tr> +<tr class="memdesc:ga3895e8e60ce8f0b6f32ab7a22c715d1a"><td class="mdescLeft"> </td><td class="mdescRight">Sets a file access property list for use in accessing a file pointed to by an external link. <a href="group___l_a_p_l.html#ga3895e8e60ce8f0b6f32ab7a22c715d1a">More...</a><br /></td></tr> +<tr class="separator:ga3895e8e60ce8f0b6f32ab7a22c715d1a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gafa5eced13ba3a00cdd65669626dc7294"><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___l_a_p_l.html#gafa5eced13ba3a00cdd65669626dc7294">H5Pset_elink_prefix</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, const char *prefix)</td></tr> +<tr class="memdesc:gafa5eced13ba3a00cdd65669626dc7294"><td class="mdescLeft"> </td><td class="mdescRight">Sets prefix to be applied to external link paths. <a href="group___l_a_p_l.html#gafa5eced13ba3a00cdd65669626dc7294">More...</a><br /></td></tr> +<tr class="separator:gafa5eced13ba3a00cdd65669626dc7294"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa46c63c196a0cf5cd94dede039c030f4"><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___l_a_p_l.html#gaa46c63c196a0cf5cd94dede039c030f4">H5Pset_nlinks</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, size_t nlinks)</td></tr> +<tr class="memdesc:gaa46c63c196a0cf5cd94dede039c030f4"><td class="mdescLeft"> </td><td class="mdescRight">Sets maximum number of soft or user-defined link traversals. <a href="group___l_a_p_l.html#gaa46c63c196a0cf5cd94dede039c030f4">More...</a><br /></td></tr> +<tr class="separator:gaa46c63c196a0cf5cd94dede039c030f4"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Function Documentation</h2> +<a id="gaf1357eb0940f171efecae06a9ed6155b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaf1357eb0940f171efecae06a9ed6155b">◆ </a></span>H5Pget_elink_acc_flags()</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> H5Pget_elink_acc_flags </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>lapl_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned * </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>Retrieves the external link traversal file access flag from the specified link access property list. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">flags</td><td>File access flag for link traversal</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___l_a_p_l.html#gaf1357eb0940f171efecae06a9ed6155b" title="Retrieves the external link traversal file access flag from the specified link access property list.">H5Pget_elink_acc_flags()</a> retrieves the file access flag used to open an external link target file from the specified link access property list.</p> +<p>Valid values for <code>flags</code> include: </p><ul> +<li><a class="el" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a> - Files opened through external links will be opened with write access </li> +<li><a class="el" href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a> - Files opened through external links will be opened with read-only access </li> +<li><a class="el" href="_h5_fpublic_8h.html#ab0ce75eb6c23c77bf2736d53e2ea5dce">H5F_ACC_DEFAULT</a> - Files opened through external links will be opened with the same access flag as the parent file</li> +</ul> +<p>The value returned, if it is not <a class="el" href="_h5_fpublic_8h.html#ab0ce75eb6c23c77bf2736d53e2ea5dce">H5F_ACC_DEFAULT</a>, will override the default access flag, which is the access flag used to open the parent file.</p> +<p><b>Example Usage:</b> The following code retrieves the external link access flag settings on the link access property list <code>lapl_id</code> into a local variable: </p><pre> + unsigned acc_flags; + status = H5Pget_elink_acc_flags(lapl_id, &acc_flags); + </pre><dl class="section since"><dt>Since</dt><dd>1.8.3 </dd></dl> + +</div> +</div> +<a id="gacbf576bd8f7e63f3a91134b12d6b2d12"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gacbf576bd8f7e63f3a91134b12d6b2d12">◆ </a></span>H5Pget_elink_cb()</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> H5Pget_elink_cb </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>lapl_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5_lpublic_8h.html#a96345937d04b66a13baec1ef1a6cff76">H5L_elink_traverse_t</a> * </td> + <td class="paramname"><em>func</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void ** </td> + <td class="paramname"><em>op_data</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Retrieves the external link traversal callback function from the specified link access property list. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">func</td><td>User-defined external link traversal callback function </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">op_data</td><td>User-defined input data for the callback function</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___l_a_p_l.html#gacbf576bd8f7e63f3a91134b12d6b2d12" title="Retrieves the external link traversal callback function from the specified link access property list.">H5Pget_elink_cb()</a> retrieves the user-defined external link traversal callback function defined in the specified link access property list.</p> +<p>The callback function may adjust the file access property list and file access flag to use when opening a file through an external link. The callback will be executed by the HDF5 library immediately before opening the target file.</p> +<p><b>Failure Modes:</b> <a class="el" href="group___l_a_p_l.html#gacbf576bd8f7e63f3a91134b12d6b2d12" title="Retrieves the external link traversal callback function from the specified link access property list.">H5Pget_elink_cb()</a> will fail if the link access property list identifier, <code>lapl_id</code>, is invalid.</p> +<p>An invalid function pointer or data pointer, <code>func</code> or <code>op_data</code> respectively, may cause a segmentation fault or an invalid memory access.</p> +<p><b>Example Usage:</b> The following code retrieves the external link callback settings on the link access property list <code>lapl_id</code> into local variables: </p><pre> + H5L_elink_traverse_t elink_callback_func; + void *elink_callback_udata; + status = H5Pget_elink_cb (lapl_id, &elink_callback_func, + &elink_callback_udata); + </pre><dl class="section since"><dt>Since</dt><dd>1.8.3 </dd></dl> + +</div> +</div> +<a id="ga2c2fe0a0396b9a0a02b28402e4ee108a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga2c2fe0a0396b9a0a02b28402e4ee108a">◆ </a></span>H5Pget_elink_fapl()</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> H5Pget_elink_fapl </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>lapl_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Retrieves the file access property list identifier associated with the link access property list. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Returns a file access property list 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___l_a_p_l.html#ga2c2fe0a0396b9a0a02b28402e4ee108a" title="Retrieves the file access property list identifier associated with the link access property list.">H5Pget_elink_fapl()</a> retrieves the file access property list identifier that is set for the link access property list identifier, <code>lapl_id</code>. The library uses this file access property list identifier to open the target file for the external link access. When no such identifier is set, this routine returns <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>.</p> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___l_a_p_l.html#ga3895e8e60ce8f0b6f32ab7a22c715d1a" title="Sets a file access property list for use in accessing a file pointed to by an external link.">H5Pset_elink_fapl()</a> and <a class="el" href="group___h5_l.html#ga15dfaeb9b1c0b3136533cb97ee45e683" title="Creates an external link, a soft link to an object in a different file.">H5Lcreate_external()</a>.</dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl> + +</div> +</div> +<a id="ga7960f746797bcf35f70746cd644f8b5a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga7960f746797bcf35f70746cd644f8b5a">◆ </a></span>H5Pget_elink_prefix()</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> H5Pget_elink_prefix </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>plist_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"><em>prefix</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 prefix applied to external link paths. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Link access property list identifier </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">prefix</td><td>Prefix applied to external link paths </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size of prefix, including null terminator</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>If successful, returns a non-negative value specifying the size in bytes of the prefix without the NULL terminator; otherwise returns a negative value.</dd></dl> +<p><a class="el" href="group___l_a_p_l.html#ga7960f746797bcf35f70746cd644f8b5a" title="Retrieves prefix applied to external link paths.">H5Pget_elink_prefix()</a> retrieves the prefix applied to the path of any external links traversed.</p> +<p>When an external link is traversed, the prefix is retrieved from the link access property list <code>plist_id</code>, returned in the user-allocated buffer pointed to by <code>prefix</code>, and prepended to the filename stored in the external link.</p> +<p>The size in bytes of the prefix, including the NULL terminator, is specified in <code>size</code>. If size is unknown, a preliminary <a class="el" href="group___l_a_p_l.html#ga7960f746797bcf35f70746cd644f8b5a" title="Retrieves prefix applied to external link paths.">H5Pget_elink_prefix()</a> call with the pointer <code>prefix</code> set to NULL will return the size of the prefix without the NULL terminator.</p> +<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl> + +</div> +</div> +<a id="ga6bfa33fa9a77011cbdc06d0fbc907177"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga6bfa33fa9a77011cbdc06d0fbc907177">◆ </a></span>H5Pget_nlinks()</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> H5Pget_nlinks </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>plist_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t * </td> + <td class="paramname"><em>nlinks</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Retrieves the maximum number of link traversals. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Link access property list identifier </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">nlinks</td><td>Maximum number of links to traverse</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___l_a_p_l.html#ga6bfa33fa9a77011cbdc06d0fbc907177" title="Retrieves the maximum number of link traversals.">H5Pget_nlinks()</a> retrieves the maximum number of soft or user-defined link traversals allowed, <code>nlinks</code>, before the library assumes it has found a cycle and aborts the traversal. This value is retrieved from the link access property list <code>plist_id</code>.</p> +<p>The limit on the number of soft or user-defined link traversals is designed to terminate link traversal if one or more links form a cycle. User control is provided because some files may have legitimate paths formed of large numbers of soft or user-defined links. This property can be used to allow traversal of as many links as desired.</p> +<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl> + +</div> +</div> +<a id="ga020f7eb2eae01043286af50db0a76d82"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga020f7eb2eae01043286af50db0a76d82">◆ </a></span>H5Pset_elink_acc_flags()</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> H5Pset_elink_acc_flags </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>lapl_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned </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>Sets the external link traversal file access flag in a link access property list. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>The access flag for external link traversal</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___l_a_p_l.html#ga020f7eb2eae01043286af50db0a76d82" title="Sets the external link traversal file access flag in a link access property list.">H5Pset_elink_acc_flags()</a> specifies the file access flag to use to open the target file of an external link. This allows read-only access of files reached through an external link in a file opened with write access, or vice-versa.</p> +<p>Valid values for <code>flags</code> include: </p><ul> +<li><a class="el" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a> - Causes files opened through external links to be opened with write access </li> +<li><a class="el" href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a> - Causes files opened through external links to be opened with read-only access </li> +<li><a class="el" href="_h5_fpublic_8h.html#ab0ce75eb6c23c77bf2736d53e2ea5dce">H5F_ACC_DEFAULT</a> - Removes any external link file access flag setting from <code>lapl_id</code>, causing the file access flag setting to be taken from the parent file</li> +</ul> +<p>The library will normally use the file access flag used to open the parent file as the file access flag for the target file. This function provides a way to override that behavior. The external link traversal callback function set by <a class="el" href="group___l_a_p_l.html#ga8850042eed51777866d7bd0d050cfdc2" title="Sets the external link traversal callback function in a link access property list.">H5Pset_elink_cb()</a> can override the setting from <a class="el" href="group___l_a_p_l.html#ga020f7eb2eae01043286af50db0a76d82" title="Sets the external link traversal file access flag in a link access property list.">H5Pset_elink_acc_flags()</a>.</p> +<p><b>Motivation:</b> <a class="el" href="group___l_a_p_l.html#ga020f7eb2eae01043286af50db0a76d82" title="Sets the external link traversal file access flag in a link access property list.">H5Pset_elink_acc_flags()</a> is used to adjust the file access flag used to open files reached through external links. This may be useful to, for example, prevent modifying files accessed through an external link. Otherwise, the target file is opened with whatever flag was used to open the parent.</p> +<p><b>Example Usage:</b> The following code sets the link access property list <code>lapl_id</code> to open external link target files with read-only access: </p><pre> + status = H5Pset_elink_acc_flags(lapl_id, H5F_ACC_RDONLY); + </pre><dl class="section since"><dt>Since</dt><dd>1.8.3 </dd></dl> + +</div> +</div> +<a id="ga8850042eed51777866d7bd0d050cfdc2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga8850042eed51777866d7bd0d050cfdc2">◆ </a></span>H5Pset_elink_cb()</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> H5Pset_elink_cb </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>lapl_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="_h5_lpublic_8h.html#a96345937d04b66a13baec1ef1a6cff76">H5L_elink_traverse_t</a> </td> + <td class="paramname"><em>func</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>op_data</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Sets the external link traversal callback function in a link access property list. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>User-defined external link traversal callback function </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">op_data</td><td>User-defined input data for the callback function</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___l_a_p_l.html#ga8850042eed51777866d7bd0d050cfdc2" title="Sets the external link traversal callback function in a link access property list.">H5Pset_elink_cb()</a> sets a user-defined external link traversal callback function in the link access property list <code>lapl_id</code>. The callback function <code>func</code> must conform to the prototype specified in <a class="el" href="_h5_lpublic_8h.html#a96345937d04b66a13baec1ef1a6cff76" title="Callback for external link traversal.">H5L_elink_traverse_t</a>.</p> +<p>The callback function may adjust the file access property list and file access flags to use when opening a file through an external link. The callback will be executed by the HDF5 library immediately before opening the target file.</p> +<p>The callback will be made after the file access property list set by <a class="el" href="group___l_a_p_l.html#ga3895e8e60ce8f0b6f32ab7a22c715d1a" title="Sets a file access property list for use in accessing a file pointed to by an external link.">H5Pset_elink_fapl()</a> and the file access flag set by <a class="el" href="group___l_a_p_l.html#ga020f7eb2eae01043286af50db0a76d82" title="Sets the external link traversal file access flag in a link access property list.">H5Pset_elink_acc_flags()</a> are applied, so changes made by this callback function will take precedence.</p> +<dl class="section attention"><dt>Attention</dt><dd>A file close degree property setting (<a class="el" href="group___f_a_p_l.html#ga60e3567f677fd3ade75b909b636d7b9c" title="Sets the file close degree.">H5Pset_fclose_degree()</a>) in this callback function or an associated property list will be ignored. A file opened by means of traversing an external link is always opened with the weak file close degree property setting, <a class="el" href="_h5_fpublic_8h.html#aa85fa00d037d2b0401cf72edf9a6475faea1127311a219b44e4af3cb12609035f">H5F_CLOSE_WEAK</a>.</dd></dl> +<p><b>Motivation:</b> <a class="el" href="group___l_a_p_l.html#ga8850042eed51777866d7bd0d050cfdc2" title="Sets the external link traversal callback function in a link access property list.">H5Pset_elink_cb()</a> is used to specify a callback function that is executed by the HDF5 library when traversing an external link. This provides a mechanism to set specific access permissions, modify the file access property list, modify the parent or target file, or take any other user-defined action. This callback function is used in situations where the HDF5 library's default behavior is not suitable.</p> +<p><b>Failure Modes:</b> <a class="el" href="group___l_a_p_l.html#ga8850042eed51777866d7bd0d050cfdc2" title="Sets the external link traversal callback function in a link access property list.">H5Pset_elink_cb()</a> will fail if the link access property list identifier, <code>lapl_id</code>, is invalid or if the function pointer, <code>func</code>, is NULL.</p> +<p>An invalid function pointer, <code>func</code>, will cause a segmentation fault or other failure when an attempt is subsequently made to traverse an external link.</p> +<p><b>Example Usage:</b> This example defines a callback function that prints the name of the target file every time an external link is followed, and sets this callback function on <code>lapl_id</code>. </p><pre> + herr_t elink_callback(const char *parent_file_name, const char + *parent_group_name, const char *child_file_name, const char + *child_object_name, unsigned *acc_flags, hid_t fapl_id, void *op_data) { + puts(child_file_name); + return 0; + } + int main(void) { + hid_t lapl_id = H5Pcreate(H5P_LINK_ACCESS); + H5Pset_elink_cb(lapl_id, elink_callback, NULL); + ... + } + </pre><dl class="section since"><dt>Since</dt><dd>1.8.3 </dd></dl> + +</div> +</div> +<a id="ga3895e8e60ce8f0b6f32ab7a22c715d1a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga3895e8e60ce8f0b6f32ab7a22c715d1a">◆ </a></span>H5Pset_elink_fapl()</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> H5Pset_elink_fapl </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>lapl_id</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>fapl_id</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Sets a file access property list for use in accessing a file pointed to by an external link. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">fapl_id</td><td>File access property list 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___l_a_p_l.html#ga3895e8e60ce8f0b6f32ab7a22c715d1a" title="Sets a file access property list for use in accessing a file pointed to by an external link.">H5Pset_elink_fapl()</a> sets the file access property list, <code>fapl_id</code>, to be used when accessing the target file of an external link associated with <code>lapl_id</code>.</p> +<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl> + +</div> +</div> +<a id="gafa5eced13ba3a00cdd65669626dc7294"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gafa5eced13ba3a00cdd65669626dc7294">◆ </a></span>H5Pset_elink_prefix()</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> H5Pset_elink_prefix </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>plist_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>prefix</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Sets prefix to be applied to external link paths. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Link access property list identifier </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">prefix</td><td>Prefix to be applied to external link paths</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___l_a_p_l.html#gafa5eced13ba3a00cdd65669626dc7294" title="Sets prefix to be applied to external link paths.">H5Pset_elink_prefix()</a> sets the prefix to be applied to the path of any external links traversed. The prefix is prepended to the filename stored in the external link.</p> +<p>The prefix is specified in the user-allocated buffer <code>prefix</code> and set in the link access property list <code>plist_id</code>. The buffer should not be freed until the property list has been closed.</p> +<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl> + +</div> +</div> +<a id="gaa46c63c196a0cf5cd94dede039c030f4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaa46c63c196a0cf5cd94dede039c030f4">◆ </a></span>H5Pset_nlinks()</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> H5Pset_nlinks </td> + <td>(</td> + <td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td> + <td class="paramname"><em>plist_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>nlinks</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Sets maximum number of soft or user-defined link traversals. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Link access property list identifier </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">nlinks</td><td>Maximum number of links to traverse</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___l_a_p_l.html#gaa46c63c196a0cf5cd94dede039c030f4" title="Sets maximum number of soft or user-defined link traversals.">H5Pset_nlinks()</a> sets the maximum number of soft or user-defined link traversals allowed, <code>nlinks</code>, before the library assumes it has found a cycle and aborts the traversal. This value is set in the link access property list <code>plist_id</code>.</p> +<p>The limit on the number of soft or user-defined link traversals is designed to terminate link traversal if one or more links form a cycle. User control is provided because some files may have legitimate paths formed of large numbers of soft or user-defined links. This property can be used to allow traversal of as many links as desired.</p> +<dl class="section since"><dt>Since</dt><dd>1.8.0 </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> |