diff options
Diffstat (limited to 'doc/html/RM_H5I.html')
| -rw-r--r-- | doc/html/RM_H5I.html | 58 |
1 files changed, 32 insertions, 26 deletions
diff --git a/doc/html/RM_H5I.html b/doc/html/RM_H5I.html index 1dd7078..472133a 100644 --- a/doc/html/RM_H5I.html +++ b/doc/html/RM_H5I.html @@ -202,10 +202,11 @@ as the corresponding C function. decremented and the HDF5 object will be closed when the reference count for that that object drops to zero. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>obj_id</code> - <dd>IN: Object identifier whose reference count will be modified. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>obj_id </code></td> + <td valign="top">IN: Object identifier whose reference count will be modified.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative reference count of the object ID after decrementing it if successful; otherwise a negative value is returned. @@ -326,16 +327,18 @@ END SUBROUTINE h5iget_file_id_f varying according to the path through the HDF5 group hierarchy used to reach that object. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>obj_id</code> - <dd>IN: Identifier of the object. - This identifier can refer to a group, dataset, or - named datatype. - <dt><em>char *</em><code>name</code> - <dd>OUT: A name associated with the identifier. - <dt><em>size_t size</em> - <dd>IN: The size of the <code>name</code> buffer. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>obj_id </code></td> + <td valign="top">IN: Identifier of the object. + This identifier can refer to a group, dataset, or named datatype.</td></tr> + <tr> + <td valign="top"><em>char *</em><code>name</code></td> + <td valign="top">OUT: A name associated with the identifier.</td></tr> + <tr> + <td valign="top"><em>size_t size</em></td> + <td valign="top">IN: The size of the <code>name</code> buffer.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the length of the name if successful, returning <code>0</code> (zero) if no name is associated with the identifier. @@ -385,10 +388,11 @@ END SUBROUTINE h5iget_name_f A non-negative return value from this function indicates that the ID is still valid. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>obj_id</code> - <dd>IN: Object identifier whose reference count will be retrieved. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>obj_id </code></td> + <td valign="top">IN: Object identifier whose reference count will be retrieved.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative current reference count of the object ID if successful; otherwise a negative value is returned. @@ -452,10 +456,11 @@ END SUBROUTINE h5iget_ref_f <code>H5Gclose</code>, etc.) to call after a call to <code>H5Rdereference</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>obj_id</code> - <dd>IN: Object identifier whose type is to be determined. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>obj_id </code></td> + <td valign="top">IN: Object identifier whose type is to be determined.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the object type if successful; otherwise <code>H5I_BADID</code>. @@ -533,10 +538,11 @@ END SUBROUTINE h5iget_type_f decremented and the HDF5 object will be closed when the reference count for that that object drops to zero. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>obj_id</code> - <dd>IN: Object identifier whose reference count will be modified. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>obj_id </code></td> + <td valign="top">IN: Object identifier whose reference count will be modified.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative reference count of the object ID after incrementing it if successful; otherwise a negative value is returned. |