summaryrefslogtreecommitdiffstats
path: root/doc/html/RM_H5A.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/RM_H5A.html')
-rw-r--r--doc/html/RM_H5A.html200
1 files changed, 114 insertions, 86 deletions
diff --git a/doc/html/RM_H5A.html b/doc/html/RM_H5A.html
index 82a3e61..334219a 100644
--- a/doc/html/RM_H5A.html
+++ b/doc/html/RM_H5A.html
@@ -208,10 +208,11 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the
Further use of a released attribute identifier is illegal;
a function using such an identifier will fail.
<dt><strong>Parameters:</strong>
- <dl>
- <dt><em>hid_t</em> <code>attr_id</code>
- <dd>IN: Attribute to release access to.
- </dl>
+ <ul><table>
+ <tr>
+ <td valign="top"><em>hid_t</em> <code>attr_id</code></td>
+ <td>IN: Attribute to release access to.</td></tr>
+ </table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
@@ -240,11 +241,11 @@ END SUBROUTINE h5aclose_f
<dl>
<dt><strong>Name:</strong> <a name="Annot-Create">H5Acreate</a>
<dt><strong>Signature:</strong>
- <dd><font size="-1"><em>hid_t</em> <code>H5Acreate</code>(<em>hid_t</em> <code>loc_id</code>,
+ <dd><em>hid_t</em> <code>H5Acreate</code>(<em>hid_t</em> <code>loc_id</code>,
<em>const char *</em><code>name</code>,
<em>hid_t</em> <code>type_id</code>,
<em>hid_t</em> <code>space_id</code>,
- <em>hid_t</em> <code>create_plist</code></font>
+ <em>hid_t</em> <code>create_plist</code>
)
<dt><strong>Purpose:</strong>
<dd>Creates a dataset as an attribute of another group, dataset,
@@ -275,19 +276,24 @@ END SUBROUTINE h5aclose_f
The attribute identifier returned from this function must be released
with <code>H5Aclose</code> or resource leaks will develop.
<dt><strong>Parameters:</strong>
- <dl>
- <dt><em>hid_t</em> <code>loc_id</code></dt>
- <dd>IN: Object (dataset, group, or named datatype) to be attached to.</dd>
- <dt><em>const char *</em><code>name</code></dt>
- <dd>IN: Name of attribute to create.</dd>
- <dt><em>hid_t</em> <code>type_id</code></dt>
- <dd>IN: Identifier of datatype for attribute.</dd>
- <dt><em>hid_t</em> <code>space_id</code></dt>
- <dd>IN: Identifier of dataspace for attribute.</dd>
- <dt><em>hid_t</em> <code>create_plist</code></dt>
- <dd>IN: Identifier of creation property list. (Currently unused;
- the only accepted value is <code>H5P_DEFAULT</code>.)</dd>
- </dl>
+ <ul><table>
+ <tr>
+ <td valign="top"><em>hid_t</em> <code>loc_id</code></td>
+ <td valign="top">IN: Object (dataset, group, or named datatype) to be attached to.</td></tr>
+ <tr>
+ <td valign="top"><em>const char *</em><code>name</code></td>
+ <td valign="top">IN: Name of attribute to create.</td></tr>
+ <tr>
+ <td valign="top"><em>hid_t</em> <code>type_id</code></td>
+ <td valign="top">IN: Identifier of datatype for attribute.</td></tr>
+ <tr>
+ <td valign="top"><em>hid_t</em> <code>space_id</code></td>
+ <td valign="top">IN: Identifier of dataspace for attribute.</td></tr>
+ <tr>
+ <td valign="top"><em>hid_t</em>&nbsp;<code>create_plist&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
+ <td valign="top">IN: Identifier of creation property list. (Currently unused;
+ the only accepted value is <code>H5P_DEFAULT</code>.)</td></tr>
+ </table></ul>
<dt><strong>Returns:</strong>
<dd>Returns an attribute identifier if successful;
otherwise returns a negative value.
@@ -338,13 +344,15 @@ END SUBROUTINE h5acreate_f
of the attributes to change and future writes to the open
attributes to produce incorrect results.
<dt><strong>Parameters:</strong>
- <dl>
- <dt><em>hid_t</em> <code>loc_id</code>
- <dd>IN: Identifier of the dataset, group, or named datatype
- to have the attribute deleted from.
- <dt><em>const char *</em><code>name</code>
- <dd>IN: Name of the attribute to delete.
- </dl>
+ <ul><table>
+ <tr>
+ <td valign="top"><em>hid_t</em> <code>loc_id</code></td>
+ <td valign="top">IN: Identifier of the dataset, group, or named datatype
+ to have the attribute deleted from.</td></tr>
+ <tr>
+ <td valign="top"><em>const&nbsp;char&nbsp;*</em><code>name&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
+ <td valign="top">IN: Name of the attribute to delete.</td></tr>
+ </table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
@@ -389,14 +397,17 @@ END SUBROUTINE h5adelete_f
<code>(buf_size -1)</code>, the string terminator is stored in the
last position of the buffer to properly terminate the string.
<dt><strong>Parameters:</strong>
- <dl>
- <dt><em>hid_t</em> <code>attr_id</code>
- <dd>IN: Identifier of the attribute.
- <dt><em>size_t</em> <code>buf_size</code>
- <dd>IN: The size of the buffer to store the name in.
- <dt><em>char *</em><code>buf</code>
- <dd>IN: Buffer to store name in.
- </dl>
+ <ul><table>
+ <tr>
+ <td valign="top"><em>hid_t</em> <code>attr_id</code></td>
+ <td valign="top">IN: Identifier of the attribute.</td></tr>
+ <tr>
+ <td valign="top"><em>size_t</em>&nbsp;<code>buf_size&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
+ <td valign="top">IN: The size of the buffer to store the name in.</td></tr>
+ <tr>
+ <td valign="top"><em>char *</em><code>buf</code></td>
+ <td valign="top">IN: Buffer to store name in.</td></tr>
+ </table></ul>
<dt><strong>Returns:</strong>
<dd>Returns the length of the attribute's name, which may be
longer than <code>buf_size</code>, if successful.
@@ -437,10 +448,11 @@ END SUBROUTINE h5aget_name_f
<code>loc_id</code>.
The object can be a group, dataset, or named datatype.
<dt><strong>Parameters:</strong>
- <dl>
- <dt><em>hid_t</em> <code>loc_id</code>
- <dd>IN: Identifier of a group, dataset, or named datatype.
- </dl>
+ <ul><table>
+ <tr>
+ <td valign="top"><em>hid_t</em>&nbsp;<code>loc_id&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
+ <td valign="top">IN: Identifier of a group, dataset, or named datatype.</td></tr>
+ </table></ul>
<dt><strong>Returns:</strong>
<dd>Returns the number of attributes if successful;
otherwise returns a negative value.
@@ -479,10 +491,11 @@ END SUBROUTINE h5aget_num_attrs_f
this function must be released with <code>H5Sclose</code>
or resource leaks will develop.
<dt><strong>Parameters:</strong>
- <dl>
- <dt><em>hid_t</em> <code>attr_id</code>
- <dd>IN: Identifier of an attribute.
- </dl>
+ <ul><table>
+ <tr>
+ <td valign="top"><em>hid_t</em>&nbsp;<code>attr_id&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
+ <td valign="top">IN: Identifier of an attribute.</td></tr>
+ </table></ul>
<dt><strong>Returns:</strong>
<dd>Returns attribute dataspace identifier if successful;
otherwise returns a negative value.
@@ -527,10 +540,11 @@ END SUBROUTINE h5aget_space_f
The datatype identifier returned from this function must be
released with <code>H5Tclose</code> or resource leaks will develop.
<dt><strong>Parameters:</strong>
- <dl>
- <dt><em>hid_t</em> <code>attr_id</code>
- <dd>IN: Identifier of an attribute.
- </dl>
+ <ul><table>
+ <tr>
+ <td valign="top"><em>hid_t</em>&nbsp;<code>attr_id&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
+ <td valign="top">IN: Identifier of an attribute.</td></tr>
+ </table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a datatype identifier if successful;
otherwise returns a negative value.
@@ -603,16 +617,20 @@ END SUBROUTINE h5aget_type_f
attribute.
</ul>
<dt><strong>Parameters:</strong>
- <dl>
- <dt><em>hid_t</em> <code>loc_id</code>
- <dd>IN: Identifier of a group, dataset or named datatype.
- <dt><em>unsigned *</em> <code>idx</code>
- <dd>IN/OUT: Starting (IN) and ending (OUT) attribute index.
- <dt><em>H5A_operator_t</em> <code>op</code>
- <dd>IN: User's function to pass each attribute to
- <dt><em>void *</em><code>op_data</code>
- <dd>IN/OUT: User's data to pass through to iterator operator function
- </dl>
+ <ul><table>
+ <tr>
+ <td valign="top"><em>hid_t</em> <code>loc_id</code></td>
+ <td valign="top">IN: Identifier of a group, dataset or named datatype.</td></tr>
+ <tr>
+ <td valign="top"><em>unsigned *</em> <code>idx</code></td>
+ <td valign="top">IN/OUT: Starting (IN) and ending (OUT) attribute index.</td></tr>
+ <tr>
+ <td valign="top"><em>H5A_operator_t</em>&nbsp;<code>op&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
+ <td valign="top">IN: User's function to pass each attribute to</td></tr>
+ <tr>
+ <td valign="top"><em>void *</em><code>op_data</code></td>
+ <td valign="top">IN/OUT: User's data to pass through to iterator operator function</td></tr>
+ </table></ul>
<dt><strong>Returns:</strong>
<dd>If successful, returns the return value of the last operator
if it was non-zero, or zero if all attributes were processed.
@@ -655,13 +673,15 @@ SUBROUTINE
The attribute identifier returned from this function must be
released with <code>H5Aclose</code> or resource leaks will develop.
<dt><strong>Parameters:</strong>
- <dl>
- <dt><em>hid_t</em> <code>loc_id</code>
- <dd>IN: Identifier of the group, dataset, or named datatype
- attribute to be attached to.
- <dt><em>unsigned int</em> <code>idx</code>
- <dd>IN: Index of the attribute to open.
- </dl>
+ <ul><table>
+ <tr>
+ <td valign="top"><em>hid_t</em> <code>loc_id</code></td>
+ <td valign="top">IN: Identifier of the group, dataset, or named datatype
+ attribute to be attached to.</td></tr>
+ <tr>
+ <td valign="top"><em>unsigned&nbsp;int</em>&nbsp;<code>idx&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
+ <td valign="top">IN: Index of the attribute to open.</td></tr>
+ </table></ul>
<dt><strong>Returns:</strong>
<dd>Returns attribute identifier if successful;
otherwise returns a negative value.
@@ -707,13 +727,15 @@ END SUBROUTINE h5aopen_idx_f
be released with <code>H5Aclose</code> or resource leaks
will develop.
<dt><strong>Parameters:</strong>
- <dl>
- <dt><em>hid_t</em> <code>loc_id</code>
- <dd>IN: Identifier of a group, dataset, or named datatype
- atttribute to be attached to.
- <dt><em>const char *</em><code>name</code>
- <dd>IN: Attribute name.
- </dl>
+ <ul><table>
+ <tr>
+ <td valign="top"><em>hid_t</em> <code>loc_id</code></td>
+ <td valign="top">IN: Identifier of a group, dataset, or named datatype
+ atttribute to be attached to.</td></tr>
+ <tr>
+ <td valign="top"><em>const&nbsp;char&nbsp;*</em><code>name&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
+ <td valign="top">IN: Attribute name.</td></tr>
+ </table></ul>
<dt><strong>Returns:</strong>
<dd>Returns attribute identifier if successful;
otherwise returns a negative value.
@@ -764,14 +786,17 @@ END SUBROUTINE h5aopen_name_f
data conversion, including the range of conversions currently
supported by the HDF5 libraries.
<dt><strong>Parameters:</strong>
- <dl>
- <dt><em>hid_t</em> <code>attr_id</code>
- <dd>IN: Identifier of an attribute to read.
- <dt><em>hid_t</em> <code>mem_type_id</code>
- <dd>IN: Identifier of the attribute datatype (in memory).
- <dt><em>void *</em><code>buf</code>
- <dd>OUT: Buffer for data to be read.
- </dl>
+ <ul><table>
+ <tr>
+ <td valign="top"><em>hid_t</em> <code>attr_id</code></td>
+ <td valign="top">IN: Identifier of an attribute to read.</td></tr>
+ <tr>
+ <td valign="top"><em>hid_t</em>&nbsp;<code>mem_type_id&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
+ <td valign="top">IN: Identifier of the attribute datatype (in memory).</td></tr>
+ <tr>
+ <td valign="top"><em>void *</em><code>buf</code></td>
+ <td valign="top">OUT: Buffer for data to be read.</td></tr>
+ </table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
@@ -831,14 +856,17 @@ END SUBROUTINE h5aread_f
data conversion, including the range of conversions currently
supported by the HDF5 libraries.
<dt><strong>Parameters:</strong>
- <dl>
- <dt><em>hid_t</em> <code>attr_id</code>
- <dd>IN: Identifier of an attribute to write.
- <dt><em>hid_t</em> <code>mem_type_id</code>
- <dd>IN: Identifier of the attribute datatype (in memory).
- <dt><em>const void *</em><code>buf</code>
- <dd>IN: Data to be written.
- </dl>
+ <ul><table>
+ <tr>
+ <td valign="top"><em>hid_t</em> <code>attr_id</code></td>
+ <td valign="top">IN: Identifier of an attribute to write.</td></tr>
+ <tr>
+ <td valign="top"><em>hid_t</em>&nbsp;<code>mem_type_id&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
+ <td valign="top">IN: Identifier of the attribute datatype (in memory).</td></tr>
+ <tr>
+ <td valign="top"><em>const void *</em><code>buf</code></td>
+ <td valign="top">IN: Data to be written.</td></tr>
+ </table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.