diff options
| author | Frank Baker <fbaker@hdfgroup.org> | 2004-02-24 22:10:12 (GMT) |
|---|---|---|
| committer | Frank Baker <fbaker@hdfgroup.org> | 2004-02-24 22:10:12 (GMT) |
| commit | 9fb77d56b800f04e7818190f50193028a134603f (patch) | |
| tree | e6d5c34ec5d291a8a4f43a97c6ba48f520153bf8 /doc/html/RM_H5P.html | |
| parent | f29e2a01e35e466fdcc292a0c443265efdf4b025 (diff) | |
| download | hdf5-9fb77d56b800f04e7818190f50193028a134603f.zip hdf5-9fb77d56b800f04e7818190f50193028a134603f.tar.gz hdf5-9fb77d56b800f04e7818190f50193028a134603f.tar.bz2 | |
[svn-r8221]
Purpose:
Clean up RM formatting.
Modify RM HTML code to facilitate automated generation of PDF version.
Minor edits.
Description:
Reworked format of "Parameters" sections.
Added HTML tags (and pseudo-HTML tags) used by HTMLdoc to
generate PDF files.
Fixed the "Copyright" link on RM_H5Front.html.
Other minor copy edits.
Platforms tested:
IE 5
Diffstat (limited to 'doc/html/RM_H5P.html')
| -rw-r--r-- | doc/html/RM_H5P.html | 2038 |
1 files changed, 1256 insertions, 782 deletions
diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html index a12084e..0dbc15f 100644 --- a/doc/html/RM_H5P.html +++ b/doc/html/RM_H5P.html @@ -61,8 +61,7 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><center> +<hr><!-- #EndLibraryItem --><center> <h1>H5P: Property List Interface</h1> </center> <h2>Property List API Functions</h2> @@ -74,6 +73,7 @@ which require many different parameters to be easily manipulated. <p> <strong>The C Interfaces:</strong> +<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------- <table border=0> <tr><td valign=top> @@ -153,9 +153,13 @@ which require many different parameters to be easily manipulated. <li><a href="#Property-SetFaplStdio">H5Pset_fapl_stdio</a> <li><a href="#Property-SetFaplStream">H5Pset_fapl_stream</a> <li><a href="#Property-GetFaplStream">H5Pget_fapl_stream</a> +<!-- FOR USE WITH ELECTRONIC VERSION -----------------------------------> <!--<li><a href="#Property-SetDriver">H5Pset_driver</a> --> +<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------- <li><a href="#Property-GetDriver">H5Pget_driver</a> +<!-- FOR USE WITH ELECTRONIC VERSION -----------------------------------> <!--<li><a href="#Property-GetDriverInfo">H5Pget_driver_info</a> --> +<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------- <li><a href="#Property-SetMetaBlockSize">H5Pset_meta_block_size</a> <li><a href="#Property-GetMetaBlockSize">H5Pget_meta_block_size</a> <li><a href="#Property-SetSieveBufSize">H5Pset_sieve_buf_size</a> @@ -170,10 +174,12 @@ which require many different parameters to be easily manipulated. <li><a href="#Property-GetFaplGass">H5Pget_fapl_gass</a> <li><a href="#Property-SetFaplSrb">H5Pset_fapl_srb</a> <li><a href="#Property-GetFaplSrb">H5Pget_fapl_srb</a> +<!-- FOR USE WITH ELECTRONIC VERSION -----------------------------------> <!-- <li><a href="#Property-xxx">xxx</a> <li><a href="#Property-xxx">xxx</a> || --> +<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------- </ul> <br> @@ -199,11 +205,13 @@ which require many different parameters to be easily manipulated. <li><a href="#Property-SetChunk">H5Pset_chunk</a> <li><a href="#Property-GetChunk">H5Pget_chunk</a> <li><a href="#Property-SetDeflate">H5Pset_deflate</a> +<!-- FOR USE WITH ELECTRONIC VERSION -----------------------------------> <!-- <li><a href="#Property-GetDeflate">H5Pget_deflate</a> <li><a href="#Property-SetCompression">H5Pset_compression</a> <li><a href="#Property-GetCompression">H5Pget_compression</a> --> +<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------- <li><a href="#Property-SetFillValue">H5Pset_fill_value</a> <li><a href="#Property-GetFillValue">H5Pget_fill_value</a> <li><a href="#Property-FillValueDefined">H5Pfill_value_defined</a> @@ -253,15 +261,218 @@ which require many different parameters to be easily manipulated. </ul> </td></tr> - +<!-- FOR USE WITH ELECTRONIC VERSION -----------------------------------> <!-- <tr><td colspan=5 align=right> <br> || <i>Available only in the parallel HDF5 library.</i> </td></tr> --> +<!-- FOR USE WITH ELECTRONIC VERSION ----------------------------------- +</table> +-- FOR USE WITH ELECTRONIC VERSION -----------------------------------> + +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> +<table border="0" width="95%"> +<tr> +<td valign="top" width="31%"> + + <i>General Functions</i> + <ul> + <li><a href="#Property-Create">H5Pcreate</a> + <li><a href="#Property-GetClass">H5Pget_class</a> + <li><a href="#Property-Copy">H5Pcopy</a> + <li><a href="#Property-Close">H5Pclose</a> + </ul> + + <i>Generic Properties</i> + <ul> + <li><a href="#Property-CreateClass">H5Pcreate_class</a> + <li><a href="#Property-CreateList">H5Pcreate_list</a> + <li><a href="#Property-Register">H5Pregister</a> + <li><a href="#Property-Insert">H5Pinsert</a> + <li><a href="#Property-Set">H5Pset</a> + <li><a href="#Property-Exist">H5Pexist</a> + <li><a href="#Property-GetSize">H5Pget_size</a> + <li><a href="#Property-GetNProps">H5Pget_nprops</a> + <li><a href="#Property-GetClassName">H5Pget_class_name</a> + <li><a href="#Property-GetClassParent">H5Pget_class_parent</a> + <li><a href="#Property-IsAClass">H5Pisa_class</a> + <li><a href="#Property-Get">H5Pget</a> + <li><a href="#Property-Equal">H5Pequal</a> + <li><a href="#Property-Iterate">H5Piterate</a> + <li><a href="#Property-CopyProp">H5Pcopy_prop</a> + <li><a href="#Property-Remove">H5Premove</a> + <li><a href="#Property-Unregister">H5Punregister</a> + <li><a href="#Property-CloseList">H5Pclose_list</a> + <li><a href="#Property-CloseClass">H5Pclose_class</a> + </ul> +</td> +<td valign="top" width="3%"> </td> +<td valign="top" width="32%"> + <i>File Access Properties</i> + <ul> + <li><a href="#Property-SetFaplCore">H5Pset_fapl_core</a> + <li><a href="#Property-GetFaplCore">H5Pget_fapl_core</a> + <li><a href="#Property-SetFaplFamily">H5Pset_fapl_family</a> + <li><a href="#Property-GetFaplFamily">H5Pget_fapl_family</a> + <li><a href="#Property-SetFamilyOffset">H5Pset_family_offset</a> + <li><a href="#Property-GetFamilyOffset">H5Pget_family_offset</a> + <li><a href="#Property-SetFaplLog">H5Pset_fapl_log</a> + <li><a href="#Property-SetFaplMpio">H5Pset_fapl_mpio</a> || + <li><a href="#Property-GetFaplMpio">H5Pget_fapl_mpio</a> || + <li><a href="#Property-SetFaplMpiPosix">H5Pset_fapl_mpiposix</a> || + <li><a href="#Property-GetFaplMpiPosix">H5Pget_fapl_mpiposix</a> || + <li><a href="#Property-SetFaplMulti">H5Pset_fapl_multi</a> + <li><a href="#Property-GetFaplMulti">H5Pget_fapl_multi</a> + <li><a href="#Property-SetMultiType">H5Pset_multi_type</a> + <li><a href="#Property-GetMultiType">H5Pget_multi_type</a> + <li><a href="#Property-SetFaplSplit">H5Pset_fapl_split</a> + <li><a href="#Property-SetFaplSec2">H5Pset_fapl_sec2</a> + <li><a href="#Property-SetFaplStdio">H5Pset_fapl_stdio</a> + <li><a href="#Property-SetFaplStream">H5Pset_fapl_stream</a> + <li><a href="#Property-GetFaplStream">H5Pget_fapl_stream</a> +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> +<!--<li><a href="#Property-SetDriver">H5Pset_driver</a> --> +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> + <li><a href="#Property-GetDriver">H5Pget_driver</a> +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> +<!--<li><a href="#Property-GetDriverInfo">H5Pget_driver_info</a> --> +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> + <li><a href="#Property-SetMetaBlockSize">H5Pset_meta_block_size</a> + <li><a href="#Property-GetMetaBlockSize">H5Pget_meta_block_size</a> + <li><a href="#Property-SetSieveBufSize">H5Pset_sieve_buf_size</a> + <li><a href="#Property-GetSieveBufSize">H5Pget_sieve_buf_size</a> + <li><a href="#Property-SetAlignment">H5Pset_alignment</a> + <li><a href="#Property-GetAlignment">H5Pget_alignment</a> + <li><a href="#Property-SetCache">H5Pset_cache</a> + <li><a href="#Property-GetCache">H5Pget_cache</a> + <li><a href="#Property-SetGCReferences">H5Pset_gc_references</a> + <li><a href="#Property-GetGCReferences">H5Pget_gc_references</a> + <li><a href="#Property-SetFaplGass">H5Pset_fapl_gass</a> + <li><a href="#Property-GetFaplGass">H5Pget_fapl_gass</a> + <li><a href="#Property-SetFaplSrb">H5Pset_fapl_srb</a> + <li><a href="#Property-GetFaplSrb">H5Pget_fapl_srb</a> +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> + <!-- + <li><a href="#Property-xxx">xxx</a> + <li><a href="#Property-xxx">xxx</a> || + --> +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> + </ul> +</td> +<td valign="top" width="3%"> </td> +<td valign="top" width="31%"> + <i>File Creation Properties</i> + <ul> + <li><a href="#Property-GetVersion">H5Pget_version</a> + <li><a href="#Property-SetUserblock">H5Pset_userblock</a> + <li><a href="#Property-GetUserblock">H5Pget_userblock</a> + <li><a href="#Property-SetSizes">H5Pset_sizes</a> + <li><a href="#Property-GetSizes">H5Pget_sizes</a> + <li><a href="#Property-SetSymK">H5Pset_sym_k</a> + <li><a href="#Property-GetSymK">H5Pget_sym_k</a> + <li><a href="#Property-SetIstoreK">H5Pset_istore_k</a> + <li><a href="#Property-GetIstoreK">H5Pget_istore_k</a> + </ul> + <i>File Close Properties</i> + <ul> + <li><a href="#Property-SetFcloseDegree">H5Pset_fclose_degree</a> + <li><a href="#Property-GetFcloseDegree">H5Pget_fclose_degree</a> + </ul> + <br><br> + || <i>Indicates functions<br> + available only in the<br> + parallel HDF5 library.</i> + <br><br><br><br><br><br><br><br><br><br><br><br> + <i>(Function listing<br> + continues on next page.)</i></pre> +</td> +</tr> +</table> +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> + +<!-- NEW PAGE --> + +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> +<table border="0" width="95%"> +<tr> +<td valign="top" width="31%"> + <i>Dataset Creation Properties</i> + <ul> + <li><a href="#Property-SetLayout">H5Pset_layout</a> + <li><a href="#Property-GetLayout">H5Pget_layout</a> + <li><a href="#Property-SetChunk">H5Pset_chunk</a> + <li><a href="#Property-GetChunk">H5Pget_chunk</a> + <li><a href="#Property-SetDeflate">H5Pset_deflate</a> +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> +<!-- + <li><a href="#Property-GetDeflate">H5Pget_deflate</a> + <li><a href="#Property-SetCompression">H5Pset_compression</a> + <li><a href="#Property-GetCompression">H5Pget_compression</a> +--> +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> + <li><a href="#Property-SetFillValue">H5Pset_fill_value</a> + <li><a href="#Property-GetFillValue">H5Pget_fill_value</a> + <li><a href="#Property-FillValueDefined">H5Pfill_value_defined</a> + <li><a href="#Property-SetFillTime">H5Pset_fill_time</a> + <li><a href="#Property-GetFillTime">H5Pget_fill_time</a> + <li><a href="#Property-SetAllocTime">H5Pset_alloc_time</a> + <li><a href="#Property-GetAllocTime">H5Pget_alloc_time</a> + <li><a href="#Property-SetFilter">H5Pset_filter</a> + <li><a href="#Property-AllFiltersAvail">H5Pall_filters_avail</a> + <li><a href="#Property-GetNFilters">H5Pget_nfilters</a> + <li><a href="#Property-GetFilter">H5Pget_filter</a> + <li><a href="#Property-GetFilterById">H5Pget_filter_by_id</a> + <li><a href="#Property-ModifyFilter">H5Pmodify_filter</a> + <li><a href="#Property-SetFletcher32">H5Pset_fletcher32</a> + <li><a href="#Property-SetShuffle">H5Pset_shuffle</a> + <li><a href="#Property-SetSzip">H5Pset_szip</a> + <li><a href="#Property-SetExternal">H5Pset_external</a> + <li><a href="#Property-GetExternalCount">H5Pget_external_count</a> + <li><a href="#Property-GetExternal">H5Pget_external</a> + </ul> +</td> +<td valign="top" width="3%"> </td> +<td valign="top" width="32%"> + <i>Dataset Access, Memory, and <br> Transfer Properties</i> + <ul> + <li><a href="#Property-SetBuffer">H5Pset_buffer</a> + <li><a href="#Property-GetBuffer">H5Pget_buffer</a> + <li><a href="#Property-SetPreserve">H5Pset_preserve</a> + <li><a href="#Property-GetPreserve">H5Pget_preserve</a> + <li><a href="#Property-SetEdcCheck">H5Pset_edc_check</a> + <li><a href="#Property-GetEdcCheck">H5Pget_edc_check</a> + <li><a href="#Property-SetFilterCallback">H5Pset_filter_callback</a> + <li><a href="#Property-SetHyperVectorSize">H5Pset_hyper_vector_size</a> + <li><a href="#Property-GetHyperVectorSize">H5Pget_hyper_vector_size</a> + <li><a href="#Property-SetBTreeRatios">H5Pset_btree_ratios</a> + <li><a href="#Property-GetBTreeRatios">H5Pget_btree_ratios</a> + <li><a href="#Property-SetVLMemManager">H5Pset_vlen_mem_manager</a> + <li><a href="#Property-GetVLMemManager">H5Pget_vlen_mem_manager</a> + <li><a href="#Property-SetDxplMpio">H5Pset_dxpl_mpio</a> || + <li><a href="#Property-GetDxplMpio">H5Pget_dxpl_mpio</a> || + <li><a href="#Property-SetDxplMulti">H5Pset_dxpl_multi</a> + <li><a href="#Property-GetDxplMulti">H5Pget_dxpl_multi</a> + <li><a href="#Property-SetMultiType">H5Pset_multi_type</a> + <li><a href="#Property-GetMultiType">H5Pget_multi_type</a> + <br> + <li><a href="#Property-SetSmallData">H5Pset_small_data_block_size</a> + <li><a href="#Property-GetSmallData">H5Pget_small_data_block_size</a> + </ul> +</td> +<td valign="top" width="3%"> </td> +<td valign="top" width="31%"> +<br> + || <i>Indicates functions<br> + available only in the<br> + parallel HDF5 library.</i> +</td> +</tr> </table> +<!-- FOR USE WITH PRINT VERSION ----------------------------------------> + <br> * Functions labelled with an asterisk (*) are provided only for @@ -269,6 +480,7 @@ backwards compatibility with HDF5 Releases 1.4.<i>x</i>. See further notes in the description of each function. <p> +<!-- NEW PAGE --> <i>Alphabetical Listing</i> <table border="0"> <tr> @@ -411,6 +623,7 @@ See further notes in the description of each function. </table> <br> +<!-- NEW PAGE --> <strong>The FORTRAN90 Interfaces:</strong> <br> @@ -606,10 +819,11 @@ as the corresponding C function. set in the dataset creation property list <code>dcpl_id</code> are currently available. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dcpl_id</code> - <dd>IN: Dataset creation property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dcpl_id </code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns <code>TRUE</code> if all filters are available and <code>FALSE</code> if one or more is not currently available.<br> @@ -646,10 +860,11 @@ SUBROUTINE finished accessing them. This frees resources used by the property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of the property list to terminate access to. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier of the property list to terminate access to.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -696,7 +911,7 @@ END SUBROUTINE h5pclose_f <dt><strong>Parameters:</strong> <ul><table> <tr> - <td><em>hid_t</em> <code>class</code></td> + <td><em>hid_t</em> <code>class </code></td> <td>IN: Property list class to close</td></tr> </table></ul> @@ -751,7 +966,7 @@ END SUBROUTINE h5pclose_class_f <dt><strong>Parameters:</strong> <ul><table> <tr> - <td><em>hid_t</em> <code>plist</code><td> + <td><em>hid_t</em> <code>plist </code><td> <td>IN: Property list to close</td></tr> </table></ul> @@ -794,10 +1009,11 @@ END SUBROUTINE h5pclose_list_f The new property list has the same properties and values as the original property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to duplicate. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier of property list to duplicate.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a property list identifier if successful; otherwise returns a negative value. @@ -873,7 +1089,7 @@ END SUBROUTINE h5pcopy_f <td><em>hid_t</em> <code>src_id</code></td> <td>IN: Identifier of the source property list or class</td></tr> <tr> - <td><em>const char *</em><code>name</code></td> + <td><em>const char *</em><code>name </code></td> <td>IN: Name of the property to copy</td></tr> </table></ul> @@ -949,10 +1165,11 @@ END SUBROUTINE h5pcopy_prop_f <code>H5Pclose</code>; otherwise, errors are likely to occur. <dt><strong>Parameters:</strong> - <dl> - <dt><em>H5P_class_t</em> <code>type</code> - <dd>IN: The type of property list to create. - </dl> + <ul><table> + <tr> + <td valign="top"><em>H5P_class_t</em> <code>type </code></td> + <td valign="top">IN: The type of property list to create.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a property list identifier (<code>plist</code>) if successful; otherwise Fail (-1). @@ -1095,7 +1312,7 @@ END SUBROUTINE h5pcreate_f <td><em>const char *</em><code>name</code></td> <td>IN: Name of property list class to register</td></tr> <tr> - <td><em>H5P_cls_create_func_t</em> <code>create</code></td> + <td><em>H5P_cls_create_func_t</em> <code>create </code></td> <td>IN: Callback routine called when a property list is created</td></tr> <tr> <td><em>H5P_cls_copy_func_t</em> <code>copy</code></td> @@ -1110,6 +1327,7 @@ END SUBROUTINE h5pcreate_f <dd>Success: a valid property list class identifier <dd>Failure: a negative value +<!-- NEW PAGE --> <dt><strong>Fortran90 Interface:</strong> h5pcreate_class_f <dd> <pre> @@ -1164,7 +1382,7 @@ END SUBROUTINE h5pcreate_class_f <dt><strong>Parameter:</strong> <ul><table> <tr> - <td><em>hid_t</em> <code>class</code>;</td> + <td><em>hid_t</em> <code>class; </code></td> <td>IN: Class of property list to create.</td></tr> </table></ul> @@ -1312,7 +1530,7 @@ END SUBROUTINE h5premove_filter_f <dt><strong>Parameters:</strong> <ul><table> <tr> - <td><em>hid_t</em> <code>id1</code></td> + <td><em>hid_t</em> <code>id1 </code></td> <td>IN: First property object to be compared</td></tr> <tr> <td><em>hid_t</em> <code>id2</code></td> @@ -1372,7 +1590,7 @@ END SUBROUTINE h5pequal_f <td><em>hid_t</em> <code>id</code></td> <td>IN: Identifier for the property to query</td></tr> <tr> - <td><em>const char *</em><code>name</code></td> + <td><em>const char *</em><code>name </code></td> <td>IN: Name of property to check for</td></tr> </table></ul> @@ -1442,12 +1660,14 @@ END SUBROUTINE h5pexist_f See <a href="RM_H5D.html#Dataset-Create">H5Dcreate</a> for further cross-references. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>H5D_fill_value_t *</em><code>status</code> - <dd>OUT: Status of fill value in property list. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5D_fill_value_t *</em><code>status </code></td> + <td valign="top">OUT: Status of fill value in property list.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1509,7 +1729,7 @@ SUBROUTINE <td><em>hid_t</em> <code>plid</ecodem></td> <td>IN: Identifier of the property list to query</td></tr> <tr> - <td><em>const char *</em><code>name</code></td> + <td><em>const char *</em><code>name </code></td> <td>IN: Name of property to query</td></tr> <tr> <td><em>void *</em><code>value</code></td> @@ -1566,14 +1786,17 @@ END SUBROUTINE h5pget_f The <code>threshold</code> and/or <code>alignment</code> pointers may be null pointers (NULL). <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of a file access property list. - <dt><em>hsize_t</em> <code>*threshold</code> - <dd>OUT: Pointer to location of return threshold value. - <dt><em>hsize_t</em> <code>*alignment</code> - <dd>OUT: Pointer to location of return alignment value. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of a file access property list.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>*threshold </code></td> + <td valign="top">OUT: Pointer to location of return threshold value.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>*alignment</code></td> + <td valign="top">OUT: Pointer to location of return alignment value.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1644,12 +1867,14 @@ END SUBROUTINE h5pget_alignment_f set with the functions <code>H5Pget_fill_value</code> and <code>H5Pget_fill_time</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>H5D_alloc_time_t *</em><code>alloc_time</code> - <dd>IN: When to allocate dataset storage space. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5D_alloc_time_t *</em><code>alloc_time </code></td> + <td valign="top">IN: When to allocate dataset storage space.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1701,16 +1926,20 @@ END SUBROUTINE h5pget_alloc_time_f arguments <code>left</code>, <code>middle</code>, and <code>right</code>, as set by the <a href="#Property-SetBTreeRatios">H5Pset_btree_ratios</a> function. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: The dataset transfer property list identifier. - <dt><em>double</em> <code>left</code> - <dd>OUT: The B-tree split ratio for left-most nodes. - <dt><em>double</em> <code>right</code> - <dd>OUT: The B-tree split ratio for right-most nodes and lone nodes. - <dt><em>double</em> <code>middle</code> - <dd>OUT: The B-tree split ratio for all other nodes. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: The dataset transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>left</code></td> + <td valign="top">OUT: The B-tree split ratio for left-most nodes.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>right</code></td> + <td valign="top">OUT: The B-tree split ratio for right-most nodes and lone nodes.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>middle </code></td> + <td valign="top">OUT: The B-tree split ratio for all other nodes.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1754,16 +1983,19 @@ END SUBROUTINE h5pget_btree_ratios_f <dd><code>H5Pget_buffer</code> reads values previously set with H5Pset_buffer. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for the dataset transfer property list. - <dt><em>void</em> <code>**tconv</code> - <dd>OUT: Address of the pointer to application-allocated - type conversion buffer. - <dt><em>void</em> <code>**bkg</code> - <dd>OUT: Address of the pointer to application-allocated - background buffer. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for the dataset transfer property list.</td></tr> + <tr> + <td valign="top"><em>void</em> <code>**tconv </code></td> + <td valign="top">OUT: Address of the pointer to application-allocated + type conversion buffer.</td></tr> + <tr> + <td valign="top"><em>void</em> <code>**bkg</code></td> + <td valign="top">OUT: Address of the pointer to application-allocated + background buffer.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns buffer size, in bytes, if successful; otherwise 0 on failure. @@ -1811,18 +2043,23 @@ END SUBROUTINE h5pget_buffer_f Any (or all) arguments may be null pointers, in which case the corresponding datum is not returned. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Identifier of the file access property list. - <dt><em>int</em> <code>*mdc_nelmts</code> - <dd>IN/OUT: Number of elements (objects) in the meta data cache. - <dt><em>int</em> <code>*rdcc_nelmts</code> - <dd>IN/OUT: Number of elements (objects) in the raw data chunk cache. - <dt><em>size_t</em> <code>*rdcc_nbytes</code> - <dd>IN/OUT: Total size of the raw data chunk cache, in bytes. - <dt><em>double</em> <code>*rdcc_w0</code> - <dd>IN/OUT: Preemption policy. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Identifier of the file access property list.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>*mdc_nelmts</code></td> + <td valign="top">IN/OUT: Number of elements (objects) in the meta data cache.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>*rdcc_nelmts</code></td> + <td valign="top">IN/OUT: Number of elements (objects) in the raw data chunk cache.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>*rdcc_nbytes </code></td> + <td valign="top">IN/OUT: Total size of the raw data chunk cache, in bytes.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>*rdcc_w0</code></td> + <td valign="top">IN/OUT: Preemption policy.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -1873,14 +2110,17 @@ END SUBROUTINE h5pget_cache_f At most, <code>max_ndims</code> elements of <code>dims</code> will be initialized. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to query. - <dt><em>int</em> <code>max_ndims</code> - <dd>IN: Size of the <code>dims</code> array. - <dt><em>hsize_t *</em> <code>dims</code> - <dd>OUT: Array to store the chunk dimensions. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of property list to query.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>max_ndims </code></td> + <td valign="top">IN: Size of the <code>dims</code> array.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em> <code>dims</code></td> + <td valign="top">OUT: Array to store the chunk dimensions.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns chunk dimensionality successful; otherwise returns a negative value. @@ -1925,10 +2165,11 @@ END SUBROUTINE h5pget_chunk_f Valid property list classes are defined in the description of <code>H5Pcreate</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier of property list to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a property list class if successful. Otherwise returns H5P_NO_CLASS (-1). @@ -1982,7 +2223,7 @@ END SUBROUTINE h5pget_class_f <dt><strong>Parameters:</strong> <ul><table> <tr> - <td><em>hid_t</em> <code>pcid</code></td> + <td><em>hid_t</em> <code>pcid </code></td> <td>IN: Identifier of the property class to query</td></tr> </table></ul> @@ -2038,7 +2279,7 @@ END SUBROUTINE h5pget_class_name_f <dt><strong>Parameters:</strong> <ul><table> <tr> - <td><em>hid_t</em> <code>pcid</code></td> + <td><em>hid_t</em> <code>pcid </code></td> <td>IN: Identifier of the property class to query</td></tr> </table></ul> @@ -2103,10 +2344,11 @@ END SUBROUTINE h5pget_class_parent_f The returned driver identifier is only valid as long as the file driver remains registered. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: File access or data transfer property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id </code></td> + <td valign="top">IN: File access or data transfer property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a valid low-level driver identifier if successful. Otherwise returns a negative value. @@ -2198,12 +2440,14 @@ END SUBROUTINE h5pget_driver_f <p> <code>H5Pget_dxpl_mpio</code> is not a collective function. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dxpl_id</code> - <dd>IN: Data transfer property list identifier. - <dt><em>H5FD_mpio_xfer_t *</em><code>xfer_mode</code> - <dd>OUT: Data transfer mode. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dxpl_id</code></td> + <td valign="top">IN: Data transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5FD_mpio_xfer_t *</em><code>xfer_mode </code></td> + <td valign="top">OUT: Data transfer mode.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2248,12 +2492,14 @@ END SUBROUTINE h5pget_dxpl_mpio_f <dd><code>H5Pget_dxpl_multi</code> returns the data transfer property list information for the multi-file driver. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dxpl_id</code>, - <dd>IN: Data transfer property list identifier. - <dt><em>const hid_t *</em><code>memb_dxpl</code> - <dd>OUT: Array of data access property lists. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dxpl_id</code>,</td> + <td valign="top">IN: Data transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>const hid_t *</em><code>memb_dxpl </code></td> + <td valign="top">OUT: Array of data access property lists.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2287,10 +2533,11 @@ SUBROUTINE list <code>plist</code> to determine whether error detection is enabled for data read operations. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Dataset transfer property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Dataset transfer property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns <code>H5Z_ENABLE_EDC</code> or <code>H5Z_DISABLE_EDC</code> if successful; @@ -2348,21 +2595,27 @@ END SUBROUTINE h5pget_edc_check_f If <code>offset</code> or <code>size</code> are null pointers then the corresponding information is not returned. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of a dataset creation property list. - <dt><em>int</em> <code>idx</code> - <dd>IN: External file index. - <dt><em>size_t</em> <code>name_size</code> - <dd>IN: Maximum length of <code>name</code> array. - <dt><em>char</em> <code>*name</code> - <dd>OUT: Name of the external file. - <dt><em>off_t</em> <code>*offset</code> - <dd>OUT: Pointer to a location to return an offset value. - <dt><em>hsize_t</em> <code>*size</code> - <dd>OUT: Pointer to a location to return the size of the - external file data. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of a dataset creation property list.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>idx</code></td> + <td valign="top">IN: External file index.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>name_size </code></td> + <td valign="top">IN: Maximum length of <code>name</code> array.</td></tr> + <tr> + <td valign="top"><em>char</em> <code>*name</code></td> + <td valign="top">OUT: Name of the external file.</td></tr> + <tr> + <td valign="top"><em>off_t</em> <code>*offset</code></td> + <td valign="top">OUT: Pointer to a location to return an offset value.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>*size</code></td> + <td valign="top">OUT: Pointer to a location to return the size of the + external file data.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -2408,10 +2661,11 @@ END SUBROUTINE h5pget_external_f <dd><code>H5Pget_external_count</code> returns the number of external files for the specified dataset. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of a dataset creation property list. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier of a dataset creation property list.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of external files if successful; otherwise returns a negative value. @@ -2466,12 +2720,14 @@ END SUBROUTINE h5pget_external_count_f Use of this function is only appropriate for an HDF5 file written as a family of files with the <code>FAMILY</code> file driver. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>hsize_t *</em><code>offset</code> - <dd>IN: Offset in bytes within the HDF5 file. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>offset </code></td> + <td valign="top">IN: Offset in bytes within the HDF5 file.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -2508,15 +2764,18 @@ SUBROUTINE <dd><code>H5Pget_fapl_core</code> queries the <code>H5FD_CORE</code> driver properties as set by <code>H5Pset_fapl_core</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>size_t</em> *<code>increment</code> - <dd>OUT: Size, in bytes, of memory increments. - <dt><em>hbool_t</em> *<code>backing_store</code> - <dd>OUT: Boolean flag indicating whether to write the file - contents to disk when the file is closed. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>size_t</em> *<code>increment</code></td> + <td valign="top">OUT: Size, in bytes, of memory increments.</td></tr> + <tr> + <td valign="top"><em>hbool_t</em> *<code>backing_store </code></td> + <td valign="top">OUT: Boolean flag indicating whether to write the file + contents to disk when the file is closed.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2562,15 +2821,18 @@ END SUBROUTINE h5pget_fapl_core_f for use with the family driver. This information is returned through the output parameters. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em> hsize_t *</em><code>memb_size</code> - <dd>OUT: Size in bytes of each file member. - <dt><em>hid_t *</em><code>memb_fapl_id</code> - <dd>OUT: Identifier of file access property list for each - family member. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em> hsize_t *</em><code>memb_size</code></td> + <td valign="top">OUT: Size in bytes of each file member.</td></tr> + <tr> + <td valign="top"><em>hid_t *</em><code>memb_fapl_id </code></td> + <td valign="top">OUT: Identifier of file access property list for each + family member.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -2625,12 +2887,14 @@ END SUBROUTINE h5pget_fapl_family_f For further information, see <a href="http://www.globus.org/">http//www.globus.org/</a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code>, - <dd>IN: File access property list identifier. - <dt><em>GASS_Info *</em><code>info</code> - <dd>OUT: Pointer to the GASS information structure. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code>,</td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>GASS_Info *</em><code>info </code></td> + <td valign="top">OUT: Pointer to the GASS information structure.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2673,14 +2937,17 @@ SUBROUTINE so they are valid only until the file access property list is either modified or closed. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>MPI_Comm *</em><code>comm</code> - <dd>OUT: MPI-2 communicator. - <dt><em>MPI_Info *</em><code>info</code> - <dd>OUT: MPI-2 info object. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>MPI_Comm *</em><code>comm </code></td> + <td valign="top">OUT: MPI-2 communicator.</td></tr> + <tr> + <td valign="top"><em>MPI_Info *</em><code>info</code></td> + <td valign="top">OUT: MPI-2 info object.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2727,12 +2994,14 @@ END SUBROUTINE h5pget_fapl_mpio_f <code>comm</code> is not copied, so it is valid only until the file access property list is either modified or closed. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>MPI_Comm *</em><code>comm</code> - <dd>OUT: MPI-2 communicator. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>MPI_Comm *</em><code>comm </code></td> + <td valign="top">OUT: MPI-2 communicator.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2776,21 +3045,27 @@ END SUBROUTINE h5pget_fapl_mpiposix_f <dd><code>H5Pget_fapl_multi</code> returns information about the multi-file access property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>const H5FD_mem_t *</em><code>memb_map</code> - <dd>OUT: Maps memory usage types to other memory usage types. - <dt><em>const hid_t *</em><code>memb_fapl</code> - <dd>OUT: Property list for each memory usage type. - <dt><em>const char **</em><code>memb_name</code> - <dd>OUT: Name generator for names of member files. - <dt><em>const haddr_t *</em><code>memb_addr</code> - <dd>OUT: - <dt><em>hbool_t *</em><code>relax</code> - <dd>OUT: Allows read-only access to incomplete file sets - when <code>TRUE</code>. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>const H5FD_mem_t *</em><code>memb_map </code></td> + <td valign="top">OUT: Maps memory usage types to other memory usage types.</td></tr> + <tr> + <td valign="top"><em>const hid_t *</em><code>memb_fapl</code></td> + <td valign="top">OUT: Property list for each memory usage type.</td></tr> + <tr> + <td valign="top"><em>const char **</em><code>memb_name</code></td> + <td valign="top">OUT: Name generator for names of member files.</td></tr> + <tr> + <td valign="top"><em>const haddr_t *</em><code>memb_addr</code></td> + <td valign="top">OUT:</td></tr> + <tr> + <td valign="top"><em>hbool_t *</em><code>relax</code></td> + <td valign="top">OUT: Allows read-only access to incomplete file sets + when <code>TRUE</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2849,12 +3124,14 @@ END SUBROUTINE h5pget_fapl_multi_f Storage Resource Broker (SRB). For further information, see <a href="http://www.npaci.edu/Research/DI/srb/">http//www.npaci.edu/Research/DI/srb/</a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>SRB_Info *</em><code>info</code> - <dd>OUT: Pointer to the SRB information structure. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>SRB_Info *</em><code>info </code></td> + <td valign="top">OUT: Pointer to the SRB information structure.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2892,12 +3169,14 @@ SUBROUTINE <code>H5Pset_fapl_stream</code> and <code>H5Pget_fapl_stream</code> are not intended for use in a parallel environment. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>H5FD_stream_fapl_t *</em><code>fapl</code> - <dd>OUT: The streaming I/O file access property list. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5FD_stream_fapl_t *</em><code>fapl </code></td> + <td valign="top">OUT: The streaming I/O file access property list.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -2935,13 +3214,15 @@ SUBROUTINE is called to close that file. <code>fc_degree</code> can have any one of four valid values as described above in <a href="#Property-SetFcloseDegree"><code>H5Pset_fclose_degree</code></a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>H5F_close_degree_t</em> <code>fc_degree</code> - <dd>OUT: Pointer to a location to which to return the file close degree - property, the value of <code>fc_degree</code>. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5F_close_degree_t</em> <code>fc_degree </code></td> + <td valign="top">OUT: Pointer to a location to which to return the file close degree + property, the value of <code>fc_degree</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -3010,12 +3291,14 @@ END SUBROUTINE h5pget_fclose_degree_f dataset storage allocation time properties, retrieved with the functions <code>H5Pget_fill_value</code> and <code>H5Pget_alloc_time</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>H5D_fill_time_t *</em><code>fill_time</code> - <dd>OUT: Setting for the timing of writing fill values to the dataset. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5D_fill_time_t *</em><code>fill_time </code></td> + <td valign="top">OUT: Setting for the timing of writing fill values to the dataset.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3085,15 +3368,17 @@ END SUBROUTINE h5pget_fill_time_f and <code>H5Pget_fill_time</code>, respectively. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>hid_t</em> <code>type_id</code>, - <dd>IN: Datatype identifier for the value passed - via <code>value</code>. - <dt><em>void *</em><code>value</code> - <dd>OUT: Pointer to buffer to contain the returned fill value. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id </code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code>,</td> + <td valign="top">IN: Datatype identifier for the value passed + via <code>value</code>.</td></tr> + <tr><td valign="top"><em>void *</em><code>value</code></td> + <td valign="top">OUT: Pointer to buffer to contain the returned fill value.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3171,24 +3456,32 @@ END SUBROUTINE h5pget_fill_value_f pipeline; <code>plist</code> must be a dataset creation property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Property list identifier. - <dt><em>int</em> <code>filter_number</code> - <dd>IN: Sequence number within the filter pipeline of - the filter for which information is sought. - <dt><em>unsigned int *</em><code>flags</code> - <dd>OUT: Bit vector specifying certain general properties - of the filter. - <dt><em>size_t *</em><code>cd_nelmts</code> - <dd>IN/OUT: Number of elements in <code>cd_values</code>. - <dt><em>unsigned int *</em><code>cd_values</code> - <dd>OUT: Auxiliary data for the filter. - <dt><em>size_t</em> <code>namelen</code> - <dd>IN: Anticipated number of characters in <code>name</code>. - <dt><em>char</em> <code>name[]</code> - <dd>OUT: Name of the filter. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Property list identifier.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>filter_number</code></td> + <td valign="top">IN: Sequence number within the filter pipeline of + the filter for which information is sought.</td></tr> + <tr> + <td valign="top"><em>unsigned int *</em><code>flags</code></td> + <td valign="top">OUT: Bit vector specifying certain general properties + of the filter.</td></tr> + <tr> + <td valign="top"><em>size_t *</em><code>cd_nelmts</code></td> + <td valign="top">IN/OUT: Number of elements in <code>cd_values</code>.</td></tr> + <tr> + <td valign="top"><em>unsigned int *</em><code>cd_values </code></td> + <td valign="top">OUT: Auxiliary data for the filter.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>namelen</code></td> + <td valign="top">IN: Anticipated number of characters in <code>name</code>.</td></tr> + <tr> + <td valign="top"><em>char</em> <code>name[]</code></td> + <td valign="top">OUT: Name of the filter.</td></tr> + </table></ul> +<!-- NEW PAGE --> <dt><strong>Returns:</strong> <dd>Returns the filter identifier if successful: <center> @@ -3219,7 +3512,8 @@ END SUBROUTINE h5pget_fill_value_f <dt><strong>Fortran90 Interface:</strong> h5pget_filter_f <dd> <pre> -SUBROUTINE h5pget_filter_f(prp_id, filter_number, flags, cd_nelmts, cd_values, namelen, name, filter_id, hdferr) +SUBROUTINE h5pget_filter_f(prp_id, filter_number, flags, cd_nelmts, cd_values, + namelen, name, filter_id, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier INTEGER, INTENT(IN) :: filter_number ! Sequence number within the filter @@ -3296,24 +3590,31 @@ END SUBROUTINE h5pget_filter_f set for the property list, an error will be returned and <code>H5Pget_filter_by_id</code> will fail. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Property list identifier. - <dt><em>H5Z_filter_t</em> <code>filter</code> - <dd>IN: Filter identifier. - <dt><em>unsigned int</em> <code>flags</code> - <dd>OUT: Bit vector specifying certain general properties - of the filter. - <dt><em>size_t</em> <code>cd_nelmts</code> - <dd>IN/OUT: Number of elements in <code>cd_values</code>. - <dt><em>const unsigned int</em> <code>cd_values[]</code> - <dd>OUT: Auxiliary data for the filter. - <dt><em>size_t</em> <code>namelen</code> - <dd>IN/OUT: Length of filter name and - number of elements in <code>name[]</code>. - <dt><em>char *</em><code>name[]</code> - <dd>OUT: Name of filter. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5Z_filter_t</em> <code>filter</code></td> + <td valign="top">IN: Filter identifier.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>flags</code></td> + <td valign="top">OUT: Bit vector specifying certain general properties + of the filter.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>cd_nelmts</code></td> + <td valign="top">IN/OUT: Number of elements in <code>cd_values</code>.</td></tr> + <tr> + <td valign="top"><em>const unsigned int</em> <code>cd_values[] </code></td> + <td valign="top">OUT: Auxiliary data for the filter.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>namelen</code></td> + <td valign="top">IN/OUT: Length of filter name and + number of elements in <code>name[]</code>.</td></tr> + <tr> + <td valign="top"><em>char *</em><code>name[]</code></td> + <td valign="top">OUT: Name of filter.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3324,7 +3625,9 @@ SUBROUTINE h5pget_filter_by_id_f(prp_id, filter_id, flags, cd_nelmts, & cd_values, namelen, name, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier - INTEGER, INTENT(IN) :: filter_id ! Filter identifier + INTEGER, INTENT(IN) :: filter_id ! Filter identifier</pre> +<!-- NEW PAGE --> +<pre> INTEGER(SIZE_T), INTENT(INOUT) :: cd_nelmts ! Number of elements in cd_values INTEGER, DIMENSION(*), INTENT(OUT) :: cd_values @@ -3365,15 +3668,17 @@ END SUBROUTINE h5pget_filter_by_id_f The garbage collection references property is set by <a href="#Property-SetGCReferences">H5Pset_gc_references</a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: File access property list identifier. - <dt><em>unsigned</em> <code>gc_ref</code> - <dd>OUT: Flag returning the state of reference garbage collection. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>unsigned</em> <code>gc_ref </code></td> + <td valign="top">OUT: Flag returning the state of reference garbage collection. A returned value of <code>1</code> indicates that garbage collection is on while - <code>0</code> indicates that garbage collection is off. - </dl> + <code>0</code> indicates that garbage collection is off.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3422,12 +3727,14 @@ END SUBROUTINE h5pget_gc_references_f was previously set with a call to <a href="#Property-SetHyperVectorSize">H5Pset_hyper_vector_size</a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dxpl_id</code> - <dd>IN: Dataset transfer property list identifier. - <dt><em>size_t *</em><code>vector_size</code> - <dd>OUT: Number of I/O vectors to accumulate in memory for I/O operations. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dxpl_id</code></td> + <td valign="top">IN: Dataset transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>size_t *</em><code>vector_size </code></td> + <td valign="top">OUT: Number of I/O vectors to accumulate in memory for I/O operations.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3471,12 +3778,14 @@ END SUBROUTINE h5pget_hyper_vector_size_f <p> See <a href="#Property-SetIstoreK">H5Pset_istore_k</a> for details. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to query. - <dt><em>int *</em> <code>ik</code> - <dd>OUT: Pointer to location to return the chunked storage B-tree 1/2 rank. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier of property list to query.</td></tr> + <tr> + <td valign="top"><em>int *</em> <code>ik</code></td> + <td valign="top">OUT: Pointer to location to return the chunked storage B-tree 1/2 rank.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3520,10 +3829,11 @@ END SUBROUTINE h5pget_istore_k_f documentation for details. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for property list to query. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier for property list to query.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the layout type (a non-negative value) of a dataset creation property list if successful. @@ -3587,12 +3897,14 @@ END SUBROUTINE h5pget_layout_f and is retrieved from the file access property list <code>fapl_id</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>hsize_t *</em><code>size</code> - <dd>OUT: Minimum size, in bytes, of metadata block allocations. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>size</code></td> + <td valign="top">OUT: Minimum size, in bytes, of metadata block allocations.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -3650,12 +3962,14 @@ END SUBROUTINE h5pget_meta_block_size_f Use of this function is only appropriate for an HDF5 file written as a set of files with the <code>MULTI</code> file driver. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list or data transfer property list identifier. - <dt><em>H5FD_mem_t *</em><code>type</code> - <dd>OUT: Type of data. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list or data transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5FD_mem_t *</em><code>type </code></td> + <td valign="top">OUT: Type of data.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -3703,10 +4017,11 @@ SUBROUTINE pipeline; <code>plist_id</code> must be a dataset creation property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns the number of filters in the pipeline if successful; otherwise returns a negative value. @@ -3761,7 +4076,7 @@ END SUBROUTINE h5pget_nfilters_f <td><em>hid_t</em> <code>id</code></td> <td>IN: Identifier of property object to query</td></tr> <tr> - <td><em>size_t *</em><code>nprops</code></td> + <td><em>size_t *</em><code>nprops </code></td> <td>OUT: Number of properties in object</td></tr> </table></ul> @@ -3802,10 +4117,11 @@ END SUBROUTINE h5pget_nprops_f <dd><code>H5Pget_preserve</code> checks the status of the dataset transfer property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for the dataset transfer property list. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier for the dataset transfer property list.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns TRUE or FALSE if successful; otherwise returns a negative value. @@ -3841,8 +4157,6 @@ END SUBROUTINE h5pget_preserve_f <em>hid_t</em> <code>fapl_id</code>, <em>hsize_t *</em><code>size</code> ) -<br> -<br> <dt><strong>Purpose:</strong> <dd> Returns maximum data sieve buffer size. <dt><strong>Description:</strong> @@ -3854,12 +4168,14 @@ END SUBROUTINE h5pget_preserve_f and is retrieved from the file access property list <code>fapl_id</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>hsize_t *</em><code>size</code> - <dd>IN: Maximum size, in bytes, of data sieve buffer. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>size</code></td> + <td valign="top">IN: Maximum size, in bytes, of data sieve buffer.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -3915,7 +4231,7 @@ END SUBROUTINE h5pget_sieve_buf_size_f <td><em>hid_t</em> <code>id</code></td> <td>IN: Identifier of property object to query</td></tr> <tr> - <td><em>const char *</em><code>name</code></td> + <td><em>const char *</em><code>name </code></td> <td>IN: Name of property to query</td></tr> <tr> <td><em>size_t *</em><code>size</code></td> @@ -3964,14 +4280,17 @@ END SUBROUTINE h5pget_size_f and lengths used in an HDF5 file. This function is only valid for file creation property lists. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to query. - <dt><em>size_t *</em> <code>size</code> - <dd>OUT: Pointer to location to return offset size in bytes. - <dt><em>size_t *</em> <code>size</code> - <dd>OUT: Pointer to location to return length size in bytes. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of property list to query.</td></tr> + <tr> + <td valign="top"><em>size_t *</em> <code>size </code></td> + <td valign="top">OUT: Pointer to location to return offset size in bytes.</td></tr> + <tr> + <td valign="top"><em>size_t *</em> <code>size</code></td> + <td valign="top">OUT: Pointer to location to return length size in bytes.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -4016,12 +4335,14 @@ END SUBROUTINE h5pget_sizes_f If the returned value is zero (<code>0</code>), the small data block mechanism has been disabled for the file. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier . - <dt><em>hsize_t *</em><code>size</code> - <dd>OUT: Maximum size, in bytes, of the small data block. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em><code>size</code></td> + <td valign="top">OUT: Maximum size, in bytes, of the small data block.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise a negative value. @@ -4068,14 +4389,17 @@ END SUBROUTINE h5pget_small_data_block_size_f <a href="#Property-SetSymK">H5Pset_sym_k</a> for more information. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Property list to query. - <dt><em>int *</em> <code>ik</code> - <dd>OUT: Pointer to location to return the symbol table's B-tree 1/2 rank. - <dt><em>int *</em> <code>size</code> - <dd>OUT: Pointer to location to return the symbol table's leaf node 1/2 size. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Property list to query.</td></tr> + <tr> + <td valign="top"><em>int *</em> <code>ik</code></td> + <td valign="top">OUT: Pointer to location to return the symbol table's B-tree 1/2 rank.</td></tr> + <tr> + <td valign="top"><em>int *</em> <code>size</code></td> + <td valign="top">OUT: Pointer to location to return the symbol table's leaf node 1/2 size.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -4115,12 +4439,14 @@ END SUBROUTINE h5pget_sym_k_f <dd><code>H5Pget_userblock</code> retrieves the size of a user block in a file creation property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for property list to query. - <dt><em>hsize_t *</em> <code>size</code> - <dd>OUT: Pointer to location to return user-block size. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for property list to query.</td></tr> + <tr> + <td valign="top"><em>hsize_t *</em> <code>size </code></td> + <td valign="top">OUT: Pointer to location to return user-block size.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -4165,25 +4491,30 @@ END SUBROUTINE h5pget_userblock_f for a file creation property list. Any pointer parameters which are passed as NULL are not queried. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of the file creation property list. - <dt><em>int *</em> <code>super</code> - <dd>OUT: Pointer to location to return super block version number. - <dt><em>int *</em> <code>freelist</code> - <dd>OUT: Pointer to location to return global freelist version number. - <dt><em>int *</em> <code>stab</code> - <dd>OUT: Pointer to location to return symbol table version number. - <dt><em>int *</em> <code>shhdr</code> - <dd>OUT: Pointer to location to return shared object header version number. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of the file creation property list.</td></tr> + <tr> + <td valign="top"><em>int *</em> <code>super</code></td> + <td valign="top">OUT: Pointer to location to return super block version number.</td></tr> + <tr> + <td valign="top"><em>int *</em> <code>freelist </code></td> + <td valign="top">OUT: Pointer to location to return global freelist version number.</td></tr> + <tr> + <td valign="top"><em>int *</em> <code>stab</code></td> + <td valign="top">OUT: Pointer to location to return symbol table version number.</td></tr> + <tr> + <td valign="top"><em>int *</em> <code>shhdr</code></td> + <td valign="top">OUT: Pointer to location to return shared object header version number.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. <dt><strong>Fortran90 Interface:</strong> h5pget_version_f <dd> <pre> -SUBROUTINE h5pget_version_f(prp_id, boot, freelist, & +SUBROUTINE h5pget_version_f(prp_id, boot, freelist, & stab, shhdr, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier @@ -4229,26 +4560,31 @@ END SUBROUTINE h5pget_version_f <code>H5Pset_vlen_mem_manager</code>, returning the parameters set by that function. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for the dataset transfer property list. - <dt><em>H5MM_allocate_t</em> <code>alloc</code> - <dd>OUT: User's allocate routine, or <code> NULL</code> - for system <code> malloc</code>. - <dt><em>void</em> *<code>alloc_info</code> - <dd>OUT: Extra parameter for user's allocation routine. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for the dataset transfer property list.</td></tr> + <tr> + <td valign="top"><em>H5MM_allocate_t</em> <code>alloc </code></td> + <td valign="top">OUT: User's allocate routine, or <code> NULL</code> + for system <code> malloc</code>.</td></tr> + <tr> + <td valign="top"><em>void</em> *<code>alloc_info</code></td> + <td valign="top">OUT: Extra parameter for user's allocation routine. <br> Contents are ignored if preceding parameter is - <code> NULL</code>. - <dt><em>H5MM_free_t</em> <code>free</code> - <dd>OUT: User's free routine, or <code> NULL</code> for - system <code>free</code>. - <dt><em>void</em> *<code>free_info</code> - <dd>OUT: Extra parameter for user's free routine. + <code> NULL</code>.</td></tr> + <tr> + <td valign="top"><em>H5MM_free_t</em> <code>free</code></td> + <td valign="top">OUT: User's free routine, or <code> NULL</code> for + system <code>free</code>.</td></tr> + <tr> + <td valign="top"><em>void</em> *<code>free_info</code></td> + <td valign="top">OUT: Extra parameter for user's free routine. <br> Contents are ignored if preceding parameter is - <code> NULL</code>. - </dl> + <code> NULL</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -4520,6 +4856,7 @@ SUBROUTINE list objects; the initial value is assumed to have any necessary setup already performed on it. +<!-- NEW PAGE --> <dt><strong>Parameters:</strong> <ul><table> <tr> @@ -4544,7 +4881,7 @@ SUBROUTINE <td>IN: Callback routine called when a property value is retrieved from the property</td></tr> <tr> - <td><em>H5P_prp_delete_func_t</em> <code>delete</code></td> + <td><em>H5P_prp_delete_func_t</em> <code>delete </code></td> <td>IN: Callback routine called when a property is deleted from a property list</td></tr> <tr> @@ -4613,7 +4950,7 @@ END SUBROUTINE h5pinsert_f <td><em>hid_t</em> <code>plist</code></td> <td>IN: Identifier of the property list</td></tr> <tr> - <td><code>hid_t</code> <em>pclass</em></td> + <td><code>hid_t</code> <em>pclass </em></td> <td>IN: Identifier of the property class</td></tr> </table></ul> @@ -4735,7 +5072,7 @@ END SUBROUTINE h5pisa_class_f <td><em>int *</em> <code>idx</code></td> <td>IN/OUT: Index of the property to begin with</td></tr> <tr> - <td><em>H5P_iterate_t</em> <code>iter_func</code></td> + <td><em>H5P_iterate_t</em> <code>iter_func </code></td> <td>IN: Function pointer to function to be called with each property iterated over</td></tr> <tr> @@ -4795,19 +5132,24 @@ SUBROUTINE pipeline; <code>plist_id</code> must be a dataset creation property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Property list identifier. - <dt><em>H5Z_filter_t</em> <code>filter</code> - <dd>IN: Filter to be modified. - <dt><em>unsigned int</em> <code>flags</code> - <dd>IN: Bit vector specifying certain general properties - of the filter. - <dt><em>size_t</em> <code>cd_nelmts</code> - <dd>IN: Number of elements in <code>cd_values</code>. - <dt><em>const unsigned int</em> <code>cd_values[]</code> - <dd>IN: Auxiliary data for the filter. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5Z_filter_t</em> <code>filter</code></td> + <td valign="top">IN: Filter to be modified.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>flags</code></td> + <td valign="top">IN: Bit vector specifying certain general properties + of the filter.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>cd_nelmts</code></td> + <td valign="top">IN: Number of elements in <code>cd_values</code>.</td></tr> + <tr> + <td valign="top"><em>const unsigned int</em> <code>cd_values[] </code></td> + <td valign="top">IN: Auxiliary data for the filter.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -4815,7 +5157,7 @@ SUBROUTINE <dt><strong>Fortran90 Interface:</strong> h5pmodify_filter_f <dd> <pre> -SUBROUTINE h5pmodify_filter_f(prp_id, filter, flags, cd_nelmts, & +SUBROUTINE h5pmodify_filter_f(prp_id, filter, flags, cd_nelmts, & cd_values, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier @@ -4953,7 +5295,7 @@ END SUBROUTINE h5pmodify_filter_f to range check the value being set for the property or may perform some tranformation or translation of the value set. The <code>get</code> callback would then - reverse the transformation or translation. + reverse the <!-- NEW PAGE -->transformation or translation. A single <code>get</code> or <code>set</code> callback could handle multiple properties by performing different actions based on the @@ -5119,36 +5461,46 @@ END SUBROUTINE h5pmodify_filter_f </P> <dt><strong>Parameters:</strong> - <ul><dl> - <dt><code>hid_t</code> <em>class</em> - <dd>IN: Property list class to register permanent property - within - <dt><code>const char *</code> <em>name</em> - <dd>IN: Name of property to register - <dt><code>size_t</code> <em>size</em> - <dd>IN: Size of property in bytes - <dt><code>void *</code> <em>default</em> - <dd>IN: Default value for property in newly created property - lists - <dt><code>H5P_prp_create_func_t</code> <em>create</em> - <dd>IN: Callback routine called when a property list is being - created and the property value will be initialized - <dt><code>H5P_prp_set_func_t</code> <em>set</em> - <dd>IN: Callback routine called before a new value is copied - into the property's value - <dt><code>H5P_prp_get_func_t</code> <em>get</em> - <dd>IN: Callback routine called when a property value is - retrieved from the property - <dt><code>H5P_prp_delete_func_t</code> <em>delete</em> - <dd>IN: Callback routine called when a property is deleted from - a property list - <dt><code>H5P_prp_copy_func_t</code> <em>copy</em> - <dd>IN: Callback routine called when a property is copied from - a property list - <dt><code>H5P_prp_close_func_t</code> <em>close</em> - <dd>IN: Callback routine called when a property list is being - closed and the property value will be disposed of - </dl></ul> + <ul><table> + <tr> + <td valign="top"><code>hid_t</code> <em>class</em></td> + <td valign="top">IN: Property list class to register permanent property + within</td></tr> + <tr> + <td valign="top"><code>const char *</code> <em>name</em></td> + <td valign="top">IN: Name of property to register</td></tr> + <tr> + <td valign="top"><code>size_t</code> <em>size</em></td> + <td valign="top">IN: Size of property in bytes</td></tr> + <tr> + <td valign="top"><code>void *</code> <em>default</em></td> + <td valign="top">IN: Default value for property in newly created property + lists</td></tr> + <tr> + <td valign="top"><code>H5P_prp_create_func_t</code> <em>create </em></td> + <td valign="top">IN: Callback routine called when a property list is being + created and the property value will be initialized</td></tr> + <tr> + <td valign="top"><code>H5P_prp_set_func_t</code> <em>set</em></td> + <td valign="top">IN: Callback routine called before a new value is copied + into the property's value</td></tr> + <tr> + <td valign="top"><code>H5P_prp_get_func_t</code> <em>get</em></td> + <td valign="top">IN: Callback routine called when a property value is + retrieved from the property</td></tr> + <tr> + <td valign="top"><code>H5P_prp_delete_func_t</code> <em>delete</em></td> + <td valign="top">IN: Callback routine called when a property is deleted from + a property list</td></tr> + <tr> + <td valign="top"><code>H5P_prp_copy_func_t</code> <em>copy</em></td> + <td valign="top">IN: Callback routine called when a property is copied from + a property list</td></tr> + <tr> + <td valign="top"><code>H5P_prp_close_func_t</code> <em>close</em></td> + <td valign="top">IN: Callback routine called when a property list is being + closed and the property value will be disposed of</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Success: a non-negative value @@ -5218,7 +5570,7 @@ END SUBROUTINE h5pregister_f <td><em>hid_t</em> <code>plid</code></td> <td>IN: Identifier of the property list to modify</td></tr> <tr> - <td><em>const char *</em><code>name</code></td> + <td><em>const char *</em><code>name </code></td> <td>IN: Name of property to remove</td></tr> </table></ul> @@ -5290,7 +5642,7 @@ END SUBROUTINE h5premove_f <td><em>hid_t</em> <code>plid</code>; <td>IN: Property list identifier to modify</td></tr> <tr> - <td><em>const char *</em><code>name</code>; + <td><em>const char *</em><code>name; </code> <td>IN: Name of property to modify</td></tr> <tr> <td><em>void *</em><code>value</code>; @@ -5357,19 +5709,22 @@ END SUBROUTINE h5pset_f For MPI-IO and other parallel systems, choose an alignment which is a multiple of the disk block size. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for a file access property list. - <dt><em>hsize_t</em> <code>threshold</code> - <dd>IN: Threshold value. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for a file access property list.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>threshold </code></td> + <td valign="top">IN: Threshold value. Must be non-negative. Note that setting the threshold value to 0 (zero) has the effect of a special case, forcing everything - to be aligned. - <dt><em>hsize_t</em> <code>alignment</code> - <dd>IN: Alignment value. - Must be a positive value. - </dl> + to be aligned.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>alignment</code></td> + <td valign="top">IN: Alignment value. + Must be a positive value.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -5454,12 +5809,14 @@ END SUBROUTINE h5pset_alignment_f See <a href="RM_H5D.html#Dataset-Create">H5Dcreate</a> for further cross-references. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>H5D_alloc_time_t</em> <code>alloc_time</code> - <dd>IN: When to allocate dataset storage space. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5D_alloc_time_t</em> <code>alloc_time </code></td> + <td valign="top">IN: When to allocate dataset storage space.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -5476,7 +5833,9 @@ SUBROUTINE h5pset_alloc_time_f(plist_id, flag, hdferr) ! H5D_ALLOC_TIME_DEFAULT_F ! H5D_ALLOC_TIME_EARLY_F ! H5D_ALLOC_TIME_LATE_F - ! H5D_ALLOC_TIME_INCR_F + ! H5D_ALLOC_TIME_INCR_F</pre> +<!-- NEW PAGE --> +<pre> INTEGER, INTENT(OUT) :: hdferr ! Error code ! 0 on success and -1 on failure END SUBROUTINE h5pset_alloc_time_f @@ -5519,16 +5878,20 @@ END SUBROUTINE h5pset_alloc_time_f <p> All ratios are real numbers between 0 and 1, inclusive. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: The dataset transfer property list identifier. - <dt><em>double</em> <code>left</code> - <dd>IN: The B-tree split ratio for left-most nodes. - <dt><em>double</em> <code>right</code> - <dd>IN: The B-tree split ratio for right-most nodes and lone nodes. - <dt><em>double</em> <code>middle</code> - <dd>IN: The B-tree split ratio for all other nodes. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: The dataset transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>left</code></td> + <td valign="top">IN: The B-tree split ratio for left-most nodes.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>right</code></td> + <td valign="top">IN: The B-tree split ratio for right-most nodes and lone nodes.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>middle </code></td> + <td valign="top">IN: The B-tree split ratio for all other nodes.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -5594,16 +5957,20 @@ END SUBROUTINE h5pset_btree_ratios_f <p> The default value for the maximum buffer is 1 Mb. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for the dataset transfer property list. - <dt><em>hsize_t</em> <code>size</code> - <dd>IN: Size, in bytes, of the type conversion and background buffers. - <dt><em>void</em> <code>tconv</code> - <dd>IN: Pointer to application-allocated type conversion buffer. - <dt><em>void</em> <code>bkg</code> - <dd>IN: Pointer to application-allocated background buffer. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for the dataset transfer property list.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>size </code></td> + <td valign="top">IN: Size, in bytes, of the type conversion and background buffers.</td></tr> + <tr> + <td valign="top"><em>void</em> <code>tconv</code></td> + <td valign="top">IN: Pointer to application-allocated type conversion buffer.</td></tr> + <tr> + <td valign="top"><em>void</em> <code>bkg</code></td> + <td valign="top">IN: Pointer to application-allocated background buffer.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -5665,18 +6032,23 @@ END SUBROUTINE h5pset_buffer_f preemption is strictly LRU) while a value of one means fully read chunks are always preempted before other chunks. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Identifier of the file access property list. - <dt><em>int</em> <code>mdc_nelmts</code> - <dd>IN: Number of elements (objects) in the meta data cache. - <dt><em>int</em> <code>rdcc_nelmts</code> - <dd>IN: Number of elements (objects) in the raw data chunk cache. - <dt><em>size_t</em> <code>rdcc_nbytes</code> - <dd>IN: Total size of the raw data chunk cache, in bytes. - <dt><em>double</em> <code>rdcc_w0</code> - <dd>IN: Preemption policy. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Identifier of the file access property list.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>mdc_nelmts</code></td> + <td valign="top">IN: Number of elements (objects) in the meta data cache.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>rdcc_nelmts</code></td> + <td valign="top">IN: Number of elements (objects) in the raw data chunk cache.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>rdcc_nbytes </code></td> + <td valign="top">IN: Total size of the raw data chunk cache, in bytes.</td></tr> + <tr> + <td valign="top"><em>double</em> <code>rdcc_w0</code></td> + <td valign="top">IN: Preemption policy.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -5728,14 +6100,17 @@ END SUBROUTINE h5pset_cache_f As a side-effect, the layout of the dataset is changed to <code>H5D_CHUNKED</code>, if it is not already. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for property list to query. - <dt><em>int</em> <code>ndims</code> - <dd>IN: The number of dimensions of each chunk. - <dt><em>const hsize_t *</em> <code>dim</code> - <dd>IN: An array containing the size of each chunk. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for property list to query.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>ndims</code></td> + <td valign="top">IN: The number of dimensions of each chunk.</td></tr> + <tr> + <td valign="top"><em>const hsize_t *</em> <code>dim </code></td> + <td valign="top">IN: An array containing the size of each chunk.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -5781,12 +6156,14 @@ END SUBROUTINE h5pset_chunk_f Lower compression levels are faster but result in less compression. This is the same algorithm as used by the GNU gzip program. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for the dataset creation property list. - <dt><em>int</em> <code>level</code> - <dd>IN: Compression level. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier for the dataset creation property list.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>level</code></td> + <td valign="top">IN: Compression level.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -5885,12 +6262,14 @@ END SUBROUTINE h5pset_deflate_f </dl> </dir></p> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dxpl_id</code> - <dd>IN: Data transfer property list identifier. - <dt><em>H5FD_mpio_xfer_t</em> <code>xfer_mode</code> - <dd>IN: Transfer mode. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dxpl_id</code></td> + <td valign="top">IN: Data transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5FD_mpio_xfer_t</em> <code>xfer_mode </code></td> + <td valign="top">IN: Transfer mode.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -5937,12 +6316,14 @@ END SUBROUTINE h5pset_dxpl_mpio_f <code>H5Pset_dxpl_multi</code> can only be used after the member map has been set with <code>H5Pset_fapl_multi</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dxpl_id</code>, - <dd>IN: Data transfer property list identifier. - <dt><em>const hid_t *</em><code>memb_dxpl</code> - <dd>IN: Array of data access property lists. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dxpl_id</code>,</td> + <td valign="top">IN: Data transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>const hid_t *</em><code>memb_dxpl </code></td> + <td valign="top">IN: Array of data access property lists.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -5997,13 +6378,15 @@ SUBROUTINE <dd>The initial error detection implementation, Fletcher32 checksum, supports error detection for chunked datasets only. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Dataset transfer property list identifier. - <dt><em>H5Z_EDC_t</em> <code>check</code> - <dd>IN: Specifies whether error checking is enabled or disabled - for dataset read operations. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Dataset transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5Z_EDC_t</em> <code>check </code></td> + <td valign="top">IN: Specifies whether error checking is enabled or disabled + for dataset read operations.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -6061,17 +6444,21 @@ END SUBROUTINE h5pset_edc_check_f external file can be of unlimited size and no more files can be added to the external files list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of a dataset creation property list. - <dt><em>const char</em> <code>*name</code> - <dd>IN: Name of an external file. - <dt><em>off_t</em> <code>offset</code> - <dd>IN: Offset, in bytes, from the beginning of the file - to the location in the file where the data starts. - <dt><em>hsize_t</em> <code>size</code> - <dd>IN: Number of bytes reserved in the file for the data. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of a dataset creation property list.</td></tr> + <tr> + <td valign="top"><em>const char</em> <code>*name </code></td> + <td valign="top">IN: Name of an external file.</td></tr> + <tr> + <td valign="top"><em>off_t</em> <code>offset</code></td> + <td valign="top">IN: Offset, in bytes, from the beginning of the file + to the location in the file where the data starts.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>size</code></td> + <td valign="top">IN: Number of bytes reserved in the file for the data.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -6132,12 +6519,14 @@ END SUBROUTINE h5pset_external_f Use of this function is only appropriate for an HDF5 file written as a family of files with the <code>FAMILY</code> file driver. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>hsize_t</em> <code>offset</code> - <dd>IN: Offset in bytes within the HDF5 file. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>offset </code></td> + <td valign="top">IN: Offset in bytes within the HDF5 file.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -6197,15 +6586,18 @@ END SUBROUTINE h5pset_family_offset_f <dd>There is currently no means for reading a file from disk then using the <code>H5FD_CORE</code> driver to manipulate the file. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>size_t</em> <code>increment</code> - <dd>IN: Size, in bytes, of memory increments. - <dt><em>hbool_t</em> <code>backing_store</code> - <dd>IN: Boolean flag indicating whether to write the file - contents to disk when the file is closed. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>increment</code></td> + <td valign="top">IN: Size, in bytes, of memory increments.</td></tr> + <tr> + <td valign="top"><em>hbool_t</em> <code>backing_store </code></td> + <td valign="top">IN: Boolean flag indicating whether to write the file + contents to disk when the file is closed.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -6256,15 +6648,18 @@ END SUBROUTINE h5pset_fapl_core_f <code>memb_fapl_id</code> is the identifier of the file access property list to be used for each family member. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em> hsize_t</em> <code>memb_size</code> - <dd>IN: Size in bytes of each file member. - <dt><em>hid_t</em> <code>memb_fapl_id</code> - <dd>IN: Identifier of file access property list for each - family member. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em> hsize_t</em> <code>memb_size</code></td> + <td valign="top">IN: Size in bytes of each file member.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>memb_fapl_id </code></td> + <td valign="top">IN: Identifier of file access property list for each + family member.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -6324,12 +6719,14 @@ END SUBROUTINE h5pset_fapl_family_f For further information, see <a href="http://www.globus.org/">http//www.globus.org/</a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code>, - <dd>IN: File access property list identifier. - <dt><em>GASS_Info</em> <code>info</code> - <dd>IN: Pointer to the GASS information structure. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code>,</td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>GASS_Info</em> <code>info </code></td> + <td valign="top">IN: Pointer to the GASS information structure.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -6494,6 +6891,7 @@ SUBROUTINE <code>(H5FD_LOG_NUM_READ | H5FD_LOG_NUM_WRITE | H5FD_LOG_NUM_SEEK)</code> </td></tr> +<!-- NEW PAGE --> <tr valign=top align=left><td> <hr> <code>H5FD_LOG_TIME_OPEN</code> @@ -6593,16 +6991,20 @@ SUBROUTINE which must be at least the size in bytes of the file to be logged. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>char *</em><code>logfile</code> - <dd>IN: Name of the log file. - <dt><em>unsigned int</em> <code>flags</code> - <dd>IN: Flags specifying the types of logging activity. - <dt><em>size_t</em> <code>buf_size</code> - <dd>IN: The size of the logging buffer. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>char *</em><code>logfile</code></td> + <td valign="top">IN: Name of the log file.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>flags </code></td> + <td valign="top">IN: Flags specifying the types of logging activity.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>buf_size</code></td> + <td valign="top">IN: The size of the logging buffer.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns non-negative if successful. Otherwise returns negative. @@ -6661,14 +7063,17 @@ SUBROUTINE Users should not modify the info while it is defined in a property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>MPI_Comm</em> <code>comm</code> - <dd>IN: MPI-2 communicator. - <dt><em>MPI_Info</em> <code>info</code> - <dd>IN: MPI-2 info object. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>MPI_Comm</em> <code>comm </code></td> + <td valign="top">IN: MPI-2 communicator.</td></tr> + <tr> + <td valign="top"><em>MPI_Info</em> <code>info</code></td> + <td valign="top">IN: MPI-2 info object.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -6727,12 +7132,14 @@ END SUBROUTINE h5pset_fapl_mpio_f Users should not modify the communicator while it is defined in a property list. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>MPI_Comm</em> <code>comm</code> - <dd>IN: MPI-2 communicator. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>MPI_Comm</em> <code>comm </code></td> + <td valign="top">IN: MPI-2 communicator.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -6841,29 +7248,36 @@ END SUBROUTINE h5pset_fapl_mpiposix_f <code>l</code> for <code>H5FD_MEM_LHEAP</code> <br> <code>o</code> for <code>H5FD_MEM_OHDR</code> - </dir> + </dir></dd></dt> +<!-- NEW PAGE --> <dt><code>memb_addr</code> <dd>The default value is <code>HADDR_UNDEF</code> for each element. </dl> </dir> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>const H5FD_mem_t *</em><code>memb_map</code> - <dd>IN: Maps memory usage types to other memory usage types. - <dt><em>const hid_t *</em><code>memb_fapl</code> - <dd>IN: Property list for each memory usage type. - <dt><em>const char **</em><code>memb_name</code> - <dd>IN: Name generator for names of member files. - <dt><em>const haddr_t *</em><code>memb_addr</code> - <dd>IN: The offsets within the virtual address space, + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>const H5FD_mem_t *</em><code>memb_map </code></td> + <td valign="top">IN: Maps memory usage types to other memory usage types.</td></tr> + <tr> + <td valign="top"><em>const hid_t *</em><code>memb_fapl</code></td> + <td valign="top">IN: Property list for each memory usage type.</td></tr> + <tr> + <td valign="top"><em>const char **</em><code>memb_name</code></td> + <td valign="top">IN: Name generator for names of member files.</td></tr> + <tr> + <td valign="top"><em>const haddr_t *</em><code>memb_addr</code></td> + <td valign="top">IN: The offsets within the virtual address space, from <code>0</code> (zero) to <code>HADDR_MAX</code>, - at which each type of data storage begins. - <dt><em>hbool_t</em> <code>relax</code> - <dd>IN: Allows read-only access to incomplete file sets - when <code>TRUE</code>. - </dl> + at which each type of data storage begins.</td></tr> + <tr> + <td valign="top"><em>hbool_t</em> <code>relax</code></td> + <td valign="top">IN: Allows read-only access to incomplete file sets + when <code>TRUE</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -6907,7 +7321,9 @@ SUBROUTINE h5pset_fapl_multi_f(prp_id, memb_map, memb_fapl, memb_name, & INTEGER,DIMENSION(0:H5FD_MEM_NTYPES_F-1),INTENT(IN) :: memb_map INTEGER(HID_T),DIMENSION(0:H5FD_MEM_NTYPES_F-1),INTENT(IN) :: memb_fapl - CHARACTER(LEN=*),DIMENSION(0:H5FD_MEM_NTYPES_F-1),INTENT(IN) :: memb_name + CHARACTER(LEN=*),DIMENSION(0:H5FD_MEM_NTYPES_F-1),INTENT(IN) :: memb_name</pre> +<!-- NEW PAGE --> +<pre> REAL, DIMENSION(0:H5FD_MEM_NTYPES_F-1), INTENT(IN) :: memb_addr ! Numbers in the interval [0,1) (e.g. 0.0 0.1 0.5 0.2 0.3 0.4) ! real address in the file will be calculated as X*HADDR_MAX @@ -6941,10 +7357,11 @@ END SUBROUTINE h5pset_fapl_multi_f <dd><code>H5Pset_fapl_sec2</code> modifies the file access property list to use the <code>H5FD_SEC2</code> driver. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -7018,19 +7435,23 @@ END SUBROUTINE h5pset_fapl_sec2_f HDF5 provides no mechanism to determine whether it was called as the special case invoked by <code>H5Pset_fapl_split</code>. <dt><strong>Parameters:</strong> - <dl> - <dt> - <dt><em>hid_t</em> <code>fapl_id</code>, - <dd>IN: File access property list identifier. - <dt><em>const char *</em><code>meta_ext</code>, - <dd>IN: Metadata filename extension. - <dt><em>hid_t</em> <code>meta_plist_id</code>, - <dd>IN: File access property list identifier for the metadata file. - <dt><em>const char *</em><code>raw_ext</code>, - <dd>IN: Raw data filename extension. - <dt><em>hid_t</em> <code>raw_plist_id</code> - <dd>IN: File access property list identifier for the raw data file. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code>,</td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>meta_ext, </code></td> + <td valign="top">IN: Metadata filename extension.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>meta_plist_id</code>,</td> + <td valign="top">IN: File access property list identifier for the metadata file.</td></tr> + <tr> + <td valign="top"><em>const char *</em><code>raw_ext</code>,</td> + <td valign="top">IN: Raw data filename extension.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>raw_plist_id</code></td> + <td valign="top">IN: File access property list identifier for the raw data file.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -7109,12 +7530,14 @@ END SUBROUTINE h5pset_fapl_split_f Storage Resource Broker (SRB). For further information, see <a href="http://www.npaci.edu/Research/DI/srb/">http//www.npaci.edu/Research/DI/srb/</a>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>SRB_Info</em> <code>info</code> - <dd>IN: Pointer to the SRB information structure. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>SRB_Info</em> <code>info</code></td> + <td valign="top">IN: Pointer to the SRB information structure.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -7149,10 +7572,11 @@ SUBROUTINE <dd><code>H5Pset_fapl_stdio</code> modifies the file access property list to use the standard I/O driver, <code>H5FD_STDIO</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -7237,12 +7661,14 @@ END SUBROUTINE h5pset_fapl_stdio_f <code>H5Pset_fapl_stream</code> and <code>H5Pget_fapl_stream</code> are not intended for use in a parallel environment. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>H5FD_stream_fapl_t *</em><code>fapl</code> - <dd>IN: The streaming I/O file access property list. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5FD_stream_fapl_t *</em><code>fapl </code></td> + <td valign="top">IN: The streaming I/O file access property list.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -7315,13 +7741,15 @@ SUBROUTINE </table> </div> <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>H5F_close_degree_t</em> <code>fc_degree</code> - <dd>IN: Pointer to a location containing the file close degree property, - the value of <code>fc_degree</code>. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5F_close_degree_t</em> <code>fc_degree </code></td> + <td valign="top">IN: Pointer to a location containing the file close degree property, + the value of <code>fc_degree</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -7350,7 +7778,6 @@ END SUBROUTINE h5pset_fclose_degree_f --> </dl> -<!-- NEW PAGE --> <!-- HEADER RIGHT "H5Pset_fill_time" --> <hr> <dl> @@ -7393,12 +7820,14 @@ END SUBROUTINE h5pset_fclose_degree_f See <a href="RM_H5D.html#Dataset-Create">H5Dcreate</a> for further cross-references. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>H5D_fill_time_t</em> <code>fill_time</code> - <dd>IN: When to write fill values to a dataset. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5D_fill_time_t</em> <code>fill_time </code></td> + <td valign="top">IN: When to write fill values to a dataset.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -7484,14 +7913,17 @@ END SUBROUTINE h5pset_fill_time_f See <a href="RM_H5D.html#Dataset-Create">H5Dcreate</a> for further cross-references. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - <dt><em>hid_t</em> <code>type_id</code>, - <dd>IN: Datatype of <code>value</code>. - <dt><em>const void *</em><code>value</code> - <dd>IN: Pointer to buffer containing value to use as fill value. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id</code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + <tr> + <td valign="top"><em>hid_t</em> <code>type_id</code>,</td> + <td valign="top">IN: Datatype of <code>value</code>.</td></tr> + <tr> + <td valign="top"><em>const void *</em><code>value </code></td> + <td valign="top">IN: Pointer to buffer containing value to use as fill value.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -7611,19 +8043,24 @@ END SUBROUTINE h5pset_fill_value_f If multiple filters are set for a property list, they will be applied to each chunk in the order in which they were set. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Property list identifier. - <dt><em>H5Z_filter_t</em> <code>filter</code> - <dd>IN: Filter to be added to the pipeline. - <dt><em>unsigned int</em> <code>flags</code> - <dd>IN: Bit vector specifying certain general properties - of the filter. - <dt><em>size_t</em> <code>cd_nelmts</code> - <dd>IN: Number of elements in <code>cd_values</code>. - <dt><em>const unsigned int</em> <code>cd_values[]</code> - <dd>IN: Auxiliary data for the filter. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5Z_filter_t</em> <code>filter</code></td> + <td valign="top">IN: Filter to be added to the pipeline.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>flags</code></td> + <td valign="top">IN: Bit vector specifying certain general properties + of the filter.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>cd_nelmts</code></td> + <td valign="top">IN: Number of elements in <code>cd_values</code>.</td></tr> + <tr> + <td valign="top"><em>const unsigned int</em> <code>cd_values[] </code></td> + <td valign="top">IN: Auxiliary data for the filter.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -7693,14 +8130,17 @@ END SUBROUTINE h5pset_filter_f Valid callback function return values are <code>H5Z_CB_FAIL</code> and <code>H5Z_CB_CONT</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Dataset transfer property list identifier. - <dt><em>H5Z_filter_func_t</em> <code>func</code> - <dd>IN: User-defined filter callback function. - <dt><em>void *</em><code>op_data</code> - <dd>IN: User-defined input data for the callback function. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Dataset transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5Z_filter_func_t</em> <code>func </code></td> + <td valign="top">IN: User-defined filter callback function.</td></tr> + <tr> + <td valign="top"><em>void *</em><code>op_data</code></td> + <td valign="top">IN: User-defined input data for the callback function.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -7736,10 +8176,11 @@ SUBROUTINE <dd>The initial error detection implementation supports error detection for chunked datasets only. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Dataset creation property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -7790,13 +8231,15 @@ END SUBROUTINE h5pset_fletcher32_f <p> The default value for garbage collecting references is off. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: File access property list identifier. - <dt><em>unsigned</em> <code>gc_ref</code> - <dd>IN: Flag setting reference garbage collection to - on (<code>1</code>) or off (<code>0</code>). - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>unsigned</em> <code>gc_ref </code></td> + <td valign="top">IN: Flag setting reference garbage collection to + on (<code>1</code>) or off (<code>0</code>).</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -7851,14 +8294,15 @@ END SUBROUTINE h5pset_gc_references_f but the library will use more memory during hyperslab I/O. The default value of <code>vector_size</code> is <code>1024</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>dxpl_id</code> - <dd>IN: Dataset transfer property list identifier. - <dt><em>size_t</em> <code>vector_size</code> - <dd>IN: Number of I/O vectors to accumulate in memory for I/O operations. - Must be greater than <code>1</code> (one). - Default value: <code>1024</code>. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>dxpl_id</code></td> + <td valign="top">IN: Dataset transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>vector_size </code></td> + <td valign="top">IN: Number of I/O vectors to accumulate in memory for I/O operations. + Must be greater than <code>1</code> (one). Default value: <code>1024</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -7905,12 +8349,14 @@ END SUBROUTINE h5pset_hyper_vector_size_f or have an average rank of 1.5 times the value of <code>ik</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to query. - <dt><em>int</em> <code>ik</code> - <dd>IN: 1/2 rank of chunked storage B-tree. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier of property list to query.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>ik</code></td> + <td valign="top">IN: 1/2 rank of chunked storage B-tree.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -7970,12 +8416,14 @@ END SUBROUTINE h5pset_istore_k_f <a href="RM_H5D.html#Dataset-Write">H5Dwrite</a> documentation for details. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to query. - <dt><em>H5D_layout_t</em> <code>layout</code> - <dd>IN: Type of storage layout for raw data. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of property list to query.</td></tr> + <tr> + <td valign="top"><em>H5D_layout_t</em> <code>layout </code></td> + <td valign="top">IN: Type of storage layout for raw data.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8037,12 +8485,14 @@ END SUBROUTINE h5pset_layout_f potentially significantly improving library and application performance. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>hsize_t</em> <code>size</code> - <dd>IN: Minimum size, in bytes, of metadata block allocations. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>size</code></td> + <td valign="top">IN: Minimum size, in bytes, of metadata block allocations.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -8134,12 +8584,14 @@ END SUBROUTINE h5pset_meta_block_size_f Use of this function is only appropriate for an HDF5 file written as a set of files with the <code>MULTI</code> file driver. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list or data transfer property list identifier. - <dt><em>H5FD_mem_t</em> <code>type</code> - <dd>OUT: Type of data. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id</code></td> + <td valign="top">IN: File access property list or data transfer property list identifier.</td></tr> + <tr> + <td valign="top"><em>H5FD_mem_t</em> <code>type </code></td> + <td valign="top">OUT: Type of data.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8180,13 +8632,15 @@ SUBROUTINE property to TRUE. Otherwise the I/O pipeline treats the destination datapoints as completely uninitialized. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for the dataset transfer property list. - <dt><em>hbool_t</em> <code>status</code> - <dd>IN: Status of for the dataset transfer property list - (TRUE/FALSE). - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for the dataset transfer property list.</td></tr> + <tr> + <td valign="top"><em>hbool_t</em> <code>status </code></td> + <td valign="top">IN: Status of for the dataset transfer property list + (TRUE/FALSE).</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8243,10 +8697,11 @@ END SUBROUTINE h5pset_preserve_f This filter is designed to be used in combination with a compression filter. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist_id</code> - <dd>IN: Dataset creation property list identifier. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist_id </code></td> + <td valign="top">IN: Dataset creation property list identifier.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8296,12 +8751,14 @@ END SUBROUTINE h5pset_shuffle_f Setting the value to 0 with this API function will turn off the data sieving, even if the VFL driver attempts to use that strategy. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier. - <dt><em>hsize_t</em> <code>size</code> - <dd>IN: Maximum size, in bytes, of data sieve buffer. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>size</code></td> + <td valign="top">IN: Maximum size, in bytes, of data sieve buffer.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful. Otherwise returns a negative value. @@ -8349,14 +8806,17 @@ END SUBROUTINE h5pset_sieve_buf_size_f <code>sizeof(hsize_t)</code> in the library (normally 8 bytes). Valid values currently are 2, 4, 8 and 16. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to modify. - <dt><em>size_t</em> <code>sizeof_addr</code> - <dd>IN: Size of an object offset in bytes. - <dt><em>size_t</em> <code>sizeof_size</code> - <dd>IN: Size of an object length in bytes. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of property list to modify.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>sizeof_addr </code></td> + <td valign="top">IN: Size of an object offset in bytes.</td></tr> + <tr> + <td valign="top"><em>size_t</em> <code>sizeof_size</code></td> + <td valign="top">IN: Size of an object length in bytes.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8422,14 +8882,16 @@ END SUBROUTINE h5pset_sizes_f Setting <code>size</code> to zero (<code>0</code>) disables the small data block mechanism. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>fapl_id</code> - <dd>IN: File access property list identifier . - <dt><em>hsize_t</em> <code>size</code> - <dd>IN: Maximum size, in bytes, of the small data block. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>fapl_id </code></td> + <td valign="top">IN: File access property list identifier.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>size</code></td> + <td valign="top">IN: Maximum size, in bytes, of the small data block. <br> - The default size is <code>2048</code>. - </dl> + The default size is <code>2048</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise a negative value. @@ -8485,14 +8947,17 @@ END SUBROUTINE h5pset_small_data_block_size_f contain 1.5 times the number of symbols specified by <code>lk</code>. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for property list to query. - <dt><em>int</em> <code>ik</code> - <dd>IN: Symbol table tree rank. - <dt><em>int</em> <code>lk</code> - <dd>IN: Symbol table node size. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist </code></td> + <td valign="top">IN: Identifier for property list to query.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>ik</code></td> + <td valign="top">IN: Symbol table tree rank.</td></tr> + <tr> + <td valign="top"><em>int</em> <code>lk</code></td> + <td valign="top">IN: Symbol table node size.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8652,15 +9117,18 @@ END LIBRARY-SET OPTION TAGS --> and for a list of SZIP-related references. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Dataset creation or dataset transfer property list - identifier. - <dt><em>unsigned int</em> <code>options_mask</code> - <dd>IN: A bit-mask conveying the desired SZIP options. - <dt><em>unsigned int</em> <code>pixels_per_block</code> - <dd>IN: The number of pixels or data elements in each data block. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Dataset creation or dataset transfer property list + identifier.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>options_mask</code></td> + <td valign="top">IN: A bit-mask conveying the desired SZIP options.</td></tr> + <tr> + <td valign="top"><em>unsigned int</em> <code>pixels_per_block </code></td> + <td valign="top">IN: The number of pixels or data elements in each data block.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8771,12 +9239,14 @@ END SUBROUTINE h5pset_szip_f The default user block size is 0; it may be set to any power of 2 equal to 512 or greater (512, 1024, 2048, etc.). <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier of property list to modify. - <dt><em>hsize_t</em> <code>size</code> - <dd>IN: Size of the user-block in bytes. - </dl> + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier of property list to modify.</td></tr> + <tr> + <td valign="top"><em>hsize_t</em> <code>size </code></td> + <td valign="top">IN: Size of the user-block in bytes.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8855,26 +9325,31 @@ END SUBROUTINE h5pset_userblock_f and the <code>alloc_info</code> and <code>free_info</code> parameters are ignored. <dt><strong>Parameters:</strong> - <dl> - <dt><em>hid_t</em> <code>plist</code> - <dd>IN: Identifier for the dataset transfer property list. - <dt><em>H5MM_allocate_t</em> <code>alloc</code> - <dd>IN: User's allocate routine, or <code> NULL</code> - for system <code> malloc</code>. - <dt><em>void</em> *<code>alloc_info</code> - <dd>IN: Extra parameter for user's allocation routine. + <ul><table> + <tr> + <td valign="top"><em>hid_t</em> <code>plist</code></td> + <td valign="top">IN: Identifier for the dataset transfer property list.</td></tr> + <tr> + <td valign="top"><em>H5MM_allocate_t</em> <code>alloc </code></td> + <td valign="top">IN: User's allocate routine, or <code> NULL</code> + for system <code> malloc</code>.</td></tr> + <tr> + <td valign="top"><em>void</em> *<code>alloc_info</code></td> + <td valign="top">IN: Extra parameter for user's allocation routine. <br> Contents are ignored if preceding parameter is - <code> NULL</code>. - <dt><em>H5MM_free_t</em> <code>free</code> - <dd>IN: User's free routine, or <code> NULL</code> - for system <code>free</code>. - <dt><em>void</em> *<code>free_info</code> - <dd>IN: Extra parameter for user's free routine. + <code> NULL</code>.</td></tr> + <tr> + <td valign="top"><em>H5MM_free_t</em> <code>free</code></td> + <td valign="top">IN: User's free routine, or <code> NULL</code> + for system <code>free</code>.</td></tr> + <tr> + <td valign="top"><em>void</em> *<code>free_info</code></td> + <td valign="top">IN: Extra parameter for user's free routine. <br> Contents are ignored if preceding parameter is - <code> NULL</code>. - </dl> + <code> NULL</code>.</td></tr> + </table></ul> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; otherwise returns a negative value. @@ -8921,7 +9396,7 @@ SUBROUTINE <dt><strong>Parameters:</strong> <ul><table> <tr> - <td><em>H5P_class_t</em> <code>class</code></td> + <td><em>H5P_class_t</em> <code>class </code></td> <td>IN: Property list class from which to remove permanent property</td></tr> <tr> @@ -9202,14 +9677,13 @@ And in this document, the </td></tr> </table> </center> -<hr> -<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> +<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 14 January 2004"); +document.writeln("Last modified: 24 February 2004"); --> </SCRIPT> |