summaryrefslogtreecommitdiffstats
path: root/develop/group___h5_i_u_d.html
diff options
context:
space:
mode:
authorlrknox <lrknox@users.noreply.github.com>2024-01-11 00:50:56 (GMT)
committerlrknox <lrknox@users.noreply.github.com>2024-01-11 00:50:56 (GMT)
commit6ba66d0a9efca6f012934bfbeb9bf4ef19465bbd (patch)
tree6062a76d316baa841b63396c145fd3a27ef71c15 /develop/group___h5_i_u_d.html
parent1245d2a51cd01b6ecfe9da8750207c9ebda20d00 (diff)
downloadhdf5-6ba66d0a9efca6f012934bfbeb9bf4ef19465bbd.zip
hdf5-6ba66d0a9efca6f012934bfbeb9bf4ef19465bbd.tar.gz
hdf5-6ba66d0a9efca6f012934bfbeb9bf4ef19465bbd.tar.bz2
deploy: 5f5f5f030ed6fff758ebddc0a007652e2c70c186
Diffstat (limited to 'develop/group___h5_i_u_d.html')
-rw-r--r--develop/group___h5_i_u_d.html35
1 files changed, 23 insertions, 12 deletions
diff --git a/develop/group___h5_i_u_d.html b/develop/group___h5_i_u_d.html
index d6cbe92..43a6c68 100644
--- a/develop/group___h5_i_u_d.html
+++ b/develop/group___h5_i_u_d.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>
- &#160;<span id="projectnumber">1.15.0.184445f</span>
+ &#160;<span id="projectnumber">1.15.0.5f5f5f0</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
@@ -335,7 +335,8 @@ Functions</h2></td></tr>
<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___h5_i_u_d.html#ga97966e203f0967fc19b38b93c2972c08" title="Deletes all identifiers of the given type.">H5Iclear_type()</a> deletes all identifiers of the type identified by the argument <code>type</code>.</p>
<p>The identifier type's free function is first called on all of these identifiers to free their memory, then they are removed from the type.</p>
-<p>If the <code>force</code> flag is set to false, only those identifiers whose reference counts are equal to 1 will be deleted, and all other identifiers will be entirely unchanged. If the force flag is true, all identifiers of this type will be deleted. </p>
+<p>If the <code>force</code> flag is set to false, only those identifiers whose reference counts are equal to 1 will be deleted, and all other identifiers will be entirely unchanged. If the force flag is true, all identifiers of this type will be deleted.</p>
+<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
@@ -364,7 +365,8 @@ Functions</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the current reference count on success, negative on failure.</dd></dl>
<p><a class="el" href="group___h5_i_u_d.html#ga3d29394ea751712e8ef5f9548f611e57" title="Decrements the reference count on an identifier type.">H5Idec_type_ref()</a> decrements the reference count on an identifier type. The reference count is used by the library to indicate when an identifier type can be destroyed. If the reference count reaches zero, this function will destroy it.</p>
-<p>The type parameter is the identifier for the identifier type whose reference count is to be decremented. This identifier must have been created by a call to <a class="el" href="group___h5_i_u_d.html#gae10d4baa1335b2d1f1aecffb305e1613" title="Creates and returns a new ID type.">H5Iregister_type()</a>. </p>
+<p>The type parameter is the identifier for the identifier type whose reference count is to be decremented. This identifier must have been created by a call to <a class="el" href="group___h5_i_u_d.html#gae10d4baa1335b2d1f1aecffb305e1613" title="Creates and returns a new ID type.">H5Iregister_type()</a>.</p>
+<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
@@ -394,7 +396,8 @@ Functions</h2></td></tr>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p>H5Idestroy_type deletes an entire identifier type <code>type</code>. All identifiers of this type are destroyed and no new identifiers of this type can be registered.</p>
<p>The type's free function is called on all of the identifiers which are deleted by this function, freeing their memory. In addition, all memory used by this type's hash table is freed.</p>
-<p>Since the H5I_type_t values of destroyed identifier types are reused when new types are registered, it is a good idea to set the variable holding the value of the destroyed type to <a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832bac3bd281c14f862130b9dc14ceb8acbf0">H5I_UNINIT</a>. </p>
+<p>Since the H5I_type_t values of destroyed identifier types are reused when new types are registered, it is a good idea to set the variable holding the value of the destroyed type to <a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832bac3bd281c14f862130b9dc14ceb8acbf0">H5I_UNINIT</a>.</p>
+<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
@@ -423,7 +426,8 @@ Functions</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the current reference count on success, negative on failure.</dd></dl>
<p><a class="el" href="group___h5_i_u_d.html#ga991d7305ffbd4fdd84432b58f704fd3b" title="Retrieves the reference count on an ID type.">H5Iget_type_ref()</a> retrieves the reference count on an ID type. The reference count is used by the library to indicate when an ID type can be destroyed.</p>
-<p>The type parameter is the identifier for the ID type whose reference count is to be retrieved. This identifier must have been created by a call to <a class="el" href="group___h5_i_u_d.html#gae10d4baa1335b2d1f1aecffb305e1613" title="Creates and returns a new ID type.">H5Iregister_type()</a>. </p>
+<p>The type parameter is the identifier for the ID type whose reference count is to be retrieved. This identifier must have been created by a call to <a class="el" href="group___h5_i_u_d.html#gae10d4baa1335b2d1f1aecffb305e1613" title="Creates and returns a new ID type.">H5Iregister_type()</a>.</p>
+<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
@@ -452,7 +456,8 @@ Functions</h2></td></tr>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the current reference count on success, negative on failure.</dd></dl>
<p><a class="el" href="group___h5_i_u_d.html#gae8302de9f2734882596a83f3117f2c9e" title="Increments the reference count on an ID type.">H5Iinc_type_ref()</a> increments the reference count on an ID type. The reference count is used by the library to indicate when an ID type can be destroyed.</p>
-<p>The type parameter is the identifier for the ID type whose reference count is to be incremented. This identifier must have been created by a call to <a class="el" href="group___h5_i_u_d.html#gae10d4baa1335b2d1f1aecffb305e1613" title="Creates and returns a new ID type.">H5Iregister_type()</a>. </p>
+<p>The type parameter is the identifier for the ID type whose reference count is to be incremented. This identifier must have been created by a call to <a class="el" href="group___h5_i_u_d.html#gae10d4baa1335b2d1f1aecffb305e1613" title="Creates and returns a new ID type.">H5Iregister_type()</a>.</p>
+<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
@@ -543,7 +548,8 @@ 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___h5_i_u_d.html#ga839170c17fb8be7e14d16ee74a314a33" title="Returns the number of identifiers in a given identifier type.">H5Inmembers()</a> returns the number of identifiers of the identifier type specified in <code>type</code>.</p>
-<p>The number of identifiers is returned in <code>num_members</code>. If no identifiers of this type have been registered, the type does not exist, or it has been destroyed, <code>num_members</code> is returned with the value 0. </p>
+<p>The number of identifiers is returned in <code>num_members</code>. If no identifiers of this type have been registered, the type does not exist, or it has been destroyed, <code>num_members</code> is returned with the value 0.</p>
+<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
@@ -584,7 +590,8 @@ Functions</h2></td></tr>
<dl class="section return"><dt>Returns</dt><dd>Pointer to the object referenced by <code>id</code> on success, NULL on failure.</dd></dl>
<p><a class="el" href="group___h5_i_u_d.html#gaafb1c684673762bc83546e1216fa6b10" title="Returns the object referenced by an ID.">H5Iobject_verify()</a> returns a pointer to the memory referenced by id after verifying that <code>id</code> is of type <code>type</code>. This function is analogous to dereferencing a pointer in C with type checking.</p>
<dl class="section note"><dt>Note</dt><dd><a class="el" href="group___h5_i_u_d.html#gaafb1c684673762bc83546e1216fa6b10" title="Returns the object referenced by an ID.">H5Iobject_verify()</a> does not change the ID it is called on in any way (as opposed to <a class="el" href="group___h5_i_u_d.html#ga7ba6445e056849a3fe331f64e84a1709" title="Removes an ID from its type.">H5Iremove_verify()</a>, which removes the ID from its type's hash table).</dd></dl>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_i_u_d.html#gab90ab765fa23e8ffbafa228d3c8e82c5" title="Registers an object under a type and returns an ID for it.">H5Iregister()</a> </dd></dl>
+<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_i_u_d.html#gab90ab765fa23e8ffbafa228d3c8e82c5" title="Registers an object under a type and returns an ID for it.">H5Iregister()</a></dd></dl>
+<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
@@ -625,7 +632,8 @@ Functions</h2></td></tr>
<dl class="section return"><dt>Returns</dt><dd>Returns a object 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___h5_i_u_d.html#gab90ab765fa23e8ffbafa228d3c8e82c5" title="Registers an object under a type and returns an ID for it.">H5Iregister()</a> creates and returns a new ID for an object.</p>
<p>The <code>type</code> parameter is the identifier for the ID type to which this new ID will belong. This identifier must have been created by a call to <a class="el" href="group___h5_i_u_d.html#gae10d4baa1335b2d1f1aecffb305e1613" title="Creates and returns a new ID type.">H5Iregister_type()</a>.</p>
-<p>The <code>object</code> parameter is a pointer to the memory which the new ID will be a reference to. This pointer will be stored by the library and returned via a call to <a class="el" href="group___h5_i_u_d.html#gaafb1c684673762bc83546e1216fa6b10" title="Returns the object referenced by an ID.">H5Iobject_verify()</a>. </p>
+<p>The <code>object</code> parameter is a pointer to the memory which the new ID will be a reference to. This pointer will be stored by the library and returned via a call to <a class="el" href="group___h5_i_u_d.html#gaafb1c684673762bc83546e1216fa6b10" title="Returns the object referenced by an ID.">H5Iobject_verify()</a>.</p>
+<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
@@ -674,7 +682,8 @@ Functions</h2></td></tr>
<p><a class="el" href="group___h5_i_u_d.html#gae10d4baa1335b2d1f1aecffb305e1613" title="Creates and returns a new ID type.">H5Iregister_type()</a> allocates space for a new ID type and returns an identifier for it.</p>
<p>The <code>hash_size</code> parameter indicates the minimum size of the hash table used to store IDs in the new type.</p>
<p>The <code>reserved</code> parameter indicates the number of IDs in this new type to be reserved. Reserved IDs are valid IDs which are not associated with any storage within the library.</p>
-<p>The <code>free_func</code> parameter is a function pointer to a function which returns an herr_t and accepts a <code>void*</code>. The purpose of this function is to deallocate memory for a single ID. It will be called by <a class="el" href="group___h5_i_u_d.html#ga97966e203f0967fc19b38b93c2972c08" title="Deletes all identifiers of the given type.">H5Iclear_type()</a> and <a class="el" href="group___h5_i_u_d.html#gaabc75ed99fd6b206154b899fac64977e" title="Removes an identifier type and all identifiers within that type.">H5Idestroy_type()</a> on each ID. This function is NOT called by <a class="el" href="group___h5_i_u_d.html#ga7ba6445e056849a3fe331f64e84a1709" title="Removes an ID from its type.">H5Iremove_verify()</a>. The <code>void*</code> will be the same pointer which was passed in to the <a class="el" href="group___h5_i_u_d.html#gab90ab765fa23e8ffbafa228d3c8e82c5" title="Registers an object under a type and returns an ID for it.">H5Iregister()</a> function. The <code>free_func</code> function should return 0 on success and -1 on failure. </p>
+<p>The <code>free_func</code> parameter is a function pointer to a function which returns an herr_t and accepts a <code>void*</code>. The purpose of this function is to deallocate memory for a single ID. It will be called by <a class="el" href="group___h5_i_u_d.html#ga97966e203f0967fc19b38b93c2972c08" title="Deletes all identifiers of the given type.">H5Iclear_type()</a> and <a class="el" href="group___h5_i_u_d.html#gaabc75ed99fd6b206154b899fac64977e" title="Removes an identifier type and all identifiers within that type.">H5Idestroy_type()</a> on each ID. This function is NOT called by <a class="el" href="group___h5_i_u_d.html#ga7ba6445e056849a3fe331f64e84a1709" title="Removes an ID from its type.">H5Iremove_verify()</a>. The <code>void*</code> will be the same pointer which was passed in to the <a class="el" href="group___h5_i_u_d.html#gab90ab765fa23e8ffbafa228d3c8e82c5" title="Registers an object under a type and returns an ID for it.">H5Iregister()</a> function. The <code>free_func</code> function should return 0 on success and -1 on failure.</p>
+<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
@@ -716,7 +725,8 @@ Functions</h2></td></tr>
<p><a class="el" href="group___h5_i_u_d.html#ga7ba6445e056849a3fe331f64e84a1709" title="Removes an ID from its type.">H5Iremove_verify()</a> first ensures that <code>id</code> belongs to <code>type</code>. If so, it removes <code>id</code> from its type and returns the pointer to the memory it referred to. This pointer is the same pointer that was placed in storage by <a class="el" href="group___h5_i_u_d.html#gab90ab765fa23e8ffbafa228d3c8e82c5" title="Registers an object under a type and returns an ID for it.">H5Iregister()</a>. If id does not belong to <code>type</code>, then NULL is returned.</p>
<p>The <code>id</code> parameter is the ID which is to be removed from its type.</p>
<p>The <code>type</code> parameter is the identifier for the ID type which <code>id</code> is supposed to belong to. This identifier must have been created by a call to <a class="el" href="group___h5_i_u_d.html#gae10d4baa1335b2d1f1aecffb305e1613" title="Creates and returns a new ID type.">H5Iregister_type()</a>.</p>
-<dl class="section note"><dt>Note</dt><dd>This function does NOT deallocate the memory that <code>id</code> refers to. The pointer returned by <a class="el" href="group___h5_i_u_d.html#gab90ab765fa23e8ffbafa228d3c8e82c5" title="Registers an object under a type and returns an ID for it.">H5Iregister()</a> must be deallocated by the user to avoid memory leaks. </dd></dl>
+<dl class="section note"><dt>Note</dt><dd>This function does NOT deallocate the memory that <code>id</code> refers to. The pointer returned by <a class="el" href="group___h5_i_u_d.html#gab90ab765fa23e8ffbafa228d3c8e82c5" title="Registers an object under a type and returns an ID for it.">H5Iregister()</a> must be deallocated by the user to avoid memory leaks.</dd></dl>
+<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
@@ -766,7 +776,8 @@ Functions</h2></td></tr>
<p>The <code>type</code> parameter is the identifier for the ID type which is to be searched. This identifier must have been created by a call to <a class="el" href="group___h5_i_u_d.html#gae10d4baa1335b2d1f1aecffb305e1613" title="Creates and returns a new ID type.">H5Iregister_type()</a>.</p>
<p>The parameter <code>func</code> is a function pointer to a function which takes three parameters. The first parameter is a <code>void*</code> and will be a pointer to the object to be tested. This is the same object that was placed in storage using <a class="el" href="group___h5_i_u_d.html#gab90ab765fa23e8ffbafa228d3c8e82c5" title="Registers an object under a type and returns an ID for it.">H5Iregister()</a>. The second parameter is a hid_t and is the ID of the object to be tested. The last parameter is a <code>void*</code>. This is the <code>key</code> parameter and can be used however the user finds helpful, or it can be ignored if it is not needed. <code>func</code> returns 0 if the object it is testing does not pass its criteria. A non-zero value should be returned if the object does pass its criteria. H5I_search_func_t is defined in <a class="el" href="_h5_ipublic_8h.html">H5Ipublic.h</a> and is shown below. </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> int (*<a class="code" href="_h5_ipublic_8h.html#a7400bdcded3eef3c4c4cf930173f9f72">H5I_search_func_t</a>)(<span class="keywordtype">void</span> *obj, <a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> id, <span class="keywordtype">void</span> *key);</div>
<div class="ttc" id="a_h5_ipublic_8h_html_a7400bdcded3eef3c4c4cf930173f9f72"><div class="ttname"><a href="_h5_ipublic_8h.html#a7400bdcded3eef3c4c4cf930173f9f72">H5I_search_func_t</a></div><div class="ttdeci">int(* H5I_search_func_t)(void *obj, hid_t id, void *key)</div><div class="ttdef"><b>Definition:</b> H5Ipublic.h:92</div></div>
-</div><!-- fragment --><p> The <code>key</code> parameter will be passed to the search function as a parameter. It can be used to further define the search at run-time. </p>
+</div><!-- fragment --><p> The <code>key</code> parameter will be passed to the search function as a parameter. It can be used to further define the search at run-time.</p>
+<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>