From c9c54b60413e004032f52c058c97e5734f2574fe Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Fri, 3 Oct 2003 17:53:10 -0500 Subject: [svn-r7537] Purpose: Alphabetizing the RM function entries. This commit finishes the task in the 1.6 release branch. Platforms tested: IE 5, Safari --- doc/html/RM_H5P.html | 1330 ++++++++++++++++++++++---------------------------- 1 file changed, 580 insertions(+), 750 deletions(-) diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html index fa725d5..e7e377b 100644 --- a/doc/html/RM_H5P.html +++ b/doc/html/RM_H5P.html @@ -4744,6 +4744,53 @@ facilitate moving easily between them. --> + +
@@ -5466,6 +5513,56 @@ facilitate moving easily between them. --> + + + +
+
+
Name: H5Pset_fapl_mpiposix +
Signature: +
herr_t H5Pset_fapl_mpiposix( + hid_t fapl_id, + MPI_Comm comm + ) +
Purpose: +
Stores MPI IO communicator information to a file access property list. +
Description: +
H5Pset_fapl_mpiposix stores the user-supplied + MPI IO parameter comm, for communicator, + in the file access property list fapl_id. + That property list can then be used to create and/or open the file. +

+ H5Pset_fapl_mpiposix is available only in the + parallel HDF5 library and is not a collective function. +

+ comm is the MPI communicator to be used for + file open as defined in MPI_FILE_OPEN of MPI-2. + This function does not create a duplicated communicator. + Modifications to comm 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. +

Parameters: +
+
hid_t fapl_id +
IN: File access property list identifier. +
MPI_Comm comm +
IN: MPI-2 communicator. +
+
Returns: +
Returns a non-negative value if successful. + Otherwise returns a negative value. + +
+ +
@@ -6574,87 +6671,50 @@ fid=H5Fcreate("PointA",H5F_ACC_TRUNC,H5P_DEFAULT,fapl); - -
-
-
Name: H5Punregister - -
Signature: -
herr_t H5Punregister( - H5P_class_t class, - const char *name - ) - -
Purpose: -
Removes a property from a property list class. - -
Description: -
H5Punregister removes a property from a - property list class. - -

- Future property lists created of that class will not contain - this property; - existing property lists containing this property are not affected. - -

Parameters: -
    - - - - - - -
    H5P_class_t classIN: Property list class from which to remove - permanent property
    const char *nameIN: Name of property to remove
- -
Returns: -
Success: a non-negative value -
Failure: a negative value - -
Non-C APIs: -
- -
- - - - - - - - - +
-
Name: H5Pset_userblock +
Name: H5Pset_meta_block_size
Signature: -
herr_t H5Pset_userblock(hid_t plist, - hsize_t size - ) +
herr_t H5Pset_meta_block_size( + hid_t fapl_id, + hsize_t size + )
Purpose: -
Sets user block size. +
Sets the minimum metadata block size.
Description: -
H5Pset_userblock sets the user block size of a - file creation property list. - 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.). +
H5Pset_meta_block_size sets the + minimum size, in bytes, of metadata block allocations when + H5FD_FEAT_AGGREGATE_METADATA is set by a VFL driver. +

+ Each raw metadata block is initially allocated to be of the + given size. Specific metadata objects (e.g., object headers, + local heaps, B-trees) are then sub-allocated from this block. +

+ The default setting is 2048 bytes, meaning that the library + will attempt to aggregate metadata in at least 2K blocks in the file. + Setting the value to 0 (zero) with this function + will turn off metadata aggregation, even if the VFL driver attempts + to use the metadata aggregation strategy. +

+ Metadata aggregation reduces the number of small data objects + in the file that would otherwise be required for metadata. + The aggregated block of metadata is usually written in a + single write action and always in a contiguous block, + potentially significantly improving library and application + performance.

