mirror of
https://github.com/HDFGroup/hdf5.git
synced 2025-03-31 17:10:47 +08:00
[svn-r2873]
Purpose:
Adding all functions new to Release 1.4.
Solution:
Adding first cut of all new API functions.
H5Dvlen_get_buf_size
H5Epush
H5Pset_fapl_family H5Pget_fapl_family
H5Pset_fapl_mpio H5Pget_fapl_mpio
H5Pset_dxpl_mpio H5Pget_dxpl_mpio
H5Pset_fapl_multi H5Pget_fapl_multi
H5Pset_dxpl_multi H5Pget_dxpl_multi
H5Pset_fapl_split H5Pset_fapl_sec2 H5Pset_fapl_stdio
H5Pset_fapl_stream H5Pget_fapl_stream
H5Pset_fapl_log
H5Pset_driver H5Pget_driver H5Pget_driver_info
H5Pset_meta_block_size H5Pget_meta_block_size
H5Pset_sieve_buf_size H5Pget_sieve_buf_size
H5Pset_fapl_dpss
H5Pset_fapl_gass H5Pget_fapl_gass
H5Pset_fapl_srb H5Pget_fapl_srb
H5Tarray_create H5Tget_array_ndims H5Tget_array_dims
Platforms tested:
IE 5.
This commit is contained in:
Frank Baker
parent
7a4d4b9aa2
commit
b527d73dda
@ -67,7 +67,7 @@ and set and retrieve their constant or persistent properties.
|
||||
<ul>
|
||||
<li><a href="#Dataset-GetCreatePlist">H5Dget_create_plist</a>
|
||||
<li><a href="#Dataset-GetStorageSize">H5Dget_storage_size</a>
|
||||
<li><a href="#Dataset-GetVLBuf">H5Dget_vlen_buf_size</a>
|
||||
<li><a href="#Dataset-VLGetBuf">H5Dvlen_get_buf_size</a>
|
||||
<li><a href="#Dataset-VLReclaim">H5Dvlen_reclaim</a>
|
||||
</ul>
|
||||
</td><td> </td><td valign=top>
|
||||
@ -111,7 +111,7 @@ facilitate moving easily between them.</i>
|
||||
<li><a href="#Dataset-GetType">h5dget_type_f</a>
|
||||
<li><a href="#Dataset-GetCreatePlist">h5dget_create_plist_f</a>
|
||||
<!--<li><a href="#Dataset-GetStorageSize">h5dget_storage_size_f</a> -->
|
||||
<!--<li><a href="#Dataset-GetVLBuf">h5dget_vlen_buf_size_f</a> -->
|
||||
<!--<li><a href="#Dataset-VLGetBuf">h5dvlen_get_buf_size_f</a> -->
|
||||
<!--<li><a href="#Dataset-VLReclaim">h5dvlen_reclaim_f</a> -->
|
||||
</ul>
|
||||
</td><td> </td><td valign=top>
|
||||
@ -355,10 +355,9 @@ facilitate moving easily between them.</i>
|
||||
|
||||
<hr>
|
||||
<dl>
|
||||
<dt><strong>Name:</strong> <a name="Dataset-GetVLBuf">H5Dget_vlen_buf_size</a>
|
||||
<i><b>(Not yet implemented.)</b></i>
|
||||
<dt><strong>Name:</strong> <a name="Dataset-VLGetBuf">H5Dvlen_get_buf_size</a>
|
||||
<dt><strong>Signature:</strong>
|
||||
<dd><em>herr_t </em><code>H5Dget_vlen_buf_size</code>(<em>hid_t </em><code>dataset_id</code>,
|
||||
<dd><em>herr_t </em><code>H5Dvlen_get_buf_size</code>(<em>hid_t </em><code>dataset_id</code>,
|
||||
<em>hid_t</em> <code>type_id</code>,
|
||||
<em>hid_t</em> <code>space_id</code>,
|
||||
<em>hsize_t</em> *<code>size</code>
|
||||
@ -366,31 +365,31 @@ facilitate moving easily between them.</i>
|
||||
<dt><strong>Purpose:</strong>
|
||||
<dd>Determines the number of bytes required to store VL data.
|
||||
<dt><strong>Description:</strong>
|
||||
<dd><code>H5Dget_vlen_buf_size</code> determines the number of bytes
|
||||
<dd><code>H5Dvlen_get_buf_size</code> determines the number of bytes
|
||||
required to store the VL data from the dataset, using the
|
||||
<code>space_id</code> for the selection in the dataset on
|
||||
disk and the <code>type_id</code> for the memory representation
|
||||
of the VL data in memory.
|
||||
<p>
|
||||
<code>*size</code> is returned with the number of bytes are
|
||||
<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>Identifier of the dataset to query.
|
||||
<dt><em>hid_t</em> <code>type_id</code>
|
||||
<dd>Identifier of the datatype.
|
||||
<dd>Datatype identifier.
|
||||
<dt><em>hid_t</em> <code>space_id</code>
|
||||
<dd>Identifier of the dataspace.
|
||||
<dd>Dataspace identifier.
|
||||
<dt><em>hsize_t</em> *<code>size</code>
|
||||
<dd>The size in bytes of the buffer required to store the VL data.
|
||||
<dd>The size in bytes of the memory buffer required to store the VL data.
|
||||
</dl>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns non-negative value if successful;
|
||||
otherwise returns a negative value.
|
||||
<!--
|
||||
<dt><strong>Non-C API(s):</strong>
|
||||
<dd><a href="fortran/h5d_FORTRAN.html#h5dget_vlen_buf_size_f"
|
||||
<dd><a href="fortran/h5d_FORTRAN.html#h5dvlen_get_buf_size_f"
|
||||
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
|
||||
--> <!--
|
||||
<img src="Graphics/Java.gif">
|
||||
|
||||
@ -55,19 +55,20 @@ These functions provide error handling capabilities in the HDF5 environment.
|
||||
|
||||
<table border=0>
|
||||
<tr><td valign=top>
|
||||
<ul>
|
||||
<li><a href="#Error-Clear">H5Eclear</a>
|
||||
<li><a href="#Error-Print">H5Eprint</a>
|
||||
<li><a href="#Error-Push">H5Epush</a>
|
||||
</ul>
|
||||
</td><td> </td><td valign=top>
|
||||
<ul>
|
||||
<li><a href="#Error-SetAuto">H5Eset_auto</a>
|
||||
<li><a href="#Error-GetAuto">H5Eget_auto</a>
|
||||
<li><a href="#Error-Clear">H5Eclear</a>
|
||||
</ul>
|
||||
</td><td> </td><td valign=top>
|
||||
<ul>
|
||||
<li><a href="#Error-Print">H5Eprint</a>
|
||||
<li><a href="#Error-Walk">H5Ewalk</a>
|
||||
<li><a href="#Error-WalkCB">H5Ewalk_cb</a>
|
||||
</ul>
|
||||
</td><td> </td><td valign=top>
|
||||
<ul>
|
||||
<li><a href="#Error-WalkCB">H5Ewalk_cb</a>
|
||||
<li><a href="#Error-GetMajor">H5Eget_major</a>
|
||||
<li><a href="#Error-GetMinor">H5Eget_minor</a>
|
||||
</ul>
|
||||
@ -250,6 +251,63 @@ errors within the H5E package.
|
||||
</dl>
|
||||
|
||||
|
||||
<hr>
|
||||
<dl>
|
||||
<dt><strong>Name:</strong> <a name="Error-Push">H5Epush</a>
|
||||
<dt><strong>Signature:</strong>
|
||||
<dd><em>herr_t</em> <code>H5Epush</code>(
|
||||
<em>const char *</em><code>file</code>,
|
||||
<em>const char *</em><code>func</code>,
|
||||
<em>unsigned</em> <code>line</code>,
|
||||
<em>H5E_major_t</em> <code>maj_num</code>,
|
||||
<em>H5E_minor_t</em> <code>min_num</code>,
|
||||
<em>const char *</em><code>str</code>
|
||||
)
|
||||
<dt><strong>Purpose:</strong>
|
||||
<dd>Pushes new error record onto error stack.
|
||||
<dt><strong>Description:</strong>
|
||||
<dd><code>H5Epush</code> pushes a new error record onto the
|
||||
error stack for the current thread.
|
||||
<p>
|
||||
The error has major and minor numbers <code>maj_num</code> and
|
||||
<code>min_num</code>,
|
||||
the function <code>func</code> where the error was detected,
|
||||
the name of the file <code>file</code> where the error was detected,
|
||||
the line <code>line</code> within that file,
|
||||
and an error description string <code>str</code>.
|
||||
<p>
|
||||
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>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns a non-negative value if successful;
|
||||
otherwise returns a negative value.
|
||||
<!--
|
||||
<dt><strong>Non-C API(s):</strong>
|
||||
<dd><a href="fortran/h5e_FORTRAN.html#h5epush_f"
|
||||
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
|
||||
-->
|
||||
<!--
|
||||
<img src="Graphics/Java.gif">
|
||||
<img src="Graphics/C++.gif">
|
||||
-->
|
||||
</dl>
|
||||
|
||||
|
||||
<hr>
|
||||
<dl>
|
||||
<dt><strong>Name:</strong> <a name="Error-Print">H5Eprint</a>
|
||||
|
||||
1492
doc/html/RM_H5P.html
1492
doc/html/RM_H5P.html
File diff suppressed because it is too large
Load Diff
@ -91,11 +91,11 @@ of a dataset.
|
||||
<li><a href="#Datatype-SetPad">H5Tset_pad</a>
|
||||
<li><a href="#Datatype-GetSign">H5Tget_sign</a>
|
||||
<li><a href="#Datatype-SetSign">H5Tset_sign</a>
|
||||
</td><td valign=top>
|
||||
<li><a href="#Datatype-GetFields">H5Tget_fields</a>
|
||||
<li><a href="#Datatype-SetFields">H5Tset_fields</a>
|
||||
<li><a href="#Datatype-GetEbias">H5Tget_ebias</a>
|
||||
<li><a href="#Datatype-SetEbias">H5Tset_ebias</a>
|
||||
</td><td valign=top>
|
||||
<li><a href="#Datatype-GetNorm">H5Tget_norm</a>
|
||||
<li><a href="#Datatype-SetNorm">H5Tset_norm</a>
|
||||
<li><a href="#Datatype-GetInpad">H5Tget_inpad</a>
|
||||
@ -108,6 +108,11 @@ of a dataset.
|
||||
<p>
|
||||
<i>Variable-length Datatypes</i>
|
||||
<li><a href="#Datatype-VLCreate">H5Tvlen_create</a>
|
||||
<p>
|
||||
<i>Array Datatypes</i>
|
||||
<li><a href="#Datatype-ArrayCreate">H5Tarray_create</a>
|
||||
<li><a href="#Datatype-GetArrayNdims">H5Tget_array_ndims</a>
|
||||
<li><a href="#Datatype-GetArrayDims">H5Tget_array_dims</a>
|
||||
</td><td> </td><td valign=top>
|
||||
<i>Compound Datatype Properties</i>
|
||||
<li><a href="#Datatype-GetNmembers">H5Tget_nmembers</a>
|
||||
@ -200,6 +205,11 @@ facilitate moving easily between them.</i>
|
||||
<li><a href="#Datatype-SetStrpad">h5tset_strpad_f</a>
|
||||
<!-- </td></tr></table> -->
|
||||
<!--<p> -->
|
||||
<!--<i>Array Datatypes</i>
|
||||
<!-- <li><a href="#Datatype-ArrayCreate">H5Tarray_create</a> -->
|
||||
<!-- <li><a href="#Datatype-GetArrayNdims">H5Tget_array_ndims</a> -->
|
||||
<!-- <li><a href="#Datatype-GetArrayDims">H5Tget_array_dims</a> -->
|
||||
<!--<p> -->
|
||||
<!--<i>Variable-length Datatypes</i> -->
|
||||
<!--<li><a href="#Datatype-VLCreate">h5tvlen_create_f</a> -->
|
||||
</td><td> </td><td valign=top width=32%>
|
||||
@ -2580,6 +2590,139 @@ zero.
|
||||
</dl>
|
||||
|
||||
|
||||
<hr>
|
||||
<dl>
|
||||
<dt><strong>Name:</strong> <a name="Datatype-ArrayCreate">H5Tarray_create</a>
|
||||
<dt><strong>Signature:</strong>
|
||||
<dd><em>hid_t</em> *<code>H5Tarray_create</code>(
|
||||
<em>hid_t</em> <code>base</code>,
|
||||
<em>int</em> <code>rank</code>,
|
||||
<em>const hsize_t</em> <code>dims[/*rank*/]</code>,
|
||||
<em>const int</em> <code>perm[/*rank*/]</code>
|
||||
)
|
||||
<dt><strong>Purpose:</strong>
|
||||
<dd>Creates an array datatype object.
|
||||
<dt><strong>Description:</strong>
|
||||
<dd><code>H5Tarray_create</code> creates a new array datatype object.
|
||||
<p>
|
||||
<code>base</code> is the datatype of every element of the array,
|
||||
i.e., of the number at each position in the array.
|
||||
<p>
|
||||
<code>rank</code> is the number of dimensions and the
|
||||
size of each dimension is specified in the array <code>dims</code>.
|
||||
The value of <code>rank</code> is currently limited to
|
||||
<code>H5S_MAX_RANK</code> and must be greater than <code>0</code>
|
||||
(zero).
|
||||
All dimension sizes specified in <code>dims</code> must be greater
|
||||
than <code>0</code> (zero).
|
||||
<p>
|
||||
The array <code>perm</code> is designed to contain the dimension
|
||||
permutation, i.e. C versus FORTRAN array order.
|
||||
|
||||
<b><i>(The parameter </i><code>perm</code><i> is currently unused and is not yet implemented.)</i></b>
|
||||
<p>
|
||||
<dt><strong>Parameters:</strong>
|
||||
<dl>
|
||||
<dt><em>hid_t</em> <code>base</code>
|
||||
<dd>IN: Datatype identifier for the array base datatype.
|
||||
<dt><em>int</em> <code>rank</code>
|
||||
<dd>IN: Rank of the array.
|
||||
<dt><em>const hsize_t</em> <code>dims[/*rank*/]</code>
|
||||
<dd>IN: Size of each array dimension.
|
||||
<dt><em>const int</em> <code>perm[/*rank*/]</code>
|
||||
<dd>IN: Dimension permutation.
|
||||
|
||||
<b><i>(Currently not implemented.)</i></b>
|
||||
</dl>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns a non-negative value if successful;
|
||||
otherwise returns a negative value.
|
||||
<!--
|
||||
<dt><strong>Non-C API(s):</strong>
|
||||
<dd><a href="fortran/h5t_FORTRAN.html#h5txxx_f"
|
||||
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
|
||||
-->
|
||||
<!--
|
||||
<img src="Graphics/Java.gif">
|
||||
<img src="Graphics/C++.gif">
|
||||
-->
|
||||
</dl>
|
||||
|
||||
|
||||
<hr>
|
||||
<dl>
|
||||
<dt><strong>Name:</strong> <a name="Datatype-GetArrayNdims">H5Tget_array_ndims</a>
|
||||
<dt><strong>Signature:</strong>
|
||||
<dd><em>int</em> *<code>H5Tget_array_ndims</code>(
|
||||
<em>hid_t</em> <code>adtype_id</code>
|
||||
)
|
||||
<dt><strong>Purpose:</strong>
|
||||
<dd>Returns the rank of an array datatype.
|
||||
<dt><strong>Description:</strong>
|
||||
<dd><code>H5Tget_array_ndims</code> returns the rank,
|
||||
the number of dimensions, of an array datatype object.
|
||||
<dt><strong>Parameters:</strong>
|
||||
<dl>
|
||||
<dt><em>hid_t</em> <code>adtype_id</code>
|
||||
<dd>IN: Datatype identifier of array object.
|
||||
</dl>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns the rank of the array if successful;
|
||||
otherwise returns a negative value.
|
||||
<!--
|
||||
<dt><strong>Non-C API(s):</strong>
|
||||
<dd><a href="fortran/h5t_FORTRAN.html#h5txxx_f"
|
||||
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
|
||||
-->
|
||||
<!--
|
||||
<img src="Graphics/Java.gif">
|
||||
<img src="Graphics/C++.gif">
|
||||
-->
|
||||
</dl>
|
||||
|
||||
|
||||
<hr>
|
||||
<dl>
|
||||
<dt><strong>Name:</strong> <a name="Datatype-GetArrayDims">H5Tget_array_dims</a>
|
||||
<dt><strong>Signature:</strong>
|
||||
<dd><em>int</em> *<code>H5Tget_array_dims</code>(
|
||||
<em>hid_t</em> <code>adtype_id</code>,
|
||||
<em>hsize_t *</em><code>dims[]</code>,
|
||||
<em>int *</em><code>perm[]</code>
|
||||
)
|
||||
<dt><strong>Purpose:</strong>
|
||||
<dd>Returns sizes of array dimensions and dimension permutations.
|
||||
<dt><strong>Description:</strong>
|
||||
<dd><code>H5Tget_array_dims</code> returns the sizes of the dimensions
|
||||
and the dimension permutations of the specified array datatype object.
|
||||
<p>
|
||||
The sizes of the dimensions are returned in the array <code>dims</code>.
|
||||
The dimension permutations, i.e., C versus FORTRAN array order,
|
||||
are returned in the array <code>perm</code>.
|
||||
<dt><strong>Parameters:</strong>
|
||||
<dl>
|
||||
<dt><em>hid_t</em> <code>adtype_id</code>
|
||||
<dd>IN: Datatype identifier of array object.
|
||||
<dt><em>hsize_t *</em><code>dims[]</code>
|
||||
<dd>OUT: Sizes of array dimensions.
|
||||
<dt><em>int *</em><code>perm[]</code>
|
||||
<dd>OUT: Dimension permutations.
|
||||
</dl>
|
||||
<dt><strong>Returns:</strong>
|
||||
<dd>Returns a non-negative value if successful;
|
||||
otherwise returns a negative value.
|
||||
<!--
|
||||
<dt><strong>Non-C API(s):</strong>
|
||||
<dd><a href="fortran/h5t_FORTRAN.html#h5txxx_f"
|
||||
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
|
||||
-->
|
||||
<!--
|
||||
<img src="Graphics/Java.gif">
|
||||
<img src="Graphics/C++.gif">
|
||||
-->
|
||||
</dl>
|
||||
|
||||
|
||||
<hr>
|
||||
<dl>
|
||||
<dt><strong>Name:</strong> <a name="Datatype-Close">H5Tclose</a>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user