mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-01-18 15:15:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

[svn-r1890] RM_H5G.html H5Giterate: Corrected H5G_operator_t to read H5G_iterate_t.

Browse Source 
Minor corrections to H5G_iterate_t prototype syntax.
	          Added note that H5Giterate's behavior is undefined if
	             the group structure or membership changes.
This commit is contained in:
Frank Baker 1999-12-17 10:41:05 -05:00
parent 620c3d380d
commit d15a2ce142
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/html/RM_H5G.html
View File

@ -387,7 +387,7 @@ create or access function.
<dd><em>int</em> <code>H5Giterate</code>(<em>hid_t</em> <code>loc_id</code>,
<em>const char</em> <code>*name</code>,
<em>int</em> <code>*idx</code>,
<em>H5G_operator_t</em> <code>operator</code>,
<em>H5G_iterate_t</em> <code>operator</code>,
<em>void</em> <code>*operator_data</code>
)
<dt><strong>Purpose:</strong>
@ -407,10 +407,11 @@ create or access function.
cannot be restarted if one of the calls to its operator returns
non-zero.
<p>
The prototype for <code>H5G_operator_t</code> is:
The prototype for <code>H5G_iterate_t</code> is:
<ul><dl>
<dd><code>typedef</code> <em>herr_t *</em>(<code>H5G_operator_t</code>)(<em>hid_t</em> <code>group_id</code>,
<em>const char *</em><code>member_name</code>, <em>void *</em><code>operator_data/*in,out*/</code>);
<dd><code>typedef</code> <em>herr_t </em>(*<code>H5G_iterate_t</code>)(<em>hid_t</em> <code>group_id</code>,
<em>const char *</em><code>member_name</code>,
<em>void *</em><code>operator_data</code>);
</dl></ul>
<dd>The operation receives the group identifier for the group being
iterated over, <code>group_id</code>, the name of the current
@ -429,6 +430,11 @@ create or access function.
indicating failure. The iterator can be restarted at the next
group member.
</ul>
<p>
<code>H5Giterate</code> assumes that the membership of the group
identified by <code>name</code> remains unchanged through the
iteration. If the membership changes during the iteration,
the function's behavior is undefined.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>loc_id</code>