Parameters:
-
hid_t plist -
IN: Identifier of property list to modify. +
hid_t fapl_id +
IN: File access property list identifier.
hsize_t size -
IN: Size of the user-block in bytes. +
IN: Minimum size, in bytes, of metadata block allocations.
Returns: -
Returns a non-negative value if successful; - otherwise returns a negative value. +
Returns a non-negative value if successful. + Otherwise returns a negative value.
Non-C API(s): -
- - - +
-
Name: H5Pset_sizes +
Name: H5Pset_multi_type
Signature: -
herr_t H5Pset_sizes(hid_t plist, - size_t sizeof_addr, - size_t sizeof_size - ) +
herr_t H5Pset_multi_type ( + hid_t fapl_id, + H5FD_mem_t type + )
Purpose: -
Sets the byte size of the offsets and lengths used to address objects - in an HDF5 file. +
Sets data type property for MULTI driver.
Description: -
H5Pset_sizes sets the byte size of the offsets and lengths used to - address objects in an HDF5 file. This function is only valid for - file creation property lists. Passing in a value of 0 for one of the - sizeof parameters retains the current value. The default value - for both values is same as sizeof(hsize_t) in the library - (normally 8 bytes). Valid values currently are 2, 4, - 8 and 16. -
Parameters: -
-
hid_t plist -
IN: Identifier of property list to modify. -
size_t sizeof_addr -
IN: Size of an object offset in bytes. -
size_t sizeof_size -
IN: Size of an object length in bytes. -
-
Returns: -
Returns a non-negative value if successful; - otherwise returns a negative value. -
Non-C API(s): -
- -
- - - - - -
-
-
Name: H5Pset_sym_k -
Signature: -
herr_t H5Pset_sym_k(hid_t plist, - int ik, - int lk - ) +
H5Pset_multi_type sets the data type property in the + file access or data transfer property list fapl_id. + 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 MULTI files in which that type of data is stored. + The file handle is retrieved with a separate call + to H5Fget_vfd_handle + (or, in special circumstances, to H5FDget_vfd_handle; + see Virtual File Layer and List of VFL Functions + in HDF5 Technical Notes). +

+ The type of data specified in type may be one of the following: + + + + + + + + +
     + H5FD_MEM_DEFAULT   + + Need description.... +
  + H5FD_MEM_SUPER + + Super block ... need description.... +
  + H5FD_MEM_BTREE + + Btree ... need description.... +
  + H5FD_MEM_DRAW + + Need description.... +
  + H5FD_MEM_GHEAP + + Global heap ... need description.... +
  + H5FD_MEM_LHEAP + + Local Heap ... need description.... +
  + H5FD_MEM_OHDR + + Need description.... +
+

+ Use of this function is only appropriate for an HDF5 file written + as a set of files with the MULTI file driver. +

Parameters: +
+
hid_t fapl_id +
IN: File access property list or data transfer property list identifier. +
H5FD_mem_t type +
OUT: Type of data. +
+
Returns: +
Returns a non-negative value if successful; + otherwise returns a negative value. + + +
+ + + +
+
+
Name: H5Pset_preserve +
Signature: +
herr_t H5Pset_preserve(hid_t plist, + hbool_t status + )
Purpose: -
Sets the size of parameters used to control the symbol table nodes. +
Sets the dataset transfer property list status to TRUE or FALSE.
Description: -
H5Pset_sym_k sets the size of parameters used to - control the symbol table nodes. This function is only valid - for file creation property lists. Passing in a value of 0 for - one of the parameters retains the current value. -

- ik is one half the rank of a tree that stores a symbol - table for a group. Internal nodes of the symbol table are on - average 75% full. That is, the average rank of the tree is - 1.5 times the value of ik. -

- lk is one half of the number of symbols that can - be stored in a symbol table node. A symbol table node is the - leaf of a symbol table tree which is used to store a group. - When symbols are inserted randomly into a group, the group's - symbol table nodes are 75% full on average. That is, they - contain 1.5 times the number of symbols specified by - lk. +

