diff options
author | lrknox <lrknox@users.noreply.github.com> | 2023-07-21 00:49:17 (GMT) |
---|---|---|
committer | lrknox <lrknox@users.noreply.github.com> | 2023-07-21 00:49:17 (GMT) |
commit | 175161c045ec8f1cc69b22030e416b60f40d5343 (patch) | |
tree | 9141df9563c2079e5b21245b7b5ca7e77a11066a /group___t_r_a_v.html | |
parent | c5642bdd325aaecbe7da51c4ecb02b2347867560 (diff) | |
download | hdf5-175161c045ec8f1cc69b22030e416b60f40d5343.zip hdf5-175161c045ec8f1cc69b22030e416b60f40d5343.tar.gz hdf5-175161c045ec8f1cc69b22030e416b60f40d5343.tar.bz2 |
deploy: 1706355ee10cdad20b79603b3f39935601c5fff0
Diffstat (limited to 'group___t_r_a_v.html')
-rw-r--r-- | group___t_r_a_v.html | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/group___t_r_a_v.html b/group___t_r_a_v.html index 38ed6fd..3ce4286 100644 --- a/group___t_r_a_v.html +++ b/group___t_r_a_v.html @@ -37,7 +37,7 @@ <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.800edda</span> +  <span id="projectnumber">1.15.0.1706355</span> </div> <div id="projectbrief">API Reference</div> </td> @@ -505,7 +505,7 @@ Functions</h2></td></tr> <td><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a15eebaf7d85d5e37e918858634e29d01">H5_ITER_NATIVE</a></td><td>Fastest available order</td></tr> </table> <p><code>idx</code> allows an interrupted iteration to be resumed; it is passed in by the application with a starting point and returned by the library with the point at which the iteration stopped.</p> -<dl class="section warning"><dt>Warning</dt><dd><a class="el" href="group___t_r_a_v.html#ga87e036da0c8d1146a073f3ee08e0fedc" title="Iterates through links in a group by its name.">H5Literate_by_name1()</a> assumes that the membership of the group being iterated over remains unchanged through the iteration; if any of the links in the group change during the iteration, the function’s behavior is undefined. Note, however, that objects pointed to by the links can be modified.</dd></dl> +<dl class="section warning"><dt>Warning</dt><dd><a class="el" href="group___t_r_a_v.html#ga87e036da0c8d1146a073f3ee08e0fedc" title="Iterates through links in a group by its name.">H5Literate_by_name1()</a> assumes that the membership of the group being iterated over remains unchanged through the iteration; if any of the links in the group change during the iteration, the function's behavior is undefined. Note, however, that objects pointed to by the links can be modified.</dd></dl> <dl class="section note"><dt>Note</dt><dd><a class="el" href="group___t_r_a_v.html#ga87e036da0c8d1146a073f3ee08e0fedc" title="Iterates through links in a group by its name.">H5Literate_by_name1()</a> is not recursive. In particular, if a member of <code>group_name</code> is found to be a group, call it <code>subgroup_a</code>, <a class="el" href="group___t_r_a_v.html#ga87e036da0c8d1146a073f3ee08e0fedc" title="Iterates through links in a group by its name.">H5Literate_by_name1()</a> does not examine the members of <code>subgroup_a</code>. When recursive iteration is required, the application must handle the recursion, explicitly calling <a class="el" href="group___t_r_a_v.html#ga87e036da0c8d1146a073f3ee08e0fedc" title="Iterates through links in a group by its name.">H5Literate_by_name1()</a> on discovered subgroups.</dd> <dd> <a class="el" href="group___t_r_a_v.html#ga87e036da0c8d1146a073f3ee08e0fedc" title="Iterates through links in a group by its name.">H5Literate_by_name1()</a> is the same as <a class="el" href="group___h5_g.html#ga957fee64f796f184f542537127ad6c11" title="Iterates over the entries of a group invoking a callback for each entry encountered.">H5Giterate()</a>, except that <a class="el" href="group___h5_g.html#ga957fee64f796f184f542537127ad6c11" title="Iterates over the entries of a group invoking a callback for each entry encountered.">H5Giterate()</a> always proceeds in lexicographic order.</dd></dl> @@ -611,7 +611,7 @@ Functions</h2></td></tr> <td><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a15eebaf7d85d5e37e918858634e29d01">H5_ITER_NATIVE</a></td><td>Fastest available order</td></tr> </table> <p><code>idx_p</code> allows an interrupted iteration to be resumed; it is passed in by the application with a starting point and returned by the library with the point at which the iteration stopped.</p> -<dl class="section warning"><dt>Warning</dt><dd><a class="el" href="group___t_r_a_v.html#ga745a65eb516ce40a3be43490aaeb5c5e" title="Iterates through links in a group.">H5Literate_by_name2()</a> assumes that the membership of the group being iterated over remains unchanged through the iteration; if any of the links in the group change during the iteration, the function’s behavior is undefined. Note, however, that objects pointed to by the links can be modified.</dd></dl> +<dl class="section warning"><dt>Warning</dt><dd><a class="el" href="group___t_r_a_v.html#ga745a65eb516ce40a3be43490aaeb5c5e" title="Iterates through links in a group.">H5Literate_by_name2()</a> assumes that the membership of the group being iterated over remains unchanged through the iteration; if any of the links in the group change during the iteration, the function's behavior is undefined. Note, however, that objects pointed to by the links can be modified.</dd></dl> <dl class="section note"><dt>Note</dt><dd><a class="el" href="group___t_r_a_v.html#ga745a65eb516ce40a3be43490aaeb5c5e" title="Iterates through links in a group.">H5Literate_by_name2()</a> is not recursive. In particular, if a member of <code>group_name</code> is found to be a group, call it <code>subgroup_a</code>, <a class="el" href="group___t_r_a_v.html#ga745a65eb516ce40a3be43490aaeb5c5e" title="Iterates through links in a group.">H5Literate_by_name2()</a> does not examine the members of <code>subgroup_a</code>. When recursive iteration is required, the application must handle the recursion, explicitly calling <a class="el" href="group___t_r_a_v.html#ga745a65eb516ce40a3be43490aaeb5c5e" title="Iterates through links in a group.">H5Literate_by_name2()</a> on discovered subgroups.</dd> <dd> <a class="el" href="group___t_r_a_v.html#ga745a65eb516ce40a3be43490aaeb5c5e" title="Iterates through links in a group.">H5Literate_by_name2()</a> is the same as <a class="el" href="group___t_r_a_v.html#gad7ca4206f06b5ada85b6ec5867ec6c73" title="Iterates over links in a group, with user callback routine, according to the order within an index.">H5Literate2()</a>, except that <a class="el" href="group___t_r_a_v.html#gad7ca4206f06b5ada85b6ec5867ec6c73" title="Iterates over links in a group, with user callback routine, according to the order within an index.">H5Literate2()</a> always proceeds in alphanumeric order.</dd></dl> @@ -905,7 +905,7 @@ Functions</h2></td></tr> <b>Failure:</b> Negative if an error occurs in the library, or the negative value returned by one of the operators.</dd></dl> <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000055">Deprecated:</a></b></dt><dd>As of HDF5-1.12 this function has been deprecated in favor of the function <a class="el" href="group___t_r_a_v.html#gafee93792c7e27a7e78b1ec221876b173" title="Recursively visits all links starting from a specified group.">H5Lvisit_by_name2()</a> or the macro <a class="el" href="group___t_r_a_v.html#ga138405315e233673741893e4e250f055">H5Lvisit_by_name()</a>.</dd></dl> <p><a class="el" href="group___t_r_a_v.html#ga1f1ba1bb4d44f2c111990024809417ac" title="Recursively visits all links starting from a specified group.">H5Lvisit_by_name1()</a> is a recursive iteration function to visit all links in and below a group in an HDF5 file, thus providing a mechanism for an application to perform a common set of operations across all of those links or a dynamically selected subset. For non-recursive iteration across the members of a group, see <a class="el" href="group___t_r_a_v.html#ga1e7c0a8cf17699563c02e128f27042f1" title="Iterates over links in a group, with user callback routine, according to the order within an index.">H5Literate1()</a>.</p> -<p>The group serving as the root of the iteration is specified by the <code>loc_id</code> / <code>group_name</code> parameter pair. <code>loc_id</code> specifies a file or group; group_name specifies either a group in the file (with an absolute name based in the file’s root group) or a group relative to <code>loc_id</code>. If <code>loc_id</code> fully specifies the group that is to serve as the root of the iteration, group_name should be '.' (a dot). (Note that when <code>loc_id</code> fully specifies the group that is to serve as the root of the iteration, the user may wish to consider using <a class="el" href="group___t_r_a_v.html#ga5424ef7043c82147490d027a0e8a59ef" title="Recursively visits all links starting from a specified group.">H5Lvisit1()</a> instead of <a class="el" href="group___t_r_a_v.html#ga1f1ba1bb4d44f2c111990024809417ac" title="Recursively visits all links starting from a specified group.">H5Lvisit_by_name1()</a>.)</p> +<p>The group serving as the root of the iteration is specified by the <code>loc_id</code> / <code>group_name</code> parameter pair. <code>loc_id</code> specifies a file or group; group_name specifies either a group in the file (with an absolute name based in the file's root group) or a group relative to <code>loc_id</code>. If <code>loc_id</code> fully specifies the group that is to serve as the root of the iteration, group_name should be '.' (a dot). (Note that when <code>loc_id</code> fully specifies the group that is to serve as the root of the iteration, the user may wish to consider using <a class="el" href="group___t_r_a_v.html#ga5424ef7043c82147490d027a0e8a59ef" title="Recursively visits all links starting from a specified group.">H5Lvisit1()</a> instead of <a class="el" href="group___t_r_a_v.html#ga1f1ba1bb4d44f2c111990024809417ac" title="Recursively visits all links starting from a specified group.">H5Lvisit_by_name1()</a>.)</p> <p>Two parameters are used to establish the iteration: <code>idx_type</code> and <code>order</code>.</p> <p><code>idx_type</code> specifies the index to be used. If the links have not been indexed by the index type, they will first be sorted by that index then the iteration will begin; if the links have been so indexed, the sorting step will be unnecessary, so the iteration may begin more quickly. Valid values include the following: </p><table class="doxtable"> <tr> @@ -1002,7 +1002,7 @@ Functions</h2></td></tr> </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___t_r_a_v.html#gafee93792c7e27a7e78b1ec221876b173" title="Recursively visits all links starting from a specified group.">H5Lvisit_by_name2()</a> is a recursive iteration function to visit all links in and below a group in an HDF5 file, thus providing a mechanism for an application to perform a common set of operations across all of those links or a dynamically selected subset. For non-recursive iteration across the members of a group, see <a class="el" href="group___t_r_a_v.html#gad7ca4206f06b5ada85b6ec5867ec6c73" title="Iterates over links in a group, with user callback routine, according to the order within an index.">H5Literate2()</a>.</p> -<p>The group serving as the root of the iteration is specified by the <code>loc_id</code> / <code>group_name</code> parameter pair. <code>loc_id</code> specifies a file or group; group_name specifies either a group in the file (with an absolute name based in the file’s root group) or a group relative to <code>loc_id</code>. If <code>loc_id</code> fully specifies the group that is to serve as the root of the iteration, group_name should be '.' (a dot). (Note that when <code>loc_id</code> fully specifies the group that is to serve as the root of the iteration, the user may wish to consider using <a class="el" href="group___t_r_a_v.html#gae1c6f963892a5f4e8922a66fbe338f66" title="Recursively visits all links starting from a specified group.">H5Lvisit2()</a> instead of <a class="el" href="group___t_r_a_v.html#gafee93792c7e27a7e78b1ec221876b173" title="Recursively visits all links starting from a specified group.">H5Lvisit_by_name2()</a>.)</p> +<p>The group serving as the root of the iteration is specified by the <code>loc_id</code> / <code>group_name</code> parameter pair. <code>loc_id</code> specifies a file or group; group_name specifies either a group in the file (with an absolute name based in the file's root group) or a group relative to <code>loc_id</code>. If <code>loc_id</code> fully specifies the group that is to serve as the root of the iteration, group_name should be '.' (a dot). (Note that when <code>loc_id</code> fully specifies the group that is to serve as the root of the iteration, the user may wish to consider using <a class="el" href="group___t_r_a_v.html#gae1c6f963892a5f4e8922a66fbe338f66" title="Recursively visits all links starting from a specified group.">H5Lvisit2()</a> instead of <a class="el" href="group___t_r_a_v.html#gafee93792c7e27a7e78b1ec221876b173" title="Recursively visits all links starting from a specified group.">H5Lvisit_by_name2()</a>.)</p> <p>Two parameters are used to establish the iteration: <code>idx_type</code> and <code>order</code>.</p> <p><code>idx_type</code> specifies the index to be used. If the links have not been indexed by the index type, they will first be sorted by that index then the iteration will begin; if the links have been so indexed, the sorting step will be unnecessary, so the iteration may begin more quickly. Valid values include the following: </p><table class="doxtable"> <tr> @@ -1032,7 +1032,7 @@ Functions</h2></td></tr> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Jul 19 2023 00:58:05 for HDF5 by + <li class="footer">Generated on Fri Jul 21 2023 00:33:48 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> |