diff options
| author | Frank Baker <fbaker@hdfgroup.org> | 2004-02-24 22:10:12 (GMT) |
|---|---|---|
| committer | Frank Baker <fbaker@hdfgroup.org> | 2004-02-24 22:10:12 (GMT) |
| commit | 9fb77d56b800f04e7818190f50193028a134603f (patch) | |
| tree | e6d5c34ec5d291a8a4f43a97c6ba48f520153bf8 | |
| parent | f29e2a01e35e466fdcc292a0c443265efdf4b025 (diff) | |
| download | hdf5-9fb77d56b800f04e7818190f50193028a134603f.zip hdf5-9fb77d56b800f04e7818190f50193028a134603f.tar.gz hdf5-9fb77d56b800f04e7818190f50193028a134603f.tar.bz2 | |
[svn-r8221]
Purpose:
Clean up RM formatting.
Modify RM HTML code to facilitate automated generation of PDF version.
Minor edits.
Description:
Reworked format of "Parameters" sections.
Added HTML tags (and pseudo-HTML tags) used by HTMLdoc to
generate PDF files.
Fixed the "Copyright" link on RM_H5Front.html.
Other minor copy edits.
Platforms tested:
IE 5
| -rw-r--r-- | doc/html/Glossary.html | 9 | ||||
| -rw-r--r-- | doc/html/PredefDTypes.html | 10 | ||||
| -rw-r--r-- | doc/html/RM_H5.html | 85 | ||||
| -rw-r--r-- | doc/html/RM_H5A.html | 208 | ||||
| -rw-r--r-- | doc/html/RM_H5D.html | 370 | ||||
| -rw-r--r-- | doc/html/RM_H5E.html | 145 | ||||
| -rw-r--r-- | doc/html/RM_H5F.html | 262 | ||||
| -rw-r--r-- | doc/html/RM_H5Front.html | 25 | ||||
| -rw-r--r-- | doc/html/RM_H5G.html | 385 | ||||
| -rw-r--r-- | doc/html/RM_H5I.html | 68 | ||||
| -rw-r--r-- | doc/html/RM_H5P.html | 2038 | ||||
| -rw-r--r-- | doc/html/RM_H5R.html | 109 | ||||
| -rw-r--r-- | doc/html/RM_H5S.html | 378 | ||||
| -rw-r--r-- | doc/html/RM_H5T.html | 912 | ||||
| -rw-r--r-- | doc/html/RM_H5Z.html | 35 | ||||
| -rw-r--r-- | doc/html/Tools.html | 71 |
16 files changed, 2984 insertions, 2126 deletions
diff --git a/doc/html/Glossary.html b/doc/html/Glossary.html index 8564b32..94ff8e5 100644 --- a/doc/html/Glossary.html +++ b/doc/html/Glossary.html @@ -42,8 +42,7 @@ HDF5 Glossary </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><center> +<hr><!-- #EndLibraryItem --><center> <h1>HDF5 Glossary</h1> </center> @@ -239,6 +238,7 @@ HDF5 Glossary supporting metadata. <P> +<!-- NEW PAGE --> <DT><B><a name="Glossary-PListDSetAccess">dataset access property list</a></B> <DD>A property list containing information on how a dataset is to be accessed. <P> @@ -557,14 +557,13 @@ HDF5 Glossary </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> +<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 18 October 1999"); +document.writeln("Last modified: 24 February 2004"); --> </SCRIPT> diff --git a/doc/html/PredefDTypes.html b/doc/html/PredefDTypes.html index 4ad5c01..853279a 100644 --- a/doc/html/PredefDTypes.html +++ b/doc/html/PredefDTypes.html @@ -60,8 +60,7 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><center> +<hr><!-- #EndLibraryItem --><center> <h1>HDF5 Predefined Datatypes</h1> </center> @@ -388,7 +387,7 @@ The following datatypes are predefined in HDF5. </tr></td> </table> - +<!-- NEW PAGE --> <a name="F90"> <h4>FORTRAN90 API datatypes</h4> </a> @@ -493,14 +492,13 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> +<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 12 December 2000"); +document.writeln("Last modified: 24 February 2004"); --> </SCRIPT> diff --git a/doc/html/RM_H5.html b/doc/html/RM_H5.html index 4232ac6..0f7d673 100644 --- a/doc/html/RM_H5.html +++ b/doc/html/RM_H5.html @@ -22,10 +22,7 @@ HDF5/H5 API Specification --> <link href="ed_styles/RMelect.css" rel="stylesheet" type="text/css"> -<!-- #EndLibraryItem --></head> - -<body bgcolor="#FFFFFF"> - +<!-- #EndLibraryItem --></head> <body bgcolor="#FFFFFF"> <!-- #BeginLibraryItem "/ed_libs/NavBar_RM.lbi" --><hr> <center> @@ -60,8 +57,7 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><center> +<hr><!-- #EndLibraryItem --><center> <h1>H5: General Library Functions</h1> </center> @@ -240,14 +236,17 @@ facilitate moving easily between them.</i> the 1 is the release number, <code>relnum</code>. --> <dt><strong>Parameters:</strong> - <dl> - <dt><em>unsigned </em><code>majnum</code> - <dd>IN: The major version of the library. - <dt><em>unsigned </em><code>minnum</code> - <dd>IN: The minor version of the library. - <dt><em>unsigned </em><code>relnum</code> - <dd>IN: The release number of the library. - </dl> + <ul><table> + <tr> + <td valign="top"><em>unsigned </em><code>majnum</code></td> + <td valign="top">IN: The major version of the library.</td></tr> + <tr> + <td valign="top"><em>unsigned </em><code>minnum </code></td> + <td valign="top">IN: The minor version of the library.</td></tr> + <tr> + <td valign="top"><em>unsigned </em><code>relnum</code></td> + <td valign="top">IN: The release number of the library.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Upon failure, this function causes the application to abort. @@ -429,14 +428,17 @@ END SUBROUTINE h5garbage_collect_f numbers of the version of the HDF library which is linked to the application. <dt><strong>Parameters:</strong> - <dl> - <dt><em>unsigned *</em><code>majnum</code> - <dd>OUT: The major version of the library. - <dt><em>unsigned *</em><code>minnum</code> - <dd>OUT: The minor version of the library. - <dt><em>unsigned *</em><code>relnum</code> - <dd>OUT: The release number of the library. - </dl> + <ul><table> + <tr> + <td valign="top"><em>unsigned *</em><code>majnum</code></td> + <td valign="top">OUT: The major version of the library.</td></tr> + <tr> + <td valign="top"><em>unsigned *</em><code>minnum </code></td> + <td valign="top">OUT: The minor version of the library.</td></tr> + <tr> + <td valign="top"><em>unsigned *</em><code>relnum</code></td> + <td valign="top">OUT: The release number of the library.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -559,20 +561,26 @@ END SUBROUTINE h5open_f Using a value of <code>-1</code> for a limit means that no limit is set for the specified type of free list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>int</em> <code>reg_global_lim</code> - <dd>IN: The limit on all regular free list memory used - <dt><em>int</em> <code>reg_list_lim</code> - <dd>IN: The limit on memory used in each regular free list - <dt><em>int</em> <code>arr_global_lim</code> - <dd>IN: The limit on all array free list memory used - <dt><em>int</em> <code>arr_list_lim</code> - <dd>IN: The limit on memory used in each array free list - <dt><em>int</em> <code>blk_global_lim</code> - <dd>IN: The limit on all block free list memory used - <dt><em>int</em> <code>blk_list_lim</code> - <dd>IN: The limit on memory used in each block free list - </dl> + <ul><table> + <tr> + <td valign="top"><em>int</em> <code>reg_global_lim </code></td> + <td valign="top">IN: The limit on all regular free list memory used</td></tr> + <tr> + <td valign="top"><em>int</em> <code>reg_list_lim</code></td> + <td valign="top">IN: The limit on memory used in each regular free list</td></tr> + <tr> + <td valign="top"><em>int</em> <code>arr_global_lim</code></td> + <td valign="top">IN: The limit on all array free list memory used</td></tr> + <tr> + <td valign="top"><em>int</em> <code>arr_list_lim</code></td> + <td valign="top">IN: The limit on memory used in each array free list</td></tr> + <tr> + <td valign="top"><em>int</em> <code>blk_global_lim</code></td> + <td valign="top">IN: The limit on all block free list memory used</td></tr> + <tr> + <td valign="top"><em>int</em> <code>blk_list_lim</code></td> + <td valign="top">IN: The limit on memory used in each block free list</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -626,14 +634,13 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> +<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 20 October 2003"); +document.writeln("Last modified: 24 February 2004"); --> </SCRIPT> diff --git a/doc/html/RM_H5A.html b/doc/html/RM_H5A.html index b3334bf..68b51c3 100644 --- a/doc/html/RM_H5A.html +++ b/doc/html/RM_H5A.html @@ -61,8 +61,7 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><center> +<hr><!-- #EndLibraryItem --><center> <h1>H5A: Attribute Interface</h1> </center> @@ -205,10 +204,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. @@ -237,11 +237,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, @@ -272,19 +272,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> <code>create_plist </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. @@ -333,13 +338,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 char *</em><code>name </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. @@ -384,14 +391,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> <code>buf_size </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. @@ -432,10 +442,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> <code>loc_id </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. @@ -474,10 +485,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> <code>attr_id </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. @@ -522,10 +534,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> <code>attr_id </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. @@ -598,16 +611,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> <code>op </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. @@ -650,13 +667,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 int</em> <code>idx </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. @@ -702,13 +721,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 char *</em><code>name </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. @@ -759,14 +780,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> <code>mem_type_id </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. @@ -826,14 +850,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> <code>mem_type_id </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. @@ -900,14 +927,13 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> +<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 21 October 2003"); +document.writeln("Last modified: 24 February 2004"); --> </SCRIPT> diff --git a/doc/html/RM_H5D.html b/doc/html/RM_H5D.html index 59e5fb6..f77a3ec 100644 --- a/doc/html/RM_H5D.html +++ b/doc/html/RM_H5D.html @@ -61,8 +61,7 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><center> +<hr><!-- #EndLibraryItem --><center> <h1>H5D: Datasets Interface</h1> </center> @@ -207,10 +206,11 @@ as the corresponding C function. Further use of the dataset identifier is illegal in calls to the dataset API. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset_id</code> - <dd>IN: Identifier of the dataset to close access to. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset_id </code></td> + <td valign="top">IN: Identifier of the dataset to close access to.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -294,15 +294,15 @@ END SUBROUTINE h5dclose_f <table width=80% border="0"> <tr valign="top" align="left"><td width=10%> </td><td width=45%> - <a href="#Dataset-Fill">H5Dfill</a><br> - <a href="RM_H5P.html#Property-SetFillValue">H5Pset_fill_value</a><br> - <a href="RM_H5P.html#Property-GetFillValue">H5Pget_fill_value</a><br> - <a href="RM_H5P.html#Property-FillValueDefined">H5Pfill_value_defined</a> + <a href="#Dataset-Fill"><code>H5Dfill</code></a><br> + <a href="RM_H5P.html#Property-SetFillValue"><code>H5Pset_fill_value</code></a><br> + <a href="RM_H5P.html#Property-GetFillValue"><code>H5Pget_fill_value</code></a><br> + <a href="RM_H5P.html#Property-FillValueDefined"><code>H5Pfill_value_defined</code></a> </td><td width=45%> - <a href="RM_H5P.html#Property-SetFillTime">H5Pset_fill_time</a><br> - <a href="RM_H5P.html#Property-GetFillTime">H5Pget_fill_time</a><br> - <a href="RM_H5P.html#Property-SetAllocTime">H5Pset_alloc_time</a><br> - <a href="RM_H5P.html#Property-GetAllocTime">H5Pget_alloc_time</a> + <a href="RM_H5P.html#Property-SetFillTime"><code>H5Pset_fill_time</code></a><br> + <a href="RM_H5P.html#Property-GetFillTime"><code>H5Pget_fill_time</code></a><br> + <a href="RM_H5P.html#Property-SetAllocTime"><code>H5Pset_alloc_time</code></a><br> + <a href="RM_H5P.html#Property-GetAllocTime"><code>H5Pget_alloc_time</code></a> </td></tr> </table> This information is also included in the @@ -310,21 +310,27 @@ END SUBROUTINE h5dclose_f the new <cite>HDF5 User's Guide</cite>, which is being prepared for release. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of the file or group - within which to create the dataset. - <dt><em>const char *</em> <code>name</code> - <dd>IN: The name of the dataset to create. - <dt><em>hid_t</em> <code>type_id</code> - <dd>IN: Identifier of the datatype to use - when creating the dataset. - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Identifier of the dataspace to use - when creating the dataset. - <dt><em>hid_t</em> <code>create_plist_id</code> - <dd>IN: Identifier of the set creation property list. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Identifier of the file or group + within which to create the dataset.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>name</code></td> + <td valign="top">IN: The name of the dataset to create.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">IN: Identifier of the datatype to use + when creating the dataset.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id</code></td> + <td valign="top">IN: Identifier of the dataspace to use + when creating the dataset.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>create_plist_id </code></td> + <td valign="top">IN: Identifier of the set creation property list.</td></tr> + </table></ul> +<!-- NEW PAGE --> <dt><strong>Returns:</strong> <dd>Returns a dataset identifier if successful; otherwise returns a negative value. @@ -386,12 +392,14 @@ END SUBROUTINE h5dcreate_f <a href="RM_H5P.html#Property-SetAllocTime">H5Pset_alloc_time</a>.) <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset_id</code> - <dd>IN: Identifier of the dataset. - <dt><em>const hsize_t *</em> <code>size</code> - <dd>IN: Array containing the new magnitude of each dimension. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset_id</code></td> + <td valign="top">IN: Identifier of the dataset.</td></tr> + <tr> + <td valign="top"><em>const hsize_t *</em> <code>size </code></td> + <td valign="top">IN: Array containing the new magnitude of each dimension.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -465,20 +473,25 @@ END SUBROUTINE h5dextend_f and <a href="#Dataset-Create">H5Dcreate</a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>const void *</em><code>fill</code> - <dd>IN: Pointer to the fill value to be used. - <dt><em>hid_t </em><code>fill_type_id</code> - <dd>IN: Fill value datatype identifier. - <dt><em>void *</em><code>buf</code> - <dd>IN/OUT: Pointer to the memory buffer containing the - selection to be filled. - <dt><em>hid_t </em><code>buf_type_id</code> - <dd>IN: Datatype of dataspace elements to be filled. - <dt><em>hid_t </em><code>space_id</code> - <dd>IN: Dataspace describing memory buffer and - containing the selection to be filled. - </dl> + <ul><table> + <tr> + <td valign="top"><em>const void *</em><code>fill</code></td> + <td valign="top">IN: Pointer to the fill value to be used.</td></tr> + <tr> + <td valign="top"><em>hid_t </em><code>fill_type_id </code></td> + <td valign="top">IN: Fill value datatype identifier.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>buf</code></td> + <td valign="top">IN/OUT: Pointer to the memory buffer containing the + selection to be filled.</td></tr> + <tr> + <td valign="top"><em>hid_t </em><code>buf_type_id</code></td> + <td valign="top">IN: Datatype of dataspace elements to be filled.</td></tr> + <tr> + <td valign="top"><em>hid_t </em><code>space_id</code></td> + <td valign="top">IN: Dataspace describing memory buffer and + containing the selection to be filled.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -524,10 +537,11 @@ END SUBROUTINE h5dfill_f The creation property list identifier should be released with the <code>H5Pclose</code> function. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset_id</code> - <dd>IN: Identifier of the dataset to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset_id </code></td> + <td valign="top">IN: Identifier of the dataset to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a dataset creation property list identifier if successful; otherwise returns a negative value. @@ -568,10 +582,11 @@ END SUBROUTINE h5dget_create_plist_f That address is expressed as the offset in bytes from the beginning of the file. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t </em><code>dset_id</code> - <dd>Dataset identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t </em><code>dset_id </code></td> + <td valign="top">Dataset identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the offset in bytes; otherwise returns <code>HADDR_UNDEF</code>, a negative value. @@ -607,10 +622,11 @@ SUBROUTINE The dataspace identifier should be released with the <code>H5Sclose</code> function. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset_id</code> - <dd>IN: Identifier of the dataset to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset_id </code></td> + <td valign="top">IN: Identifier of the dataset to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a dataspace identifier if successful; otherwise returns a negative value. @@ -653,15 +669,15 @@ END SUBROUTINE h5dget_space_f <center> <table border="0"> <tr valign="top"><td rowspan="3"> </td><td> - H5D_SPACE_STATUS_NOT_ALLOCATED + <code>H5D_SPACE_STATUS_NOT_ALLOCATED</code> </td><td> Space has not been allocated for this dataset. </td></tr><tr valign="top"><td> - H5D_SPACE_STATUS_ALLOCATED + <code>H5D_SPACE_STATUS_ALLOCATED</code> </td><td> Space has been allocated for this dataset. </td></tr><tr valign="top"><td> - H5D_SPACE_STATUS_PART_ALLOCATED + <code>H5D_SPACE_STATUS_PART_ALLOCATED</code> </td><td> Space has been partially allocated for this dataset. (Used only for datasets with chunked storage.) @@ -669,12 +685,14 @@ END SUBROUTINE h5dget_space_f </table> </center> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dset_id</code> - <dd>IN: Identifier of the dataset to query. - <dt><em>H5D_space_status_t *</em><code>status</code> - <dd>OUT: Space allocation status. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dset_id</code></td> + <td valign="top">IN: Identifier of the dataset to query.</td></tr> + <tr> + <td valign="top"><em>H5D_space_status_t *</em><code>status </code></td> + <td valign="top">OUT: Space allocation status.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -719,10 +737,11 @@ END SUBROUTINE h5dget_space_status_f the chunk size. The return value may be zero if no data has been stored. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset_id</code> - <dd>IN: Identifier of the dataset to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset_id </code></td> + <td valign="top">IN: Identifier of the dataset to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the amount of storage space allocated for the dataset, not counting meta data; @@ -768,10 +787,11 @@ END SUBROUTINE h5dget_storage_size_f Otherwise, the returned datatype is read-only. If atomization of the datatype fails, then the datatype is closed. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset_id</code> - <dd>IN: Identifier of the dataset to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset_id </code></td> + <td valign="top">IN: Identifier of the dataset to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a datatype identifier if successful; otherwise returns a negative value. @@ -822,23 +842,28 @@ END SUBROUTINE h5dget_type_f the iteration may then be re-started by the user where it left off. <dt><strong>Parameters:</strong> - <dl> - <dt><em>void *</em><code>buf</code> - <dd>IN/OUT: Pointer to the buffer in memory containing the - elements to iterate over. - <dt><em>hid_t </em><code>type_id</code> - <dd>IN: Datatype identifier for the elements stored in - <code>buf</code>. - <dt><em>hid_t </em><code>space_id</code> - <dd>IN: Dataspace identifier for <code>buf</code>. - Also contains the selection to iterate over. - <dt><em>H5D_operator_t </em><code>operator</code> - <dd>IN: Function pointer to the routine to be called - for each element in <code>buf</code> iterated over. - <dt><em>void *</em><code>operator_data</code> - <dd>IN/OUT: Pointer to any user-defined data associated - with the operation. - </dl> + <ul><table> + <tr> + <td valign="top"><em>void *</em><code>buf</code></td> + <td valign="top">IN/OUT: Pointer to the buffer in memory containing the + elements to iterate over.</td></tr> + <tr> + <td valign="top"><em>hid_t </em><code>type_id</code></td> + <td valign="top">IN: Datatype identifier for the elements stored in + <code>buf</code>.</td></tr> + <tr> + <td valign="top"><em>hid_t </em><code>space_id</code></td> + <td valign="top">IN: Dataspace identifier for <code>buf</code>. + Also contains the selection to iterate over.</td></tr> + <tr> + <td valign="top"><em>H5D_operator_t </em><code>operator </code></td> + <td valign="top">IN: Function pointer to the routine to be called + for each element in <code>buf</code> iterated over.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>operator_data</code></td> + <td valign="top">IN/OUT: Pointer to any user-defined data associated + with the operation.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the return value of the last operator if it was non-zero, or zero if all elements have been processed. @@ -875,13 +900,15 @@ SUBROUTINE or group specified in <code>loc_id</code>. <code>name</code> is a dataset name and is used to identify the dataset in the file. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of the file or group - within which the dataset to be accessed will be found. - <dt><em>const char *</em> <code>name</code> - <dd>IN: The name of the dataset to access. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Identifier of the file or group + within which the dataset to be accessed will be found.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>name </code></td> + <td valign="top">IN: The name of the dataset to access.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a dataset identifier if successful; otherwise returns a negative value. @@ -1049,21 +1076,27 @@ END SUBROUTINE h5dopen_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>dataset_id</code> - <dd>IN: Identifier of the dataset read from. - <dt><em>hid_t</em> <code>mem_type_id</code> - <dd>IN: Identifier of the memory datatype. - <dt><em>hid_t</em> <code>mem_space_id</code> - <dd>IN: Identifier of the memory dataspace. - <dt><em>hid_t</em> <code>file_space_id</code> - <dd>IN: Identifier of the dataset's dataspace in the file. - <dt><em>hid_t</em> <code>xfer_plist_id</code> - <dd>IN: Identifier of a transfer property list - for this I/O operation. - <dt><em>void *</em> <code>buf</code> - <dd>OUT: Buffer to receive data read from file. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset_id</code></td> + <td valign="top">IN: Identifier of the dataset read from.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>mem_type_id</code></td> + <td valign="top">IN: Identifier of the memory datatype.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>mem_space_id</code></td> + <td valign="top">IN: Identifier of the memory dataspace.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>file_space_id </code></td> + <td valign="top">IN: Identifier of the dataset's dataspace in the file.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>xfer_plist_id </code></td> + <td valign="top">IN: Identifier of a transfer property list + for this I/O operation.</td></tr> + <tr> + <td valign="top"><em>void *</em> <code>buf</code></td> + <td valign="top">OUT: Buffer to receive data read from file.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1077,7 +1110,7 @@ END SUBROUTINE h5dopen_f <dd> <pre> -SUBROUTINE h5dread_f(dset_id, mem_type_id, buf, dims, hdferr, & +SUBROUTINE h5dread_f(dset_id, mem_type_id, buf, dims, hdferr, & mem_space_id, file_space_id, xfer_prp) IMPLICIT NONE @@ -1107,11 +1140,12 @@ SUBROUTINE h5dread_f(dset_id, mem_type_id, buf, dims, hdferr, & END SUBROUTINE h5dread_f </pre> +<!-- NEW PAGE --> <p>Use this <code>h5dread_f</code> call for object reference and dataset region reference datatypes: <pre> -SUBROUTINE h5dread_f(dset_id, mem_type_id, buf, n, hdferr, & +SUBROUTINE h5dread_f(dset_id, mem_type_id, buf, n, hdferr, & mem_space_id, file_space_id, xfer_prp) IMPLICIT NONE @@ -1172,16 +1206,21 @@ END SUBROUTINE h5dread_f <code>*size</code> is returned with the number of bytes required to store the VL data in memory. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset_id</code> - <dd>IN: Identifier of the dataset to query. - <dt><em>hid_t</em> <code>type_id</code> - <dd>IN: Datatype identifier. - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Dataspace identifier. - <dt><em>hsize_t</em> *<code>size</code> - <dd>OUT: The size in bytes of the memory buffer required to store the VL data. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset_id </code></td> + <td valign="top">IN: Identifier of the dataset to query.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">IN: Datatype identifier.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id</code></td> + <td valign="top">IN: Dataspace identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> *<code>size</code></td> + <td valign="top">OUT: The size in bytes of the memory + buffer required to store the VL data.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns non-negative value if successful; otherwise returns a negative value. @@ -1241,16 +1280,20 @@ END SUBROUTINE h5dvlen_get_max_len_f this routine frees them <em>from the bottom up</em>, releasing all the memory without creating memory leaks. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>IN: Identifier of the datatype. - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Identifier of the dataspace. - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Identifier of the property list used to create the buffer. - <dt><em>void</em> *<code>buf</code> - <dd>IN: Pointer to the buffer to be reclaimed. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">IN: Identifier of the datatype.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">IN: Identifier of the dataspace.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Identifier of the property list used to create the buffer.</td></tr> + <tr> + <td valign="top"><em>void</em> *<code>buf</code></td> + <td valign="top">IN: Pointer to the buffer to be reclaimed.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns non-negative value if successful; otherwise returns a negative value. @@ -1431,21 +1474,27 @@ SUBROUTINE write identical data to the dataset from all processes. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset_id</code> - <dd>IN: Identifier of the dataset to write to. - <dt><em>hid_t</em> <code>mem_type_id</code> - <dd>IN: Identifier of the memory datatype. - <dt><em>hid_t</em> <code>mem_space_id</code> - <dd>IN: Identifier of the memory dataspace. - <dt><em>hid_t</em> <code>file_space_id</code> - <dd>IN: Identifier of the dataset's dataspace in the file. - <dt><em>hid_t</em> <code>xfer_plist_id</code> - <dd>IN: Identifier of a transfer property list - for this I/O operation. - <dt><em>const void *</em> <code>buf</code> - <dd>IN: Buffer with data to be written to the file. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset_id</code></td> + <td valign="top">IN: Identifier of the dataset to write to.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>mem_type_id</code></td> + <td valign="top">IN: Identifier of the memory datatype.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>mem_space_id</code></td> + <td valign="top">IN: Identifier of the memory dataspace.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>file_space_id </code></td> + <td valign="top">IN: Identifier of the dataset's dataspace in the file.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>xfer_plist_id</code></td> + <td valign="top">IN: Identifier of a transfer property list + for this I/O operation.</td></tr> + <tr> + <td valign="top"><em>const void *</em> <code>buf</code></td> + <td valign="top">IN: Buffer with data to be written to the file.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1459,14 +1508,16 @@ SUBROUTINE <dd> <pre> -SUBROUTINE h5dwrite_f(dset_id, mem_type_id, buf, dims, hdferr, & +SUBROUTINE h5dwrite_f(dset_id, mem_type_id, buf, dims, hdferr, & mem_space_id, file_space_id, xfer_prp) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier INTEGER(HID_T), INTENT(IN) :: mem_type_id ! Memory datatype identifier TYPE, INTENT(IN) :: buf ! Data buffer; may be a scalar - ! or an array + ! or an array</pre> +<!-- NEW PAGE --> +<pre> DIMENSION(*), INTEGER(HSIZE_T), INTENT(IN) :: dims ! Array to hold corresponding ! dimension sizes of data @@ -1494,7 +1545,7 @@ END SUBROUTINE h5dwrite_f and dataset region reference datatypes: <pre> -SUBROUTINE h5dwrite_f(dset_id, mem_type_id, buf, n, hdferr, & +SUBROUTINE h5dwrite_f(dset_id, mem_type_id, buf, n, hdferr, & mem_space_id, file_space_id, xfer_prp) IMPLICIT NONE @@ -1566,14 +1617,13 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> +<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 21 October 2003"); +document.writeln("Last modified: 24 February 2004"); --> </SCRIPT> diff --git a/doc/html/RM_H5E.html b/doc/html/RM_H5E.html index 6d1efa4..8f4d3ce 100644 --- a/doc/html/RM_H5E.html +++ b/doc/html/RM_H5E.html @@ -61,8 +61,7 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><center> +<hr><!-- #EndLibraryItem --><center> <h1>H5E: Error Interface</h1> </center> @@ -203,9 +202,9 @@ errors within the H5E package. <code>H5Eclear</code> can fail if there are problems initializing the library. <dt><strong>Parameters:</strong> - <dl> - <dt>None - </dl> + <ul><table> + <tr><td valign="top">None</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -245,13 +244,15 @@ END SUBROUTINE h5eclear_f and its data, <code>client_data</code>. Either (or both) arguments may be null in which case the value is not returned. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5E_auto_t *</em> <code>func</code> - <dd>OUT: Current setting for the function to be called upon an - error condition. - <dt><em>void **</em><code>client_data</code> - <dd>OUT: Current setting for the data passed to the error function. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5E_auto_t *</em> <code>func</code></td> + <td valign="top">OUT: Current setting for the function to be called upon an + error condition.</td></tr> + <tr> + <td valign="top"><em>void **</em><code>client_data </code></td> + <td valign="top">OUT: Current setting for the data passed to the error function.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -286,10 +287,11 @@ SUBROUTINE <dd>Given a major error number, <code>H5Eget_major</code> returns a constant character string that describes the error. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5E_major_t</em> <code>n</code> - <dd>IN: Major error number. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5E_major_t</em> <code>n </code></td> + <td valign="top">IN: Major error number.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd> Returns a character string describing the error if successful. Otherwise returns "Invalid major error number." @@ -326,10 +328,11 @@ END SUBROUTINE h5eget_major_f <dd>Given a minor error number, <code>H5Eget_minor</code> returns a constant character string that describes the error. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5E_minor_t</em> <code>n</code> - <dd>IN: Minor error number. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5E_minor_t</em> <code>n </code></td> + <td valign="top">IN: Minor error number.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd> Returns a character string describing the error if successful. Otherwise returns "Invalid minor error number." @@ -372,10 +375,11 @@ END SUBROUTINE h5eget_minor_f <code>H5Ewalk</code> with a function that prints error messages. Users are encouraged to write their own more specific error handlers. <dt><strong>Parameters:</strong> - <dl> - <dt><em>FILE *</em> <code>stream</code> - <dd>IN: File pointer, or stderr if NULL. - </dl> + <ul><table> + <tr> + <td valign="top"><em>FILE *</em> <code>stream </code></td> + <td valign="top">IN: File pointer, or stderr if NULL.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -427,20 +431,26 @@ END SUBROUTINE h5eprint_f The function name, file name, and error description strings must be statically allocated. <dt><strong>Parameters:</strong> - <dl> - <dt><em>const char *</em><code>file</code>, - <dd>IN: Name of the file in which the error was detected. - <dt><em>const char *</em><code>func</code>, - <dd>IN: Name of the function in which the error was detected. - <dt><em>unsigned</em> <code>line</code>, - <dd>IN: Line within the file at which the error was detected. - <dt><em>H5E_major_t</em> <code>maj_num</code>, - <dd>IN: Major error number. - <dt><em>H5E_minor_t</em> <code>min_num</code>, - <dd>IN: Minor error number. - <dt><em>const char *</em><code>str</code> - <dd>IN: Error description string. - </dl> + <ul><table> + <tr> + <td valign="top"><em>const char *</em><code>file</code>,</td> + <td valign="top">IN: Name of the file in which the error was detected.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>func</code>,</td> + <td valign="top">IN: Name of the function in which the error was detected.</td></tr> + <tr> + <td valign="top"><em>unsigned</em> <code>line</code>,</td> + <td valign="top">IN: Line within the file at which the error was detected.</td></tr> + <tr> + <td valign="top"><em>H5E_major_t</em> <code>maj_num, </code></td> + <td valign="top">IN: Major error number.</td></tr> + <tr> + <td valign="top"><em>H5E_minor_t</em> <code>min_num</code>,</td> + <td valign="top">IN: Minor error number.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>str</code></td> + <td valign="top">IN: Error description string.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -487,12 +497,14 @@ SUBROUTINE Automatic stack traversal is always in the <code>H5E_WALK_DOWNWARD</code> direction. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5E_auto_t</em> <code>func</code> - <dd>IN: Function to be called upon an error condition. - <dt><em>void *</em><code>client_data</code> - <dd>IN: Data passed to the error function. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5E_auto_t</em> <code>func</code></td> + <td valign="top">IN: Function to be called upon an error condition.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>client_data </code></td> + <td valign="top">IN: Data passed to the error function.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -576,14 +588,17 @@ END SUBROUTINE h5eset_auto_f <code>H5Ewalk</code> can fail if there are problems initializing the library. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5E_direction_t</em> <code>direction</code> - <dd>IN: Direction in which the error stack is to be walked. - <dt><em>H5E_walk_t</em> <code>func</code> - <dd>IN: Function to be called for each error encountered. - <dt><em>void *</em> <code>client_data</code> - <dd>IN: Data to be passed with <code>func</code>. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5E_direction_t</em> <code>direction </code></td> + <td valign="top">IN: Direction in which the error stack is to be walked.</td></tr> + <tr> + <td valign="top"><em>H5E_walk_t</em> <code>func</code></td> + <td valign="top">IN: Function to be called for each error encountered.</td></tr> + <tr> + <td valign="top"><em>void *</em> <code>client_data</code></td> + <td valign="top">IN: Data to be passed with <code>func</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -639,15 +654,18 @@ SUBROUTINE <code>client_data</code> argument of <code>H5Ewalk</code>. It is expected to be a file pointer (or stderr if NULL). <dt><strong>Parameters:</strong> - <dl> - <dt><em>int</em> <code>n</code> - <dd>IN/OUT: Number of times this function has been called - for this traversal of the stack. - <dt><em>H5E_error_t *</em><code>err_desc</code> - <dd>OUT: Error description. - <dt><em>void</em> <code>*client_data</code> - <dd>IN: A file pointer, or stderr if NULL. - </dl> + <ul><table> + <tr> + <td valign="top"><em>int</em> <code>n</code></td> + <td valign="top">IN/OUT: Number of times this function has been called + for this traversal of the stack.</td></tr> + <tr> + <td valign="top"><em>H5E_error_t *</em><code>err_desc </code></td> + <td valign="top">OUT: Error description.</td></tr> + <tr> + <td valign="top"><em>void</em> <code>*client_data</code></td> + <td valign="top">IN: A file pointer, or stderr if NULL.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -701,14 +719,13 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> +<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 21 October 2003"); +document.writeln("Last modified: 24 February 2004"); --> </SCRIPT> diff --git a/doc/html/RM_H5F.html b/doc/html/RM_H5F.html index ef2d9d0..6d662a3 100644 --- a/doc/html/RM_H5F.html +++ b/doc/html/RM_H5F.html @@ -61,8 +61,7 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><center> +<hr><!-- #EndLibraryItem --><center> <h1>H5F: File Interface</h1> </center> @@ -234,10 +233,11 @@ facilitate moving easily between them.</i> in a file before calling <code>H5Fclose</code>. It is generally recommended to do so in all cases. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>file_id</code> - <dd>IN: Identifier of a file to terminate access to. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>file_id </code></td> + <td valign="top">IN: Identifier of a file to terminate access to.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -327,11 +327,13 @@ END SUBROUTINE h5fclose_f with an already opened file. <dt><strong>Parameters:</strong> - <dl> - <dt><em>const char *</em><code>name</code> - <dd>IN: Name of the file to access. - <dt><em>uintn</em> <code>flags</code> - <dd>IN: File access flags. Allowable values are: + <ul><table> + <tr> + <td valign="top"><em>const char *</em><code>name </code></td> + <td valign="top">IN: Name of the file to access.</td></tr> + <tr> + <td valign="top"><em>uintn</em> <code>flags</code></td> + <td valign="top">IN: File access flags. Allowable values are: <ul><dl> <dt><code>H5F_ACC_TRUNC</code> <dd>Truncate file, if it already exists, @@ -344,18 +346,20 @@ END SUBROUTINE h5fclose_f <li>An additional flag, <code>H5F_ACC_DEBUG</code>, prints debug information. This flag is used only by HDF5 library developers; <i>it is neither tested nor supported</i> - for use in applications. - <dt><em>hid_t</em> <code>create_id</code> - <dd>IN: File creation property list identifier, used when modifying + for use in applications.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>create_id </code></td> + <td valign="top">IN: File creation property list identifier, used when modifying default file meta-data. - Use <code>H5P_DEFAULT</code> for default file creation properties. - <dt><em>hid_t</em> <code>access_id</code> - <dd>IN: File access property list identifier. + Use <code>H5P_DEFAULT</code> for default file creation properties.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>access_id</code></td> + <td valign="top">IN: File access property list identifier. If parallel file access is desired, this is a collective call according to the communicator stored in the <code>access_id</code>. - Use <code>H5P_DEFAULT</code> for default file access properties. - </dl> + Use <code>H5P_DEFAULT</code> for default file access properties.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a file identifier if successful; otherwise returns a negative value. @@ -419,16 +423,14 @@ END SUBROUTINE h5fcreate_f <p> <code>scope</code> specifies whether the scope of the flushing action is global or local. Valid values are - <center> <table border=0> - <tr><td align=left valign=bottom><code>H5F_SCOPE_GLOBAL</code></td> + <tr><td align=left valign=top><code>H5F_SCOPE_GLOBAL</code></td> <td> </td> - <td align=left valign=bottom>Flushes the entire virtual file.</td></tr> - <tr><td align=left valign=bottom><code>H5F_SCOPE_LOCAL</code></td> + <td align=left valign=top>Flushes the entire virtual file.</td></tr> + <tr><td align=left valign=top><code>H5F_SCOPE_LOCAL</code></td> <td></td> - <td align=left valign=bottom>Flushes only the specified file.</td></tr> + <td align=left valign=top>Flushes only the specified file.</td></tr> </table> - </center> <dt><strong>Note:</strong> <dd>HDF5 does not possess full control over buffering. <code>H5Fflush</code> flushes the internal HDF5 buffers then @@ -436,12 +438,14 @@ END SUBROUTINE h5fcreate_f open files. After that, the OS is responsible for ensuring that the data is actually flushed to disk. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t </em><code>object_id</code> - <dd>IN: Identifier of object used to identify the file. - <dt><em>H5F_scope_t</em> <code>scope</code> - <dd>IN: Specifies the scope of the flushing action. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t </em><code>object_id</code></td> + <td valign="top">IN: Identifier of object used to identify the file.</td></tr> + <tr> + <td valign="top"><em>H5F_scope_t</em> <code>scope </code></td> + <td valign="top">IN: Specifies the scope of the flushing action.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -488,10 +492,11 @@ END SUBROUTINE h5fflush_f <cite>HDF5 User's Guide</cite> for additional information and related functions. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>file_id</code> - <dd>IN: Identifier of file to get access property list of - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>file_id </code></td> + <td valign="top">IN: Identifier of file to get access property list of</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a file access property list identifier if successful; otherwise returns a negative value. @@ -540,10 +545,11 @@ END SUBROUTINE h5fget_access_plist_f <cite>HDF5 User's Guide</cite> for additional information and related functions. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>file_id</code> - <dd>IN: Identifier of the file to get creation property list of - </dl> + <ul><table> + <dt> + <td valign="top"><em>hid_t</em> <code>file_id </code></td> + <td valign="top">IN: Identifier of the file to get creation property list of</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a file creation property list identifier if successful; otherwise returns a negative value. @@ -589,10 +595,11 @@ END SUBROUTINE h5fget_create_plist_f only report the free space that has been created during that interval. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>file_id</code> - <dd>IN: Identifier of a currently-open HDF5 file - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>file_id </code></td> + <td valign="top">IN: Identifier of a currently-open HDF5 file</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a the amount of free space in the file if successful; otherwise returns a negative value. @@ -681,13 +688,15 @@ END SUBROUTINE h5fget_freespace_f For example, the expression <code>(H5F_OBJ_DATASET|H5F_OBJ_GROUP)</code> would call for datasets and groups. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>file_id</code> - <dd>IN: Identifier of a currently-open HDF5 file or - <code>H5F_OBJ_ALL</code> for all currently-open HDF5 files. - <dt><em>unsigned int</em> <code>types</code> - <dd>IN: Type of object for which identifiers are to be returned. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>file_id</code></td> + <td valign="top">IN: Identifier of a currently-open HDF5 file or + <code>H5F_OBJ_ALL</code> for all currently-open HDF5 files.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>types </code></td> + <td valign="top">IN: Type of object for which identifiers are to be returned.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a the number of open objects if successful; otherwise returns a negative value. @@ -748,17 +757,22 @@ END SUBROUTINE h5fget_obj_count_f To retrieve identifiers for all open objects, pass a negative value for the <code>max_objs</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>file_id</code> - <dd>IN: Identifier of a currently-open HDF5 file or - <code>H5F_OBJ_ALL</code> for all currently-open HDF5 files. - <dt><em>unsigned int</em> <code>types</code> - <dd>IN: Type of object for which identifiers are to be returned. - <dt><em>int</em> <code>max_objs</code> - <dd>IN: Maximum number of object identifiers to place into <code>obj_id_list</code>. - <dt><em>hid_t *</em><code>obj_id_list</code> - <dd>OUT: Pointer to the returned list of open object identifiers. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>file_id</code></td> + <td valign="top">IN: Identifier of a currently-open HDF5 file or + <code>H5F_OBJ_ALL</code> for all currently-open HDF5 files.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>types</code></td> + <td valign="top">IN: Type of object for which identifiers are to be returned.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>max_objs</code></td> + <td valign="top">IN: Maximum number of object identifiers to place into + <code>obj_id_list</code>.</td></tr> + <tr> + <td valign="top"><em>hid_t *</em><code>obj_id_list </code></td> + <td valign="top">OUT: Pointer to the returned list of open object identifiers.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns number of objects placed into <code>obj_id_list</code> if successful; otherwise returns a negative value. @@ -818,22 +832,25 @@ END SUBROUTINE h5fget_obj_ids_f open; it will be invalid if the file is closed and reopened or opened during a subsequent session. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>file_id</code> - <dd>IN: Identifier of the file to be queried. - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>file_id</code></td> + <td valign="top">IN: Identifier of the file to be queried.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier. For most drivers, the value will be <code>H5P_DEFAULT</code>. - For the <code>FAMILY</code> or <code>MULTI</code> drivers, - this value should be defined through the property list - functions: - <code>H5Pset_family_offset</code> for the <code>FAMILY</code> - driver and <code>H5Pset_multi_type</code> for the - <code>MULTI</code> driver. - <dt><em>void *</em><code>file_handle</code> - <dd>OUT: Pointer to the file handle being used by - the low-level virtual file driver. - </dl> + For the <code>FAMILY</code> or <code>MULTI</code> drivers, + this value should be defined through the property list + functions: + <code>H5Pset_family_offset</code> for the <code>FAMILY</code> + driver and <code>H5Pset_multi_type</code> for the + <code>MULTI</code> driver.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>file_handle </code></td> + <td valign="top">OUT: Pointer to the file handle being used by + the low-level virtual file driver.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -868,10 +885,11 @@ SUBROUTINE <dd><code>H5Fis_hdf5</code> determines whether a file is in the HDF5 format. <dt><strong>Parameters:</strong> - <dl> - <dt><em>const char *</em><code>name</code> - <dd>IN: File name to check format. - </dl> + <ul><table> + <tr> + <td valign="top"><em>const char *</em><code>name </code></td> + <td valign="top">IN: File name to check format.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>When successful, returns a positive value, for <code>TRUE</code>, or <code>0</code> (zero), for <code>FALSE</code>. @@ -920,19 +938,23 @@ END SUBROUTINE h5fis_hdf5_f Note that <code>loc_id</code> is either a file or group identifier and <code>name</code> is relative to <code>loc_id</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier for of file or group in - which <code>name</code> is defined. - <dt><em>const char *</em><code>name</code> - <dd>IN: Name of the group onto which the + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Identifier for of file or group in + which <code>name</code> is defined.</td> + <tr> + <td valign="top"><em>const char *</em><code>name </code></td> + <td valign="top">IN: Name of the group onto which the file specified by <code>child_id</code> - is to be mounted. - <dt><em>hid_t</em> <code>child_id</code> - <dd>IN: Identifier of the file to be mounted. - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Identifier of the property list to be used. - </dl> + is to be mounted.</td> + <tr> + <td valign="top"><em>hid_t</em> <code>child_id</code></td> + <td valign="top">IN: Identifier of the file to be mounted.</td> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Identifier of the property list to be used.</td> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1020,11 +1042,13 @@ END SUBROUTINE h5fmount_f multiple opens of the same file. <dt><strong>Parameters:</strong> - <dl> - <dt><em>const char *</em><code>name</code> - <dd>IN: Name of the file to access. - <dt><em>unsigned</em> <code>flags</code> - <dd>IN: File access flags. Allowable values are: + <ul><table> + <tr> + <td valign="top"><em>const char *</em><code>name </code></td> + <td valign="top">IN: Name of the file to access.</td></tr> + <tr> + <td valign="top"><em>unsigned</em> <code>flags</code></td> + <td valign="top">IN: File access flags. Allowable values are: <ul><dl> <dt><code>H5F_ACC_RDWR</code> <dd>Allow read and write access to file. @@ -1037,14 +1061,16 @@ END SUBROUTINE h5fmount_f debug information. This flag is used only by HDF5 library developers; it is neither tested nor supported for use in applications. - </ul> - <dt><em>hid_t</em> <code>access_id</code> - <dd>IN: Identifier for the file access properties list. + </ul></td></tr> +<!-- NEW PAGE --> + <tr> + <td valign="top"><em>hid_t</em> <code>access_id </code></td> + <td valign="top">IN: Identifier for the file access properties list. If parallel file access is desired, this is a collective call according to the communicator stored in the <code>access_id</code>. - Use <code>H5P_DEFAULT</code> for default file access properties. - </dl> + Use <code>H5P_DEFAULT</code> for default file access properties.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a file identifier if successful; otherwise returns a negative value. @@ -1104,11 +1130,12 @@ END SUBROUTINE h5fopen_f The new file identifier should be closed by calling <code>H5Fclose</code> when it is no longer needed. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>file_id</code> - <dd>IN: Identifier of a file for which an additional identifier - is required. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>file_id </code></td> + <td valign="top">IN: Identifier of a file for which an additional identifier + is required.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a new file identifier if successful; otherwise returns a negative value. @@ -1159,13 +1186,15 @@ END SUBROUTINE h5freopen_f Note that <code>loc_id</code> is either a file or group identifier and <code>name</code> is relative to <code>loc_id</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: File or group identifier for the location at which - the specified file is to be unmounted. - <dt><em>const char *</em><code>name</code> - <dd>IN: Name of the mount point. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: File or group identifier for the location at which + the specified file is to be unmounted.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>name </code></td> + <td valign="top">IN: Name of the mount point.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1225,14 +1254,13 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> +<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 21 October 2003"); +document.writeln("Last modified: 24 February 2004"); --> </SCRIPT> diff --git a/doc/html/RM_H5Front.html b/doc/html/RM_H5Front.html index 8bdca20..fa588df 100644 --- a/doc/html/RM_H5Front.html +++ b/doc/html/RM_H5Front.html @@ -66,8 +66,7 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><center> +<hr><!-- #EndLibraryItem --><center> <h1>HDF5: API Specification<br>Reference Manual</h1> @@ -75,7 +74,15 @@ And in this document, the The HDF5 library provides several interfaces, each of which provides the tools required to meet specific aspects of the HDF5 data-handling requirements. <p> -See <a href="#F90andCPPlus">below</a> for the FORTRAN90 and C++ APIs. +<SCRIPT language="JavaScript"> +<!-- +document.writeln("See <a href="#F90andCPPlus">below</a> for the FORTRAN90 and C++ APIs.") +--> +</SCRIPT> + +<!-- FOR USE WITH PRINT VERSION ONLY -----------------------------------> +Notes regarding FORTRAN90 and C++ APIs appear on the next page. +<!-- FOR USE WITH PRINT VERSION ONLY -----------------------------------> <p> <center> @@ -138,6 +145,8 @@ from <a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/PSandPDF/"> http://hdf.ncsa.uiuc.edu/HDF5/doc/PSandPDF/</a> approximately one week after each release. +<!-- NEW PAGE --> +<!-- NEW PAGE --> <a name="F90andCPPlus"> <hr> @@ -169,7 +178,8 @@ which are described in the following documents. H5R, H5S, H5T, and H5Z interfaces and are described on those pages. In general, each Fortran subroutine performs exactly the same task as the corresponding C function. - <p> + + <p> Whereas Fortran subroutines had been described on separate pages in prior releases, those descriptions were fully integrated into the body of the reference manual for HDF5 Release 1.6.2 @@ -232,8 +242,7 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><table width=100% border=0> +<hr><!-- #EndLibraryItem --><table width=100% border=0> <tr><td align=left valign=top> <!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> @@ -242,7 +251,7 @@ And in this document, the Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 18 February 2004"); +document.writeln("Last modified: 24 February 2004"); --> </SCRIPT> @@ -250,7 +259,7 @@ document.writeln("Last modified: 18 February 2004"); </td><td align=right valign=top> <SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("<a href=../Copyright.html>Copyright</a> "); +document.writeln("<a href=Copyright.html>Copyright</a> "); --> </SCRIPT> </td></tr> diff --git a/doc/html/RM_H5G.html b/doc/html/RM_H5G.html index 6823f00..6f2e191 100644 --- a/doc/html/RM_H5G.html +++ b/doc/html/RM_H5G.html @@ -61,8 +61,7 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><center> +<hr><!-- #EndLibraryItem --><center> <h1>H5G: Group Interface</h1> </center> @@ -221,10 +220,11 @@ create or access function. <p> Failure to release a group with this call will result in resource leaks. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>group_id</code> - <dd>IN: Group identifier to release. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>group_id </code></td> + <td valign="top">IN: Group identifier to release.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -279,20 +279,23 @@ END SUBROUTINE h5gclose_f This group identifier should be closed by calling <code>H5Gclose</code> when it is no longer needed. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: File or group identifier. - <dt><em>const char *</em><code>name</code> - <dd>IN: Absolute or relative name of the new group. - <dt><em>size_t</em> <code>size_hint</code> - <dd>IN: Optional parameter indicating the number of bytes - to reserve for the names that will appear in the group. - A conservative estimate could result in multiple - system-level I/O requests to read the group name heap; - a liberal estimate could result in a single large - I/O request even when the group has just a few names. - HDF5 stores each name with a null terminator. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: File or group identifier.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>name</code></td> + <td valign="top">IN: Absolute or relative name of the new group.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>size_hint </code></td> + <td valign="top">IN: Optional parameter indicating the number of bytes + to reserve for the names that will appear in the group. + A conservative estimate could result in multiple + system-level I/O requests to read the group name heap; + a liberal estimate could result in a single large + I/O request even when the group has just a few names. + HDF5 stores each name with a null terminator.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid group identifier for the open group if successful; otherwise returns a negative value. @@ -348,17 +351,21 @@ END SUBROUTINE h5gcreate_f If an object does not have a comment, the empty string is returned. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of the file or group. - <dt><em>const char *</em><code>name</code> - <dd>IN: Name of the object whose comment is to be set or reset. - <dt><em>size_t</em> <code>bufsize</code> - <dd>IN: Anticipated size of the buffer required to hold - <code>comment</code>. - <dt><em>char *</em><code>comment</code> - <dd>OUT: The comment. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Identifier of the file or group.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>name </code></td> + <td valign="top">IN: Name of the object whose comment is to be set or reset.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>bufsize</code></td> + <td valign="top">IN: Anticipated size of the buffer required to hold + <code>comment</code>.</td></tr> + <tr> + <td valign="top"><em>char *</em><code>comment</code></td> + <td valign="top">OUT: The comment.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of characters in the comment, counting the null terminator, if successful; the value @@ -418,17 +425,21 @@ END SUBROUTINE h5gget_comment_f This function should be used only after <code>H5Gget_objinfo</code> has been called to verify that <code>name</code> is a symbolic link. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of the file or group. - <dt><em>const char *</em><code>name</code> - <dd>IN: Symbolic link to the object whose name is to be returned. - <dt><em>size_t</em> <code>size</code> - <dd>IN: Maximum number of characters of <code>value</code> - to be returned. - <dt><em>char *</em><code>value</code> - <dd>OUT: A buffer to hold the name of the object being sought. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Identifier of the file or group.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>name </code></td> + <td valign="top">IN: Symbolic link to the object whose name is to be returned.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>size</code></td> + <td valign="top">IN: Maximum number of characters of <code>value</code> + to be returned.</td></tr> + <tr> + <td valign="top"><em>char *</em><code>value</code></td> + <td valign="top">OUT: A buffer to hold the name of the object being sought.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value, with the link value in <code>value</code>, if successful. @@ -472,12 +483,14 @@ END SUBROUTINE h5gget_linkval_f If a file identifier is passed in, then the number of objects in the root group is returned. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of the group or the file - <dt><em>hsize_t*</em> <code>num_obj</code> - <dd>OUT: Number of objects in the group. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Identifier of the group or the file</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>num_obj </code></td> + <td valign="top">OUT: Number of objects in the group.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns positive value if successful; otherwise returns a negative value. @@ -575,17 +588,22 @@ SUBROUTINE <dd>Some systems will be able to record the time accurately but unable to retrieve the correct time; such systems (e.g., Irix64) will report an <code>mtime</code> value of 0 (zero). +<!-- NEW PAGE --> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: File or group identifier. - <dt><em>const char</em> <code>*name</code> - <dd>IN: Name of the object for which status is being sought. - <dt><em>hbool_t</em> <code>follow_link</code> - <dd>IN: Link flag. - <dt><em>H5G_stat_t</em> <code>*statbuf</code> - <dd>OUT: Buffer in which to return information about the object. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: File or group identifier.</td></tr> + <tr> + <td valign="top"><em>const char</em> <code>*name</code></td> + <td valign="top">IN: Name of the object for which status is being sought.</td></tr> + <tr> + <td valign="top"><em>hbool_t</em> <code>follow_link</code></td> + <td valign="top">IN: Link flag.</td></tr> + <tr> + <td valign="top"><em>H5G_stat_t</em> <code>*statbuf </code></td> + <td valign="top">OUT: Buffer in which to return information about the object.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd> Returns a non-negative value if successful, with the fields of <code>statbuf</code> (if non-null) initialized. @@ -647,16 +665,20 @@ SUBROUTINE A second call to <code>H5Gget_objname_by_idx</code> can then be used to retrieve the actual name. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Group or file identifier. - <dt><em>hsize_t</em> <code>idx</code> - <dd>IN: Transient index identifying object. - <dt><em>char *</em><code>name</code> - <dd>IN/OUT: Pointer to user-provided buffer the object name. - <dt><em>size_t</em> <code>size</code> - <dd>IN: Name length. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id </code></td> + <td valign="top">IN: Group or file identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>idx</code></td> + <td valign="top">IN: Transient index identifying object.</td></tr> + <tr> + <td valign="top"><em>char *</em><code>name</code></td> + <td valign="top">IN/OUT: Pointer to user-provided buffer the object name.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>size</code></td> + <td valign="top">IN: Name length.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the size of the object name if successful, or <code>0</code> if no name is associated with the group identifier. @@ -750,12 +772,14 @@ SUBROUTINE </table> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Group or file identifier. - <dt><em>hsize_t</em> <code>idx</code> - <dd>IN: Transient index identifying object. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id </code></td> + <td valign="top">IN: Group or file identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>idx</code></td> + <td valign="top">IN: Transient index identifying object.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the type of the object if successful. Otherwise returns a negative value. @@ -806,12 +830,15 @@ SUBROUTINE non-zero. <p> The prototype for <code>H5G_iterate_t</code> is: - <ul><dl> - <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 + <table> + <tr> + <td valign="top"> </td> + <td valign="top"><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>);</td></tr> + </table> + + <p>The operation receives the group identifier for the group being iterated over, <code>group_id</code>, the name of the current object within the group, <code>member_name</code>, and the pointer to the operator data passed in to <code>H5Giterate</code>, @@ -834,23 +861,29 @@ SUBROUTINE 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> - <dd>IN: File or group identifier. - <dt><em>const char</em> <code>*name</code> - <dd>IN: Group over which the iteration is performed. - <dt><em>int</em> <code>*idx</code> - <dd>IN/OUT: Location at which to begin the iteration. - <dt><em>H5G_iterate_t</em> <code>operator</code> - <dd>IN: Operation to be performed on an object at each step of - the iteration. - <dt><em>void</em> <code>*operator_data</code> - <dd>IN/OUT: Data associated with the operation. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: File or group identifier.</td></tr> + <tr> + <td valign="top"><em>const char</em> <code>*name</code></td> + <td valign="top">IN: Group over which the iteration is performed.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>*idx</code></td> + <td valign="top">IN/OUT: Location at which to begin the iteration.</td></tr> + <tr> + <td valign="top"><em>H5G_iterate_t</em> <code>operator </code></td> + <td valign="top">IN: Operation to be performed on an object at each step of + the iteration.</td></tr> + <tr> + <td valign="top"><em>void</em> <code>*operator_data</code></td> + <td valign="top">IN/OUT: Data associated with the operation.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the return value of the last operator if it was non-zero, or zero if all group members were processed. Otherwise returns a negative value. +<!-- NEW PAGE --> <dt><strong>Fortran90 Interface:</strong> <dd>There is no direct FORTRAN couterpart for the C function <code>H5Giterate</code>. @@ -868,15 +901,8 @@ SUBROUTINE Returns the number of group members. </tr> <tr valign=top align=left> - <td> - <code>h5gget_obj_info_idx_f</code> - </td><td> </td><td> - <strong>Purpose:</strong> - Returns the number of group members. - </tr><tr valign=top align=left> <td> - <a href="fortran/h5g_FORTRAN.html#h5gget_obj_info_idx_f" - target="FortranWin"><code>h5gget_obj_info_idx_f</code></a> + <code>h5gget_obj_info_idx_f</code> </td><td> </td><td> <strong>Purpose:</strong> Returns name and type of the group member identified by its index. @@ -897,7 +923,7 @@ END SUBROUTINE h5gn_members_f </pre> <pre> -SUBROUTINE h5gget_obj_info_idx_f(loc_id, name, idx, & +SUBROUTINE h5gget_obj_info_idx_f(loc_id, name, idx, & obj_name, obj_type, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier @@ -948,19 +974,23 @@ END SUBROUTINE h5gget_obj_info_idx_f is made for <code>./x/y/bar</code>, then the actual object looked up is <code>./x/y/./foo</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: File or group identifier. - <dt><em>H5G_link_t</em> <code>link_type</code> - <dd>IN: Link type. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: File or group identifier.</td></tr> + <tr> + <td valign="top"><em>H5G_link_t</em> <code>link_type</code></td> + <td valign="top">IN: Link type. Possible values are <code>H5G_LINK_HARD</code> and - <code>H5G_LINK_SOFT</code>. - <dt><em>const char *</em> <code>current_name</code> - <dd>IN: Name of the existing object if link is a hard link. - Can be anything for the soft link. - <dt><em>const char *</em> <code>new_name</code> - <dd>IN: New name for the object. - </dl> + <code>H5G_LINK_SOFT</code>.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>current_name </code></td> + <td valign="top">IN: Name of the existing object if link is a hard link. + Can be anything for the soft link.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>new_name</code></td> + <td valign="top">IN: New name for the object.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1024,21 +1054,25 @@ END SUBROUTINE h5glink_f is made for <code>./x/y/bar</code>, then the actual object looked up is <code>./x/y/./foo</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>curr_loc_id</code> - <dd>IN: The file or group identifier for the original object. - <dt><em>const char *</em> <code>current_name</code> - <dd>IN: Name of the existing object if link is a hard link. - Can be anything for the soft link. - <dt><em>H5G_link_t</em> <code>link_type</code> - <dd>IN: Link type. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>curr_loc_id</code></td> + <td valign="top">IN: The file or group identifier for the original object.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>current_name </code></td> + <td valign="top">IN: Name of the existing object if link is a hard link. + Can be anything for the soft link.</td></tr> + <tr> + <td valign="top"><em>H5G_link_t</em> <code>link_type</code></td> + <td valign="top">IN: Link type. Possible values are <code>H5G_LINK_HARD</code> and - <code>H5G_LINK_SOFT</code>. - <dt><em>hid_t</em> <code>new_loc_id</code> - <dd>IN: The file or group identifier for the new link. - <dt><em>const char *</em> <code>new_name</code> - <dd>IN: New name for the object. - </dl> + <code>H5G_LINK_SOFT</code>.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>new_loc_id</code></td> + <td valign="top">IN: The file or group identifier for the new link.</td></tr> + <td valign="top"><em>const char *</em> <code>new_name</code></td> + <td valign="top">IN: New name for the object.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1094,14 +1128,17 @@ END SUBROUTINE h5glink2_f See <a href="Groups.html#H5GUnlinkToCorrupt">The Group Interface</a> in the <cite>HDF5 User's Guide</cite>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: File or group identifier. - <dt><em>const char</em> <code>*src_name</code> - <dd>IN: Object's original name. - <dt><em>const char</em> <code>*dst_name</code> - <dd>IN: Object's new name. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: File or group identifier.</td></tr> + <tr> + <td valign="top"><em>const char</em> <code>*src_name </code></td> + <td valign="top">IN: Object's original name.</td></tr> + <tr> + <td valign="top"><em>const char</em> <code>*dst_name</code></td> + <td valign="top">IN: Object's new name.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1150,16 +1187,20 @@ END SUBROUTINE h5gmove_f inaccessible with <code>H5Gmove</code>. See <a href="Groups.html#H5GUnlinkToCorrupt">The Group Interface</a> in the <cite>HDF5 User's Guide</cite>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>src_loc_id</code> - <dd>IN: Original file or group identifier. - <dt><em>const char</em> <code>*src_name</code> - <dd>IN: Object's original name. - <dt><em>hid_t</em> <code>dst_loc_id</code> - <dd>IN: Destination file or group identifier. - <dt><em>const char</em> <code>*dst_name</code> - <dd>IN: Object's new name. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>src_loc_id</code></td> + <td valign="top">IN: Original file or group identifier.</td></tr> + <tr> + <td valign="top"><em>const char</em> <code>*src_name </code></td> + <td valign="top">IN: Object's original name.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>dst_loc_id</code></td> + <td valign="top">IN: Destination file or group identifier.</td></tr> + <tr> + <td valign="top"><em>const char</em> <code>*dst_name</code></td> + <td valign="top">IN: Object's new name.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1209,12 +1250,14 @@ END SUBROUTINE h5gmove2_f that was opened. This group identifier should be released by calling <code>H5Gclose</code> when it is no longer needed. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: File or group identifier within which group is to be open. - <dt><em>const char *</em> <code>name</code> - <dd>IN: Name of group to open. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: File or group identifier within which group is to be open.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>name </code></td> + <td valign="top">IN: Name of group to open.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid group identifier if successful; otherwise returns a negative value. @@ -1266,14 +1309,17 @@ END SUBROUTINE h5gopen_f e.g., data sets, groups, named data types, and data spaces, but not symbolic links. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of the file or group. - <dt><em>const char *</em><code>name</code> - <dd>IN: Name of the object whose comment is to be set or reset. - <dt><em>const char *</em><code>comment</code> - <dd>IN: The new comment. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Identifier of the file or group.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>name</code></td> + <td valign="top">IN: Name of the object whose comment is to be set or reset.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>comment </code></td> + <td valign="top">IN: The new comment.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1337,12 +1383,14 @@ END SUBROUTINE h5gset_comment_f See <a href="Groups.html#H5GUnlinkToCorrupt">The Group Interface</a> in the <cite>HDF5 User's Guide</cite>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of the file or group containing the object. - <dt><em>const char *</em> <code>name</code> - <dd>IN: Name of the object to unlink. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Identifier of the file or group containing the object.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>name </code></td> + <td valign="top">IN: Name of the object to unlink.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1399,14 +1447,13 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> +<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 22 January 2004"); +document.writeln("Last modified: 24 February 2004"); --> </SCRIPT> diff --git a/doc/html/RM_H5I.html b/doc/html/RM_H5I.html index 478671f..b17c668 100644 --- a/doc/html/RM_H5I.html +++ b/doc/html/RM_H5I.html @@ -61,8 +61,7 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><center> +<hr><!-- #EndLibraryItem --><center> <h1>H5I: Identifier Interface</h1> </center> @@ -151,6 +150,7 @@ as the corresponding C function. </table> <!-- NEW PAGE --> +<!-- NEW PAGE --> <!-- HEADER RIGHT "H5Idec_ref" --> <hr> <dl> @@ -197,10 +197,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. @@ -225,7 +226,6 @@ END SUBROUTINE h5idec_ref_f </dl> <!-- NEW PAGE --> -<!-- NEW PAGE --> <!-- HEADER RIGHT "H5Iget_name" --> <hr> <dl> @@ -262,16 +262,18 @@ END SUBROUTINE h5idec_ref_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. @@ -321,10 +323,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. @@ -388,10 +391,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>. @@ -469,10 +473,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. @@ -529,14 +534,13 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> +<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 11 December 2003"); +document.writeln("Last modified: 24 February 2004"); --> </SCRIPT> diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html index a12084e..0dbc15f 100644 --- a/doc/html/RM_H5P.html +++ b/doc/html/RM_H5P.html @@ -61,8 +61,7 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><center> +<hr><!-- #EndLibraryItem --><center> <h1>H5P: Property List Interface</h1> </center> <h2>Property List API Functions</h2> @@ -74,6 +73,7 @@ which require many different parameters to be easily manipulated. <p> <strong>The C Interfaces:</strong> +<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------- <table border=0> <tr><td valign=top> @@ -153,9 +153,13 @@ which require many different parameters to be easily manipulated. <li><a href="#Property-SetFaplStdio">H5Pset_fapl_stdio</a> <li><a href="#Property-SetFaplStream">H5Pset_fapl_stream</a> <li><a href="#Property-GetFaplStream">H5Pget_fapl_stream</a> +<!-- FOR USE WITH ELECTRONIC VERSION -----------------------------------> <!--<li><a href="#Property-SetDriver">H5Pset_driver</a> --> +<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------- <li><a href="#Property-GetDriver">H5Pget_driver</a> +<!-- FOR USE WITH ELECTRONIC VERSION -----------------------------------> <!--<li><a href="#Property-GetDriverInfo">H5Pget_driver_info</a> --> +<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------- <li><a href="#Property-SetMetaBlockSize">H5Pset_meta_block_size</a> <li><a href="#Property-GetMetaBlockSize">H5Pget_meta_block_size</a> <li><a href="#Property-SetSieveBufSize">H5Pset_sieve_buf_size</a> @@ -170,10 +174,12 @@ which require many different parameters to be easily manipulated. <li><a href="#Property-GetFaplGass">H5Pget_fapl_gass</a> <li><a href="#Property-SetFaplSrb">H5Pset_fapl_srb</a> <li><a href="#Property-GetFaplSrb">H5Pget_fapl_srb</a> +<!-- FOR USE WITH ELECTRONIC VERSION -----------------------------------> <!-- <li><a href="#Property-xxx">xxx</a> <li><a href="#Property-xxx">xxx</a> || --> +<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------- </ul> <br> @@ -199,11 +205,13 @@ which require many different parameters to be easily manipulated. <li><a href="#Property-SetChunk">H5Pset_chunk</a> <li><a href="#Property-GetChunk">H5Pget_chunk</a> <li><a href="#Property-SetDeflate">H5Pset_deflate</a> +<!-- FOR USE WITH ELECTRONIC VERSION -----------------------------------> <!-- <li><a href="#Property-GetDeflate">H5Pget_deflate</a> <li><a href="#Property-SetCompression">H5Pset_compression</a> <li><a href="#Property-GetCompression">H5Pget_compression</a> --> +<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------- <li><a href="#Property-SetFillValue">H5Pset_fill_value</a> <li><a href="#Property-GetFillValue">H5Pget_fill_value</a> <li><a href="#Property-FillValueDefined">H5Pfill_value_defined</a> @@ -253,15 +261,218 @@ which require many different parameters to be easily manipulated. </ul> </td></tr> - +<!-- FOR USE WITH ELECTRONIC VERSION -----------------------------------> <!-- <tr><td colspan=5 align=right> <br> || <i>Available only in the parallel HDF5 library.</i> </td></tr> --> +<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------- +</table> +-- FOR USE WITH ELECTRONIC VERSION -----------------------------------> + +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> +<table border="0" width="95%"> +<tr> +<td valign="top" width="31%"> + + <i>General Functions</i> + <ul> + <li><a href="#Property-Create">H5Pcreate</a> + <li><a href="#Property-GetClass">H5Pget_class</a> + <li><a href="#Property-Copy">H5Pcopy</a> + <li><a href="#Property-Close">H5Pclose</a> + </ul> + + <i>Generic Properties</i> + <ul> + <li><a href="#Property-CreateClass">H5Pcreate_class</a> + <li><a href="#Property-CreateList">H5Pcreate_list</a> + <li><a href="#Property-Register">H5Pregister</a> + <li><a href="#Property-Insert">H5Pinsert</a> + <li><a href="#Property-Set">H5Pset</a> + <li><a href="#Property-Exist">H5Pexist</a> + <li><a href="#Property-GetSize">H5Pget_size</a> + <li><a href="#Property-GetNProps">H5Pget_nprops</a> + <li><a href="#Property-GetClassName">H5Pget_class_name</a> + <li><a href="#Property-GetClassParent">H5Pget_class_parent</a> + <li><a href="#Property-IsAClass">H5Pisa_class</a> + <li><a href="#Property-Get">H5Pget</a> + <li><a href="#Property-Equal">H5Pequal</a> + <li><a href="#Property-Iterate">H5Piterate</a> + <li><a href="#Property-CopyProp">H5Pcopy_prop</a> + <li><a href="#Property-Remove">H5Premove</a> + <li><a href="#Property-Unregister">H5Punregister</a> + <li><a href="#Property-CloseList">H5Pclose_list</a> + <li><a href="#Property-CloseClass">H5Pclose_class</a> + </ul> +</td> +<td valign="top" width="3%"> </td> +<td valign="top" width="32%"> + <i>File Access Properties</i> + <ul> + <li><a href="#Property-SetFaplCore">H5Pset_fapl_core</a> + <li><a href="#Property-GetFaplCore">H5Pget_fapl_core</a> + <li><a href="#Property-SetFaplFamily">H5Pset_fapl_family</a> + <li><a href="#Property-GetFaplFamily">H5Pget_fapl_family</a> + <li><a href="#Property-SetFamilyOffset">H5Pset_family_offset</a> + <li><a href="#Property-GetFamilyOffset">H5Pget_family_offset</a> + <li><a href="#Property-SetFaplLog">H5Pset_fapl_log</a> + <li><a href="#Property-SetFaplMpio">H5Pset_fapl_mpio</a> || + <li><a href="#Property-GetFaplMpio">H5Pget_fapl_mpio</a> || + <li><a href="#Property-SetFaplMpiPosix">H5Pset_fapl_mpiposix</a> || + <li><a href="#Property-GetFaplMpiPosix">H5Pget_fapl_mpiposix</a> || + <li><a href="#Property-SetFaplMulti">H5Pset_fapl_multi</a> + <li><a href="#Property-GetFaplMulti">H5Pget_fapl_multi</a> + <li><a href="#Property-SetMultiType">H5Pset_multi_type</a> + <li><a href="#Property-GetMultiType">H5Pget_multi_type</a> + <li><a href="#Property-SetFaplSplit">H5Pset_fapl_split</a> + <li><a href="#Property-SetFaplSec2">H5Pset_fapl_sec2</a> + <li><a href="#Property-SetFaplStdio">H5Pset_fapl_stdio</a> + <li><a href="#Property-SetFaplStream">H5Pset_fapl_stream</a> + <li><a href="#Property-GetFaplStream">H5Pget_fapl_stream</a> +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> +<!--<li><a href="#Property-SetDriver">H5Pset_driver</a> --> +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> + <li><a href="#Property-GetDriver">H5Pget_driver</a> +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> +<!--<li><a href="#Property-GetDriverInfo">H5Pget_driver_info</a> --> +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> + <li><a href="#Property-SetMetaBlockSize">H5Pset_meta_block_size</a> + <li><a href="#Property-GetMetaBlockSize">H5Pget_meta_block_size</a> + <li><a href="#Property-SetSieveBufSize">H5Pset_sieve_buf_size</a> + <li><a href="#Property-GetSieveBufSize">H5Pget_sieve_buf_size</a> + <li><a href="#Property-SetAlignment">H5Pset_alignment</a> + <li><a href="#Property-GetAlignment">H5Pget_alignment</a> + <li><a href="#Property-SetCache">H5Pset_cache</a> + <li><a href="#Property-GetCache">H5Pget_cache</a> + <li><a href="#Property-SetGCReferences">H5Pset_gc_references</a> + <li><a href="#Property-GetGCReferences">H5Pget_gc_references</a> + <li><a href="#Property-SetFaplGass">H5Pset_fapl_gass</a> + <li><a href="#Property-GetFaplGass">H5Pget_fapl_gass</a> + <li><a href="#Property-SetFaplSrb">H5Pset_fapl_srb</a> + <li><a href="#Property-GetFaplSrb">H5Pget_fapl_srb</a> +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> + <!-- + <li><a href="#Property-xxx">xxx</a> + <li><a href="#Property-xxx">xxx</a> || + --> +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> + </ul> +</td> +<td valign="top" width="3%"> </td> +<td valign="top" width="31%"> + <i>File Creation Properties</i> + <ul> + <li><a href="#Property-GetVersion">H5Pget_version</a> + <li><a href="#Property-SetUserblock">H5Pset_userblock</a> + <li><a href="#Property-GetUserblock">H5Pget_userblock</a> + <li><a href="#Property-SetSizes">H5Pset_sizes</a> + <li><a href="#Property-GetSizes">H5Pget_sizes</a> + <li><a href="#Property-SetSymK">H5Pset_sym_k</a> + <li><a href="#Property-GetSymK">H5Pget_sym_k</a> + <li><a href="#Property-SetIstoreK">H5Pset_istore_k</a> + <li><a href="#Property-GetIstoreK">H5Pget_istore_k</a> + </ul> + <i>File Close Properties</i> + <ul> + <li><a href="#Property-SetFcloseDegree">H5Pset_fclose_degree</a> + <li><a href="#Property-GetFcloseDegree">H5Pget_fclose_degree</a> + </ul> + <br><br> + || <i>Indicates functions<br> + available only in the<br> + parallel HDF5 library.</i> + <br><br><br><br><br><br><br><br><br><br><br><br> + <i>(Function listing<br> + continues on next page.)</i></pre> +</td> +</tr> +</table> +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> + +<!-- NEW PAGE --> + +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> +<table border="0" width="95%"> +<tr> +<td valign="top" width="31%"> + <i>Dataset Creation Properties</i> + <ul> + <li><a href="#Property-SetLayout">H5Pset_layout</a> + <li><a href="#Property-GetLayout">H5Pget_layout</a> + <li><a href="#Property-SetChunk">H5Pset_chunk</a> + <li><a href="#Property-GetChunk">H5Pget_chunk</a> + <li><a href="#Property-SetDeflate">H5Pset_deflate</a> +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> +<!-- + <li><a href="#Property-GetDeflate">H5Pget_deflate</a> + <li><a href="#Property-SetCompression">H5Pset_compression</a> + <li><a href="#Property-GetCompression">H5Pget_compression</a> +--> +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> + <li><a href="#Property-SetFillValue">H5Pset_fill_value</a> + <li><a href="#Property-GetFillValue">H5Pget_fill_value</a> + <li><a href="#Property-FillValueDefined">H5Pfill_value_defined</a> + <li><a href="#Property-SetFillTime">H5Pset_fill_time</a> + <li><a href="#Property-GetFillTime">H5Pget_fill_time</a> + <li><a href="#Property-SetAllocTime">H5Pset_alloc_time</a> + <li><a href="#Property-GetAllocTime">H5Pget_alloc_time</a> + <li><a href="#Property-SetFilter">H5Pset_filter</a> + <li><a href="#Property-AllFiltersAvail">H5Pall_filters_avail</a> + <li><a href="#Property-GetNFilters">H5Pget_nfilters</a> + <li><a href="#Property-GetFilter">H5Pget_filter</a> + <li><a href="#Property-GetFilterById">H5Pget_filter_by_id</a> + <li><a href="#Property-ModifyFilter">H5Pmodify_filter</a> + <li><a href="#Property-SetFletcher32">H5Pset_fletcher32</a> + <li><a href="#Property-SetShuffle">H5Pset_shuffle</a> + <li><a href="#Property-SetSzip">H5Pset_szip</a> + <li><a href="#Property-SetExternal">H5Pset_external</a> + <li><a href="#Property-GetExternalCount">H5Pget_external_count</a> + <li><a href="#Property-GetExternal">H5Pget_external</a> + </ul> +</td> +<td valign="top" width="3%"> </td> +<td valign="top" width="32%"> + <i>Dataset Access, Memory, and <br> Transfer Properties</i> + <ul> + <li><a href="#Property-SetBuffer">H5Pset_buffer</a> + <li><a href="#Property-GetBuffer">H5Pget_buffer</a> + <li><a href="#Property-SetPreserve">H5Pset_preserve</a> + <li><a href="#Property-GetPreserve">H5Pget_preserve</a> + <li><a href="#Property-SetEdcCheck">H5Pset_edc_check</a> + <li><a href="#Property-GetEdcCheck">H5Pget_edc_check</a> + <li><a href="#Property-SetFilterCallback">H5Pset_filter_callback</a> + <li><a href="#Property-SetHyperVectorSize">H5Pset_hyper_vector_size</a> + <li><a href="#Property-GetHyperVectorSize">H5Pget_hyper_vector_size</a> + <li><a href="#Property-SetBTreeRatios">H5Pset_btree_ratios</a> + <li><a href="#Property-GetBTreeRatios">H5Pget_btree_ratios</a> + <li><a href="#Property-SetVLMemManager">H5Pset_vlen_mem_manager</a> + <li><a href="#Property-GetVLMemManager">H5Pget_vlen_mem_manager</a> + <li><a href="#Property-SetDxplMpio">H5Pset_dxpl_mpio</a> || + <li><a href="#Property-GetDxplMpio">H5Pget_dxpl_mpio</a> || + <li><a href="#Property-SetDxplMulti">H5Pset_dxpl_multi</a> + <li><a href="#Property-GetDxplMulti">H5Pget_dxpl_multi</a> + <li><a href="#Property-SetMultiType">H5Pset_multi_type</a> + <li><a href="#Property-GetMultiType">H5Pget_multi_type</a> + <br> + <li><a href="#Property-SetSmallData">H5Pset_small_data_block_size</a> + <li><a href="#Property-GetSmallData">H5Pget_small_data_block_size</a> + </ul> +</td> +<td valign="top" width="3%"> </td> +<td valign="top" width="31%"> +<br> + || <i>Indicates functions<br> + available only in the<br> + parallel HDF5 library.</i> +</td> +</tr> </table> +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> + <br> * Functions labelled with an asterisk (*) are provided only for @@ -269,6 +480,7 @@ backwards compatibility with HDF5 Releases 1.4.<i>x</i>. See further notes in the description of each function. <p> +<!-- NEW PAGE --> <i>Alphabetical Listing</i> <table border="0"> <tr> @@ -411,6 +623,7 @@ See further notes in the description of each function. </table> <br> +<!-- NEW PAGE --> <strong>The FORTRAN90 Interfaces:</strong> <br> @@ -606,10 +819,11 @@ as the corresponding C function. set in the dataset creation property list <code>dcpl_id</code> are currently available. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dcpl_id</code> - <dd>IN: Dataset creation property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dcpl_id </code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns <code>TRUE</code> if all filters are available and <code>FALSE</code> if one or more is not currently available.<br> @@ -646,10 +860,11 @@ SUBROUTINE finished accessing them. This frees resources used by the property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of the property list to terminate access to. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier of the property list to terminate access to.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -696,7 +911,7 @@ END SUBROUTINE h5pclose_f <dt><strong>Parameters:</strong> <ul><table> <tr> - <td><em>hid_t</em> <code>class</code></td> + <td><em>hid_t</em> <code>class </code></td> <td>IN: Property list class to close</td></tr> </table></ul> @@ -751,7 +966,7 @@ END SUBROUTINE h5pclose_class_f <dt><strong>Parameters:</strong> <ul><table> <tr> - <td><em>hid_t</em> <code>plist</code><td> + <td><em>hid_t</em> <code>plist </code><td> <td>IN: Property list to close</td></tr> </table></ul> @@ -794,10 +1009,11 @@ END SUBROUTINE h5pclose_list_f The new property list has the same properties and values as the original property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to duplicate. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier of property list to duplicate.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a property list identifier if successful; otherwise returns a negative value. @@ -873,7 +1089,7 @@ END SUBROUTINE h5pcopy_f <td><em>hid_t</em> <code>src_id</code></td> <td>IN: Identifier of the source property list or class</td></tr> <tr> - <td><em>const char *</em><code>name</code></td> + <td><em>const char *</em><code>name </code></td> <td>IN: Name of the property to copy</td></tr> </table></ul> @@ -949,10 +1165,11 @@ END SUBROUTINE h5pcopy_prop_f <code>H5Pclose</code>; otherwise, errors are likely to occur. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5P_class_t</em> <code>type</code> - <dd>IN: The type of property list to create. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5P_class_t</em> <code>type </code></td> + <td valign="top">IN: The type of property list to create.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a property list identifier (<code>plist</code>) if successful; otherwise Fail (-1). @@ -1095,7 +1312,7 @@ END SUBROUTINE h5pcreate_f <td><em>const char *</em><code>name</code></td> <td>IN: Name of property list class to register</td></tr> <tr> - <td><em>H5P_cls_create_func_t</em> <code>create</code></td> + <td><em>H5P_cls_create_func_t</em> <code>create </code></td> <td>IN: Callback routine called when a property list is created</td></tr> <tr> <td><em>H5P_cls_copy_func_t</em> <code>copy</code></td> @@ -1110,6 +1327,7 @@ END SUBROUTINE h5pcreate_f <dd>Success: a valid property list class identifier <dd>Failure: a negative value +<!-- NEW PAGE --> <dt><strong>Fortran90 Interface:</strong> h5pcreate_class_f <dd> <pre> @@ -1164,7 +1382,7 @@ END SUBROUTINE h5pcreate_class_f <dt><strong>Parameter:</strong> <ul><table> <tr> - <td><em>hid_t</em> <code>class</code>;</td> + <td><em>hid_t</em> <code>class; </code></td> <td>IN: Class of property list to create.</td></tr> </table></ul> @@ -1312,7 +1530,7 @@ END SUBROUTINE h5premove_filter_f <dt><strong>Parameters:</strong> <ul><table> <tr> - <td><em>hid_t</em> <code>id1</code></td> + <td><em>hid_t</em> <code>id1 </code></td> <td>IN: First property object to be compared</td></tr> <tr> <td><em>hid_t</em> <code>id2</code></td> @@ -1372,7 +1590,7 @@ END SUBROUTINE h5pequal_f <td><em>hid_t</em> <code>id</code></td> <td>IN: Identifier for the property to query</td></tr> <tr> - <td><em>const char *</em><code>name</code></td> + <td><em>const char *</em><code>name </code></td> <td>IN: Name of property to check for</td></tr> </table></ul> @@ -1442,12 +1660,14 @@ END SUBROUTINE h5pexist_f See <a href="RM_H5D.html#Dataset-Create">H5Dcreate</a> for further cross-references. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>H5D_fill_value_t *</em><code>status</code> - <dd>OUT: Status of fill value in property list. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5D_fill_value_t *</em><code>status </code></td> + <td valign="top">OUT: Status of fill value in property list.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1509,7 +1729,7 @@ SUBROUTINE <td><em>hid_t</em> <code>plid</ecodem></td> <td>IN: Identifier of the property list to query</td></tr> <tr> - <td><em>const char *</em><code>name</code></td> + <td><em>const char *</em><code>name </code></td> <td>IN: Name of property to query</td></tr> <tr> <td><em>void *</em><code>value</code></td> @@ -1566,14 +1786,17 @@ END SUBROUTINE h5pget_f The <code>threshold</code> and/or <code>alignment</code> pointers may be null pointers (NULL). <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of a file access property list. - <dt><em>hsize_t</em> <code>*threshold</code> - <dd>OUT: Pointer to location of return threshold value. - <dt><em>hsize_t</em> <code>*alignment</code> - <dd>OUT: Pointer to location of return alignment value. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of a file access property list.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>*threshold </code></td> + <td valign="top">OUT: Pointer to location of return threshold value.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>*alignment</code></td> + <td valign="top">OUT: Pointer to location of return alignment value.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1644,12 +1867,14 @@ END SUBROUTINE h5pget_alignment_f set with the functions <code>H5Pget_fill_value</code> and <code>H5Pget_fill_time</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>H5D_alloc_time_t *</em><code>alloc_time</code> - <dd>IN: When to allocate dataset storage space. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5D_alloc_time_t *</em><code>alloc_time </code></td> + <td valign="top">IN: When to allocate dataset storage space.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1701,16 +1926,20 @@ END SUBROUTINE h5pget_alloc_time_f arguments <code>left</code>, <code>middle</code>, and <code>right</code>, as set by the <a href="#Property-SetBTreeRatios">H5Pset_btree_ratios</a> function. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: The dataset transfer property list identifier. - <dt><em>double</em> <code>left</code> - <dd>OUT: The B-tree split ratio for left-most nodes. - <dt><em>double</em> <code>right</code> - <dd>OUT: The B-tree split ratio for right-most nodes and lone nodes. - <dt><em>double</em> <code>middle</code> - <dd>OUT: The B-tree split ratio for all other nodes. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: The dataset transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>left</code></td> + <td valign="top">OUT: The B-tree split ratio for left-most nodes.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>right</code></td> + <td valign="top">OUT: The B-tree split ratio for right-most nodes and lone nodes.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>middle </code></td> + <td valign="top">OUT: The B-tree split ratio for all other nodes.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1754,16 +1983,19 @@ END SUBROUTINE h5pget_btree_ratios_f <dd><code>H5Pget_buffer</code> reads values previously set with H5Pset_buffer. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for the dataset transfer property list. - <dt><em>void</em> <code>**tconv</code> - <dd>OUT: Address of the pointer to application-allocated - type conversion buffer. - <dt><em>void</em> <code>**bkg</code> - <dd>OUT: Address of the pointer to application-allocated - background buffer. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for the dataset transfer property list.</td></tr> + <tr> + <td valign="top"><em>void</em> <code>**tconv </code></td> + <td valign="top">OUT: Address of the pointer to application-allocated + type conversion buffer.</td></tr> + <tr> + <td valign="top"><em>void</em> <code>**bkg</code></td> + <td valign="top">OUT: Address of the pointer to application-allocated + background buffer.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns buffer size, in bytes, if successful; otherwise 0 on failure. @@ -1811,18 +2043,23 @@ END SUBROUTINE h5pget_buffer_f Any (or all) arguments may be null pointers, in which case the corresponding datum is not returned. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Identifier of the file access property list. - <dt><em>int</em> <code>*mdc_nelmts</code> - <dd>IN/OUT: Number of elements (objects) in the meta data cache. - <dt><em>int</em> <code>*rdcc_nelmts</code> - <dd>IN/OUT: Number of elements (objects) in the raw data chunk cache. - <dt><em>size_t</em> <code>*rdcc_nbytes</code> - <dd>IN/OUT: Total size of the raw data chunk cache, in bytes. - <dt><em>double</em> <code>*rdcc_w0</code> - <dd>IN/OUT: Preemption policy. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Identifier of the file access property list.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>*mdc_nelmts</code></td> + <td valign="top">IN/OUT: Number of elements (objects) in the meta data cache.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>*rdcc_nelmts</code></td> + <td valign="top">IN/OUT: Number of elements (objects) in the raw data chunk cache.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>*rdcc_nbytes </code></td> + <td valign="top">IN/OUT: Total size of the raw data chunk cache, in bytes.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>*rdcc_w0</code></td> + <td valign="top">IN/OUT: Preemption policy.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1873,14 +2110,17 @@ END SUBROUTINE h5pget_cache_f At most, <code>max_ndims</code> elements of <code>dims</code> will be initialized. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to query. - <dt><em>int</em> <code>max_ndims</code> - <dd>IN: Size of the <code>dims</code> array. - <dt><em>hsize_t *</em> <code>dims</code> - <dd>OUT: Array to store the chunk dimensions. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of property list to query.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>max_ndims </code></td> + <td valign="top">IN: Size of the <code>dims</code> array.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em> <code>dims</code></td> + <td valign="top">OUT: Array to store the chunk dimensions.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns chunk dimensionality successful; otherwise returns a negative value. @@ -1925,10 +2165,11 @@ END SUBROUTINE h5pget_chunk_f Valid property list classes are defined in the description of <code>H5Pcreate</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier of property list to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a property list class if successful. Otherwise returns H5P_NO_CLASS (-1). @@ -1982,7 +2223,7 @@ END SUBROUTINE h5pget_class_f <dt><strong>Parameters:</strong> <ul><table> <tr> - <td><em>hid_t</em> <code>pcid</code></td> + <td><em>hid_t</em> <code>pcid </code></td> <td>IN: Identifier of the property class to query</td></tr> </table></ul> @@ -2038,7 +2279,7 @@ END SUBROUTINE h5pget_class_name_f <dt><strong>Parameters:</strong> <ul><table> <tr> - <td><em>hid_t</em> <code>pcid</code></td> + <td><em>hid_t</em> <code>pcid </code></td> <td>IN: Identifier of the property class to query</td></tr> </table></ul> @@ -2103,10 +2344,11 @@ END SUBROUTINE h5pget_class_parent_f The returned driver identifier is only valid as long as the file driver remains registered. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: File access or data transfer property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id </code></td> + <td valign="top">IN: File access or data transfer property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid low-level driver identifier if successful. Otherwise returns a negative value. @@ -2198,12 +2440,14 @@ END SUBROUTINE h5pget_driver_f <p> <code>H5Pget_dxpl_mpio</code> is not a collective function. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dxpl_id</code> - <dd>IN: Data transfer property list identifier. - <dt><em>H5FD_mpio_xfer_t *</em><code>xfer_mode</code> - <dd>OUT: Data transfer mode. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dxpl_id</code></td> + <td valign="top">IN: Data transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5FD_mpio_xfer_t *</em><code>xfer_mode </code></td> + <td valign="top">OUT: Data transfer mode.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2248,12 +2492,14 @@ END SUBROUTINE h5pget_dxpl_mpio_f <dd><code>H5Pget_dxpl_multi</code> returns the data transfer property list information for the multi-file driver. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dxpl_id</code>, - <dd>IN: Data transfer property list identifier. - <dt><em>const hid_t *</em><code>memb_dxpl</code> - <dd>OUT: Array of data access property lists. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dxpl_id</code>,</td> + <td valign="top">IN: Data transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>const hid_t *</em><code>memb_dxpl </code></td> + <td valign="top">OUT: Array of data access property lists.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2287,10 +2533,11 @@ SUBROUTINE list <code>plist</code> to determine whether error detection is enabled for data read operations. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Dataset transfer property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Dataset transfer property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns <code>H5Z_ENABLE_EDC</code> or <code>H5Z_DISABLE_EDC</code> if successful; @@ -2348,21 +2595,27 @@ END SUBROUTINE h5pget_edc_check_f If <code>offset</code> or <code>size</code> are null pointers then the corresponding information is not returned. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of a dataset creation property list. - <dt><em>int</em> <code>idx</code> - <dd>IN: External file index. - <dt><em>size_t</em> <code>name_size</code> - <dd>IN: Maximum length of <code>name</code> array. - <dt><em>char</em> <code>*name</code> - <dd>OUT: Name of the external file. - <dt><em>off_t</em> <code>*offset</code> - <dd>OUT: Pointer to a location to return an offset value. - <dt><em>hsize_t</em> <code>*size</code> - <dd>OUT: Pointer to a location to return the size of the - external file data. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of a dataset creation property list.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>idx</code></td> + <td valign="top">IN: External file index.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>name_size </code></td> + <td valign="top">IN: Maximum length of <code>name</code> array.</td></tr> + <tr> + <td valign="top"><em>char</em> <code>*name</code></td> + <td valign="top">OUT: Name of the external file.</td></tr> + <tr> + <td valign="top"><em>off_t</em> <code>*offset</code></td> + <td valign="top">OUT: Pointer to a location to return an offset value.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>*size</code></td> + <td valign="top">OUT: Pointer to a location to return the size of the + external file data.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -2408,10 +2661,11 @@ END SUBROUTINE h5pget_external_f <dd><code>H5Pget_external_count</code> returns the number of external files for the specified dataset. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of a dataset creation property list. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier of a dataset creation property list.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of external files if successful; otherwise returns a negative value. @@ -2466,12 +2720,14 @@ END SUBROUTINE h5pget_external_count_f Use of this function is only appropriate for an HDF5 file written as a family of files with the <code>FAMILY</code> file driver. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>hsize_t *</em><code>offset</code> - <dd>IN: Offset in bytes within the HDF5 file. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>offset </code></td> + <td valign="top">IN: Offset in bytes within the HDF5 file.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -2508,15 +2764,18 @@ SUBROUTINE <dd><code>H5Pget_fapl_core</code> queries the <code>H5FD_CORE</code> driver properties as set by <code>H5Pset_fapl_core</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>size_t</em> *<code>increment</code> - <dd>OUT: Size, in bytes, of memory increments. - <dt><em>hbool_t</em> *<code>backing_store</code> - <dd>OUT: Boolean flag indicating whether to write the file - contents to disk when the file is closed. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>size_t</em> *<code>increment</code></td> + <td valign="top">OUT: Size, in bytes, of memory increments.</td></tr> + <tr> + <td valign="top"><em>hbool_t</em> *<code>backing_store </code></td> + <td valign="top">OUT: Boolean flag indicating whether to write the file + contents to disk when the file is closed.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2562,15 +2821,18 @@ END SUBROUTINE h5pget_fapl_core_f for use with the family driver. This information is returned through the output parameters. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em> hsize_t *</em><code>memb_size</code> - <dd>OUT: Size in bytes of each file member. - <dt><em>hid_t *</em><code>memb_fapl_id</code> - <dd>OUT: Identifier of file access property list for each - family member. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em> hsize_t *</em><code>memb_size</code></td> + <td valign="top">OUT: Size in bytes of each file member.</td></tr> + <tr> + <td valign="top"><em>hid_t *</em><code>memb_fapl_id </code></td> + <td valign="top">OUT: Identifier of file access property list for each + family member.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -2625,12 +2887,14 @@ END SUBROUTINE h5pget_fapl_family_f For further information, see <a href="http://www.globus.org/">http//www.globus.org/</a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code>, - <dd>IN: File access property list identifier. - <dt><em>GASS_Info *</em><code>info</code> - <dd>OUT: Pointer to the GASS information structure. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code>,</td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>GASS_Info *</em><code>info </code></td> + <td valign="top">OUT: Pointer to the GASS information structure.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2673,14 +2937,17 @@ SUBROUTINE so they are valid only until the file access property list is either modified or closed. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>MPI_Comm *</em><code>comm</code> - <dd>OUT: MPI-2 communicator. - <dt><em>MPI_Info *</em><code>info</code> - <dd>OUT: MPI-2 info object. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>MPI_Comm *</em><code>comm </code></td> + <td valign="top">OUT: MPI-2 communicator.</td></tr> + <tr> + <td valign="top"><em>MPI_Info *</em><code>info</code></td> + <td valign="top">OUT: MPI-2 info object.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2727,12 +2994,14 @@ END SUBROUTINE h5pget_fapl_mpio_f <code>comm</code> is not copied, so it is valid only until the file access property list is either modified or closed. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>MPI_Comm *</em><code>comm</code> - <dd>OUT: MPI-2 communicator. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>MPI_Comm *</em><code>comm </code></td> + <td valign="top">OUT: MPI-2 communicator.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2776,21 +3045,27 @@ END SUBROUTINE h5pget_fapl_mpiposix_f <dd><code>H5Pget_fapl_multi</code> returns information about the multi-file access property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>const H5FD_mem_t *</em><code>memb_map</code> - <dd>OUT: Maps memory usage types to other memory usage types. - <dt><em>const hid_t *</em><code>memb_fapl</code> - <dd>OUT: Property list for each memory usage type. - <dt><em>const char **</em><code>memb_name</code> - <dd>OUT: Name generator for names of member files. - <dt><em>const haddr_t *</em><code>memb_addr</code> - <dd>OUT: - <dt><em>hbool_t *</em><code>relax</code> - <dd>OUT: Allows read-only access to incomplete file sets - when <code>TRUE</code>. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>const H5FD_mem_t *</em><code>memb_map </code></td> + <td valign="top">OUT: Maps memory usage types to other memory usage types.</td></tr> + <tr> + <td valign="top"><em>const hid_t *</em><code>memb_fapl</code></td> + <td valign="top">OUT: Property list for each memory usage type.</td></tr> + <tr> + <td valign="top"><em>const char **</em><code>memb_name</code></td> + <td valign="top">OUT: Name generator for names of member files.</td></tr> + <tr> + <td valign="top"><em>const haddr_t *</em><code>memb_addr</code></td> + <td valign="top">OUT:</td></tr> + <tr> + <td valign="top"><em>hbool_t *</em><code>relax</code></td> + <td valign="top">OUT: Allows read-only access to incomplete file sets + when <code>TRUE</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2849,12 +3124,14 @@ END SUBROUTINE h5pget_fapl_multi_f Storage Resource Broker (SRB). For further information, see <a href="http://www.npaci.edu/Research/DI/srb/">http//www.npaci.edu/Research/DI/srb/</a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>SRB_Info *</em><code>info</code> - <dd>OUT: Pointer to the SRB information structure. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>SRB_Info *</em><code>info </code></td> + <td valign="top">OUT: Pointer to the SRB information structure.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2892,12 +3169,14 @@ SUBROUTINE <code>H5Pset_fapl_stream</code> and <code>H5Pget_fapl_stream</code> are not intended for use in a parallel environment. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>H5FD_stream_fapl_t *</em><code>fapl</code> - <dd>OUT: The streaming I/O file access property list. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5FD_stream_fapl_t *</em><code>fapl </code></td> + <td valign="top">OUT: The streaming I/O file access property list.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2935,13 +3214,15 @@ SUBROUTINE is called to close that file. <code>fc_degree</code> can have any one of four valid values as described above in <a href="#Property-SetFcloseDegree"><code>H5Pset_fclose_degree</code></a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>H5F_close_degree_t</em> <code>fc_degree</code> - <dd>OUT: Pointer to a location to which to return the file close degree - property, the value of <code>fc_degree</code>. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5F_close_degree_t</em> <code>fc_degree </code></td> + <td valign="top">OUT: Pointer to a location to which to return the file close degree + property, the value of <code>fc_degree</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -3010,12 +3291,14 @@ END SUBROUTINE h5pget_fclose_degree_f dataset storage allocation time properties, retrieved with the functions <code>H5Pget_fill_value</code> and <code>H5Pget_alloc_time</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>H5D_fill_time_t *</em><code>fill_time</code> - <dd>OUT: Setting for the timing of writing fill values to the dataset. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5D_fill_time_t *</em><code>fill_time </code></td> + <td valign="top">OUT: Setting for the timing of writing fill values to the dataset.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3085,15 +3368,17 @@ END SUBROUTINE h5pget_fill_time_f and <code>H5Pget_fill_time</code>, respectively. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>hid_t</em> <code>type_id</code>, - <dd>IN: Datatype identifier for the value passed - via <code>value</code>. - <dt><em>void *</em><code>value</code> - <dd>OUT: Pointer to buffer to contain the returned fill value. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id </code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code>,</td> + <td valign="top">IN: Datatype identifier for the value passed + via <code>value</code>.</td></tr> + <tr><td valign="top"><em>void *</em><code>value</code></td> + <td valign="top">OUT: Pointer to buffer to contain the returned fill value.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3171,24 +3456,32 @@ END SUBROUTINE h5pget_fill_value_f pipeline; <code>plist</code> must be a dataset creation property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Property list identifier. - <dt><em>int</em> <code>filter_number</code> - <dd>IN: Sequence number within the filter pipeline of - the filter for which information is sought. - <dt><em>unsigned int *</em><code>flags</code> - <dd>OUT: Bit vector specifying certain general properties - of the filter. - <dt><em>size_t *</em><code>cd_nelmts</code> - <dd>IN/OUT: Number of elements in <code>cd_values</code>. - <dt><em>unsigned int *</em><code>cd_values</code> - <dd>OUT: Auxiliary data for the filter. - <dt><em>size_t</em> <code>namelen</code> - <dd>IN: Anticipated number of characters in <code>name</code>. - <dt><em>char</em> <code>name[]</code> - <dd>OUT: Name of the filter. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Property list identifier.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>filter_number</code></td> + <td valign="top">IN: Sequence number within the filter pipeline of + the filter for which information is sought.</td></tr> + <tr> + <td valign="top"><em>unsigned int *</em><code>flags</code></td> + <td valign="top">OUT: Bit vector specifying certain general properties + of the filter.</td></tr> + <tr> + <td valign="top"><em>size_t *</em><code>cd_nelmts</code></td> + <td valign="top">IN/OUT: Number of elements in <code>cd_values</code>.</td></tr> + <tr> + <td valign="top"><em>unsigned int *</em><code>cd_values </code></td> + <td valign="top">OUT: Auxiliary data for the filter.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>namelen</code></td> + <td valign="top">IN: Anticipated number of characters in <code>name</code>.</td></tr> + <tr> + <td valign="top"><em>char</em> <code>name[]</code></td> + <td valign="top">OUT: Name of the filter.</td></tr> + </table></ul> +<!-- NEW PAGE --> <dt><strong>Returns:</strong> <dd>Returns the filter identifier if successful: <center> @@ -3219,7 +3512,8 @@ END SUBROUTINE h5pget_fill_value_f <dt><strong>Fortran90 Interface:</strong> h5pget_filter_f <dd> <pre> -SUBROUTINE h5pget_filter_f(prp_id, filter_number, flags, cd_nelmts, cd_values, namelen, name, filter_id, hdferr) +SUBROUTINE h5pget_filter_f(prp_id, filter_number, flags, cd_nelmts, cd_values, + namelen, name, filter_id, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier INTEGER, INTENT(IN) :: filter_number ! Sequence number within the filter @@ -3296,24 +3590,31 @@ END SUBROUTINE h5pget_filter_f set for the property list, an error will be returned and <code>H5Pget_filter_by_id</code> will fail. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Property list identifier. - <dt><em>H5Z_filter_t</em> <code>filter</code> - <dd>IN: Filter identifier. - <dt><em>unsigned int</em> <code>flags</code> - <dd>OUT: Bit vector specifying certain general properties - of the filter. - <dt><em>size_t</em> <code>cd_nelmts</code> - <dd>IN/OUT: Number of elements in <code>cd_values</code>. - <dt><em>const unsigned int</em> <code>cd_values[]</code> - <dd>OUT: Auxiliary data for the filter. - <dt><em>size_t</em> <code>namelen</code> - <dd>IN/OUT: Length of filter name and - number of elements in <code>name[]</code>. - <dt><em>char *</em><code>name[]</code> - <dd>OUT: Name of filter. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5Z_filter_t</em> <code>filter</code></td> + <td valign="top">IN: Filter identifier.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>flags</code></td> + <td valign="top">OUT: Bit vector specifying certain general properties + of the filter.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>cd_nelmts</code></td> + <td valign="top">IN/OUT: Number of elements in <code>cd_values</code>.</td></tr> + <tr> + <td valign="top"><em>const unsigned int</em> <code>cd_values[] </code></td> + <td valign="top">OUT: Auxiliary data for the filter.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>namelen</code></td> + <td valign="top">IN/OUT: Length of filter name and + number of elements in <code>name[]</code>.</td></tr> + <tr> + <td valign="top"><em>char *</em><code>name[]</code></td> + <td valign="top">OUT: Name of filter.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3324,7 +3625,9 @@ SUBROUTINE h5pget_filter_by_id_f(prp_id, filter_id, flags, cd_nelmts, & cd_values, namelen, name, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier - INTEGER, INTENT(IN) :: filter_id ! Filter identifier + INTEGER, INTENT(IN) :: filter_id ! Filter identifier</pre> +<!-- NEW PAGE --> +<pre> INTEGER(SIZE_T), INTENT(INOUT) :: cd_nelmts ! Number of elements in cd_values INTEGER, DIMENSION(*), INTENT(OUT) :: cd_values @@ -3365,15 +3668,17 @@ END SUBROUTINE h5pget_filter_by_id_f The garbage collection references property is set by <a href="#Property-SetGCReferences">H5Pset_gc_references</a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: File access property list identifier. - <dt><em>unsigned</em> <code>gc_ref</code> - <dd>OUT: Flag returning the state of reference garbage collection. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>unsigned</em> <code>gc_ref </code></td> + <td valign="top">OUT: Flag returning the state of reference garbage collection. A returned value of <code>1</code> indicates that garbage collection is on while - <code>0</code> indicates that garbage collection is off. - </dl> + <code>0</code> indicates that garbage collection is off.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3422,12 +3727,14 @@ END SUBROUTINE h5pget_gc_references_f was previously set with a call to <a href="#Property-SetHyperVectorSize">H5Pset_hyper_vector_size</a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dxpl_id</code> - <dd>IN: Dataset transfer property list identifier. - <dt><em>size_t *</em><code>vector_size</code> - <dd>OUT: Number of I/O vectors to accumulate in memory for I/O operations. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dxpl_id</code></td> + <td valign="top">IN: Dataset transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>size_t *</em><code>vector_size </code></td> + <td valign="top">OUT: Number of I/O vectors to accumulate in memory for I/O operations.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3471,12 +3778,14 @@ END SUBROUTINE h5pget_hyper_vector_size_f <p> See <a href="#Property-SetIstoreK">H5Pset_istore_k</a> for details. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to query. - <dt><em>int *</em> <code>ik</code> - <dd>OUT: Pointer to location to return the chunked storage B-tree 1/2 rank. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier of property list to query.</td></tr> + <tr> + <td valign="top"><em>int *</em> <code>ik</code></td> + <td valign="top">OUT: Pointer to location to return the chunked storage B-tree 1/2 rank.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3520,10 +3829,11 @@ END SUBROUTINE h5pget_istore_k_f documentation for details. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for property list to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier for property list to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the layout type (a non-negative value) of a dataset creation property list if successful. @@ -3587,12 +3897,14 @@ END SUBROUTINE h5pget_layout_f and is retrieved from the file access property list <code>fapl_id</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>hsize_t *</em><code>size</code> - <dd>OUT: Minimum size, in bytes, of metadata block allocations. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>size</code></td> + <td valign="top">OUT: Minimum size, in bytes, of metadata block allocations.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -3650,12 +3962,14 @@ END SUBROUTINE h5pget_meta_block_size_f Use of this function is only appropriate for an HDF5 file written as a set of files with the <code>MULTI</code> file driver. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list or data transfer property list identifier. - <dt><em>H5FD_mem_t *</em><code>type</code> - <dd>OUT: Type of data. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list or data transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5FD_mem_t *</em><code>type </code></td> + <td valign="top">OUT: Type of data.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3703,10 +4017,11 @@ SUBROUTINE pipeline; <code>plist_id</code> must be a dataset creation property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of filters in the pipeline if successful; otherwise returns a negative value. @@ -3761,7 +4076,7 @@ END SUBROUTINE h5pget_nfilters_f <td><em>hid_t</em> <code>id</code></td> <td>IN: Identifier of property object to query</td></tr> <tr> - <td><em>size_t *</em><code>nprops</code></td> + <td><em>size_t *</em><code>nprops </code></td> <td>OUT: Number of properties in object</td></tr> </table></ul> @@ -3802,10 +4117,11 @@ END SUBROUTINE h5pget_nprops_f <dd><code>H5Pget_preserve</code> checks the status of the dataset transfer property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for the dataset transfer property list. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier for the dataset transfer property list.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns TRUE or FALSE if successful; otherwise returns a negative value. @@ -3841,8 +4157,6 @@ END SUBROUTINE h5pget_preserve_f <em>hid_t</em> <code>fapl_id</code>, <em>hsize_t *</em><code>size</code> ) -<br> -<br> <dt><strong>Purpose:</strong> <dd> Returns maximum data sieve buffer size. <dt><strong>Description:</strong> @@ -3854,12 +4168,14 @@ END SUBROUTINE h5pget_preserve_f and is retrieved from the file access property list <code>fapl_id</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>hsize_t *</em><code>size</code> - <dd>IN: Maximum size, in bytes, of data sieve buffer. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>size</code></td> + <td valign="top">IN: Maximum size, in bytes, of data sieve buffer.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -3915,7 +4231,7 @@ END SUBROUTINE h5pget_sieve_buf_size_f <td><em>hid_t</em> <code>id</code></td> <td>IN: Identifier of property object to query</td></tr> <tr> - <td><em>const char *</em><code>name</code></td> + <td><em>const char *</em><code>name </code></td> <td>IN: Name of property to query</td></tr> <tr> <td><em>size_t *</em><code>size</code></td> @@ -3964,14 +4280,17 @@ END SUBROUTINE h5pget_size_f and lengths used in an HDF5 file. This function is only valid for file creation property lists. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to query. - <dt><em>size_t *</em> <code>size</code> - <dd>OUT: Pointer to location to return offset size in bytes. - <dt><em>size_t *</em> <code>size</code> - <dd>OUT: Pointer to location to return length size in bytes. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of property list to query.</td></tr> + <tr> + <td valign="top"><em>size_t *</em> <code>size </code></td> + <td valign="top">OUT: Pointer to location to return offset size in bytes.</td></tr> + <tr> + <td valign="top"><em>size_t *</em> <code>size</code></td> + <td valign="top">OUT: Pointer to location to return length size in bytes.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -4016,12 +4335,14 @@ END SUBROUTINE h5pget_sizes_f If the returned value is zero (<code>0</code>), the small data block mechanism has been disabled for the file. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier . - <dt><em>hsize_t *</em><code>size</code> - <dd>OUT: Maximum size, in bytes, of the small data block. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>size</code></td> + <td valign="top">OUT: Maximum size, in bytes, of the small data block.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise a negative value. @@ -4068,14 +4389,17 @@ END SUBROUTINE h5pget_small_data_block_size_f <a href="#Property-SetSymK">H5Pset_sym_k</a> for more information. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Property list to query. - <dt><em>int *</em> <code>ik</code> - <dd>OUT: Pointer to location to return the symbol table's B-tree 1/2 rank. - <dt><em>int *</em> <code>size</code> - <dd>OUT: Pointer to location to return the symbol table's leaf node 1/2 size. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Property list to query.</td></tr> + <tr> + <td valign="top"><em>int *</em> <code>ik</code></td> + <td valign="top">OUT: Pointer to location to return the symbol table's B-tree 1/2 rank.</td></tr> + <tr> + <td valign="top"><em>int *</em> <code>size</code></td> + <td valign="top">OUT: Pointer to location to return the symbol table's leaf node 1/2 size.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -4115,12 +4439,14 @@ END SUBROUTINE h5pget_sym_k_f <dd><code>H5Pget_userblock</code> retrieves the size of a user block in a file creation property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for property list to query. - <dt><em>hsize_t *</em> <code>size</code> - <dd>OUT: Pointer to location to return user-block size. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for property list to query.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em> <code>size </code></td> + <td valign="top">OUT: Pointer to location to return user-block size.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -4165,25 +4491,30 @@ END SUBROUTINE h5pget_userblock_f for a file creation property list. Any pointer parameters which are passed as NULL are not queried. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of the file creation property list. - <dt><em>int *</em> <code>super</code> - <dd>OUT: Pointer to location to return super block version number. - <dt><em>int *</em> <code>freelist</code> - <dd>OUT: Pointer to location to return global freelist version number. - <dt><em>int *</em> <code>stab</code> - <dd>OUT: Pointer to location to return symbol table version number. - <dt><em>int *</em> <code>shhdr</code> - <dd>OUT: Pointer to location to return shared object header version number. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of the file creation property list.</td></tr> + <tr> + <td valign="top"><em>int *</em> <code>super</code></td> + <td valign="top">OUT: Pointer to location to return super block version number.</td></tr> + <tr> + <td valign="top"><em>int *</em> <code>freelist </code></td> + <td valign="top">OUT: Pointer to location to return global freelist version number.</td></tr> + <tr> + <td valign="top"><em>int *</em> <code>stab</code></td> + <td valign="top">OUT: Pointer to location to return symbol table version number.</td></tr> + <tr> + <td valign="top"><em>int *</em> <code>shhdr</code></td> + <td valign="top">OUT: Pointer to location to return shared object header version number.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. <dt><strong>Fortran90 Interface:</strong> h5pget_version_f <dd> <pre> -SUBROUTINE h5pget_version_f(prp_id, boot, freelist, & +SUBROUTINE h5pget_version_f(prp_id, boot, freelist, & stab, shhdr, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier @@ -4229,26 +4560,31 @@ END SUBROUTINE h5pget_version_f <code>H5Pset_vlen_mem_manager</code>, returning the parameters set by that function. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for the dataset transfer property list. - <dt><em>H5MM_allocate_t</em> <code>alloc</code> - <dd>OUT: User's allocate routine, or <code> NULL</code> - for system <code> malloc</code>. - <dt><em>void</em> *<code>alloc_info</code> - <dd>OUT: Extra parameter for user's allocation routine. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for the dataset transfer property list.</td></tr> + <tr> + <td valign="top"><em>H5MM_allocate_t</em> <code>alloc </code></td> + <td valign="top">OUT: User's allocate routine, or <code> NULL</code> + for system <code> malloc</code>.</td></tr> + <tr> + <td valign="top"><em>void</em> *<code>alloc_info</code></td> + <td valign="top">OUT: Extra parameter for user's allocation routine. <br> Contents are ignored if preceding parameter is - <code> NULL</code>. - <dt><em>H5MM_free_t</em> <code>free</code> - <dd>OUT: User's free routine, or <code> NULL</code> for - system <code>free</code>. - <dt><em>void</em> *<code>free_info</code> - <dd>OUT: Extra parameter for user's free routine. + <code> NULL</code>.</td></tr> + <tr> + <td valign="top"><em>H5MM_free_t</em> <code>free</code></td> + <td valign="top">OUT: User's free routine, or <code> NULL</code> for + system <code>free</code>.</td></tr> + <tr> + <td valign="top"><em>void</em> *<code>free_info</code></td> + <td valign="top">OUT: Extra parameter for user's free routine. <br> Contents are ignored if preceding parameter is - <code> NULL</code>. - </dl> + <code> NULL</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -4520,6 +4856,7 @@ SUBROUTINE list objects; the initial value is assumed to have any necessary setup already performed on it. +<!-- NEW PAGE --> <dt><strong>Parameters:</strong> <ul><table> <tr> @@ -4544,7 +4881,7 @@ SUBROUTINE <td>IN: Callback routine called when a property value is retrieved from the property</td></tr> <tr> - <td><em>H5P_prp_delete_func_t</em> <code>delete</code></td> + <td><em>H5P_prp_delete_func_t</em> <code>delete </code></td> <td>IN: Callback routine called when a property is deleted from a property list</td></tr> <tr> @@ -4613,7 +4950,7 @@ END SUBROUTINE h5pinsert_f <td><em>hid_t</em> <code>plist</code></td> <td>IN: Identifier of the property list</td></tr> <tr> - <td><code>hid_t</code> <em>pclass</em></td> + <td><code>hid_t</code> <em>pclass </em></td> <td>IN: Identifier of the property class</td></tr> </table></ul> @@ -4735,7 +5072,7 @@ END SUBROUTINE h5pisa_class_f <td><em>int *</em> <code>idx</code></td> <td>IN/OUT: Index of the property to begin with</td></tr> <tr> - <td><em>H5P_iterate_t</em> <code>iter_func</code></td> + <td><em>H5P_iterate_t</em> <code>iter_func </code></td> <td>IN: Function pointer to function to be called with each property iterated over</td></tr> <tr> @@ -4795,19 +5132,24 @@ SUBROUTINE pipeline; <code>plist_id</code> must be a dataset creation property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Property list identifier. - <dt><em>H5Z_filter_t</em> <code>filter</code> - <dd>IN: Filter to be modified. - <dt><em>unsigned int</em> <code>flags</code> - <dd>IN: Bit vector specifying certain general properties - of the filter. - <dt><em>size_t</em> <code>cd_nelmts</code> - <dd>IN: Number of elements in <code>cd_values</code>. - <dt><em>const unsigned int</em> <code>cd_values[]</code> - <dd>IN: Auxiliary data for the filter. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5Z_filter_t</em> <code>filter</code></td> + <td valign="top">IN: Filter to be modified.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>flags</code></td> + <td valign="top">IN: Bit vector specifying certain general properties + of the filter.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>cd_nelmts</code></td> + <td valign="top">IN: Number of elements in <code>cd_values</code>.</td></tr> + <tr> + <td valign="top"><em>const unsigned int</em> <code>cd_values[] </code></td> + <td valign="top">IN: Auxiliary data for the filter.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -4815,7 +5157,7 @@ SUBROUTINE <dt><strong>Fortran90 Interface:</strong> h5pmodify_filter_f <dd> <pre> -SUBROUTINE h5pmodify_filter_f(prp_id, filter, flags, cd_nelmts, & +SUBROUTINE h5pmodify_filter_f(prp_id, filter, flags, cd_nelmts, & cd_values, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier @@ -4953,7 +5295,7 @@ END SUBROUTINE h5pmodify_filter_f to range check the value being set for the property or may perform some tranformation or translation of the value set. The <code>get</code> callback would then - reverse the transformation or translation. + reverse the <!-- NEW PAGE -->transformation or translation. A single <code>get</code> or <code>set</code> callback could handle multiple properties by performing different actions based on the @@ -5119,36 +5461,46 @@ END SUBROUTINE h5pmodify_filter_f </P> <dt><strong>Parameters:</strong> - <ul><dl> - <dt><code>hid_t</code> <em>class</em> - <dd>IN: Property list class to register permanent property - within - <dt><code>const char *</code> <em>name</em> - <dd>IN: Name of property to register - <dt><code>size_t</code> <em>size</em> - <dd>IN: Size of property in bytes - <dt><code>void *</code> <em>default</em> - <dd>IN: Default value for property in newly created property - lists - <dt><code>H5P_prp_create_func_t</code> <em>create</em> - <dd>IN: Callback routine called when a property list is being - created and the property value will be initialized - <dt><code>H5P_prp_set_func_t</code> <em>set</em> - <dd>IN: Callback routine called before a new value is copied - into the property's value - <dt><code>H5P_prp_get_func_t</code> <em>get</em> - <dd>IN: Callback routine called when a property value is - retrieved from the property - <dt><code>H5P_prp_delete_func_t</code> <em>delete</em> - <dd>IN: Callback routine called when a property is deleted from - a property list - <dt><code>H5P_prp_copy_func_t</code> <em>copy</em> - <dd>IN: Callback routine called when a property is copied from - a property list - <dt><code>H5P_prp_close_func_t</code> <em>close</em> - <dd>IN: Callback routine called when a property list is being - closed and the property value will be disposed of - </dl></ul> + <ul><table> + <tr> + <td valign="top"><code>hid_t</code> <em>class</em></td> + <td valign="top">IN: Property list class to register permanent property + within</td></tr> + <tr> + <td valign="top"><code>const char *</code> <em>name</em></td> + <td valign="top">IN: Name of property to register</td></tr> + <tr> + <td valign="top"><code>size_t</code> <em>size</em></td> + <td valign="top">IN: Size of property in bytes</td></tr> + <tr> + <td valign="top"><code>void *</code> <em>default</em></td> + <td valign="top">IN: Default value for property in newly created property + lists</td></tr> + <tr> + <td valign="top"><code>H5P_prp_create_func_t</code> <em>create </em></td> + <td valign="top">IN: Callback routine called when a property list is being + created and the property value will be initialized</td></tr> + <tr> + <td valign="top"><code>H5P_prp_set_func_t</code> <em>set</em></td> + <td valign="top">IN: Callback routine called before a new value is copied + into the property's value</td></tr> + <tr> + <td valign="top"><code>H5P_prp_get_func_t</code> <em>get</em></td> + <td valign="top">IN: Callback routine called when a property value is + retrieved from the property</td></tr> + <tr> + <td valign="top"><code>H5P_prp_delete_func_t</code> <em>delete</em></td> + <td valign="top">IN: Callback routine called when a property is deleted from + a property list</td></tr> + <tr> + <td valign="top"><code>H5P_prp_copy_func_t</code> <em>copy</em></td> + <td valign="top">IN: Callback routine called when a property is copied from + a property list</td></tr> + <tr> + <td valign="top"><code>H5P_prp_close_func_t</code> <em>close</em></td> + <td valign="top">IN: Callback routine called when a property list is being + closed and the property value will be disposed of</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Success: a non-negative value @@ -5218,7 +5570,7 @@ END SUBROUTINE h5pregister_f <td><em>hid_t</em> <code>plid</code></td> <td>IN: Identifier of the property list to modify</td></tr> <tr> - <td><em>const char *</em><code>name</code></td> + <td><em>const char *</em><code>name </code></td> <td>IN: Name of property to remove</td></tr> </table></ul> @@ -5290,7 +5642,7 @@ END SUBROUTINE h5premove_f <td><em>hid_t</em> <code>plid</code>; <td>IN: Property list identifier to modify</td></tr> <tr> - <td><em>const char *</em><code>name</code>; + <td><em>const char *</em><code>name; </code> <td>IN: Name of property to modify</td></tr> <tr> <td><em>void *</em><code>value</code>; @@ -5357,19 +5709,22 @@ END SUBROUTINE h5pset_f For MPI-IO and other parallel systems, choose an alignment which is a multiple of the disk block size. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for a file access property list. - <dt><em>hsize_t</em> <code>threshold</code> - <dd>IN: Threshold value. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for a file access property list.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>threshold </code></td> + <td valign="top">IN: Threshold value. Must be non-negative. Note that setting the threshold value to 0 (zero) has the effect of a special case, forcing everything - to be aligned. - <dt><em>hsize_t</em> <code>alignment</code> - <dd>IN: Alignment value. - Must be a positive value. - </dl> + to be aligned.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>alignment</code></td> + <td valign="top">IN: Alignment value. + Must be a positive value.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -5454,12 +5809,14 @@ END SUBROUTINE h5pset_alignment_f See <a href="RM_H5D.html#Dataset-Create">H5Dcreate</a> for further cross-references. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>H5D_alloc_time_t</em> <code>alloc_time</code> - <dd>IN: When to allocate dataset storage space. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5D_alloc_time_t</em> <code>alloc_time </code></td> + <td valign="top">IN: When to allocate dataset storage space.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -5476,7 +5833,9 @@ SUBROUTINE h5pset_alloc_time_f(plist_id, flag, hdferr) ! H5D_ALLOC_TIME_DEFAULT_F ! H5D_ALLOC_TIME_EARLY_F ! H5D_ALLOC_TIME_LATE_F - ! H5D_ALLOC_TIME_INCR_F + ! H5D_ALLOC_TIME_INCR_F</pre> +<!-- NEW PAGE --> +<pre> INTEGER, INTENT(OUT) :: hdferr ! Error code ! 0 on success and -1 on failure END SUBROUTINE h5pset_alloc_time_f @@ -5519,16 +5878,20 @@ END SUBROUTINE h5pset_alloc_time_f <p> All ratios are real numbers between 0 and 1, inclusive. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: The dataset transfer property list identifier. - <dt><em>double</em> <code>left</code> - <dd>IN: The B-tree split ratio for left-most nodes. - <dt><em>double</em> <code>right</code> - <dd>IN: The B-tree split ratio for right-most nodes and lone nodes. - <dt><em>double</em> <code>middle</code> - <dd>IN: The B-tree split ratio for all other nodes. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: The dataset transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>left</code></td> + <td valign="top">IN: The B-tree split ratio for left-most nodes.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>right</code></td> + <td valign="top">IN: The B-tree split ratio for right-most nodes and lone nodes.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>middle </code></td> + <td valign="top">IN: The B-tree split ratio for all other nodes.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -5594,16 +5957,20 @@ END SUBROUTINE h5pset_btree_ratios_f <p> The default value for the maximum buffer is 1 Mb. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for the dataset transfer property list. - <dt><em>hsize_t</em> <code>size</code> - <dd>IN: Size, in bytes, of the type conversion and background buffers. - <dt><em>void</em> <code>tconv</code> - <dd>IN: Pointer to application-allocated type conversion buffer. - <dt><em>void</em> <code>bkg</code> - <dd>IN: Pointer to application-allocated background buffer. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for the dataset transfer property list.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>size </code></td> + <td valign="top">IN: Size, in bytes, of the type conversion and background buffers.</td></tr> + <tr> + <td valign="top"><em>void</em> <code>tconv</code></td> + <td valign="top">IN: Pointer to application-allocated type conversion buffer.</td></tr> + <tr> + <td valign="top"><em>void</em> <code>bkg</code></td> + <td valign="top">IN: Pointer to application-allocated background buffer.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -5665,18 +6032,23 @@ END SUBROUTINE h5pset_buffer_f preemption is strictly LRU) while a value of one means fully read chunks are always preempted before other chunks. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Identifier of the file access property list. - <dt><em>int</em> <code>mdc_nelmts</code> - <dd>IN: Number of elements (objects) in the meta data cache. - <dt><em>int</em> <code>rdcc_nelmts</code> - <dd>IN: Number of elements (objects) in the raw data chunk cache. - <dt><em>size_t</em> <code>rdcc_nbytes</code> - <dd>IN: Total size of the raw data chunk cache, in bytes. - <dt><em>double</em> <code>rdcc_w0</code> - <dd>IN: Preemption policy. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Identifier of the file access property list.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>mdc_nelmts</code></td> + <td valign="top">IN: Number of elements (objects) in the meta data cache.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>rdcc_nelmts</code></td> + <td valign="top">IN: Number of elements (objects) in the raw data chunk cache.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>rdcc_nbytes </code></td> + <td valign="top">IN: Total size of the raw data chunk cache, in bytes.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>rdcc_w0</code></td> + <td valign="top">IN: Preemption policy.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -5728,14 +6100,17 @@ END SUBROUTINE h5pset_cache_f As a side-effect, the layout of the dataset is changed to <code>H5D_CHUNKED</code>, if it is not already. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for property list to query. - <dt><em>int</em> <code>ndims</code> - <dd>IN: The number of dimensions of each chunk. - <dt><em>const hsize_t *</em> <code>dim</code> - <dd>IN: An array containing the size of each chunk. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for property list to query.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>ndims</code></td> + <td valign="top">IN: The number of dimensions of each chunk.</td></tr> + <tr> + <td valign="top"><em>const hsize_t *</em> <code>dim </code></td> + <td valign="top">IN: An array containing the size of each chunk.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -5781,12 +6156,14 @@ END SUBROUTINE h5pset_chunk_f Lower compression levels are faster but result in less compression. This is the same algorithm as used by the GNU gzip program. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for the dataset creation property list. - <dt><em>int</em> <code>level</code> - <dd>IN: Compression level. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier for the dataset creation property list.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>level</code></td> + <td valign="top">IN: Compression level.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -5885,12 +6262,14 @@ END SUBROUTINE h5pset_deflate_f </dl> </dir></p> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dxpl_id</code> - <dd>IN: Data transfer property list identifier. - <dt><em>H5FD_mpio_xfer_t</em> <code>xfer_mode</code> - <dd>IN: Transfer mode. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dxpl_id</code></td> + <td valign="top">IN: Data transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5FD_mpio_xfer_t</em> <code>xfer_mode </code></td> + <td valign="top">IN: Transfer mode.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -5937,12 +6316,14 @@ END SUBROUTINE h5pset_dxpl_mpio_f <code>H5Pset_dxpl_multi</code> can only be used after the member map has been set with <code>H5Pset_fapl_multi</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dxpl_id</code>, - <dd>IN: Data transfer property list identifier. - <dt><em>const hid_t *</em><code>memb_dxpl</code> - <dd>IN: Array of data access property lists. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dxpl_id</code>,</td> + <td valign="top">IN: Data transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>const hid_t *</em><code>memb_dxpl </code></td> + <td valign="top">IN: Array of data access property lists.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -5997,13 +6378,15 @@ SUBROUTINE <dd>The initial error detection implementation, Fletcher32 checksum, supports error detection for chunked datasets only. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Dataset transfer property list identifier. - <dt><em>H5Z_EDC_t</em> <code>check</code> - <dd>IN: Specifies whether error checking is enabled or disabled - for dataset read operations. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Dataset transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5Z_EDC_t</em> <code>check </code></td> + <td valign="top">IN: Specifies whether error checking is enabled or disabled + for dataset read operations.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -6061,17 +6444,21 @@ END SUBROUTINE h5pset_edc_check_f external file can be of unlimited size and no more files can be added to the external files list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of a dataset creation property list. - <dt><em>const char</em> <code>*name</code> - <dd>IN: Name of an external file. - <dt><em>off_t</em> <code>offset</code> - <dd>IN: Offset, in bytes, from the beginning of the file - to the location in the file where the data starts. - <dt><em>hsize_t</em> <code>size</code> - <dd>IN: Number of bytes reserved in the file for the data. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of a dataset creation property list.</td></tr> + <tr> + <td valign="top"><em>const char</em> <code>*name </code></td> + <td valign="top">IN: Name of an external file.</td></tr> + <tr> + <td valign="top"><em>off_t</em> <code>offset</code></td> + <td valign="top">IN: Offset, in bytes, from the beginning of the file + to the location in the file where the data starts.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>size</code></td> + <td valign="top">IN: Number of bytes reserved in the file for the data.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -6132,12 +6519,14 @@ END SUBROUTINE h5pset_external_f Use of this function is only appropriate for an HDF5 file written as a family of files with the <code>FAMILY</code> file driver. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>hsize_t</em> <code>offset</code> - <dd>IN: Offset in bytes within the HDF5 file. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>offset </code></td> + <td valign="top">IN: Offset in bytes within the HDF5 file.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -6197,15 +6586,18 @@ END SUBROUTINE h5pset_family_offset_f <dd>There is currently no means for reading a file from disk then using the <code>H5FD_CORE</code> driver to manipulate the file. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>size_t</em> <code>increment</code> - <dd>IN: Size, in bytes, of memory increments. - <dt><em>hbool_t</em> <code>backing_store</code> - <dd>IN: Boolean flag indicating whether to write the file - contents to disk when the file is closed. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>increment</code></td> + <td valign="top">IN: Size, in bytes, of memory increments.</td></tr> + <tr> + <td valign="top"><em>hbool_t</em> <code>backing_store </code></td> + <td valign="top">IN: Boolean flag indicating whether to write the file + contents to disk when the file is closed.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -6256,15 +6648,18 @@ END SUBROUTINE h5pset_fapl_core_f <code>memb_fapl_id</code> is the identifier of the file access property list to be used for each family member. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em> hsize_t</em> <code>memb_size</code> - <dd>IN: Size in bytes of each file member. - <dt><em>hid_t</em> <code>memb_fapl_id</code> - <dd>IN: Identifier of file access property list for each - family member. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em> hsize_t</em> <code>memb_size</code></td> + <td valign="top">IN: Size in bytes of each file member.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>memb_fapl_id </code></td> + <td valign="top">IN: Identifier of file access property list for each + family member.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -6324,12 +6719,14 @@ END SUBROUTINE h5pset_fapl_family_f For further information, see <a href="http://www.globus.org/">http//www.globus.org/</a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code>, - <dd>IN: File access property list identifier. - <dt><em>GASS_Info</em> <code>info</code> - <dd>IN: Pointer to the GASS information structure. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code>,</td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>GASS_Info</em> <code>info </code></td> + <td valign="top">IN: Pointer to the GASS information structure.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -6494,6 +6891,7 @@ SUBROUTINE <code>(H5FD_LOG_NUM_READ | H5FD_LOG_NUM_WRITE | H5FD_LOG_NUM_SEEK)</code> </td></tr> +<!-- NEW PAGE --> <tr valign=top align=left><td> <hr> <code>H5FD_LOG_TIME_OPEN</code> @@ -6593,16 +6991,20 @@ SUBROUTINE which must be at least the size in bytes of the file to be logged. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>char *</em><code>logfile</code> - <dd>IN: Name of the log file. - <dt><em>unsigned int</em> <code>flags</code> - <dd>IN: Flags specifying the types of logging activity. - <dt><em>size_t</em> <code>buf_size</code> - <dd>IN: The size of the logging buffer. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>char *</em><code>logfile</code></td> + <td valign="top">IN: Name of the log file.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>flags </code></td> + <td valign="top">IN: Flags specifying the types of logging activity.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>buf_size</code></td> + <td valign="top">IN: The size of the logging buffer.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns non-negative if successful. Otherwise returns negative. @@ -6661,14 +7063,17 @@ SUBROUTINE Users should not modify the info while it is defined in a property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>MPI_Comm</em> <code>comm</code> - <dd>IN: MPI-2 communicator. - <dt><em>MPI_Info</em> <code>info</code> - <dd>IN: MPI-2 info object. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>MPI_Comm</em> <code>comm </code></td> + <td valign="top">IN: MPI-2 communicator.</td></tr> + <tr> + <td valign="top"><em>MPI_Info</em> <code>info</code></td> + <td valign="top">IN: MPI-2 info object.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -6727,12 +7132,14 @@ END SUBROUTINE h5pset_fapl_mpio_f Users should not modify the communicator while it is defined in a property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>MPI_Comm</em> <code>comm</code> - <dd>IN: MPI-2 communicator. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>MPI_Comm</em> <code>comm </code></td> + <td valign="top">IN: MPI-2 communicator.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -6841,29 +7248,36 @@ END SUBROUTINE h5pset_fapl_mpiposix_f <code>l</code> for <code>H5FD_MEM_LHEAP</code> <br> <code>o</code> for <code>H5FD_MEM_OHDR</code> - </dir> + </dir></dd></dt> +<!-- NEW PAGE --> <dt><code>memb_addr</code> <dd>The default value is <code>HADDR_UNDEF</code> for each element. </dl> </dir> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>const H5FD_mem_t *</em><code>memb_map</code> - <dd>IN: Maps memory usage types to other memory usage types. - <dt><em>const hid_t *</em><code>memb_fapl</code> - <dd>IN: Property list for each memory usage type. - <dt><em>const char **</em><code>memb_name</code> - <dd>IN: Name generator for names of member files. - <dt><em>const haddr_t *</em><code>memb_addr</code> - <dd>IN: The offsets within the virtual address space, + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>const H5FD_mem_t *</em><code>memb_map </code></td> + <td valign="top">IN: Maps memory usage types to other memory usage types.</td></tr> + <tr> + <td valign="top"><em>const hid_t *</em><code>memb_fapl</code></td> + <td valign="top">IN: Property list for each memory usage type.</td></tr> + <tr> + <td valign="top"><em>const char **</em><code>memb_name</code></td> + <td valign="top">IN: Name generator for names of member files.</td></tr> + <tr> + <td valign="top"><em>const haddr_t *</em><code>memb_addr</code></td> + <td valign="top">IN: The offsets within the virtual address space, from <code>0</code> (zero) to <code>HADDR_MAX</code>, - at which each type of data storage begins. - <dt><em>hbool_t</em> <code>relax</code> - <dd>IN: Allows read-only access to incomplete file sets - when <code>TRUE</code>. - </dl> + at which each type of data storage begins.</td></tr> + <tr> + <td valign="top"><em>hbool_t</em> <code>relax</code></td> + <td valign="top">IN: Allows read-only access to incomplete file sets + when <code>TRUE</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -6907,7 +7321,9 @@ SUBROUTINE h5pset_fapl_multi_f(prp_id, memb_map, memb_fapl, memb_name, & INTEGER,DIMENSION(0:H5FD_MEM_NTYPES_F-1),INTENT(IN) :: memb_map INTEGER(HID_T),DIMENSION(0:H5FD_MEM_NTYPES_F-1),INTENT(IN) :: memb_fapl - CHARACTER(LEN=*),DIMENSION(0:H5FD_MEM_NTYPES_F-1),INTENT(IN) :: memb_name + CHARACTER(LEN=*),DIMENSION(0:H5FD_MEM_NTYPES_F-1),INTENT(IN) :: memb_name</pre> +<!-- NEW PAGE --> +<pre> REAL, DIMENSION(0:H5FD_MEM_NTYPES_F-1), INTENT(IN) :: memb_addr ! Numbers in the interval [0,1) (e.g. 0.0 0.1 0.5 0.2 0.3 0.4) ! real address in the file will be calculated as X*HADDR_MAX @@ -6941,10 +7357,11 @@ END SUBROUTINE h5pset_fapl_multi_f <dd><code>H5Pset_fapl_sec2</code> modifies the file access property list to use the <code>H5FD_SEC2</code> driver. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -7018,19 +7435,23 @@ END SUBROUTINE h5pset_fapl_sec2_f HDF5 provides no mechanism to determine whether it was called as the special case invoked by <code>H5Pset_fapl_split</code>. <dt><strong>Parameters:</strong> - <dl> - <dt> - <dt><em>hid_t</em> <code>fapl_id</code>, - <dd>IN: File access property list identifier. - <dt><em>const char *</em><code>meta_ext</code>, - <dd>IN: Metadata filename extension. - <dt><em>hid_t</em> <code>meta_plist_id</code>, - <dd>IN: File access property list identifier for the metadata file. - <dt><em>const char *</em><code>raw_ext</code>, - <dd>IN: Raw data filename extension. - <dt><em>hid_t</em> <code>raw_plist_id</code> - <dd>IN: File access property list identifier for the raw data file. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code>,</td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>meta_ext, </code></td> + <td valign="top">IN: Metadata filename extension.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>meta_plist_id</code>,</td> + <td valign="top">IN: File access property list identifier for the metadata file.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>raw_ext</code>,</td> + <td valign="top">IN: Raw data filename extension.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>raw_plist_id</code></td> + <td valign="top">IN: File access property list identifier for the raw data file.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -7109,12 +7530,14 @@ END SUBROUTINE h5pset_fapl_split_f Storage Resource Broker (SRB). For further information, see <a href="http://www.npaci.edu/Research/DI/srb/">http//www.npaci.edu/Research/DI/srb/</a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>SRB_Info</em> <code>info</code> - <dd>IN: Pointer to the SRB information structure. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>SRB_Info</em> <code>info</code></td> + <td valign="top">IN: Pointer to the SRB information structure.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -7149,10 +7572,11 @@ SUBROUTINE <dd><code>H5Pset_fapl_stdio</code> modifies the file access property list to use the standard I/O driver, <code>H5FD_STDIO</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -7237,12 +7661,14 @@ END SUBROUTINE h5pset_fapl_stdio_f <code>H5Pset_fapl_stream</code> and <code>H5Pget_fapl_stream</code> are not intended for use in a parallel environment. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>H5FD_stream_fapl_t *</em><code>fapl</code> - <dd>IN: The streaming I/O file access property list. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5FD_stream_fapl_t *</em><code>fapl </code></td> + <td valign="top">IN: The streaming I/O file access property list.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -7315,13 +7741,15 @@ SUBROUTINE </table> </div> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>H5F_close_degree_t</em> <code>fc_degree</code> - <dd>IN: Pointer to a location containing the file close degree property, - the value of <code>fc_degree</code>. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5F_close_degree_t</em> <code>fc_degree </code></td> + <td valign="top">IN: Pointer to a location containing the file close degree property, + the value of <code>fc_degree</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -7350,7 +7778,6 @@ END SUBROUTINE h5pset_fclose_degree_f --> </dl> -<!-- NEW PAGE --> <!-- HEADER RIGHT "H5Pset_fill_time" --> <hr> <dl> @@ -7393,12 +7820,14 @@ END SUBROUTINE h5pset_fclose_degree_f See <a href="RM_H5D.html#Dataset-Create">H5Dcreate</a> for further cross-references. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>H5D_fill_time_t</em> <code>fill_time</code> - <dd>IN: When to write fill values to a dataset. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5D_fill_time_t</em> <code>fill_time </code></td> + <td valign="top">IN: When to write fill values to a dataset.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -7484,14 +7913,17 @@ END SUBROUTINE h5pset_fill_time_f See <a href="RM_H5D.html#Dataset-Create">H5Dcreate</a> for further cross-references. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>hid_t</em> <code>type_id</code>, - <dd>IN: Datatype of <code>value</code>. - <dt><em>const void *</em><code>value</code> - <dd>IN: Pointer to buffer containing value to use as fill value. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code>,</td> + <td valign="top">IN: Datatype of <code>value</code>.</td></tr> + <tr> + <td valign="top"><em>const void *</em><code>value </code></td> + <td valign="top">IN: Pointer to buffer containing value to use as fill value.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -7611,19 +8043,24 @@ END SUBROUTINE h5pset_fill_value_f If multiple filters are set for a property list, they will be applied to each chunk in the order in which they were set. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Property list identifier. - <dt><em>H5Z_filter_t</em> <code>filter</code> - <dd>IN: Filter to be added to the pipeline. - <dt><em>unsigned int</em> <code>flags</code> - <dd>IN: Bit vector specifying certain general properties - of the filter. - <dt><em>size_t</em> <code>cd_nelmts</code> - <dd>IN: Number of elements in <code>cd_values</code>. - <dt><em>const unsigned int</em> <code>cd_values[]</code> - <dd>IN: Auxiliary data for the filter. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5Z_filter_t</em> <code>filter</code></td> + <td valign="top">IN: Filter to be added to the pipeline.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>flags</code></td> + <td valign="top">IN: Bit vector specifying certain general properties + of the filter.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>cd_nelmts</code></td> + <td valign="top">IN: Number of elements in <code>cd_values</code>.</td></tr> + <tr> + <td valign="top"><em>const unsigned int</em> <code>cd_values[] </code></td> + <td valign="top">IN: Auxiliary data for the filter.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -7693,14 +8130,17 @@ END SUBROUTINE h5pset_filter_f Valid callback function return values are <code>H5Z_CB_FAIL</code> and <code>H5Z_CB_CONT</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Dataset transfer property list identifier. - <dt><em>H5Z_filter_func_t</em> <code>func</code> - <dd>IN: User-defined filter callback function. - <dt><em>void *</em><code>op_data</code> - <dd>IN: User-defined input data for the callback function. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Dataset transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5Z_filter_func_t</em> <code>func </code></td> + <td valign="top">IN: User-defined filter callback function.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>op_data</code></td> + <td valign="top">IN: User-defined input data for the callback function.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -7736,10 +8176,11 @@ SUBROUTINE <dd>The initial error detection implementation supports error detection for chunked datasets only. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Dataset creation property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -7790,13 +8231,15 @@ END SUBROUTINE h5pset_fletcher32_f <p> The default value for garbage collecting references is off. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: File access property list identifier. - <dt><em>unsigned</em> <code>gc_ref</code> - <dd>IN: Flag setting reference garbage collection to - on (<code>1</code>) or off (<code>0</code>). - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>unsigned</em> <code>gc_ref </code></td> + <td valign="top">IN: Flag setting reference garbage collection to + on (<code>1</code>) or off (<code>0</code>).</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -7851,14 +8294,15 @@ END SUBROUTINE h5pset_gc_references_f but the library will use more memory during hyperslab I/O. The default value of <code>vector_size</code> is <code>1024</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dxpl_id</code> - <dd>IN: Dataset transfer property list identifier. - <dt><em>size_t</em> <code>vector_size</code> - <dd>IN: Number of I/O vectors to accumulate in memory for I/O operations. - Must be greater than <code>1</code> (one). - Default value: <code>1024</code>. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dxpl_id</code></td> + <td valign="top">IN: Dataset transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>vector_size </code></td> + <td valign="top">IN: Number of I/O vectors to accumulate in memory for I/O operations. + Must be greater than <code>1</code> (one). Default value: <code>1024</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -7905,12 +8349,14 @@ END SUBROUTINE h5pset_hyper_vector_size_f or have an average rank of 1.5 times the value of <code>ik</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to query. - <dt><em>int</em> <code>ik</code> - <dd>IN: 1/2 rank of chunked storage B-tree. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier of property list to query.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>ik</code></td> + <td valign="top">IN: 1/2 rank of chunked storage B-tree.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -7970,12 +8416,14 @@ END SUBROUTINE h5pset_istore_k_f <a href="RM_H5D.html#Dataset-Write">H5Dwrite</a> documentation for details. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to query. - <dt><em>H5D_layout_t</em> <code>layout</code> - <dd>IN: Type of storage layout for raw data. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of property list to query.</td></tr> + <tr> + <td valign="top"><em>H5D_layout_t</em> <code>layout </code></td> + <td valign="top">IN: Type of storage layout for raw data.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8037,12 +8485,14 @@ END SUBROUTINE h5pset_layout_f potentially significantly improving library and application performance. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>hsize_t</em> <code>size</code> - <dd>IN: Minimum size, in bytes, of metadata block allocations. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>size</code></td> + <td valign="top">IN: Minimum size, in bytes, of metadata block allocations.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -8134,12 +8584,14 @@ END SUBROUTINE h5pset_meta_block_size_f Use of this function is only appropriate for an HDF5 file written as a set of files with the <code>MULTI</code> file driver. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list or data transfer property list identifier. - <dt><em>H5FD_mem_t</em> <code>type</code> - <dd>OUT: Type of data. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list or data transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5FD_mem_t</em> <code>type </code></td> + <td valign="top">OUT: Type of data.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8180,13 +8632,15 @@ SUBROUTINE property to TRUE. Otherwise the I/O pipeline treats the destination datapoints as completely uninitialized. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for the dataset transfer property list. - <dt><em>hbool_t</em> <code>status</code> - <dd>IN: Status of for the dataset transfer property list - (TRUE/FALSE). - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for the dataset transfer property list.</td></tr> + <tr> + <td valign="top"><em>hbool_t</em> <code>status </code></td> + <td valign="top">IN: Status of for the dataset transfer property list + (TRUE/FALSE).</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8243,10 +8697,11 @@ END SUBROUTINE h5pset_preserve_f This filter is designed to be used in combination with a compression filter. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id </code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8296,12 +8751,14 @@ END SUBROUTINE h5pset_shuffle_f Setting the value to 0 with this API function will turn off the data sieving, even if the VFL driver attempts to use that strategy. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>hsize_t</em> <code>size</code> - <dd>IN: Maximum size, in bytes, of data sieve buffer. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>size</code></td> + <td valign="top">IN: Maximum size, in bytes, of data sieve buffer.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -8349,14 +8806,17 @@ END SUBROUTINE h5pset_sieve_buf_size_f <code>sizeof(hsize_t)</code> in the library (normally 8 bytes). Valid values currently are 2, 4, 8 and 16. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to modify. - <dt><em>size_t</em> <code>sizeof_addr</code> - <dd>IN: Size of an object offset in bytes. - <dt><em>size_t</em> <code>sizeof_size</code> - <dd>IN: Size of an object length in bytes. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of property list to modify.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>sizeof_addr </code></td> + <td valign="top">IN: Size of an object offset in bytes.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>sizeof_size</code></td> + <td valign="top">IN: Size of an object length in bytes.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8422,14 +8882,16 @@ END SUBROUTINE h5pset_sizes_f Setting <code>size</code> to zero (<code>0</code>) disables the small data block mechanism. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier . - <dt><em>hsize_t</em> <code>size</code> - <dd>IN: Maximum size, in bytes, of the small data block. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>size</code></td> + <td valign="top">IN: Maximum size, in bytes, of the small data block. <br> - The default size is <code>2048</code>. - </dl> + The default size is <code>2048</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise a negative value. @@ -8485,14 +8947,17 @@ END SUBROUTINE h5pset_small_data_block_size_f contain 1.5 times the number of symbols specified by <code>lk</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for property list to query. - <dt><em>int</em> <code>ik</code> - <dd>IN: Symbol table tree rank. - <dt><em>int</em> <code>lk</code> - <dd>IN: Symbol table node size. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier for property list to query.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>ik</code></td> + <td valign="top">IN: Symbol table tree rank.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>lk</code></td> + <td valign="top">IN: Symbol table node size.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8652,15 +9117,18 @@ END LIBRARY-SET OPTION TAGS --> and for a list of SZIP-related references. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Dataset creation or dataset transfer property list - identifier. - <dt><em>unsigned int</em> <code>options_mask</code> - <dd>IN: A bit-mask conveying the desired SZIP options. - <dt><em>unsigned int</em> <code>pixels_per_block</code> - <dd>IN: The number of pixels or data elements in each data block. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Dataset creation or dataset transfer property list + identifier.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>options_mask</code></td> + <td valign="top">IN: A bit-mask conveying the desired SZIP options.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>pixels_per_block </code></td> + <td valign="top">IN: The number of pixels or data elements in each data block.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8771,12 +9239,14 @@ END SUBROUTINE h5pset_szip_f The default user block size is 0; it may be set to any power of 2 equal to 512 or greater (512, 1024, 2048, etc.). <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to modify. - <dt><em>hsize_t</em> <code>size</code> - <dd>IN: Size of the user-block in bytes. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of property list to modify.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>size </code></td> + <td valign="top">IN: Size of the user-block in bytes.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8855,26 +9325,31 @@ END SUBROUTINE h5pset_userblock_f and the <code>alloc_info</code> and <code>free_info</code> parameters are ignored. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for the dataset transfer property list. - <dt><em>H5MM_allocate_t</em> <code>alloc</code> - <dd>IN: User's allocate routine, or <code> NULL</code> - for system <code> malloc</code>. - <dt><em>void</em> *<code>alloc_info</code> - <dd>IN: Extra parameter for user's allocation routine. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for the dataset transfer property list.</td></tr> + <tr> + <td valign="top"><em>H5MM_allocate_t</em> <code>alloc </code></td> + <td valign="top">IN: User's allocate routine, or <code> NULL</code> + for system <code> malloc</code>.</td></tr> + <tr> + <td valign="top"><em>void</em> *<code>alloc_info</code></td> + <td valign="top">IN: Extra parameter for user's allocation routine. <br> Contents are ignored if preceding parameter is - <code> NULL</code>. - <dt><em>H5MM_free_t</em> <code>free</code> - <dd>IN: User's free routine, or <code> NULL</code> - for system <code>free</code>. - <dt><em>void</em> *<code>free_info</code> - <dd>IN: Extra parameter for user's free routine. + <code> NULL</code>.</td></tr> + <tr> + <td valign="top"><em>H5MM_free_t</em> <code>free</code></td> + <td valign="top">IN: User's free routine, or <code> NULL</code> + for system <code>free</code>.</td></tr> + <tr> + <td valign="top"><em>void</em> *<code>free_info</code></td> + <td valign="top">IN: Extra parameter for user's free routine. <br> Contents are ignored if preceding parameter is - <code> NULL</code>. - </dl> + <code> NULL</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8921,7 +9396,7 @@ SUBROUTINE <dt><strong>Parameters:</strong> <ul><table> <tr> - <td><em>H5P_class_t</em> <code>class</code></td> + <td><em>H5P_class_t</em> <code>class </code></td> <td>IN: Property list class from which to remove permanent property</td></tr> <tr> @@ -9202,14 +9677,13 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> +<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 14 January 2004"); +document.writeln("Last modified: 24 February 2004"); --> </SCRIPT> diff --git a/doc/html/RM_H5R.html b/doc/html/RM_H5R.html index 1443e11..5c93eb9 100644 --- a/doc/html/RM_H5R.html +++ b/doc/html/RM_H5R.html @@ -61,8 +61,7 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><center> +<hr><!-- #EndLibraryItem --><center> <h1>H5R: Reference Interface</h1> </center> @@ -195,27 +194,32 @@ as the corresponding C function. to be pointed to for a dataset region reference. This parameter is unused with object references. <dt><strong>Parameters:</strong> - <dl> - <dt><em>void *</em><code>ref</code> - <dd>OUT: Reference created by the function call. - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Location identifier used to locate the object being - pointed to. - <dt><em>const char *</em><code>name</code> - <dd>IN: Name of object at location <code>loc_id</code>. - <dt><em>H5R_type_t</em> <code>ref_type</code> - <dd>IN: Type of reference. - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Dataspace identifier with selection. - Used for dataset region references. - </dl> + <ul><table> + <tr> + <td valign="top"><em>void *</em><code>ref</code></td> + <td valign="top">OUT: Reference created by the function call.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: Location identifier used to locate the object being + pointed to.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>name</code></td> + <td valign="top">IN: Name of object at location <code>loc_id</code>.</td></tr> + <tr> + <td valign="top"><em>H5R_type_t</em> <code>ref_type </code></td> + <td valign="top">IN: Type of reference.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id</code></td> + <td valign="top">IN: Dataspace identifier with selection. + Used for dataset region references.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. <dt><strong>Fortran90 Interface:</strong> h5rcreate_f - <p><strong>To create an object reference</strong> - <dd> + <dd><p><strong>To create an object reference</strong> + <pre> SUBROUTINE h5rcreate_f(loc_id, name, ref, hdferr) IMPLICIT NONE @@ -227,9 +231,10 @@ SUBROUTINE h5rcreate_f(loc_id, name, ref, hdferr) END SUBROUTINE h5rcreate_f </pre></dt> + +<!-- NEW PAGE --> +<dt><dd><strong>To create a region reference</strong> -<dt><strong>To create a region reference</strong> - <dd> <pre> SUBROUTINE h5rcreate_f(loc_id, name, space_id, ref, hdferr) IMPLICIT NONE @@ -275,14 +280,17 @@ END SUBROUTINE h5rcreate_f <li><code>H5R_DATASET_REGION</code> (<code>1</code>) </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset</code> - <dd>IN: Dataset containing reference object. - <dt><em>H5R_type_t</em> <code>ref_type</code> - <dd>IN: The reference type of <code>ref</code>. - <dt><em>void *</em><code>ref</code> - <dd>IN: Reference to open. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset</code></td> + <td valign="top">IN: Dataset containing reference object.</td></tr> + <tr> + <td valign="top"><em>H5R_type_t</em> <code>ref_type </code></td> + <td valign="top">IN: The reference type of <code>ref</code>.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>ref</code></td> + <td valign="top">IN: Reference to open.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns valid identifier if successful; otherwise returns a negative value. @@ -374,16 +382,19 @@ END SUBROUTINE h5rdereference_f </td></tr> </table> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>id</code>, - <dd>IN: The dataset containing the reference object or + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>id</code>,</td> + <td valign="top">IN: The dataset containing the reference object or the location identifier of the object that the - dataset is located within. - <dt><em>H5R_type_t</em> <code>ref_type</code> - <dd>IN: Type of reference to query. - <dt><em>void *</em><code>ref</code> - <dd>IN: Reference to query. - </dl> + dataset is located within.</td></tr> + <tr> + <td valign="top"><em>H5R_type_t</em> <code>ref_type </code></td> + <td valign="top">IN: Type of reference to query.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>ref</code></td> + <td valign="top">IN: Reference to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns an object type as defined in <code>H5Gpublic.h</code> if successful; otherwise returns <code>H5G_UNKNOWN</code>. @@ -439,14 +450,17 @@ END SUBROUTINE h5rget_object_type_f <li><code>H5R_DATASET_REGION</code> (<code>1</code>) </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dataset</code>, - <dd>IN: Dataset containing reference object. - <dt><em>H5R_type_t</em> <code>ref_type</code>, - <dd>IN: The reference type of <code>ref</code>. - <dt><em>void *</em><code>ref</code> - <dd>IN: Reference to open. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dataset</code></td> + <td valign="top">IN: Dataset containing reference object.</td></tr> + <tr> + <td valign="top"><em>H5R_type_t</em> <code>ref_type </code></td> + <td valign="top">IN: The reference type of <code>ref</code>.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>ref</code></td> + <td valign="top">IN: Reference to open.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid identifier if successful; otherwise returns a negative value. @@ -504,14 +518,13 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> +<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 21 October 2003"); +document.writeln("Last modified: 24 February 2004"); --> </SCRIPT> diff --git a/doc/html/RM_H5S.html b/doc/html/RM_H5S.html index b977c0b..ba530a1 100644 --- a/doc/html/RM_H5S.html +++ b/doc/html/RM_H5S.html @@ -61,8 +61,7 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><center> +<hr><!-- #EndLibraryItem --><center> <h1>H5S: Dataspace Interface</h1> </center> @@ -251,10 +250,11 @@ of the <cite>HDF5 User's Guide.</cite>. Failure to release a dataspace with this call will result in resource leaks. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>Identifier of dataspace to release. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">Identifier of dataspace to release.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -293,10 +293,11 @@ END SUBROUTINE h5sclose_f The dataspace identifier returned from this function should be released with <code>H5Sclose</code> or resource leaks will occur. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>Identifier of dataspace to copy. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">Identifier of dataspace to copy.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a dataspace identifier if successful; otherwise returns a negative value. @@ -336,10 +337,11 @@ END SUBROUTINE h5scopy_f <code>H5S_SIMPLE</code>; others are planned to be added later. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5S_class_t</em> <code>type</code> - <dd>The type of dataspace to be created. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5S_class_t</em> <code>type </code></td> + <td valign="top">The type of dataspace to be created.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a dataspace identifier if successful; otherwise returns a negative value. @@ -402,14 +404,17 @@ END SUBROUTINE h5screate_f The dataspace identifier returned from this function must be released with <code>H5Sclose</code> or resource leaks will occur. <dt><strong>Parameters:</strong> - <dl> - <dt><em>int</em> <code>rank</code> - <dd>Number of dimensions of dataspace. - <dt><em>const hsize_t *</em> <code>dims</code> - <dd>An array of the size of each dimension. - <dt><em>const hsize_t *</em> <code>maxdims</code> - <dd>An array of the maximum size of each dimension. - </dl> + <ul><table> + <tr> + <td valign="top"><em>int</em> <code>rank</code></td> + <td valign="top">Number of dimensions of dataspace.</td></tr> + <tr> + <td valign="top"><em>const hsize_t *</em> <code>dims</code></td> + <td valign="top">An array of the size of each dimension.</td></tr> + <tr> + <td valign="top"><em>const hsize_t *</em> <code>maxdims </code></td> + <td valign="top">An array of the maximum size of each dimension.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a dataspace identifier if successful; otherwise returns a negative value. @@ -453,14 +458,16 @@ END SUBROUTINE h5screate_simple_f <code>source_space_id</code> to <code>dest_space_id</code>. This action may change the type of the dataspace. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dest_space_id</code> - <dd>IN: The identifier for the dataspace to which - the extent is copied. - <dt><em>hid_t</em> <code>source_space_id</code> - <dd>IN: The identifier for the dataspace from which - the extent is copied. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dest_space_id</code></td> + <td valign="top">IN: The identifier for the dataspace to which + the extent is copied.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>source_space_id </code></td> + <td valign="top">IN: The identifier for the dataspace from which + the extent is copied.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -517,15 +524,18 @@ END SUBROUTINE h5sextent_copy_f Calling this function on a <code>none</code> selection will return <code>FAIL</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Identifier of dataspace to query. - <dt><em>hssize_t *</em><code>start</code> - <dd>OUT: Starting coordinates of the bounding box. - <dt><em>hssize_t *</em><code>end</code> - <dd>OUT: Ending coordinates of the bounding box, - i.e., the coordinates of the diagonally opposite corner. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">IN: Identifier of dataspace to query.</td></tr> + <tr> + <td valign="top"><em>hssize_t *</em><code>start</code></td> + <td valign="top">OUT: Starting coordinates of the bounding box.</td></tr> + <tr> + <td valign="top"><em>hssize_t *</em><code>end</code></td> + <td valign="top">OUT: Ending coordinates of the bounding box, + i.e., the coordinates of the diagonally opposite corner.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -559,10 +569,11 @@ END SUBROUTINE h5sextent_copy_f <dd><code>H5Sget_select_elem_npoints</code> returns the number of element points in the current dataspace selection. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Identifier of dataspace to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">IN: Identifier of dataspace to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of element points in the current dataspace selection if successful. Otherwise returns a negative value. @@ -623,16 +634,20 @@ END SUBROUTINE h5sget_select_elem_npoints_f The points are returned in the order they will be iterated through when the selection is read/written from/to disk. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Dataspace identifier of selection to query. - <dt><em>hsize_t </em><code>startpoint</code> - <dd>IN: Element point to start with. - <dt><em>hsize_t </em><code>numpoints</code> - <dd>IN: Number of element points to get. - <dt><em>hsize_t *</em><code>buf</code> - <dd>OUT: List of element points selected. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id</code></td> + <td valign="top">IN: Dataspace identifier of selection to query.</td></tr> + <tr> + <td valign="top"><em>hsize_t </em><code>startpoint </code></td> + <td valign="top">IN: Element point to start with.</td></tr> + <tr> + <td valign="top"><em>hsize_t </em><code>numpoints</code></td> + <td valign="top">IN: Number of element points to get.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>buf</code></td> + <td valign="top">OUT: List of element points selected.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -698,16 +713,20 @@ END SUBROUTINE h5sget_select_elem_pointlist_f <p> No guarantee is implied as the order in which blocks are listed. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Dataspace identifier of selection to query. - <dt><em>hsize_t </em><code>startblock</code> - <dd>IN: Hyperslab block to start with. - <dt><em>hsize_t </em><code>numblocks</code> - <dd>IN: Number of hyperslab blocks to get. - <dt><em>hsize_t *</em><code>buf</code> - <dd>OUT: List of hyperslab blocks selected. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id</code></td> + <td valign="top">IN: Dataspace identifier of selection to query.</td></tr> + <tr> + <td valign="top"><em>hsize_t </em><code>startblock </code></td> + <td valign="top">IN: Hyperslab block to start with.</td></tr> + <tr> + <td valign="top"><em>hsize_t </em><code>numblocks</code></td> + <td valign="top">IN: Number of hyperslab blocks to get.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>buf</code></td> + <td valign="top">OUT: List of hyperslab blocks selected.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -750,10 +769,11 @@ END SUBROUTINE h5sget_select_hyper_blocklist_f <dd><code>H5Sget_select_hyper_nblocks</code> returns the number of hyperslab blocks in the current dataspace selection. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Identifier of dataspace to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">IN: Identifier of dataspace to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of hyperslab blocks in the current dataspace selection if successful. @@ -791,10 +811,11 @@ END SUBROUTINE h5sget_select_hyper_nblocks_f <dd><code>H5Sget_select_npoints</code> determines the number of elements in the current selection of a dataspace. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>Dataspace identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">Dataspace identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of elements in the selection if successful; otherwise returns a negative value. @@ -833,10 +854,11 @@ END SUBROUTINE h5sget_select_npoints_f type of selection currently defined for the dataspace <code>space_id</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>Dataspace identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">Dataspace identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the dataspace selection type, a value of the enumerated datatype <code>H5S_sel_type</code>, @@ -913,14 +935,17 @@ END SUBROUTINE h5sget_select_type_f <code>H5S_UNLIMITED</code> (</code>-1</code>), the maximum size of that dimension is unlimited. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Identifier of the dataspace object to query - <dt><em>hsize_t *</em><code>dims</code> - <dd>OUT: Pointer to array to store the size of each dimension. - <dt><em>hsize_t *</em><code>maxdims</code> - <dd>OUT: Pointer to array to store the maximum size of each dimension. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id</code></td> + <td valign="top">IN: Identifier of the dataspace object to query</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>dims</code></td> + <td valign="top">OUT: Pointer to array to store the size of each dimension.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>maxdims </code></td> + <td valign="top">OUT: Pointer to array to store the maximum size of each dimension.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of dimensions in the dataspace if successful; otherwise returns a negative value. @@ -961,10 +986,11 @@ END SUBROUTINE h5sget_simple_extent_dims_f <dd><code>H5Sget_simple_extent_ndims</code> determines the dimensionality (or rank) of a dataspace. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>Identifier of the dataspace - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">Identifier of the dataspace</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of dimensions in the dataspace if successful; otherwise returns a negative value. @@ -1002,10 +1028,11 @@ END SUBROUTINE h5sget_simple_extent_ndims_f in a dataspace. For example, a simple 3-dimensional dataspace with dimensions 2, 3, and 4 would have 24 elements. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>ID of the dataspace object to query - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">ID of the dataspace object to query</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of elements in the dataspace if successful; otherwise returns 0. @@ -1047,10 +1074,11 @@ END SUBROUTINE h5sget_simple_extent_npoints_f <code>H5S_SIMPLE</code>, or <code>H5S_NONE</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>Dataspace identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">Dataspace identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a dataspace class name if successful; otherwise H5S_NO_CLASS (-1). @@ -1092,10 +1120,11 @@ END SUBROUTINE h5sget_simple_extent_type_f a simple dataspace. [Currently, all dataspace objects are simple dataspaces, complex dataspace support will be added in the future] <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>Identifier of the dataspace to query - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">Identifier of the dataspace to query</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>When successful, returns a positive value, for <code>TRUE</code>, or <code>0</code> (zero), for <code>FALSE</code>. @@ -1145,12 +1174,14 @@ END SUBROUTINE h5sis_simple_f to different locations within a dataspace without requiring it to be redefined. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: The identifier for the dataspace object to reset. - <dt><em>const hssize_t *</em><code>offset</code> - <dd>IN: The offset at which to position the selection. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id</code></td> + <td valign="top">IN: The identifier for the dataspace object to reset.</td></tr> + <tr> + <td valign="top"><em>const hssize_t *</em><code>offset </code></td> + <td valign="top">IN: The offset at which to position the selection.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1194,11 +1225,12 @@ END SUBROUTINE h5soffset_simple_f <code>space_id</code>. <tt>H5S_SELECT_ALL</tt> selects the entire dataspace for any dataspace it is applied to. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: The identifier for the dataspace in which the - selection is being made. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">IN: The identifier for the dataspace in which the + selection is being made.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1284,18 +1316,22 @@ END SUBROUTINE h5sselect_all_f the selection ordering is reset to C array ordering. --> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>Identifier of the dataspace. - <dt><em>H5S_seloper_t</em> <code>op</code> - <dd>Operator specifying how the new selection is to be - combined with the existing selection for the dataspace. - <dt><em>const size_t</em> <code>num_elements</code> - <dd>Number of elements to be selected. - <dt><em>const hssize_t *</em><code>coord</code>[ ] - <dd>A 2-dimensional array of 0-based values specifying the - coordinates of the elements being selected. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id</code></td> + <td valign="top">Identifier of the dataspace.</td></tr> + <tr> + <td valign="top"><em>H5S_seloper_t</em> <code>op</code></td> + <td valign="top">Operator specifying how the new selection is to be + combined with the existing selection for the dataspace.</td></tr> + <tr> + <td valign="top"><em>const size_t</em> <code>num_elements </code></td> + <td valign="top">Number of elements to be selected.</td></tr> + <tr> + <td valign="top"><em>const hssize_t *</em><code>coord</code>[ ]</td> + <td valign="top">A 2-dimensional array of 0-based values specifying the + coordinates of the elements being selected.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1313,7 +1349,9 @@ SUBROUTINE h5sselect_elements_f(space_id, operator, num_elements, & INTEGER(HSSIZE_T), DIMENSION(*,*), INTENT(IN) :: coord ! Array with the coordinates ! of the selected elements: - ! coord(num_elements, rank) + ! coord(num_elements, rank)</pre> +<!-- NEW PAGE --> +<pre> INTEGER, INTENT(OUT) :: hdferr ! Error code ! 0 on success and -1 on failure END SUBROUTINE h5sselect_elements_f @@ -1438,20 +1476,26 @@ END SUBROUTINE h5sselect_elements_f Regions selected with this function call default to C order iteration when I/O is performed. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: Identifier of dataspace selection to modify - <dt><em>H5S_seloper_t</em> <code>op</code> - <dd>IN: Operation to perform on current selection. - <dt><em>const hssize_t *</em><code>start</code> - <dd>IN: Offset of start of hyperslab - <dt><em>const hsize_t *</em><code>count</code> - <dd>IN: Number of blocks included in hyperslab. - <dt><em>const hsize_t *</em><code>stride</code> - <dd>IN: Hyperslab stride. - <dt><em>const hsize_t *</em><code>block</code> - <dd>IN: Size of block in hyperslab. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id</code></td> + <td valign="top">IN: Identifier of dataspace selection to modify</td></tr> + <tr> + <td valign="top"><em>H5S_seloper_t</em> <code>op</code></td> + <td valign="top">IN: Operation to perform on current selection.</td></tr> + <tr> + <td valign="top"><em>const hssize_t *</em><code>start</code></td> + <td valign="top">IN: Offset of start of hyperslab</td></tr> + <tr> + <td valign="top"><em>const hsize_t *</em><code>count</code></td> + <td valign="top">IN: Number of blocks included in hyperslab.</td></tr> + <tr> + <td valign="top"><em>const hsize_t *</em><code>stride </code></td> + <td valign="top">IN: Hyperslab stride.</td></tr> + <tr> + <td valign="top"><em>const hsize_t *</em><code>block</code></td> + <td valign="top">IN: Size of block in hyperslab.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1501,11 +1545,12 @@ END SUBROUTINE h5sselect_hyperslab_f <dd><code>H5Sselect_none</code> resets the selection region for the dataspace <code>space_id</code> to include no elements. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>IN: The identifier for the dataspace in which the - selection is being reset. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">IN: The identifier for the dataspace in which the + selection is being reset.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1542,10 +1587,11 @@ END SUBROUTINE h5sselect_none_f for the dataspace <code>space_id</code> is within the extent of the dataspace if the current offset for the dataspace is used. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>The identifier for the dataspace being queried. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">The identifier for the dataspace being queried.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a positive value, for <code>TRUE</code>, if the selection is contained within the extent @@ -1587,11 +1633,12 @@ END SUBROUTINE h5sselect_valid_f <dd><code>H5Sset_extent_none</code> removes the extent from a dataspace and sets the type to <tt>H5S_NO_CLASS</tt>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>The identifier for the dataspace from which - the extent is to be removed. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id </code></td> + <td valign="top">The identifier for the dataspace from which + the extent is to be removed.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1644,16 +1691,20 @@ END SUBROUTINE h5sset_extent_none_f type is set to <code>H5S_SIMPLE</code>, and the extent is set as specified. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>space_id</code> - <dd>Dataspace identifier. - <dt><em>int</em> <code>rank</code> - <dd>Rank, or dimensionality, of the dataspace. - <dt><em>const hsize_t *</em><code>current_size</code> - <dd>Array containing current size of dataspace. - <dt><em>const hsize_t *</em><code>maximum_size</code> - <dd>Array containing maximum size of dataspace. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>space_id</code></td> + <td valign="top">Dataspace identifier.</td> + <tr> + <td valign="top"><em>int</em> <code>rank</code></td> + <td valign="top">Rank, or dimensionality, of the dataspace.</td> + <tr> + <td valign="top"><em>const hsize_t *</em><code>current_size </code></td> + <td valign="top">Array containing current size of dataspace.</td> + <tr> + <td valign="top"><em>const hsize_t *</em><code>maximum_size</code></td> + <td valign="top">Array containing maximum size of dataspace.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a dataspace identifier if successful; otherwise returns a negative value. @@ -1800,14 +1851,13 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> +<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 29 October 2003"); +document.writeln("Last modified: 24 February 2004"); --> </SCRIPT> diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html index 880faa9..6846776 100644 --- a/doc/html/RM_H5T.html +++ b/doc/html/RM_H5T.html @@ -61,8 +61,7 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><center> +<hr><!-- #EndLibraryItem --><center> <h1>H5T: Datatype Interface</h1> </center> @@ -409,20 +408,24 @@ in the <cite>HDF5 User's Guide</cite> for further information, including a compl permutation, i.e. C versus FORTRAN array order. <b><i>(The parameter </i><code>perm</code><i> is currently unused and is not yet implemented.)</i></b> - <p> + <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>base</code> - <dd>IN: Datatype identifier for the array base datatype. - <dt><em>int</em> <code>rank</code> - <dd>IN: Rank of the array. - <dt><em>const hsize_t</em> <code>dims[/*rank*/]</code> - <dd>IN: Size of each array dimension. - <dt><em>const int</em> <code>perm[/*rank*/]</code> - <dd>IN: Dimension permutation. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>base</code></td> + <td valign="top">IN: Datatype identifier for the array base datatype.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>rank</code></td> + <td valign="top">IN: Rank of the array.</td></tr> + <tr> + <td valign="top"><em>const hsize_t</em> <code>dims[/*rank*/] </code></td> + <td valign="top">IN: Size of each array dimension.</td></tr> + <tr> + <td valign="top"><em>const int</em> <code>perm[/*rank*/]</code></td> + <td valign="top">IN: Dimension permutation. - <b><i>(Currently not implemented.)</i></b> - </dl> + <b><i>(Currently not implemented.)</i></b></td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -463,10 +466,11 @@ END SUBROUTINE h5tarray_create_f through the datatype identifier is illegal. Failure to release a datatype with this call will result in resource leaks. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to release. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to release.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -508,14 +512,17 @@ END SUBROUTINE h5tclose_f which, when combined with <code>name</code>, refers to a new named datatype. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: A file or group identifier. - <dt><em>const char *</em> <code>name</code> - <dd>IN: A datatype name. - <dt><em>hid_t</em> <code>type</code> - <dd>IN: A datatype identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: A file or group identifier.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>name </code></td> + <td valign="top">IN: A datatype name.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>type</code></td> + <td valign="top">IN: A datatype identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -558,10 +565,11 @@ END SUBROUTINE h5tcommit_f return committed datatypes with <code>H5Dget_type()</code> are able to share the datatype with other datasets in the same file. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type</code> - <dd>IN: Datatype identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type </code></td> + <td valign="top">IN: Datatype identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>When successful, returns a positive value, for <code>TRUE</code>, if the datatype has been committed, or <code>0</code> (zero), @@ -620,20 +628,26 @@ END SUBROUTINE h5tcommitted_f As of Release 1.2, this parameter is only used to pass along the variable-length datatype custom allocation information. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>src_id</code> - <dd>Identifier for the source datatype. - <dt><em>hid_t</em> <code>dst_id</code> - <dd>Identifier for the destination datatype. - <dt><em>hsize_t</em> <code>nelmts</code> - <dd>Size of array <code>buf</code>. - <dt><em>void *</em><code>buf</code> - <dd>Array containing pre- and post-conversion values. - <dt><em>void *</em><code>background</code> - <dd>Optional background buffer. - <dt><em>hid_t</em> <code>plist_id</code> - <dd>Dataset transfer property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>src_id</code></td> + <td valign="top">Identifier for the source datatype.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>dst_id</code></td> + <td valign="top">Identifier for the destination datatype.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>nelmts</code></td> + <td valign="top">Size of array <code>buf</code>.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>buf</code></td> + <td valign="top">Array containing pre- and post-conversion values.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>background </code></td> + <td valign="top">Optional background buffer.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">Dataset transfer property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -730,12 +744,13 @@ SUBROUTINE </dl> </ul> --> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to copy. Can be a datatype + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to copy. Can be a datatype identifier, a predefined datatype (defined in - <code>H5Tpublic.h</code>), or a dataset identifier. - </dl> + <code>H5Tpublic.h</code>), or a dataset identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a datatype identifier if successful; otherwise returns a negative value @@ -786,12 +801,14 @@ END SUBROUTINE h5tcopy_f The datatype identifier returned from this function should be released with <code>H5Tclose</code> or resource leaks will result. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5T_class_t</em> <code>class</code> - <dd>Class of datatype to create. - <dt><em>size_t</em> <code>size</code> - <dd>The number of bytes in the datatype to create. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5T_class_t</em> <code>class </code></td> + <td valign="top">Class of datatype to create.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>size</code></td> + <td valign="top">The number of bytes in the datatype to create.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns datatype identifier if successful; otherwise returns a negative value. @@ -842,12 +859,14 @@ END SUBROUTINE h5tcreate_f Valid class identifiers are as defined in <a href="#Datatype-GetClass"><code>H5Tget_class</code></a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dtype_id</code> - <dd>Datatype identifier. - <dt><em>H5T_class_t</em><code>dtype_class</code> - <dd>Datatype class. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dtype_id</code></td> + <td valign="top">Datatype identifier.</td></tr> + <tr> + <td valign="top"><em>H5T_class_t</em> <code>dtype_class </code></td> + <td valign="top">Datatype class.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns <code>TRUE</code> or <code>FALSE</code> if successful; otherwise returns a negative value. @@ -883,10 +902,11 @@ SUBROUTINE based on the specified base datatype, <code>parent_id</code>, which must be an integer type. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>parent_id</code> - <dd>IN: Datatype identifier for the base datatype. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>parent_id </code></td> + <td valign="top">IN: Datatype identifier for the base datatype.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the datatype identifier for the new enumeration datatype if successful; otherwise returns a negative value. @@ -937,14 +957,17 @@ END SUBROUTINE h5tenum_create_f <code>value</code> points to data which is of the datatype defined when the enumeration datatype was created. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type</code> - <dd>IN: Datatype identifier for the enumeration datatype. - <dt><em>const char</em> *<code>name</code> - <dd>IN: Name of the new member. - <dt><em>void</em> *<code>value</code> - <dd>IN: Pointer to the value of the new member. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type</code></td> + <td valign="top">IN: Datatype identifier for the enumeration datatype.</td></tr> + <tr> + <td valign="top"><em>const char</em> *<code>name </code></td> + <td valign="top">IN: Name of the new member.</td></tr> + <tr> + <td valign="top"><em>void</em> *<code>value</code></td> + <td valign="top">IN: Pointer to the value of the new member.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -993,16 +1016,20 @@ END SUBROUTINE h5tenum_insert_f many characters as possible are copied (not null terminated) and the function fails. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type</code> - <dd>IN: Enumeration datatype identifier. - <dt><em>void</em> *<code>value</code>, - <dd>IN: Value of the enumeration datatype. - <dt><em>char</em> *<code>name</code>, - <dd>OUT: Buffer for output of the symbol name. - <dt><em>size_t</em> <code>size</code> - <dd>IN: Anticipated size of the symbol name, in bytes (characters). - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type</code></td> + <td valign="top">IN: Enumeration datatype identifier.</td></tr> + <tr> + <td valign="top"><em>void</em> *<code>value, </code></td> + <td valign="top">IN: Value of the enumeration datatype.</td></tr> + <tr> + <td valign="top"><em>char</em> *<code>name</code>,</td> + <td valign="top">OUT: Buffer for output of the symbol name.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>size</code></td> + <td valign="top">IN: Anticipated size of the symbol name, in bytes (characters).</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value @@ -1051,14 +1078,17 @@ END SUBROUTINE h5tenum_nameof_f as large as the value of <code>H5Tget_size(type)</code> in order to hold the result. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type</code> - <dd>IN: Enumeration datatype identifier. - <dt><em>const char</em> *<code>name</code>, - <dd>IN: Symbol name of the enumeration datatype. - <dt><em>void</em> *<code>value</code>, - <dd>OUT: Buffer for output of the value of the enumeration datatype. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type</code></td> + <td valign="top">IN: Enumeration datatype identifier.</td></tr> + <tr> + <td valign="top"><em>const char</em> *<code>name, </code></td> + <td valign="top">IN: Symbol name of the enumeration datatype.</td></tr> + <tr> + <td valign="top"><em>void</em> *<code>value</code>,</td> + <td valign="top">OUT: Buffer for output of the value of the enumeration datatype.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1097,12 +1127,14 @@ END SUBROUTINE h5tenum_valueof_f <dd><code>H5Tequal</code> determines whether two datatype identifiers refer to the same datatype. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id1</code> - <dd>Identifier of datatype to compare. - <dt><em>hid_t</em> <code>type_id2</code> - <dd>Identifier of datatype to compare. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id1 </code></td> + <td valign="top">Identifier of datatype to compare.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id2</code></td> + <td valign="top">Identifier of datatype to compare.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>When successful, returns a positive value, for <code>TRUE</code>, if the datatype identifiers refer to the same datatype, @@ -1150,14 +1182,17 @@ END SUBROUTINE h5tequal_f by the soft type conversion function of this path when the conversion function was installed on the path. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>src_id</code> - <dd>IN: Identifier for the source datatype. - <dt><em>hid_t</em> <code>dst_id</code> - <dd>IN: Identifier for the destination datatype. - <dt><em>H5T_cdata_t **</em><code>pcdata</code> - <dd>OUT: Pointer to type conversion data. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>src_id</code></td> + <td valign="top">IN: Identifier for the source datatype.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>dst_id</code></td> + <td valign="top">IN: Identifier for the destination datatype.</td></tr> + <tr> + <td valign="top"><em>H5T_cdata_t **</em><code>pcdata </code></td> + <td valign="top">OUT: Pointer to type conversion data.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a pointer to a suitable conversion function if successful. Otherwise returns NULL. @@ -1198,14 +1233,17 @@ SUBROUTINE The dimension permutations, i.e., C versus FORTRAN array order, are returned in the array <code>perm</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>adtype_id</code> - <dd>IN: Datatype identifier of array object. - <dt><em>hsize_t *</em><code>dims[]</code> - <dd>OUT: Sizes of array dimensions. - <dt><em>int *</em><code>perm[]</code> - <dd>OUT: Dimension permutations. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>adtype_id </code></td> + <td valign="top">IN: Datatype identifier of array object.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>dims[]</code></td> + <td valign="top">OUT: Sizes of array dimensions.</td></tr> + <tr> + <td valign="top"><em>int *</em><code>perm[]</code></td> + <td valign="top">OUT: Dimension permutations.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the non-negative number of dimensions of the array type if successful; otherwise returns a negative value. @@ -1244,10 +1282,11 @@ END SUBROUTINE h5tget_array_dims_f <dd><code>H5Tget_array_ndims</code> returns the rank, the number of dimensions, of an array datatype object. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>adtype_id</code> - <dd>IN: Datatype identifier of array object. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>adtype_id </code></td> + <td valign="top">IN: Datatype identifier of array object.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the rank of the array if successful; otherwise returns a negative value. @@ -1297,10 +1336,11 @@ END SUBROUTINE h5tget_array_ndims_f <li><code>H5T_ARRAY</code> </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns datatype class identifier if successful; otherwise <code>H5T_NO_CLASS</code> (-1). @@ -1347,15 +1387,16 @@ END SUBROUTINE h5tget_class_f <dt><strong>Description:</strong> <dd><code>H5Tget_cset</code> retrieves the character set type of a string datatype. Valid character set types are: - <ul> <dl> + <dl><ul> <dt>H5T_CSET_ASCII (<code>0</code>) <dd>Character set is US ASCII - </dl> </ul> + </ul></dl> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid character set type if successful; otherwise <code>H5T_CSET_ERROR</code> (-1). @@ -1394,10 +1435,11 @@ END SUBROUTINE h5tget_cset_f <dt><strong>Description:</strong> <dd><code>H5Tget_ebias</code> retrieves the exponent bias of a floating-point type. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the bias if successful; otherwise 0. @@ -1443,20 +1485,26 @@ END SUBROUTINE h5tget_ebias_f numbered with the least significant bit number zero. Any (or even all) of the arguments can be null pointers. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>IN: Identifier of datatype to query. - <dt><em>size_t *</em><code>spos</code> - <dd>OUT: Pointer to location to return floating-point sign bit. - <dt><em>size_t *</em><code>epos</code> - <dd>OUT: Pointer to location to return exponent bit-position. - <dt><em>size_t *</em><code>esize</code> - <dd>OUT: Pointer to location to return size of exponent in bits. - <dt><em>size_t *</em><code>mpos</code> - <dd>OUT: Pointer to location to return mantissa bit-position. - <dt><em>size_t *</em><code>msize</code> - <dd>OUT: Pointer to location to return size of mantissa in bits. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">IN: Identifier of datatype to query.</td></tr> + <tr> + <td valign="top"><em>size_t *</em><code>spos</code></td> + <td valign="top">OUT: Pointer to location to return floating-point sign bit.</td></tr> + <tr> + <td valign="top"><em>size_t *</em><code>epos</code></td> + <td valign="top">OUT: Pointer to location to return exponent bit-position.</td></tr> + <tr> + <td valign="top"><em>size_t *</em><code>esize</code></td> + <td valign="top">OUT: Pointer to location to return size of exponent in bits.</td></tr> + <tr> + <td valign="top"><em>size_t *</em><code>mpos</code></td> + <td valign="top">OUT: Pointer to location to return mantissa bit-position.</td></tr> + <tr> + <td valign="top"><em>size_t *</em><code>msize</code></td> + <td valign="top">OUT: Pointer to location to return size of mantissa in bits.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1505,10 +1553,11 @@ END SUBROUTINE h5tget_fields_f <dd>Leave background alone. </dl> </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid padding type if successful; otherwise <code>H5T_PAD_ERROR</code> (-1). @@ -1553,12 +1602,14 @@ END SUBROUTINE h5tget_inpad_f <code>H5Tget_member_class</code> returns the datatype class of the compound datatype member specified by <code>member_no</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>cdtype_id</code> - <dd>IN: Datatype identifier of compound object. - <dt><em>int</em> <code>member_no</code> - <dd>IN: Compound object member number. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>cdtype_id </code></td> + <td valign="top">IN: Datatype identifier of compound object.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>member_no</code></td> + <td valign="top">IN: Compound object member number.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the datatype class, a non-negative value, if successful; otherwise returns a negative value. @@ -1599,12 +1650,14 @@ END SUBROUTINE h5tget_inpad_f with index values of 0 through <em>N</em>-1, where <em>N</em> is the value returned by <code>H5Tget_nmembers</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - <dt><em>const char *</em> <code>field_name</code> - <dd>Name of the field or member whose index is to be retrieved. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>field_name </code></td> + <td valign="top">Name of the field or member whose index is to be retrieved.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid field or member index if successful; otherwise returns a negative value. @@ -1650,13 +1703,15 @@ END SUBROUTINE h5tget_inpad_f allocated with <code>malloc()</code> and the caller is responsible for freeing the memory used. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - <dt><em>int</em> <code>field_idx</code> - <dd>Zero-based index of the field or element whose name - is to be retrieved. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>field_idx</code></td> + <td valign="top">Zero-based index of the field or element whose name + is to be retrieved.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid pointer to a string allocated with <code>malloc()</code> if successful; @@ -1701,12 +1756,14 @@ END SUBROUTINE h5tget_member_name_f compound datatype with respect to the beginning of the compound data type datum. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - <dt><em>int</em> <code>memb_no</code> - <dd>Number of the field whose offset is requested. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>memb_no</code></td> + <td valign="top">Number of the field whose offset is requested.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the byte offset of the field if successful; otherwise returns <code>0</code> (zero). @@ -1750,12 +1807,14 @@ END SUBROUTINE h5tget_member_offset_f <dd><code>H5Tget_member_type</code> returns the datatype of the specified member. The caller should invoke H5Tclose() to release resources associated with the type. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - <dt><em>int</em> <code>field_idx</code> - <dd>Field index (0-based) of the field type to retrieve. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>field_idx</code></td> + <td valign="top">Field index (0-based) of the field type to retrieve.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the identifier of a copy of the datatype of the field if successful; @@ -1801,15 +1860,18 @@ END SUBROUTINE h5tget_member_type_f The member value is returned in a user-supplied buffer pointed to by <code>value</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type</code> - <dd>IN: Datatype identifier for the enumeration datatype. - <dt><em>int</em> <code>memb_no</code>, - <dd>IN: Number of the enumeration datatype member. - <dt><em>void</em> *<code>value</code> - <dd>OUT: Pointer to a buffer for output of the - value of the enumeration datatype member. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type</code></td> + <td valign="top">IN: Datatype identifier for the enumeration datatype.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>memb_no</code>,</td> + <td valign="top">IN: Number of the enumeration datatype member.</td></tr> + <tr> + <td valign="top"><em>void</em> *<code>value </code></td> + <td valign="top">OUT: Pointer to a buffer for output of the + value of the enumeration datatype member.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1903,12 +1965,15 @@ END SUBROUTINE h5tget_member_value_f should eventually be closed by calling <code>H5Tclose</code> to release resources. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Datatype identifier for the dataset datatype. - <dt><em>H5T_direction_t</em> <code>direction</code> - <dd>Direction of search. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">Datatype identifier for the dataset datatype.</td></tr> + <tr> + <td valign="top"><em>H5T_direction_t</em> <code>direction </code></td> + <td valign="top">Direction of search.</td></tr> + </table></ul> +<!-- NEW PAGE --> <dt><strong>Returns:</strong> <dd>Returns the native datatype identifier for the specified dataset datatype if successful; @@ -1944,10 +2009,11 @@ SUBROUTINE the number of fields in a compound datatype or the number of members of an enumeration datatype. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of elements if successful; otherwise returns a negative value. @@ -1993,10 +2059,11 @@ END SUBROUTINE h5tget_nmembers_f <dd>Mantissa is not normalized </dl> </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid normalization type if successful; otherwise <code>H5T_NORM_ERROR</code> (-1). @@ -2088,10 +2155,11 @@ END SUBROUTINE h5tget_norm_f </tr> </table> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns an offset value if successful; otherwise returns a negative value. @@ -2139,10 +2207,11 @@ END SUBROUTINE h5tget_offset_f <dd>VAX mixed byte ordering (not currently supported). </dl></ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a byte order constant if successful; otherwise <code>H5T_ORDER_ERROR</code> (-1). @@ -2235,16 +2304,19 @@ SUBROUTINE <dd>Leave background alone. </dl> </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>IN: Identifier of datatype to query. - <dt><em>H5T_pad_t *</em> <code>lsb</code> - <dd>OUT: Pointer to location to return least-significant - bit padding type. - <dt><em>H5T_pad_t *</em> <code>msb</code> - <dd>OUT: Pointer to location to return most-significant - bit padding type. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">IN: Identifier of datatype to query.</td></tr> + <tr> + <td valign="top"><em>H5T_pad_t *</em> <code>lsb </code></td> + <td valign="top">OUT: Pointer to location to return least-significant + bit padding type.</td></tr> + <tr> + <td valign="top"><em>H5T_pad_t *</em> <code>msb</code></td> + <td valign="top">OUT: Pointer to location to return most-significant + bit padding type.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -2292,10 +2364,11 @@ END SUBROUTINE h5tget_pad_f precision is the number of significant bits which, unless padding is present, is 8 times larger than the value returned by H5Tget_size(). <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of significant bits if successful; otherwise 0. @@ -2338,10 +2411,11 @@ END SUBROUTINE h5tget_precision_f <dd>Two's complement signed integer type. </dl> </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid sign type if successful; otherwise <code>H5T_SGN_ERROR</code> (-1). @@ -2385,10 +2459,11 @@ END SUBROUTINE h5tget_sign_f <dt><strong>Description:</strong> <dd><code>H5Tget_size</code> returns the size of a datatype in bytes. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the size of the datatype in bytes if successful; otherwise 0. @@ -2427,10 +2502,11 @@ END SUBROUTINE h5tget_size_f for a string datatype, as defined in <a href="#Datatype-SetStrpad"><code>H5Tset_strpad</code></a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid string storage mechanism if successful; otherwise <code>H5T_STR_ERROR</code> (-1). @@ -2475,10 +2551,11 @@ END SUBROUTINE h5tget_strpad_f <P> In the case of an enumeration type, the return value is an integer type. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type</code> - <dd>Datatype identifier for the derived datatype. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type </code></td> + <td valign="top">Datatype identifier for the derived datatype.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the datatype identifier for the base datatype if successful; otherwise returns a negative value. @@ -2518,10 +2595,11 @@ END SUBROUTINE h5tget_super_f The tag is returned via a pointer to an allocated string, which the caller must free. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Datatype identifier for the opaque datatype. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Datatype identifier for the opaque datatype.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a pointer to an allocated string if successful; otherwise returns <code>NULL</code>. @@ -2570,16 +2648,20 @@ END SUBROUTINE h5tget_tag_f Note: Members of a compound datatype do not have to be atomic datatypes; a compound datatype can have a member which is a compound datatype. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of compound datatype to modify. - <dt><em>const char *</em> <code>name</code> - <dd>Name of the field to insert. - <dt><em>size_t</em> <code>offset</code> - <dd>Offset in memory structure of the field to insert. - <dt><em>hid_t</em> <code>field_id</code> - <dd>Datatype identifier of the field to insert. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">Identifier of compound datatype to modify.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>name </code></td> + <td valign="top">Name of the field to insert.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>offset</code></td> + <td valign="top">Offset in memory structure of the field to insert.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>field_id</code></td> + <td valign="top">Datatype identifier of the field to insert.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -2623,10 +2705,11 @@ END SUBROUTINE h5tinsert_f This function can be used to distinguish between fixed and variable-length string datatypes. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dtype_id</code> - <dd>Datatype identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dtype_id </code></td> + <td valign="top">Datatype identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns <code>TRUE</code> or <code>FALSE</code> if successful; otherwise returns a negative value. @@ -2670,10 +2753,11 @@ END SUBROUTINE h5tis_variable_str_f inadvertently change or delete a predefined type. Once a datatype is locked it can never be unlocked. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to lock. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to lock.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -2711,12 +2795,15 @@ SUBROUTINE group identifier. The identifier should eventually be closed by calling <code>H5Tclose</code> to release resources. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: A file or group identifier. - <dt><em>const char *</em> <code>name</code> - <dd>IN: A datatype name, defined within the file or group identified by <code>loc_id</code>. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top">IN: A file or group identifier.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>name </code></td> + <td valign="top">IN: A datatype name, defined within the file + or group identified by <code>loc_id</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a named datatype identifier if successful; otherwise returns a negative value. @@ -2756,10 +2843,11 @@ END SUBROUTINE h5topen_f <dd><code>H5Tpack</code> recursively removes padding from within a compound datatype to make it more efficient (space-wise) to store that data. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to modify. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to modify.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -2853,19 +2941,24 @@ END SUBROUTINE h5tpack_f section of “The Datatype Interface (H5T)” in the <cite>HDF5 User's Guide</cite>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5T_pers_t</em> <code>pers</code> - <dd><code>H5T_PERS_HARD</code> for hard conversion functions; - <code>H5T_PERS_SOFT</code> for soft conversion functions. - <dt><em>const char *</em> <code>name</code> - <dd>Name displayed in diagnostic output. - <dt><em>hid_t</em> <code>src_id</code> - <dd>Identifier of source datatype. - <dt><em>hid_t</em> <code>dst_id</code> - <dd>Identifier of destination datatype. - <dt><em>H5T_conv_t</em> <code>func</code> - <dd>Function to convert between source and destination datatypes. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5T_pers_t</em> <code>pers</code></td> + <td valign="top"><code>H5T_PERS_HARD</code> for hard conversion functions; + <code>H5T_PERS_SOFT</code> for soft conversion functions.</td></tr> + <tr> + <td valign="top"><em>const char *</em> <code>name</code></td> + <td valign="top">Name displayed in diagnostic output.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>src_id</code></td> + <td valign="top">Identifier of source datatype.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>dst_id</code></td> + <td valign="top">Identifier of destination datatype.</td></tr> + <tr> + <td valign="top"><em>H5T_conv_t</em> <code>func </code></td> + <td valign="top">Function to convert between source and destination datatypes.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -2907,12 +3000,14 @@ SUBROUTINE <dd>Character set is US ASCII. </dl> </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to modify. - <dt><em>H5T_cset_t</em> <code>cset</code> - <dd>Character set type. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">Identifier of datatype to modify.</td></tr> + <tr> + <td valign="top"><em>H5T_cset_t</em> <code>cset </code></td> + <td valign="top">Character set type.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -2952,12 +3047,14 @@ END SUBROUTINE h5tset_cset_f <dt><strong>Description:</strong> <dd><code>H5Tset_ebias</code> sets the exponent bias of a floating-point type. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to set. - <dt><em>size_t</em> <code>ebias</code> - <dd>Exponent bias value. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to set.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>ebias</code></td> + <td valign="top">Exponent bias value.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3006,21 +3103,27 @@ END SUBROUTINE h5tset_ebias_f <P>Fields are not allowed to extend beyond the number of bits of precision, nor are they allowed to overlap with one another. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to set. - <dt><em>size_t</em> <code>spos</code> - <dd>Sign position, i.e., the bit offset of the floating-point - sign bit. - <dt><em>size_t</em> <code>epos</code> - <dd>Exponent bit position. - <dt><em>size_t</em> <code>esize</code> - <dd>Size of exponent in bits. - <dt><em>size_t</em> <code>mpos</code> - <dd>Mantissa bit position. - <dt><em>size_t</em> <code>msize</code> - <dd>Size of mantissa in bits. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to set.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>spos</code></td> + <td valign="top">Sign position, i.e., the bit offset of the floating-point + sign bit.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>epos</code></td> + <td valign="top">Exponent bit position.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>esize</code></td> + <td valign="top">Size of exponent in bits.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>mpos</code></td> + <td valign="top">Mantissa bit position.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>msize</code></td> + <td valign="top">Size of mantissa in bits.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3072,12 +3175,14 @@ END SUBROUTINE h5tset_fields_f <dd>Leave background alone. </dl> </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to modify. - <dt><em>H5T_pad_t</em> <code>pad</code> - <dd>Padding type. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">Identifier of datatype to modify.</td></tr> + <tr> + <td valign="top"><em>H5T_pad_t</em> <code>pad </code></td> + <td valign="top">Padding type.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3129,12 +3234,14 @@ END SUBROUTINE h5tset_inpad_f <dd>Mantissa is not normalized </dl> </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to set. - <dt><em>H5T_norm_t</em> <code>norm</code> - <dd>Mantissa normalization type. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">Identifier of datatype to set.</td></tr> + <tr> + <td valign="top"><em>H5T_norm_t</em> <code>norm </code></td> + <td valign="top">Mantissa normalization type.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3234,12 +3341,14 @@ the value from hanging over the edge of the datatype. <P>The offset of an H5T_STRING cannot be set to anything but zero. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to set. - <dt><em>size_t</em> <code>offset</code> - <dd>Offset of first significant bit. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to set.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>offset</code></td> + <td valign="top">Offset of first significant bit.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3286,12 +3395,14 @@ END SUBROUTINE h5tset_offset_f <dd>VAX mixed byte ordering (not currently supported). </dl> </ul> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to set. - <dt><em>H5T_order_t</em> <code>order</code> - <dd>Byte ordering constant. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">Identifier of datatype to set.</td></tr> + <tr> + <td valign="top"><em>H5T_order_t</em> <code>order </code></td> + <td valign="top">Byte ordering constant.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3344,10 +3455,11 @@ END SUBROUTINE h5tset_order_f <p> The NULL pointer may be passed to remove the overflow handler. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5T_overflow_t</em> <code>func</code> - <dd>Overflow function. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5T_overflow_t</em> <code>func </code></td> + <td valign="top">Overflow function.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3381,23 +3493,26 @@ SUBROUTINE <dd>Sets the least and most-significant bits padding types. <dt><strong>Description:</strong> <dd><code>H5Tset_pad</code> sets the least and most-significant bits padding types. - <ul> <dl> + <dl> <ul> <dt>H5T_PAD_ZERO (<code>0</code>) <dd>Set background to zeros. <dt>H5T_PAD_ONE (<code>1</code>) <dd>Set background to ones. <dt>H5T_PAD_BACKGROUND (<code>2</code>) <dd>Leave background alone. - </dl> </ul> + </ul> </dl> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to set. - <dt><em>H5T_pad_t</em> <code>lsb</code> - <dd>Padding type for least-significant bits. - <dt><em>H5T_pad_t</em> <code>msb</code> - <dd>Padding type for most-significant bits. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">Identifier of datatype to set.</td></tr> + <tr> + <td valign="top"><em>H5T_pad_t</em> <code>lsb </code></td> + <td valign="top">Padding type for least-significant bits.</td></tr> + <tr> + <td valign="top"><em>H5T_pad_t</em> <code>msb</code></td> + <td valign="top">Padding type for most-significant bits.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3454,12 +3569,14 @@ END SUBROUTINE h5tset_pad_f locations and sizes of the sign, mantissa, and exponent fields first. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to set. - <dt><em>size_t</em> <code>precision</code> - <dd>Number of bits of precision for datatype. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">Identifier of datatype to set.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>precision </code></td> + <td valign="top">Number of bits of precision for datatype.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3502,12 +3619,14 @@ END SUBROUTINE h5tset_precision_f <dd>Two's complement signed integer type. </dl> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to set. - <dt><em>H5T_sign_t</em> <code>sign</code> - <dd>Sign type. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">Identifier of datatype to set.</td></tr> + <tr> + <td valign="top"><em>H5T_sign_t</em> <code>sign </code></td> + <td valign="top">Sign type.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3563,12 +3682,14 @@ END SUBROUTINE h5tset_sign_f to 8*<code>size</code>. A compound datatype may increase in size, but may not shrink. All datatypes must have a positive size. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to change size. - <dt><em>size_t</em> <code>size</code> - <dd>Size in bytes to modify datatype. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id </code></td> + <td valign="top">Identifier of datatype to change size.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>size</code></td> + <td valign="top">Size in bytes to modify datatype.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3635,12 +3756,14 @@ END SUBROUTINE h5tset_size_f <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>Identifier of datatype to modify. - <dt><em>H5T_str_t</em> <code>strpad</code> - <dd>String padding type. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">Identifier of datatype to modify.</td></tr> + <tr> + <td valign="top"><em>H5T_str_t</em> <code>strpad </code></td> + <td valign="top">String padding type.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3684,13 +3807,15 @@ END SUBROUTINE h5tset_strpad_f <dd><code>H5Tset_tag</code> tags an opaque datatype <code>type_id</code> with a descriptive ASCII identifier,<code> tag</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>type_id</code> - <dd>IN: Datatype identifier for the opaque datatype to be tagged. - <dt><em>const char</em> *<code>tag</code> - <dd>IN: Descriptive ASCII string with which the - opaque datatype is to be tagged. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code></td> + <td valign="top">IN: Datatype identifier for the opaque datatype to be tagged.</td></tr> + <tr> + <td valign="top"><em>const char</em> *<code>tag </code></td> + <td valign="top">IN: Descriptive ASCII string with which the + opaque datatype is to be tagged.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3730,10 +3855,11 @@ END SUBROUTINE h5tset_tag_f The conversion function pointer type declaration is described in <a href="#Datatype-Register">H5Tregister</a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5T_conv_t</em> <code>func</code> - <dd>Function to remove from conversion paths. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5T_conv_t</em> <code>func </code></td> + <td valign="top">Function to remove from conversion paths.</td> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3777,10 +3903,11 @@ SUBROUTINE The datatype identifier returned from this function should be released with <code>H5Tclose</code> or resource leaks will result. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>base_type_id</code> - <dd>Base type of datatype to create. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>base_type_id </code></td> + <td valign="top">Base type of datatype to create.</td></tr> + </table></ul> <dt><strong>See Also:</strong> <dd><a href="RM_H5D.html#Dataset-GetVLBuf">H5Dget_vlen_buf_size</a> <dd><a href="RM_H5D.html#Dataset-VLReclaim">H5Dvlen_reclaim</a> @@ -3840,14 +3967,13 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> +<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 8 January 2004"); +document.writeln("Last modified: 24 February 2004"); --> </SCRIPT> diff --git a/doc/html/RM_H5Z.html b/doc/html/RM_H5Z.html index b6c758b..58f14a8 100644 --- a/doc/html/RM_H5Z.html +++ b/doc/html/RM_H5Z.html @@ -62,8 +62,7 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><center> +<hr><!-- #EndLibraryItem --><center> <h1>H5Z: Filter and Compression Interface</h1> </center> @@ -158,10 +157,11 @@ data compression. <dd><code>H5Zfilter_avail</code> determines whether the filter specified in <code>filter</code> is available to the application. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5Z_filter_t</em> <code>filter</code> - <dd>IN: Filter identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5Z_filter_t</em> <code>filter </code></td> + <td valign="top">IN: Filter identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -380,10 +380,11 @@ END SUBROUTINE h5zfilter_avail_f the <i>set local</i> and <i>can apply</i> callback functions first appeared in HDF5 Release 1.6. <dt><strong>Parameters:</strong> - <dl> - <dt><em>const H5Z_class_t</em> <code>filter_class</code> - <dd>IN: Struct containing filter-definition information. - </dl> + <ul><table> + <tr> + <td valign="top"><em>const H5Z_class_t</em> <code>filter_class </code></td> + <td valign="top">IN: Struct containing filter-definition information.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -420,10 +421,11 @@ END SUBROUTINE h5zfilter_avail_f specified in <code>filter</code> will no longer be available to the application. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5Z_filter_t</em> <code>filter</code> - <dd>IN: Identifier of the filter to be unregistered. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5Z_filter_t</em> <code>filter </code></td> + <td valign="top">IN: Identifier of the filter to be unregistered.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -483,14 +485,13 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> +<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 24 October 2003"); +document.writeln("Last modified: 24 February 2004"); --> </SCRIPT> diff --git a/doc/html/Tools.html b/doc/html/Tools.html index 8ee8382..767eab8 100644 --- a/doc/html/Tools.html +++ b/doc/html/Tools.html @@ -60,8 +60,7 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><center> +<hr><!-- #EndLibraryItem --><center> <h1>HDF5 Tools</h1> </center> @@ -171,9 +170,10 @@ installed with HDF5. </table> --> +<!-- NEW PAGE --> +<!-- NEW PAGE --> <p> - <hr> <dl> <dt><strong>Tool Name:</strong> <a name="Tools-Dump">h5dump</a> @@ -263,6 +263,7 @@ installed with HDF5. in opening the file. </p> +<!-- NEW PAGE --> <dt><strong>XML Output:</strong> <dd>With the <code>--xml</code> option, <code>h5dump</code> generates XML output. This output contains a complete description of the file, @@ -342,7 +343,8 @@ installed with HDF5. <dd>Offset of start of subsetting selection. <br> Default: the beginning of the dataset.</dd> - <dt><code>-S <em>L</em></code> or +<!-- NEW PAGE --> + <dt><code>-S <em>L</em></code> or <code>--stride=<em>L</em></code></dt> <dd>Hyperslab stride. <br> @@ -421,7 +423,8 @@ installed with HDF5. <blockquote> <code>h5dump --xml bobo.h5 > bobo.h5.xml</code> </blockquote> - <li>Dumping a subset of the dataset <code>/GroupFoo/databar/</code> +<!-- NEW PAGE --> + <li>Dumping a subset of the dataset <code>/GroupFoo/databar/</code> in the file <code>quux.h5</code> <blockquote> <code>h5dump -d /GroupFoo/databar --start="1,1" --stride="2,3" @@ -507,7 +510,7 @@ installed with HDF5. </dl> - +<!-- NEW PAGE --> <hr> <dl> <dt><strong>Tool Name:</strong> <a name="Tools-Ls">h5ls</a> @@ -584,7 +587,7 @@ installed with HDF5. --> </dl> - +<!-- NEW PAGE --> <hr> <dl> <dt><strong>Tool Name:</strong> <a name="Tools-Diff">h5diff</a> <em>(Beta version)</em> @@ -680,7 +683,7 @@ installed with HDF5. --> </dl> - +<!-- NEW PAGE --> <hr> <dl> <dt><strong>Tool Name:</strong> <a name="Tools-Repart">h5repart</a> @@ -730,7 +733,7 @@ installed with HDF5. --> </dl> - +<!-- NEW PAGE --> <hr> <dl> <dt><strong>Tool Name:</strong> <a name="Tools-Import">h5import</a> @@ -1007,7 +1010,8 @@ installed with HDF5. Example: <code> 4 3 4 38 </code> for a 38x4x3x4 dataset. </td></tr> - <tr valign=top align=left><td> +<!-- NEW PAGE --> + <tr valign=top align=left><td> <hr><code>PATH</code> </td><td><hr>Path of the output dataset. </td></tr> @@ -1113,7 +1117,8 @@ installed with HDF5. (Default: <code> 32</code>) </td></tr> - <tr valign=top align=left><td> +<!-- NEW PAGE --> + <tr valign=top align=left><td> <hr><code>OUTPUT-CLASS </code> </td><td><hr>A string denoting the type of output data. </td></tr> @@ -1201,7 +1206,8 @@ installed with HDF5. </td><td>Little-endian. </td></tr> - <tr valign=top align=left><td colspan="2"> +<!-- NEW PAGE --> + <tr valign=top align=left><td colspan="2"> <hr>The following options are disabled by default, making the default storage properties no chunking, no compression, no external storage, and no extensible dimensions. @@ -1283,7 +1289,8 @@ installed with HDF5. <tr valign=top align=left><td><hr></td><td><hr></td></tr> </table> - <p> +<!-- NEW PAGE --> + <p> <b>The <code>help</code> option:</b><br> The help option, expressed as one of <table width=100% border=0> @@ -1448,9 +1455,7 @@ installed with HDF5. --> </dl> - - - +<!-- NEW PAGE --> <hr> <dl> <dt><strong>Tool Name:</strong> <a name="Tools-GIF2H5">gif2h5</a> @@ -1478,7 +1483,7 @@ installed with HDF5. --> </dl> - +<!-- NEW PAGE --> <hr> <dl> <dt><strong>Tool Name:</strong> <a name="Tools-H52GIF">h52gif</a> @@ -1526,7 +1531,7 @@ installed with HDF5. --> </dl> - +<!-- NEW PAGE --> <hr> <dl> <dt><strong>Tool Name:</strong> <a name="Tools-H5toh4">h5toh4</a> @@ -1615,7 +1620,7 @@ installed with HDF5. Floating point datatypes are converted to IEEE format. <dt><strong>Note:</strong> - <dl>The <code>h5toh4</code> and <code>h4toh5</code> utilities + <dd>The <code>h5toh4</code> and <code>h4toh5</code> utilities are no longer part of the HDF5 product; they are distributed separately through the page <a href="http://hdf.ncsa.uiuc.edu/h4toh5/"> @@ -1641,7 +1646,7 @@ installed with HDF5. --> </dl> - +<!-- NEW PAGE --> <hr> <dl> <dt><strong>Tool Name:</strong> <a name="Tools-H4toh5">h4toh5</a> @@ -1737,7 +1742,7 @@ installed with HDF5. </table> </center> <dt><strong>Note:</strong> - <dl>The <code>h4toh5</code> and <code>h5toh4</code> utilities + <dd>The <code>h4toh5</code> and <code>h5toh4</code> utilities are no longer part of the HDF5 product; they are distributed separately through the page <a href="http://hdf.ncsa.uiuc.edu/h4toh5/"> @@ -1764,7 +1769,7 @@ installed with HDF5. --> </dl> - +<!-- NEW PAGE --> <hr> <dl> <dt><strong>Tool Name:</strong> <a name="Tools-Perf">h5perf</a> @@ -1856,7 +1861,9 @@ installed with HDF5. (Default: All APIs)<br><br> Example, <code>--api=mpiio,phdf5</code> specifies that the MPI I/O and parallel HDf5 APIs are to be monitored.<br><br> - <dt><code>-B</code> <em>size</em>, <code>--block-size=</code><em>size</em> + +<!-- NEW PAGE --> + <dt><code>-B</code> <em>size</em>, <code>--block-size=</code><em>size</em> <dd>Specifies the block size within the transfer buffer. (Default: 128K)<br><br> Block size versus transfer buffer size: @@ -1922,6 +1929,7 @@ installed with HDF5. <dt><code>-I</code>, <code>--interleaved</code> <dd>Sets interleaved block I/O.<br> (Default: Contiguous block I/O)<br><br> +<!-- NEW PAGE --> Interleaved vs. Contiguous blocks in a parallel environment:<br> When contiguous blocks are written to a dataset, @@ -1986,7 +1994,7 @@ installed with HDF5. --> </dl> - +<!-- NEW PAGE --> <hr> <dl> <dt><strong>Tool Name:</strong> <a name="Tools-Redeploy">h5redeploy</a> @@ -2037,7 +2045,7 @@ installed with HDF5. --> </dl> - +<!-- NEW PAGE --> <hr> <dl> <dt><strong>Tool Name:</strong> <a name="Tools-H5CC">h5cc</a> @@ -2193,7 +2201,7 @@ installed with HDF5. --> </dl> - +<!-- NEW PAGE --> <hr> <dl> <dt><strong>Tool Name:</strong> <a name="Tools-H5C++">h5c++</a> @@ -2346,14 +2354,15 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> +<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 -</address><!-- #EndLibraryItem --> - -Last modified: 30 October 2003 +</address><!-- #EndLibraryItem --><dt><dt><SCRIPT LANGUAGE="JAVASCRIPT"> +<!-- +document.writeln("Last modified: 24 February 2004"); +--> +</SCRIPT> </body> </html> |