H5Pset_preserve sets the + dataset transfer property list status to TRUE or FALSE. +

+ When reading or writing compound data types and the + destination is partially initialized and the read/write is + intended to initialize the other members, one must set this + property to TRUE. Otherwise the I/O pipeline treats the + destination datapoints as completely uninitialized.

Parameters:
hid_t plist -
IN: Identifier for property list to query. -
int ik -
IN: Symbol table tree rank. -
int lk -
IN: Symbol table node size. +
IN: Identifier for the dataset transfer property list. +
hbool_t status +
IN: Status of for the dataset transfer property list + (TRUE/FALSE).
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Non-C API(s): -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
@@ -6856,46 +6896,241 @@ fid=H5Fcreate("PointA",H5F_ACC_TRUNC,H5P_DEFAULT,fapl); --> - + + +
+
+
Name: H5Pset_sieve_buf_size +
Signature: +
herr_t H5Pset_sieve_buf_size( + hid_t fapl_id, + hsize_t size + ) +
Purpose: +
Sets the maximum size of the data sieve buffer. +
Description: +
H5Pset_sieve_buf_size sets size, + the maximum size in bytes of the data sieve buffer, which is + used by file drivers that are capable of using data sieving. +

+ The data sieve buffer is used when performing I/O on datasets + in the file. Using a buffer which is large enough to hold + several pieces of the dataset being read in for + hyperslab selections boosts performance by quite a bit. +

+ The default value is set to 64KB, indicating that file I/O for + raw data reads and writes will occur in at least 64KB blocks. + 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. +

Parameters: +
+
hid_t fapl_id +
IN: File access property list identifier. +
hsize_t size +
IN: Maximum size, in bytes, of data sieve buffer. +
+
Returns: +
Returns a non-negative value if successful. + Otherwise returns a negative value. +
Non-C API(s): +
+ +
- +
-
Name: H5Pset_szip +
Name: H5Pset_sizes
Signature: -
herr_t H5Pset_szip(hid_t plist, - unsigned int options_mask, - unsigned int pixels_per_block) +
herr_t H5Pset_sizes(hid_t plist, + size_t sizeof_addr, + size_t sizeof_size + )
Purpose: -
Sets up use of the SZIP compression filter. +
Sets the byte size of the offsets and lengths used to address objects + in an HDF5 file.
Description: -
H5Pset_szip sets a filter for the dataset - to SZIP compression, H5Z_FILTER_SZIP, - a compression method designed for use with scientific data. -

- SZIP options are passed in an options mask, options_mask, - as follows. -

- - - - -
-
- Option - 		-
- Description -
- (Paired options are mutually exclusive.) -
-
- H5_SZIP_CHIP_OPTION_MASK   - 		-
- Compresses exactly as in hardware. -
+
H5Pset_sizes sets the byte size of the offsets and lengths used to + address objects in an HDF5 file. This function is only valid for + file creation property lists. Passing in a value of 0 for one of the + sizeof parameters retains the current value. The default value + for both values is same as sizeof(hsize_t) in the library + (normally 8 bytes). Valid values currently are 2, 4, + 8 and 16. +
Parameters: +
+
hid_t plist +
IN: Identifier of property list to modify. +
size_t sizeof_addr +
IN: Size of an object offset in bytes. +
size_t sizeof_size +
IN: Size of an object length in bytes. +
+
Returns: +
Returns a non-negative value if successful; + otherwise returns a negative value. +
Non-C API(s): +
+ + + + + +
+
+
Name: H5Pset_small_data_block_size +
Signature: +
herr_t H5Pset_small_data_block_size(hid_t fapl_id, + hsize_t size + ) +
Purpose: +
Sets the size of a contiguous block reserved for small data. +
Description: +
H5Pset_small_data_block_size reserves blocks of + size bytes for the contiguous storage of the raw data + portion of small datasets. + The HDF5 library then writes the raw data from small datasets + to this reserved space, thus reducing unnecessary discontinuities + within blocks of meta data and improving IO performance. +

