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

[svn-r8221]

Browse Source 
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
This commit is contained in:
Frank Baker 2004-02-24 17:10:12 -05:00
parent f29e2a01e3
commit 9fb77d56b8
16 changed files with 2985 additions and 2127 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/html/Glossary.html
View File

@ -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>

10
doc/html/PredefDTypes.html
View File

@ -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>

85
doc/html/RM_H5.html
View File

@ -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&nbsp;</em><code>minnum&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;*</em><code>minnum&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>reg_global_lim&nbsp;&nbsp;&nbsp;&nbsp;</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>

208
doc/html/RM_H5A.html
View File

@ -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>&nbsp;<code>create_plist&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">IN: Identifier of creation property list. (Currently unused;
the only accepted value is <code>H5P_DEFAULT</code>.)</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns an attribute identifier if successful;
otherwise returns a negative value.
@ -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&nbsp;char&nbsp;*</em><code>name&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">IN: Name of the attribute to delete.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
@ -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>&nbsp;<code>buf_size&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">IN: The size of the buffer to store the name in.</td></tr>
<tr>
<td valign="top"><em>char *</em><code>buf</code></td>
<td valign="top">IN: Buffer to store name in.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns the length of the attribute's name, which may be
longer than <code>buf_size</code>, if successful.
@ -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>&nbsp;<code>loc_id&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">IN: Identifier of a group, dataset, or named datatype.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns the number of attributes if successful;
otherwise returns a negative value.
@ -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>&nbsp;<code>attr_id&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">IN: Identifier of an attribute.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns attribute dataspace identifier if successful;
otherwise returns a negative value.
@ -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>&nbsp;<code>attr_id&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">IN: Identifier of an attribute.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a datatype identifier if successful;
otherwise returns a negative value.
@ -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>&nbsp;<code>op&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">IN: User's function to pass each attribute to</td></tr>
<tr>
<td valign="top"><em>void *</em><code>op_data</code></td>
<td valign="top">IN/OUT: User's data to pass through to iterator operator function</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>If successful, returns the return value of the last operator
if it was non-zero, or zero if all attributes were processed.
@ -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&nbsp;int</em>&nbsp;<code>idx&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">IN: Index of the attribute to open.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns attribute identifier if successful;
otherwise returns a negative value.
@ -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&nbsp;char&nbsp;*</em><code>name&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">IN: Attribute name.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns attribute identifier if successful;
otherwise returns a negative value.
@ -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>&nbsp;<code>mem_type_id&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">IN: Identifier of the attribute datatype (in memory).</td></tr>
<tr>
<td valign="top"><em>void *</em><code>buf</code></td>
<td valign="top">OUT: Buffer for data to be read.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
@ -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>&nbsp;<code>mem_type_id&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
<td valign="top">IN: Identifier of the attribute datatype (in memory).</td></tr>
<tr>
<td valign="top"><em>const void *</em><code>buf</code></td>
<td valign="top">IN: Data to be written.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
@ -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>

370
doc/html/RM_H5D.html
View File

@ -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>&nbsp;<code>dataset_id&nbsp;&nbsp;&nbsp;&nbsp;</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%>&nbsp;
</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>&nbsp;<code>create_plist_id&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;hsize_t&nbsp;*</em>&nbsp;<code>size&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;</em><code>fill_type_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>dataset_id&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;</em><code>dset_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>dataset_id&nbsp;&nbsp;&nbsp;&nbsp;</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">&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;&nbsp;
<code>H5D_SPACE_STATUS_PART_ALLOCATED</code>&nbsp;&nbsp;
</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&nbsp;*</em><code>status&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>dataset_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>dataset_id&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;</em><code>operator&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;char&nbsp;*</em>&nbsp;<code>name&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>file_space_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>xfer_plist_id&nbsp;&nbsp;&nbsp;&nbsp;</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, &amp;
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, &amp;
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>&nbsp;<code>dataset_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>space_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>file_space_id&nbsp;&nbsp;&nbsp;&nbsp;</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, &amp;
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, &amp;
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>

145
doc/html/RM_H5E.html
View File

@ -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&nbsp;**</em><code>client_data&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>n&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>n&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;*</em>&nbsp;<code>stream&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>maj_num,&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;*</em><code>client_data&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>direction&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;*</em><code>err_desc&nbsp;&nbsp;&nbsp;&nbsp;</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>

