diff options
Diffstat (limited to 'doc/html/RM_H5P.html')
| -rw-r--r-- | doc/html/RM_H5P.html | 676 |
1 files changed, 617 insertions, 59 deletions
diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html index f2e23d7..e75911e 100644 --- a/doc/html/RM_H5P.html +++ b/doc/html/RM_H5P.html @@ -120,19 +120,25 @@ which require many different parameters to be easily manipulated. <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> -<!--<li><a href="#Property-SetDriver">H5Pset_driver</a> --> + <li><a href="#Property-SetDriver">H5Pset_driver</a> <li><a href="#Property-GetDriver">H5Pget_driver</a> -<!--<li><a href="#Property-GetDriverInfo">H5Pget_driver_info</a> --> + <li><a href="#Property-GetDriverInfo">H5Pget_driver_info</a> <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> @@ -189,8 +195,11 @@ which require many different parameters to be easily manipulated. <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> @@ -220,6 +229,8 @@ which require many different parameters to be easily manipulated. <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> @@ -265,25 +276,25 @@ facilitate moving easily between them.</i> <p><i>Generic Properties</i> <ul> - <li><a href="#Property-CreateClass">H5Pcreate_class</a> + <li><a href="#Property-CreateClass">h5pcreate_class_f</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> + <li><a href="#Property-Register">h5pregister_f</a> + <li><a href="#Property-Insert">h5pinsert_f</a> + <li><a href="#Property-Set">h5pset_f</a> + <li><a href="#Property-Exist">h5pexist_f</a> + <li><a href="#Property-GetSize">h5pget_size_f</a> + <li><a href="#Property-GetNProps">h5pget_nprops_f</a> + <li><a href="#Property-GetClassName">h5pget_class_name_f</a> + <li><a href="#Property-GetClassParent">h5pget_class_parent_f</a> + <li><a href="#Property-IsAClass">h5pisa_class_f</a> + <li><a href="#Property-Get">h5pget_f</a> + <li><a href="#Property-Equal">h5pequal_f</a> +<!--<li><a href="#Property-Iterate">h5piterate_f</a> --> + <li><a href="#Property-CopyProp">h5pcopy_prop_f</a> + <li><a href="#Property-Remove">h5premove_f</a> + <li><a href="#Property-Unregister">h5punregister_f</a> + <li><a href="#Property-CloseList">h5pclose_list_f</a> + <li><a href="#Property-CloseClass">h5pclose_class_f</a> </ul> <p><i>File Creation Properties</i> @@ -332,8 +343,11 @@ facilitate moving easily between them.</i> <li><a href="#Property-SetAllocTime">h5pset_alloc_time_f</a> <li><a href="#Property-GetAllocTime">h5pget_alloc_time_f</a> <li><a href="#Property-SetFilter">h5pset_filter_f</a> +<!--<li><a href="#Property-AllFiltersAvail">h5pall_filters_avail_f</a> --> <!--<li><a href="#Property-GetNFilters">h5pget_nfilters_f</a> --> <li><a href="#Property-GetFilter">h5pget_filter_f</a> +<!--<<li><a href="#Property-GetFilterById">h5pget_filter_by_id_f</a> --> +<!--<<li><a href="#Property-ModifyFilter">h5pmodify_filter_f</a> --> <li><a href="#Property-SetFletcher32">h5pset_fletcher32_f</a> <li><a href="#Property-SetShuffle">h5pset_shuffle_f</a> <!--<li><a href="#Property-SetSzip">h5pset_szip_f</a> --> @@ -359,7 +373,9 @@ facilitate moving easily between them.</i> <i>File Access Properties</i> <ul> +<!--<li><a href="#Property-SetDriver">h5pset_driver_f</a> --> <li><a href="#Property-GetDriver">h5pget_driver_f</a> +<!--<li><a href="#Property-GetDriverInfo">h5pget_driver_info_f</a> --> <li><a href="#Property-SetMetaBlockSize">h5pset_meta_block_size_f</a> <li><a href="#Property-GetMetaBlockSize">h5pget_meta_block_size_f</a> <li><a href="#Property-SetSieveBufSize">h5pset_sieve_buf_size_f</a> @@ -374,8 +390,16 @@ facilitate moving easily between them.</i> <!--<li><a href="#Property-GetCore">h5pget_core_f</a> --> <li><a href="#Property-SetFaplMpio">h5pset_fapl_mpio_f</a> || <li><a href="#Property-GetFaplMpio">h5pget_fapl_mpio_f</a> || + <li><a href="#Property-SetFaplMpiPosix">h5pset_fapl_mpiposix_f</a> || + <li><a href="#Property-GetFaplMpiPosix">h5pget_fapl_mpiposix_f</a> || <!--<li><a href="#Property-SetFamily">h5pset_family_f</a> --> <!--<li><a href="#Property-GetFamily">h5pget_family_f</a> --> +<!--<li><a href="#Property-SetFamilyOffset">h5pset_family_offset_f</a> --> +<!--<li><a href="#Property-GetFamilyOffset">h5pget_family_offset_f</a> --> +<!--<li><a href="#Property-SetFaplMulti">h5pset_fapl_multi_f</a> --> +<!--<li><a href="#Property-GetFaplMulti">h5pget_fapl_multi_f</a> --> +<!--<li><a href="#Property-SetMultiType">h5pset_multi_type_f</a> --> +<!--<li><a href="#Property-GetMultiType">h5pget_multi_type_f</a> --> <li><a href="#Property-SetCache">h5pset_cache_f</a> <li><a href="#Property-GetCache">h5pget_cache_f</a> <li><a href="#Property-SetSplit">h5pset_split_f</a> @@ -401,6 +425,10 @@ facilitate moving easily between them.</i> <li><a href="#Property-GetBTreeRatios">h5pget_btree_ratios_f</a> <li><a href="#Property-SetDxplMpio">h5pset_dxpl_mpio_f</a> || <li><a href="#Property-GetDxplMpio">h5pget_dxpl_mpio_f</a> || +<!--<li><a href="#Property-SetDxplMulti">h5pset_dxpl_multi_f</a> --> +<!--<li><a href="#Property-GetDxplMulti">h5pget_dxpl_multi_f</a> --> +<!--<li><a href="#Property-SetMultiType">h5pset_multi_type_f</a> --> +<!--<li><a href="#Property-GetMultiType">h5pget_multi_type_f</a> --> <br> <li><a href="#Property-SetSmallData">h5pset_small_data_block_size_f</a> <li><a href="#Property-GetSmallData">h5pget_small_data_block_size_f</a> @@ -3412,6 +3440,36 @@ facilitate moving easily between them.</i> <hr> <dl> + <dt><strong>Name:</strong> <a name="Property-AllFiltersAvail">H5Pall_filters_avail</a> + <dt><strong>Signature:</strong> + <dd><em>htri_t</em> <code>H5Pall_filters_avail</code>(<em>hid_t</em> <code>dcpl_id</code>) + <dt><strong>Purpose:</strong> + <dd>Verifies that all required filters are available. + <dt><strong>Description:</strong> + <dd><code>H5Pall_filters_avail</code> verifies that all of the filters + 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> + <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> + Returns <code>FAIL</code>, a negative value, on error. +<!--<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#h5pall_filters_avail_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> <dt><strong>Name:</strong> <a name="Property-GetNFilters">H5Pget_nfilters</a> <dt><strong>Signature:</strong> <dd><em>int</em> <code>H5Pget_nfilters</code>(<em>hid_t</em> <code>plist</code>) @@ -3553,6 +3611,141 @@ facilitate moving easily between them.</i> </dl> +<hr> +<dl> + <dt><strong>Name:</strong> <a name="Property-GetFilterById">H5Pget_filter_by_id</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Pget_filter_by_id</code>( + <em>hid_t</em> <code>plist_id</code>, + <em>H5Z_filter_t</em> <code>filter</code>, + <em>unsigned int *</em><code>flags</code>, + <em>size_t *</em><code>cd_nelmts</code>, + <em>unsigned int</em> <code>cd_values[]</code>, + <em>size_t</em> <code>namelen</code>, + <em>char *</em><code>name[]</code> + ) + <dt><strong>Purpose:</strong> + <dd>Returns information about the specified filter. + <dt><strong>Description:</strong> + <dd><code>H5Pget_filter_by_id</code> returns information about the + filter specified in <code>filter</code>, a filter identifier. + <p> + If <code>plist_id</code> identifies a dataset creation property list, + <code>filter</code> will be in a permanent filter pipeline. + If <code>plist_id</code> identifies a data transfer property list, + <code>filter</code> will be in a transient filter pipeline. + <p> + The <code>filter</code> and <code>flags</code> parameters are used + in the same manner as described in the discussion of + <a href="#Property-SetFilter"><code>H5Pset_filter</code></a>. + <p> + Aside from the fact that they are used for output, the + parameters <code>cd_nelmts</code> and <code>cd_values[]</code> are + used in the same manner as described in the discussion + of <a href="#Property-SetFilter"><code>H5Pset_filter</code></a>. + On input, the <code>cd_nelmts</code> parameter indicates the + number of entries in the <code>cd_values[]</code> array + allocated by the calling program; on exit it contains the + number of values defined by the filter. + <p> + On input, the <code>name_len</code> parameter indicates the + number of characters allocated for the filter name + by the calling program in the array <code>name[]</code>. + On exit it contains the length in characters of name of the filter. + On exit <code>name[]</code> contains the name of the filter + with one character of the name in each element of the array. + <p> + If the filter specified in <code>filter</code> is not + 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> + <dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. +<!--<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#h5pget_filter_by_id_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> + <dt><strong>Name:</strong> <a name="Property-ModifyFilter">H5Pmodify_filter</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Pmodify_filter</code>(<em>hid_t</em> <code>plist</code>, + <em>H5Z_filter_t</em> <code>filter</code>, + <em>unsigned int</em> <code>flags</code>, + <em>size_t</em> <code>cd_nelmts</code>, + <em>const unsigned int</em> <code>cd_values[]</code> + ) + <dt><strong>Purpose:</strong> + <dd>Modifies a filter in the filter pipeline. + <dt><strong>Description:</strong> + <dd><code>H5Pmodify_filter</code> modifies the specified + <code>filter</code> in the filter pipeline. + If <code>plist</code> is a dataset creation property list, + the modified filter is in a permanent filter pipeline; + if <code>plist</code> is a dataset transfer property list, + the modified filter is in a transient filter pipeline. + <p> + The <code>filter</code>, <code>flags</code> + <code>cd_nelmts[]</code>, and <code>cd_values</code> parameters + are used in the same manner and accept the same values as described + in the discussion of <a href="#Property-SetFilter">H5Pset_filter</a>. + <dt><strong>Note:</strong> + <dd>This function currently supports only the permanent filter + 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> + <dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. + +<!--<dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#h5pmodify_filter_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + @@ -3563,26 +3756,20 @@ facilitate moving easily between them.</i> <dl> <dt><strong>Name:</strong> <a name="Property-SetShuffle">H5Pset_shuffle</a> <dt><strong>Signature:</strong> - <dd><em>herr_t</em> <code>H5Pset_shuffle</code>(<em>hid_t</em> <code>plist</code>, - <em>unsigned int</em> <code>bytes_in_type</code>) + <dd><em>herr_t</em> <code>H5Pset_shuffle</code>(<em>hid_t</em> <code>plist_id</code>) <dt><strong>Purpose:</strong> <dd>Sets up use of the shuffle filter. <dt><strong>Description:</strong> <dd><code>H5Pset_shuffle</code> sets the shuffle filter, <code>H5Z_FILTER_SHUFFLE</code>, - in the dataset creation property list <code>plist</code>. - <p> - The parameter <code>bytes_in_type</code>indicates the size - in bytes of the dataset's datatype. - If the datatype is a struct, <code>bytes_in_type</code> - specifies the size in bytes of the entire struct. + in the dataset creation property list <code>plist_id</code>. <p> The shuffle filter <span class=termEmphasis>de-interlaces</span> a block of data by reordering the bytes. All the bytes from one consistent byte position of each data element are placed together in one block; all bytes from a second consistent byte position of - each data element are placed together in one block; etc. + each data element are placed together a second block; etc. For example, given three data elements of a 4-byte datatype stored as <code>012301230123</code>, shuffling will re-order data as <code>000111222333</code>. @@ -3592,10 +3779,8 @@ facilitate moving easily between them.</i> can increase the compression ratio. <dt><strong>Parameters:</strong> <dl> - <dt><em>hid_t</em> <code>plist</code> + <dt><em>hid_t</em> <code>plist_id</code> <dd>IN: Dataset creation property list identifier. - <dt><em>unsigned int</em> <code>bytes_in_type</code> - <dd>IN: Size of datatype in bytes. </dl> <dt><strong>Returns:</strong> <dd>Returns a non-negative value if successful; @@ -3641,15 +3826,6 @@ facilitate moving easily between them.</i> </dl> - - - - - - - - - <hr> <dl> <dt><strong>Name:</strong> <a name="Property-SetSzip">H5Pset_szip</a> @@ -3848,17 +4024,6 @@ facilitate moving easily between them.</i> </dl> - - - - - - - - - - - <hr> <dl> <dt><strong>Name:</strong> <a name="Property-SetEdcCheck">H5Pset_edc_check</a> @@ -4479,8 +4644,41 @@ facilitate moving easily between them.</i> <hr> <dl> <dt><strong>Name:</strong> <a name="Property-SetHyperVectorSize">H5Pset_hyper_vector_size</a> - - + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Pset_hyper_vector_size</code>(<em>hid_t</em> <code>dxpl_id</code>, + <em>size_t</em> <code>vector_size</code> + ) + <dt><strong>Purpose:</strong> + <dd>Sets number of I/O vectors to be read/written in hyperslab I/O. + <dt><strong>Description:</strong> + <dd><code>H5Pset_hyper_vector_size</code> sets the number of + I/O vectors to be accumulated in memory before being issued + to the lower levels of the HDF5 library for reading or writing the + actual data. + <p> + The <em>I/O vectors</em> are hyperslab offset and length pairs + and are set at the time of the definition of the hyperslab. + <p> + The number of I/O vectors is passed in <code>vector_size</code> + to be set in the dataset transfer property list <code>dxpl_id</code>. + <code>vector_size</code> must be greater than <code>1</code> (one). + <p> + <code>H5Pset_hyper_vector_size</code> is an I/O optimization function; + increasing <code>vector_size</code> should provide better performance, + 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> + <dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. <dt><strong>Non-C API(s):</strong> <dd><a href="fortran/h5p_FORTRAN.html#h5pset_hyper_vector_size_f" target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> @@ -4494,6 +4692,33 @@ facilitate moving easily between them.</i> <hr> <dl> <dt><strong>Name:</strong> <a name="Property-GetHyperVectorSize">H5Pget_hyper_vector_size</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Pget_hyper_vector_size</code>(<em>hid_t</em> <code>dxpl_id</code>, + <em>size_t *</em><code>vector_size</code> + ) + <dt><strong>Purpose:</strong> + <dd>Retrieves number of I/O vectors to be read/written in hyperslab I/O. + <dt><strong>Description:</strong> + <dd><code>H5Pset_hyper_vector_size</code> retrieves the number of + I/O vectors to be accumulated in memory before being issued + to the lower levels of the HDF5 library for reading or writing the + actual data. + <p> + The number of I/O vectors set in the dataset transfer property list + <code>dxpl_id</code> is returned in <code>vector_size</code>. + Unless the default value is in use, <code>vector_size</code> + 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> + <dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. <dt><strong>Non-C API(s):</strong> @@ -5209,8 +5434,8 @@ facilitate moving easily between them.</i> family member. </dl> <dt><strong>Returns:</strong> - <dd>Returns a non-negative value if successful. - Otherwise returns a negative value. + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. <!-- <dt><strong>Non-C API(s):</strong> <dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f" @@ -5249,8 +5474,111 @@ facilitate moving easily between them.</i> family member. </dl> <dt><strong>Returns:</strong> - <dd>Returns a non-negative value if successful. - Otherwise returns a negative value. + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + + + + + +<hr> +<dl> + <dt><strong>Name:</strong> <a name="Property-SetFamilyOffset">H5Pset_family_offset</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Pset_family_offset</code> ( + <em>hid_t</em> <code>fapl_id</code>, + <em>hsize_t</em> <code>offset</code> + ) + <dt><strong>Purpose:</strong> + <dd>Sets offset property for low-level access to a file in a family of files. + <dt><strong>Description:</strong> + <dd><code>H5Pset_family_offset</code> sets the offset property in the + file access property list <code>fapl_id</code> so that the user application + can retrieve a file handle for low-level access to a particluar member + of a family of files. The file handle is retrieved with a separate call + to <a href="RM_H5F.html#File-GetVfdHandle"><code>H5Fget_vfd_handle</code></a> + (or, in special circumstances, to <code>H5FDget_vfd_handle</code>; + see <cite>Virtual File Layer</cite> and <cite>List of VFL Functions</cite> + in <a href="TechNotes.html"><cite>HDF5 Technical Notes</cite></a>). + <p> + The value of <code>offset</code> is an offset in bytes from the + beginning of the HDF5 file, identifying a user-determined location + within the HDF5 file. The file handle the user application is seeking + is for the specific member-file in the associated family of files + to which this offset is mapped. + <p> + 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> + <dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> + <dt><strong>Name:</strong> <a name="Property-GetFamilyOffset">H5Pget_family_offset</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Pget_family_offset</code> ( + <em>hid_t</em> <code>fapl_id</code>, + <em>hsize_t *</em><code>offset</code> + ) + <dt><strong>Purpose:</strong> + <dd>Retrieves a data offset from the file access property list. + <dt><strong>Description:</strong> + <dd><code>H5Pget_family_offset</code> retrieves the value of <code>offset</code> + from the file access property list <code>fapl_id</code> + so that the user application + can retrieve a file handle for low-level access to a particluar member + of a family of files. The file handle is retrieved with a separate call + to <a href="RM_H5F.html#File-GetVfdHandle"><code>H5Fget_vfd_handle</code></a> + (or, in special circumstances, to <code>H5FDget_vfd_handle</code>; + see <cite>Virtual File Layer</cite> and <cite>List of VFL Functions</cite> + in <a href="TechNotes.html"><cite>HDF5 Technical Notes</cite></a>). + <p> + The data offset returned in <code>offset</code> is the offset + of the data in the HDF5 file that is stored on disk in the selected + member file in a family of files. + <p> + 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> + <dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. <!-- <dt><strong>Non-C API(s):</strong> <dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f" @@ -5631,6 +5959,98 @@ facilitate moving easily between them.</i> </dl> + + +<hr> +<dl> + <dt><strong>Name:</strong> <a name="Property-SetFaplMpiPosix">H5Pset_fapl_mpiposix</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Pset_fapl_mpiposix</code>( + <em>hid_t</em> <code>fapl_id</code>, + <em>MPI_Comm</em> <code>comm</code> + ) + <dt><strong>Purpose:</strong> + <dd>Stores MPI IO communicator information to a file access property list. + <dt><strong>Description:</strong> + <dd><code>H5Pset_fapl_mpiposix</code> stores the user-supplied + MPI IO parameter <code>comm</code>, for communicator, + in the file access property list <code>fapl_id</code>. + That property list can then be used to create and/or open the file. + <p> + <code>H5Pset_fapl_mpiposix</code> is available only in the + parallel HDF5 library and is not a collective function. + <p> + <code>comm</code> is the MPI communicator to be used for + file open as defined in <code>MPI_FILE_OPEN</code> of MPI-2. + This function does not create a duplicated communicator. + Modifications to <code>comm</code> after this function call + returns may have an undetermined effect on the access property list. + 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> + <dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful. + Otherwise returns a negative value. +<!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#h5pset_fapl_mpiposix_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> + <dt><strong>Name:</strong> <a name="Property-GetFaplMpiPosix">H5Pget_fapl_mpiposix</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Pget_fapl_mpiposix</code>( + <em>hid_t</em> <code>fapl_id</code>, + <em>MPI_Comm *</em><code>comm</code> + ) + <dt><strong>Purpose:</strong> + <dd> Returns MPI communicator information. + <dt><strong>Description:</strong> + <dd>If the file access property list is set to the <code>H5FD_MPIO</code> + driver, <code>H5Pget_fapl_mpiposix</code> returns + the MPI communicator through the <code>comm</code> + pointer, if those values are non-null. + <p> + <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> + <dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful. + Otherwise returns a negative value. +<!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#h5pget_fapl_mpiposix_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> +--> <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + + + + + <hr> <dl> <dt><strong>Name:</strong> <a name="Property-SetDxplMpio">H5Pset_dxpl_mpio</a> @@ -6083,6 +6503,144 @@ fid=H5Fcreate("PointA",H5F_ACC_TRUNC,H5P_DEFAULT,fapl); <hr> <dl> + <dt><strong>Name:</strong> <a name="Property-SetMultiType">H5Pset_multi_type</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Pset_multi_type</code> ( + <em>hid_t</em> <code>fapl_id</code>, + <em>H5FD_mem_t</em> <code>type</code> + ) + <dt><strong>Purpose:</strong> + <dd>Sets data type property for <code>MULTI</code> driver. + <dt><strong>Description:</strong> + <dd><code>H5Pset_multi_type</code> sets the data type property in the + file access or data transfer property list <code>fapl_id</code>. + This enables a user application to specifiy the type of data the + appication wishes to access so that the application + can retrieve a file handle for low-level access to the particular member + of a set of <code>MULTI</code> files in which that type of data is stored. + The file handle is retrieved with a separate call + to <a href="RM_H5F.html#File-GetVfdHandle"><code>H5Fget_vfd_handle</code></a> + (or, in special circumstances, to <code>H5FDget_vfd_handle</code>; + see <cite>Virtual File Layer</cite> and <cite>List of VFL Functions</cite> + in <a href="TechNotes.html"><cite>HDF5 Technical Notes</cite></a>). + <p> + The type of data specified in <code>type</code> may be one of the following: + <table border=0> + <tr valign=top align=left><td> </td><td> + <code>H5FD_MEM_DEFAULT</code> + </td><td> + Need description.... + </td></tr> + <tr valign=top align=left><td> </td><td> + <code>H5FD_MEM_SUPER</code> + </td><td> + Super block ... need description.... + </td></tr> + <tr valign=top align=left><td> </td><td> + <code>H5FD_MEM_BTREE</code> + </td><td> + Btree ... need description.... + </td></tr> + <tr valign=top align=left><td> </td><td> + <code>H5FD_MEM_DRAW</code> + </td><td> + Need description.... + </td></tr> + <tr valign=top align=left><td> </td><td> + <code>H5FD_MEM_GHEAP</code> + </td><td> + Global heap ... need description.... + </td></tr> + <tr valign=top align=left><td> </td><td> + <code>H5FD_MEM_LHEAP</code> + </td><td> + Local Heap ... need description.... + </td></tr> + <tr valign=top align=left><td> </td><td> + <code>H5FD_MEM_OHDR</code> + </td><td> + Need description.... + </td></tr> + </table> + <p> + 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> + <dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> + <dt><strong>Name:</strong> <a name="Property-GetMultiType">H5Pget_multi_type</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Pset_multi_type</code> ( + <em>hid_t</em> <code>fapl_id</code>, + <em>H5FD_mem_t *</em><code>type</code> + ) + <dt><strong>Purpose:</strong> + <dd>Retrieves data type property for <code>MULTI</code> driver. + <dt><strong>Description:</strong> + <dd><code>H5Pget_multi_type</code> retrieves the data type setting from the + file access or data transfer property list <code>fapl_id</code>. + This enables a user application to specifiy the type of data the + application wishes to access so that the application + can retrieve a file handle for low-level access to the particular member + of a set of <code>MULTI</code> files in which that type of data is stored. + The file handle is retrieved with a separate call + to <a href="RM_H5F.html#File-GetVfdHandle"><code>H5Fget_vfd_handle</code></a> + (or, in special circumstances, to <code>H5FDget_vfd_handle</code>; + see <cite>Virtual File Layer</cite> and <cite>List of VFL Functions</cite> + in <a href="TechNotes.html"><cite>HDF5 Technical Notes</cite></a>). + <p> + The type of data returned in <code>type</code> will be one of those + listed in the discussion of the <code>type</code> parameter in the the + description of the function + <a href="#Property-SetMultiType"><code>H5Pset_multi_type</code></a>. + <p> + 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> + <dt><strong>Returns:</strong> + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. + <!-- + <dt><strong>Non-C API(s):</strong> + <dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f" + target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a> + --> + <!-- + <img src="Graphics/Java.gif"> + <img src="Graphics/C++.gif"> + --> +</dl> + + +<hr> +<dl> <dt><strong>Name:</strong> <a name="Property-SetFaplSec2">H5Pset_fapl_sec2</a> <dt><strong>Signature:</strong> <dd><em>herr_t</em> <code>H5Pset_fapl_sec2</code>( @@ -6928,7 +7486,7 @@ And in this document, the Describes HDF5 Release 1.5, Unreleased Development Branch </address><!-- #EndLibraryItem --> -Last modified: 16 April 2003 +Last modified: 6 May 2003 </body> </html> |