+ A small data block is actually allocated the first time a + qualifying small dataset is written to the file. + Space for the raw data portion of this small dataset is suballocated + within the small data block. + The raw data from each subsequent small dataset is also written to + the small data block until it is filled; additional small data blocks + are allocated as required. +

+ The HDF5 library employs an algorithm that determines whether + IO performance is likely to benefit from the use of this mechanism + with each dataset as storage space is allocated in the file. + A larger size will result in this mechanism being + employed with larger datasets. +

+ The small data block size is set as an allocation property in the + file access property list identified by fapl_id. +

+ Setting size to zero (0) disables the + small data block mechanism. +

Parameters: +
+
hid_t fapl_id +
IN: File access property list identifier . +
hsize_t size +
IN: Maximum size, in bytes, of the small data block. +
+ The default size is 2048. +
+
Returns: +
Returns a non-negative value if successful; + otherwise a negative value. +
Non-C API(s): +
+ +
+ + + +
+
+
Name: H5Pset_sym_k +
Signature: +
herr_t H5Pset_sym_k(hid_t plist, + int ik, + int lk + ) +
Purpose: +
Sets the size of parameters used to control the symbol table nodes. +
Description: +
H5Pset_sym_k sets the size of parameters used to + control the symbol table nodes. This function is only valid + for file creation property lists. Passing in a value of 0 for + one of the parameters retains the current value. +

+ ik is one half the rank of a tree that stores a symbol + table for a group. Internal nodes of the symbol table are on + average 75% full. That is, the average rank of the tree is + 1.5 times the value of ik. +

+ lk is one half of the number of symbols that can + be stored in a symbol table node. A symbol table node is the + leaf of a symbol table tree which is used to store a group. + When symbols are inserted randomly into a group, the group's + symbol table nodes are 75% full on average. That is, they + contain 1.5 times the number of symbols specified by + lk. +

Parameters: +
+
hid_t plist +
IN: Identifier for property list to query. +
int ik +
IN: Symbol table tree rank. +
int lk +
IN: Symbol table node size. +
+
Returns: +
Returns a non-negative value if successful; + otherwise returns a negative value. +
Non-C API(s): +
+ +
+ + + +
+
+
Name: H5Pset_szip +
Signature: +
herr_t H5Pset_szip(hid_t plist, + unsigned int options_mask, + unsigned int pixels_per_block) +
Purpose: +
Sets up use of the SZIP compression filter. +
Description: +
H5Pset_szip sets a filter for the dataset + to SZIP compression, H5Z_FILTER_SZIP, + a compression method designed for use with scientific data. +

+ SZIP options are passed in an options mask, options_mask, + as follows. +

+ + + + +
+
+ Option + 		+
+ Description +
+ (Paired options are mutually exclusive.) +
+
+ H5_SZIP_CHIP_OPTION_MASK   + 		+
+ Compresses exactly as in hardware. +
H5_SZIP_ALLOW_K13_OPTION_MASK   Allows k split = 13 compression mode. (Default) @@ -7068,57 +7303,34 @@ END LIBRARY-SET OPTION TAGS --> --> - - - - - - - +
-
Name: H5Pset_meta_block_size +
Name: H5Pset_userblock
Signature: -
herr_t H5Pset_meta_block_size( - hid_t fapl_id, - hsize_t size - ) +
herr_t H5Pset_userblock(hid_t plist, + hsize_t size + )
Purpose: -
Sets the minimum metadata block size. +
Sets user block size.
Description: -
H5Pset_meta_block_size sets the - minimum size, in bytes, of metadata block allocations when - H5FD_FEAT_AGGREGATE_METADATA is set by a VFL driver. -