262
doc/html/RM_H5F.html
View File

@ -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>&nbsp;<code>file_id&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;char&nbsp;*</em><code>name&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>create_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>scope&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>file_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>file_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>file_id&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;int</em>&nbsp;<code>types&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;*</em><code>obj_id_list&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;*</em><code>file_handle&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;char&nbsp;*</em><code>name&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;char&nbsp;*</em><code>name&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;char&nbsp;*</em><code>name&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>access_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>file_id&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;char&nbsp;*</em><code>name&nbsp;&nbsp;&nbsp;&nbsp;</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>

25
doc/html/RM_H5Front.html
View File

@ -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>&nbsp;&nbsp;");
document.writeln("<a href=Copyright.html>Copyright</a>&nbsp;&nbsp;");
-->
</SCRIPT>
</td></tr>

385
doc/html/RM_H5G.html
View File

@ -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>&nbsp;<code>group_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>size_hint&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;char&nbsp;*</em><code>name&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;char&nbsp;*</em><code>name&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;*</em><code>num_obj&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>*statbuf&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>loc_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>loc_id&nbsp;&nbsp;&nbsp;&nbsp;</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">&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>operator&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;&nbsp;</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>&nbsp;&nbsp;</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, &amp;
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&nbsp;char&nbsp;*</em>&nbsp;<code>current_name&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;char&nbsp;*</em>&nbsp;<code>current_name&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;char</em>&nbsp;<code>*src_name&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;char</em>&nbsp;<code>*src_name&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;char&nbsp;*</em>&nbsp;<code>name&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;char&nbsp;*</em><code>comment&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;char&nbsp;*</em>&nbsp;<code>name&nbsp;&nbsp;&nbsp;&nbsp;</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>

68
doc/html/RM_H5I.html
View File

@ -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>
@ -150,6 +149,7 @@ as the corresponding C function.
</td></tr>
</table>
<!-- NEW PAGE -->
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Idec_ref" -->
<hr>
@ -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>&nbsp;<code>obj_id&nbsp;&nbsp;&nbsp;&nbsp;</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.
@ -224,7 +225,6 @@ END SUBROUTINE h5idec_ref_f
-->
</dl>
<!-- NEW PAGE -->
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Iget_name" -->
<hr>
@ -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>&nbsp;<code>obj_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>obj_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>obj_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>obj_id&nbsp;&nbsp;&nbsp;&nbsp;</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>

2040
doc/html/RM_H5P.html
View File

File diff suppressed because it is too large Load Diff

109
doc/html/RM_H5R.html
View File

@ -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>&nbsp;<code>ref_type&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>ref_type&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>ref_type&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>ref_type&nbsp;&nbsp;&nbsp;&nbsp;</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>

378
doc/html/RM_H5S.html
View File

@ -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>&nbsp;<code>space_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>space_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>type&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;hsize_t&nbsp;*</em>&nbsp;<code>maxdims&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>source_space_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>space_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>space_id&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;</em><code>startpoint&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;</em><code>startblock&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>space_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>space_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>space_id&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;*</em><code>maxdims&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>space_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>space_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>space_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>space_id&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;hssize_t&nbsp;*</em><code>offset&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>space_id&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;size_t</em>&nbsp;<code>num_elements&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;hsize_t&nbsp;*</em><code>stride&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>space_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>space_id&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>space_id&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;hsize_t&nbsp;*</em><code>current_size&nbsp;&nbsp;&nbsp;&nbsp;</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>

912
doc/html/RM_H5T.html
View File

File diff suppressed because it is too large Load Diff

35
doc/html/RM_H5Z.html
View File

@ -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>&nbsp;<code>filter&nbsp;&nbsp;&nbsp;&nbsp;</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&nbsp;H5Z_class_t</em>&nbsp;<code>filter_class&nbsp;&nbsp;&nbsp;&nbsp;</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>&nbsp;<code>filter&nbsp;&nbsp;&nbsp;&nbsp;</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>

71
doc/html/Tools.html
View File

@ -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> &nbsp;&nbsp;or&nbsp;&nbsp;
<!-- NEW PAGE -->
<dt><code>-S <em>L</em></code> &nbsp;&nbsp;or&nbsp;&nbsp;
<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> &nbsp;&nbsp; <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> &nbsp; 4 3 4 38 &nbsp; </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&nbsp;&nbsp;</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>