diff options
author | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-11-02 14:22:18 (GMT) |
---|---|---|
committer | byrnHDF <byrnHDF@users.noreply.github.com> | 2023-11-02 14:22:18 (GMT) |
commit | 3a692d7d114a845a25bd1e19ca40af7a89e99c1c (patch) | |
tree | 83c1979724b0ddb87ce45e90b31ec8b2a4c5ea41 /v1_14/group___l_c_p_l.html | |
parent | 4f093d1140ffd9b90559b62162ba23789e421e0a (diff) | |
download | hdf5-3a692d7d114a845a25bd1e19ca40af7a89e99c1c.zip hdf5-3a692d7d114a845a25bd1e19ca40af7a89e99c1c.tar.gz hdf5-3a692d7d114a845a25bd1e19ca40af7a89e99c1c.tar.bz2 |
deploy: 61aef8d2bd69dfd6d655100ac8455184b6875459
Diffstat (limited to 'v1_14/group___l_c_p_l.html')
-rw-r--r-- | v1_14/group___l_c_p_l.html | 234 |
1 files changed, 234 insertions, 0 deletions
diff --git a/v1_14/group___l_c_p_l.html b/v1_14/group___l_c_p_l.html new file mode 100644 index 0000000..cb89b47 --- /dev/null +++ b/v1_14/group___l_c_p_l.html @@ -0,0 +1,234 @@ +<!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 Creation 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.14.4.61aef8d</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_c_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="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">Link Creation Properties<div class="ingroups"><a class="el" href="group___h5_p.html">Property Lists (H5P)</a> » <a class="el" href="group___s_t_r_c_p_l.html">String Creation Properties</a></div></div> </div> +</div><!--header--> +<div class="contents"> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<p>This creation property applies to links only, and advises the library to automatically create missing intermediate groups when creating new objects.</p> +<p><a class="anchor" id="table_lcpl_id"></a> +<table class="doxtable"> +<caption border="1" style="background-color:whitesmoke;">Link creation property list functions (H5P)</caption> +<tr> +<th>Function </th><th>Purpose </th></tr> +<tr> +<td><a class="el" href="group___l_c_p_l.html#ga66c4c5d3f34e5cf65d00e47a5387383c" title="Specifies in property list whether to create missing intermediate groups.">H5Pset_create_intermediate_group</a>/<a class="el" href="group___l_c_p_l.html#gaf7db1b7ce19703f30f1827b7c899c3b0" title="Determines whether property is set to enable creating missing intermediate groups.">H5Pget_create_intermediate_group</a> </td><td>Specifies/retrieves whether to create missing intermediate groups. </td></tr> +</table> + </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group___s_t_r_c_p_l.html">String Creation Properties</a> </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 Link Creation 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_c_p_l.png" border="0" usemap="#agroup______l__c__p__l" alt=""/></div> +<map name="agroup______l__c__p__l" id="agroup______l__c__p__l"> +<area shape="rect" href="group___s_t_r_c_p_l.html" title=" " alt="" coords="5,5,195,31"/> +<area shape="rect" title=" " alt="" coords="243,5,421,31"/> +</map> +</div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:gaf7db1b7ce19703f30f1827b7c899c3b0"><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_c_p_l.html#gaf7db1b7ce19703f30f1827b7c899c3b0">H5Pget_create_intermediate_group</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, unsigned *crt_intmd)</td></tr> +<tr class="memdesc:gaf7db1b7ce19703f30f1827b7c899c3b0"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether property is set to enable creating missing intermediate groups. <a href="group___l_c_p_l.html#gaf7db1b7ce19703f30f1827b7c899c3b0">More...</a><br /></td></tr> +<tr class="separator:gaf7db1b7ce19703f30f1827b7c899c3b0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga66c4c5d3f34e5cf65d00e47a5387383c"><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_c_p_l.html#ga66c4c5d3f34e5cf65d00e47a5387383c">H5Pset_create_intermediate_group</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, unsigned crt_intmd)</td></tr> +<tr class="memdesc:ga66c4c5d3f34e5cf65d00e47a5387383c"><td class="mdescLeft"> </td><td class="mdescRight">Specifies in property list whether to create missing intermediate groups. <a href="group___l_c_p_l.html#ga66c4c5d3f34e5cf65d00e47a5387383c">More...</a><br /></td></tr> +<tr class="separator:ga66c4c5d3f34e5cf65d00e47a5387383c"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Function Documentation</h2> +<a id="gaf7db1b7ce19703f30f1827b7c899c3b0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#gaf7db1b7ce19703f30f1827b7c899c3b0">◆ </a></span>H5Pget_create_intermediate_group()</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_create_intermediate_group </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">unsigned * </td> + <td class="paramname"><em>crt_intmd</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Determines whether property is set to enable creating missing intermediate groups. </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 creation property list identifier </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">crt_intmd</td><td>Flag specifying whether to create intermediate groups upon creation of an 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> +<p><a class="el" href="group___l_c_p_l.html#gaf7db1b7ce19703f30f1827b7c899c3b0" title="Determines whether property is set to enable creating missing intermediate groups.">H5Pget_create_intermediate_group()</a> determines whether the link creation property list <code>plist_id</code> is set to allow functions that create objects in groups different from the current working group to create intermediate groups that may be missing in the path of a new or moved object.</p> +<p>Functions that create objects in or move objects to a group other than the current working group make use of this property. <a class="el" href="group___h5_g.html#gab52641f0736281faaaae4e3039bbb344" title="Creates a new empty group without linking it into the file structure.">H5Gcreate_anon()</a> and <a class="el" href="group___h5_l.html#ga0bbc7f9bf25c8aca9dd8433a325c8acb" title="Moves a link within an HDF5 file.">H5Lmove()</a> are examples of such functions.</p> +<p>If <code>crt_intmd</code> is positive, missing intermediate groups will be created; if <code>crt_intmd</code> is non-positive, missing intermediate groups will not be created.</p> +<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl> + +</div> +</div> +<a id="ga66c4c5d3f34e5cf65d00e47a5387383c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ga66c4c5d3f34e5cf65d00e47a5387383c">◆ </a></span>H5Pset_create_intermediate_group()</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_create_intermediate_group </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">unsigned </td> + <td class="paramname"><em>crt_intmd</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Specifies in property list whether to create missing intermediate groups. </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 creation property list identifier </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">crt_intmd</td><td>Flag specifying whether to create intermediate groups upon the creation of an 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> +<p><a class="el" href="group___l_c_p_l.html#ga66c4c5d3f34e5cf65d00e47a5387383c" title="Specifies in property list whether to create missing intermediate groups.">H5Pset_create_intermediate_group()</a></p> +<dl class="section since"><dt>Since</dt><dd></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> |