- Each raw metadata block is initially allocated to be of the - given size. Specific metadata objects (e.g., object headers, - local heaps, B-trees) are then sub-allocated from this block. -

- The default setting is 2048 bytes, meaning that the library - will attempt to aggregate metadata in at least 2K blocks in the file. - Setting the value to 0 (zero) with this function - will turn off metadata aggregation, even if the VFL driver attempts - to use the metadata aggregation strategy. -

- Metadata aggregation reduces the number of small data objects - in the file that would otherwise be required for metadata. - The aggregated block of metadata is usually written in a - single write action and always in a contiguous block, - potentially significantly improving library and application - performance. +

H5Pset_userblock sets the user block size of a + file creation property list. + 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.).
Parameters:
-
hid_t fapl_id -
IN: File access property list identifier. +
hid_t plist +
IN: Identifier of property list to modify.
hsize_t size -
IN: Minimum size, in bytes, of metadata block allocations. +
IN: Size of the user-block in bytes.
Returns: -
Returns a non-negative value if successful. - Otherwise returns a negative value. +
Returns a non-negative value if successful; + otherwise returns a negative value.
Non-C API(s): -
-->
- - - +
-
Name: H5Pset_sieve_buf_size +
Name: H5Pset_vlen_mem_manager
Signature: -
herr_t H5Pset_sieve_buf_size( - hid_t fapl_id, - hsize_t size +
herr_t H5Pset_vlen_mem_manager(hid_t plist, + H5MM_allocate_t alloc, + void *alloc_info, + H5MM_free_t free, + void *free_info )
Purpose: -
Sets the maximum size of the data sieve buffer. +
Sets the memory manager for variable-length datatype allocation in + H5Dread and H5Dvlen_reclaim.
Description: -
H5Pset_sieve_buf_size sets size, - the maximum size in bytes of the data sieve buffer, which is - used by file drivers that are capable of using data sieving. +
H5Pset_vlen_mem_manager sets the memory manager for + variable-length datatype allocation in H5Dread + and free in H5Dvlen_reclaim.

- The data sieve buffer is used when performing I/O on datasets - in the file. Using a buffer which is large enough to hold - several pieces of the dataset being read in for - hyperslab selections boosts performance by quite a bit. -

- The default value is set to 64KB, indicating that file I/O for - raw data reads and writes will occur in at least 64KB blocks. - 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. -

Parameters: -
-
hid_t fapl_id -
IN: File access property list identifier. -
hsize_t size -
IN: Maximum size, in bytes, of data sieve buffer. -
-
Returns: -
Returns a non-negative value if successful. - Otherwise returns a negative value. -
Non-C API(s): -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
Name: H5Pset_small_data_block_size -
Signature: -
herr_t H5Pset_small_data_block_size(hid_t fapl_id, - hsize_t size - ) -
Purpose: -
Sets the size of a contiguous block reserved for small data. -
Description: -
H5Pset_small_data_block_size reserves blocks of - size bytes for the contiguous storage of the raw data - portion of small datasets. - The HDF5 library then writes the raw data from small datasets - to this reserved space, thus reducing unnecessary discontinuities - within blocks of meta data and improving IO performance. -

- A small data block is actually allocated the first time a - qualifying small dataset is written to the file. - Space for the raw data portion of this small dataset is suballocated - within the small data block. - The raw data from each subsequent small dataset is also written to - the small data block until it is filled; additional small data blocks - are allocated as required. -

- The HDF5 library employs an algorithm that determines whether - IO performance is likely to benefit from the use of this mechanism - with each dataset as storage space is allocated in the file. - A larger size will result in this mechanism being - employed with larger datasets. + The alloc and free parameters + identify the memory management routines to be used. + If the user has defined custom memory management routines, + alloc and/or free should be set to make + those routine calls (i.e., the name of the routine is used as + the value of the parameter); + if the user prefers to use the system's malloc + and/or free, the alloc and + free parameters, respectively, should be set to + NULL

- The small data block size is set as an allocation property in the - file access property list identified by fapl_id. + The prototypes for these user-defined functions would appear as follows: +
     + typedef void *(*H5MM_allocate_t)(size_t size, + void *alloc_info) ; + +
     + typedef void (*H5MM_free_t)(void *mem, + void *free_info) ; +
+ The alloc_info and free_info parameters + can be used to pass along any required information to + the user's memory management routines.

- Setting size to zero (0) disables the - small data block mechanism. + In summary, if the user has defined custom memory management + routines, the name(s) of the routines are passed in the + alloc and free parameters and the + custom routines' parameters are passed in the + alloc_info and free_info parameters. + If the user wishes to use the system malloc and + free functions, the alloc and/or + free parameters are set to NULL + and the alloc_info and free_info + parameters are ignored.

Parameters:
-
hid_t fapl_id -
IN: File access property list identifier . -
hsize_t size -
IN: Maximum size, in bytes, of the small data block. +
hid_t plist +
IN: Identifier for the dataset transfer property list. +
H5MM_allocate_t alloc +
IN: User's allocate routine, or   NULL + for system   malloc. +
void *alloc_info +
IN: Extra parameter for user's allocation routine.
- The default size is 2048. + Contents are ignored if preceding parameter is   + NULL. +
H5MM_free_t free +
IN: User's free routine, or   NULL + for system free. +
void *free_info +
IN: Extra parameter for user's free routine. +
+ Contents are ignored if preceding parameter is   + NULL.
Returns:
Returns a non-negative value if successful; - otherwise a negative value. + otherwise returns a negative value. +
- - - +
-
Name: H5Pset_preserve +
Name: H5Punregister +
Signature: -
herr_t H5Pset_preserve(hid_t plist, - hbool_t status +
herr_t H5Punregister( + H5P_class_t class, + const char *name ) +
Purpose: -
Sets the dataset transfer property list status to TRUE or FALSE. +
Removes a property from a property list class. +
Description: -
H5Pset_preserve sets the - dataset transfer property list status to TRUE or FALSE. -

- When reading or writing compound data types and the - destination is partially initialized and the read/write is - intended to initialize the other members, one must set this - property to TRUE. Otherwise the I/O pipeline treats the - destination datapoints as completely uninitialized. +

H5Punregister removes a property from a + property list class. + +

+ Future property lists created of that class will not contain + this property; + existing property lists containing this property are not affected. +

Parameters: -
-
hid_t plist -
IN: Identifier for the dataset transfer property list. -
hbool_t status -
IN: Status of for the dataset transfer property list - (TRUE/FALSE). -
-
Returns: -
Returns a non-negative value if successful; - otherwise returns a negative value. -
Non-C API(s): -
- -
+
    + + + + + + +
    H5P_class_t classIN: Property list class from which to remove + permanent property
    const char *nameIN: Name of property to remove
+
Returns: +
Success: a non-negative value +
Failure: a negative value +
Non-C APIs: +
+ + --> - - --> - - -
-
-
Name: H5Pset_vlen_mem_manager -
Signature: -
herr_t H5Pset_vlen_mem_manager(hid_t plist, - H5MM_allocate_t alloc, - void *alloc_info, - H5MM_free_t free, - void *free_info - ) -
Purpose: -
Sets the memory manager for variable-length datatype allocation in - H5Dread and H5Dvlen_reclaim. -
Description: -
H5Pset_vlen_mem_manager sets the memory manager for - variable-length datatype allocation in H5Dread - and free in H5Dvlen_reclaim. -

- The alloc and free parameters - identify the memory management routines to be used. - If the user has defined custom memory management routines, - alloc and/or free should be set to make - those routine calls (i.e., the name of the routine is used as - the value of the parameter); - if the user prefers to use the system's malloc - and/or free, the alloc and - free parameters, respectively, should be set to - NULL -

- The prototypes for these user-defined functions would appear as follows: -
     - typedef void *(*H5MM_allocate_t)(size_t size, - void *alloc_info) ; - -
     - typedef void (*H5MM_free_t)(void *mem, - void *free_info) ; -
- The alloc_info and free_info parameters - can be used to pass along any required information to - the user's memory management routines. -

- In summary, if the user has defined custom memory management - routines, the name(s) of the routines are passed in the - alloc and free parameters and the - custom routines' parameters are passed in the - alloc_info and free_info parameters. - If the user wishes to use the system malloc and - free functions, the alloc and/or - free parameters are set to NULL - and the alloc_info and free_info - parameters are ignored. -

Parameters: -
-
hid_t plist -
IN: Identifier for the dataset transfer property list. -
H5MM_allocate_t alloc -
IN: User's allocate routine, or   NULL - for system   malloc. -
void *alloc_info -
IN: Extra parameter for user's allocation routine. -
- Contents are ignored if preceding parameter is   - NULL. -
H5MM_free_t free -
IN: User's free routine, or   NULL - for system free. -
void *free_info -
IN: Extra parameter for user's free routine. -
- Contents are ignored if preceding parameter is   - NULL. -
-
Returns: -
Returns a non-negative value if successful; - otherwise returns a negative value. - -
- - - - - - - - - - - - - - - - - - - - - - - - -
-
-
Name: H5Pget_fapl_mpio -
Signature: -
herr_t H5Pset_fapl_mpiposix( - hid_t fapl_id, - MPI_Comm comm - ) -
Purpose: -
Stores MPI IO communicator information to a file access property list. -
Description: -
H5Pset_fapl_mpiposix stores the user-supplied - MPI IO parameter comm, for communicator, - in the file access property list fapl_id. - That property list can then be used to create and/or open the file. -

- H5Pset_fapl_mpiposix is available only in the - parallel HDF5 library and is not a collective function. -

- comm is the MPI communicator to be used for - file open as defined in MPI_FILE_OPEN of MPI-2. - This function does not create a duplicated communicator. - Modifications to comm 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. -

Parameters: -
-
hid_t fapl_id -
IN: File access property list identifier. -
MPI_Comm comm -
IN: MPI-2 communicator. -
-
Returns: -
Returns a non-negative value if successful. - Otherwise returns a negative value. - -
- - - - - - - - - - - - - - - - - - - -
-
-
Name: H5Pset_multi_type -
Signature: -
herr_t H5Pset_multi_type ( - hid_t fapl_id, - H5FD_mem_t type - ) -
Purpose: -
Sets data type property for MULTI driver. -
Description: -
H5Pset_multi_type sets the data type property in the - file access or data transfer property list fapl_id. - 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 MULTI files in which that type of data is stored. - The file handle is retrieved with a separate call - to H5Fget_vfd_handle - (or, in special circumstances, to H5FDget_vfd_handle; - see Virtual File Layer and List of VFL Functions - in HDF5 Technical Notes). -

- The type of data specified in type may be one of the following: - - - - - - - - -
     - H5FD_MEM_DEFAULT   - - Need description.... -
  - H5FD_MEM_SUPER - - Super block ... need description.... -
  - H5FD_MEM_BTREE - - Btree ... need description.... -
  - H5FD_MEM_DRAW - - Need description.... -
  - H5FD_MEM_GHEAP - - Global heap ... need description.... -
  - H5FD_MEM_LHEAP - - Local Heap ... need description.... -
  - H5FD_MEM_OHDR - - Need description.... -
-

- Use of this function is only appropriate for an HDF5 file written - as a set of files with the MULTI file driver. -

Parameters: -
-
hid_t fapl_id -
IN: File access property list or data transfer property list identifier. -
H5FD_mem_t type -
OUT: Type of data. -
-
Returns: -
Returns a non-negative value if successful; - otherwise returns a negative value. - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -