[svn-r2090] RM_H5D.html
H5Dclose: Corrected return type to herr_t (was hid_t).
H5Dcreate: Inserted missing spaces in function syntax statement.
RM_H5E.html
H5Ewalk: Added H5E_walk_t prototype and prototype parameter
descriptions.
RM_H5F.html
H5Fclose: Corrected behavior description, eliminating
comment that function fials if other access identifiers
are still open and describing actual behavior.
RM_H5T.html
H5Tregister: Corrected possible 'pers' values to H5T_PERS_HARD
(was HARD) and H5T_PERS_SOFT (was SOFT).
H5Tfind: Corrected 'pcdata' parameter IN/OUT designation.
This commit is contained in:
@@ -132,9 +132,9 @@ facilitate moving easily between them.</i>
|
||||
<dt><strong>Signature:</strong>
|
||||
<dd><em>hid_t </em><code>H5Dcreate</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_id</code>
|
||||
<em>hid_t</em> <code>type_id</code>,
|
||||
<em>hid_t</em> <code>space_id</code>,
|
||||
<em>hid_t</em> <code>create_plist_id</code>
|
||||
)
|
||||
<dt><strong>Purpose:</strong>
|
||||
<dd>Creates a dataset at the specified location.
|
||||
@@ -643,7 +643,7 @@ facilitate moving easily between them.</i>
|
||||
<dl>
|
||||
<dt><strong>Name:</strong> <a name="Dataset-Close">H5Dclose</a>
|
||||
<dt><strong>Signature:</strong>
|
||||
<dd><em>hid_t </em><code>H5Dclose</code>(<em>hid_t </em><code>dataset_id</code>
|
||||
<dd><em>herr_t </em><code>H5Dclose</code>(<em>hid_t </em><code>dataset_id</code>
|
||||
)
|
||||
<dt><strong>Purpose:</strong>
|
||||
<dd>Closes the specified dataset.
|
||||
|
||||
@@ -244,6 +244,30 @@ errors within the H5E package.
|
||||
regardless of stack traversal direction), an error stack entry,
|
||||
and the <code>client_data</code> pointer passed to
|
||||
<code>H5E_print</code>.
|
||||
The <code>H5E_walk_t</code> prototype is as follows:
|
||||
<dir>
|
||||
<p>
|
||||
<code>typedef</code> <em>herr_t</em> <code>(*H5E_walk_t)(</code><em>int</em> <code>n,</code>
|
||||
<em>H5E_error_t *</em><code>err_desc,</code>
|
||||
<em>void *</em><code>client_data)</code>
|
||||
<p>
|
||||
where the parameters have the following meanings:
|
||||
<dl>
|
||||
<dt><em>int</em> <code>n</code>
|
||||
<dd>Indexed position of the error in the stack.
|
||||
<dt><em>H5E_error_t *</em><code>err_desc</code>
|
||||
<dd>Pointer to a data structure describing the error.
|
||||
<em>(This structure is currently described only in the
|
||||
source code file </em><code>hdf5/src/H5Epublic.h</code><em>.
|
||||
That file also contains the definitive list of major
|
||||
and minor error codes. That information will
|
||||
eventually be presented as an appendix to this
|
||||
<cite>Reference Manual</cite>.)</em>
|
||||
<dt><em>void *</em><code>client_data</code>
|
||||
<dd>Pointer to client data in the format expected by
|
||||
the user-defined function.
|
||||
</dl>
|
||||
</dir>
|
||||
<p>
|
||||
<code>H5Ewalk</code> can fail if there are problems initializing
|
||||
the library.
|
||||
|
||||
@@ -429,9 +429,19 @@ facilitate moving easily between them.</i>
|
||||
<dd>Terminates access to an HDF5 file.
|
||||
<dt><strong>Description:</strong>
|
||||
<dd><code>H5Fclose</code> terminates access to an HDF5 file.
|
||||
If this is the last file identifier open for a file
|
||||
and if access identifiers are still in use,
|
||||
this function will fail.
|
||||
<p>
|
||||
If this is the last file identifier open for the file
|
||||
and no other access identifier is open (e.g., a dataset
|
||||
identifier, group identifier, or shared datatype identifier),
|
||||
the file will be fully closed and access will end.
|
||||
<p>
|
||||
If this is the last file identifier open for the file
|
||||
and other access identifiers are still in use,
|
||||
those access identifiers remain valid until separately
|
||||
closed and can still be used.
|
||||
(But the file identifier is no longer valid and cannot be used.)
|
||||
Once all of the remaining access identifiers are closed,
|
||||
the file will be fully closed and access will end.
|
||||
<dt><strong>Parameters:</strong>
|
||||
<dl>
|
||||
<dt><em>hid_t</em> <code>file_id</code>
|
||||
|
||||
@@ -461,7 +461,7 @@ in the <cite>HDF5 User's Guide</cite> for further information, including a compl
|
||||
<dt><em>hid_t</em> <code>dst_id</code>
|
||||
<dd>IN: Identifier for the destination datatype.
|
||||
<dt><em>H5T_cdata_t **</em><code>pcdata</code>
|
||||
<dd>IN: Pointer to type conversion data.
|
||||
<dd>OUT: Pointer to type conversion data.
|
||||
</dl>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns a pointer to a suitable conversion function if successful.
|
||||
@@ -2246,16 +2246,18 @@ zero.
|
||||
for a datatype conversion path.
|
||||
<p>
|
||||
The parameter <code>pers</code> indicates whether a conversion function
|
||||
is <code>HARD</code> or <code>SOFT</code>.
|
||||
is <em>hard</em> (<code>H5T_PERS_HARD</code>)
|
||||
or <em>soft</em> (<code>H5T_PERS_SOFT</code>).
|
||||
<p>
|
||||
A conversion path can have only one hard function.
|
||||
When <code>pers</code> is <code>HARD</code>, <code>func</code> replaces
|
||||
any previous hard function.
|
||||
If <code>pers</code> is <code>HARD</code> and <code>func</code>
|
||||
is the null pointer, then any hard function registered for this
|
||||
path is removed.
|
||||
When <code>pers</code> is <code>H5T_PERS_HARD</code>,
|
||||
<code>func</code> replaces any previous hard function.
|
||||
If <code>pers</code> is <code>H5T_PERS_HARD</code> and
|
||||
<code>func</code> is the null pointer, then any hard function
|
||||
registered for this path is removed.
|
||||
<p>
|
||||
When <code>pers</code> is <code>SOFT</code>, <code>H5Tregister</code>
|
||||
When <code>pers</code> is <code>H5T_PERS_SOFT</code>,
|
||||
<code>H5Tregister</code>
|
||||
adds the function to the end of the master soft list and replaces
|
||||
the soft function in all applicable existing conversion paths.
|
||||
Soft functions are used when determining which conversion function
|
||||
@@ -2275,14 +2277,16 @@ zero.
|
||||
<em>hid_t </em><code>dst_id</code>,
|
||||
<em>H5T_cdata_t *</em><code>cdata</code>,
|
||||
<em>size_t </em><code>nelmts</code>,
|
||||
<em>size_t </em><code>stride</code>,
|
||||
<em>void *</em><code>buf</code>,
|
||||
<em>void *</em><code>bkg</code>);
|
||||
<em>void *</em><code>bkg</code>,
|
||||
<em>hid_t </em><code>dset_xfer_plist</code>);
|
||||
</dl>
|
||||
<dt><strong>Parameters:</strong>
|
||||
<dl>
|
||||
<dt><em>H5T_pers_t</em> <code>pers</code>
|
||||
<dd><code>HARD</code> for hard conversion functions;
|
||||
<code>SOFT</code> for soft conversion functions.
|
||||
<dd><code>H5T_PERS_HARD</code> for hard conversion functions;
|
||||
<code>H5T_PERS_SOFT</code> for soft conversion functions.
|
||||
<dt><em>const char *</em> <code>name</code>
|
||||
<dd>Name displayed in diagnostic output.
|
||||
<dt><em>hid_t</em> <code>src_id</code>
|
||||
@@ -2682,7 +2686,7 @@ H5T
|
||||
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
|
||||
|
||||
<br>
|
||||
Last modified: 20 October 1999
|
||||
Last modified: 7 April 2000
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user