HDF5 documents and links 
Introduction to HDF5 
HDF5 User Guide 
And in this document, the HDF5 Reference Manual 
H5DS   H5IM   H5LT   H5PT   H5TB 
H5   H5A   H5D   H5E   H5F   H5G   H5I 
H5L   H5O   H5P   H5R   H5S   H5T   H5Z 
Tools   Datatypes   Fortran   Compatibility Macros  

H5P: Property List Interface

Property List API Functions

These functions manipulate property list objects to allow objects which require many different parameters to be easily manipulated.
In the following lists, italic type indicates a configurable macro.

The C Interfaces:
General Property List
Operations

Generic Properties

Link Access Properties

Object Copy and
Object Creation Properties

String Properties

Meta Data Cache Properties


 
    ||   Indicates functions
          available only in the
          parallel HDF5 library.

 
    *   Use of these functions
          is deprecated in
          Release 1.8.0.
      

Group Creation Properties

File Creation Properties

File Access Properties
       Dataset Creation Properties

Dataset Access, Memory, and
Transfer Properties

Alphabetical Listing
             
    ||  Available only in the
        parallel HDF5 library.

The FORTRAN90 Interfaces:
In general, each FORTRAN90 subroutine performs exactly the same task as the corresponding C function.
General Property List Operations

Generic Properties

File Creation Properties

       File Close Properties

Dataset Creation Properties


 
 
 
||  Available only in the
    parallel HDF5 library.
       File Access Properties

Dataset Access, Memory, and Transfer Properties


Name: H5Pall_filters_avail
Signature:
htri_t H5Pall_filters_avail(hid_t dcpl_id)
Purpose:
Verifies that all required filters are available.
Description:
H5Pall_filters_avail verifies that all of the filters set in the dataset creation property list dcpl_id are currently available.
Parameters:
Returns:
Returns TRUE if all filters are available and FALSE if one or more is not currently available.
Returns FAIL, a negative value, on error.
Fortran90 Interface:
None.
History:

Name: H5Pclose
Signature:
herr_t H5Pclose(hid_t plist )
Purpose:
Terminates access to a property list.
Description:
H5Pclose terminates access to a property list. All property lists should be closed when the application is finished accessing them. This frees resources used by the property list.
Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface: h5pclose_f
SUBROUTINE h5pclose_f(prp_id, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier 
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                        ! 0 on success and -1 on failure
END SUBROUTINE h5pclose_f
	

Name: H5Pclose_class
Signature:
herr_t H5Pclose_class( hid_t class )
Purpose:
Closes an existing property list class.
Description:
Removes a property list class from the library.

Existing property lists of this class will continue to exist, but new ones are not able to be created.

Parameters:
Returns:
Success: a non-negative value
Failure: a negative value
Fortran90 Interface: h5pclose_class_f
SUBROUTINE h5pclose_class_f(class, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: class ! Property list class identifier 
                                      ! to close
  INTEGER, INTENT(OUT) :: hdferr      ! Error code
                                      ! 0 on success and -1 on failure
END SUBROUTINE h5pclose_class_f
	

Name: H5Pcopy
Signature:
hid_t H5Pcopy(hid_t plist )
Purpose:
Copies an existing property list to create a new property list.
Description:
H5Pcopy copies an existing property list to create a new property list. The new property list has the same properties and values as the original property list.
Parameters:
Returns:
Returns a property list identifier if successful; otherwise returns a negative value.
Fortran90 Interface: h5pcopy_f
SUBROUTINE h5pcopy_f(prp_id, new_prp_id, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id       ! Property list identifier 
  INTEGER(HID_T), INTENT(OUT) :: new_prp_id  ! Identifier  of property list
                                             ! copy  
  INTEGER, INTENT(OUT) :: hdferr             ! Error code
                                             ! 0 on success and -1 on failure
END SUBROUTINE h5pcopy_f
	

Name: H5Pcopy_prop
Signature:
herr_t H5Pcopy_prop( hid_t dst_id, hid_t src_id, const char *name )
Purpose:
Copies a property from one list or class to another.
Description:
H5Pcopy_prop copies a property from one property list or class to another.

If a property is copied from one class to another, all the property information will be first deleted from the destination class and then the property information will be copied from the source class into the destination class.

If a property is copied from one list to another, the property will be first deleted from the destination list (generating a call to the close callback for the property, if one exists) and then the property is copied from the source list to the destination list (generating a call to the copy callback for the property, if one exists).

If the property does not exist in the class or list, this call is equivalent to calling H5Pregister or H5Pinsert (for a class or list, as appropriate) and the create callback will be called in the case of the property being copied into a list (if such a callback exists for the property).

Parameters:
Returns:
Success: a non-negative value
Failure: a negative value
Fortran90 Interface: h5pcopy_prop_f
SUBROUTINE h5pcopy_prop_f(dst_id, src_id, name, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: dst_id  ! Destination property list 
                                        ! identifier 
  INTEGER(HID_T), INTENT(IN) :: src_id  ! Source property list identifier 
  CHARACTER(LEN=*), INTENT(IN) :: name  ! Property name
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                        ! 0 on success and -1 on failure
END SUBROUTINE h5pcopy_prop_f
	

Name: H5Pcreate
Signature:
hid_t H5Pcreate(hid_t cls_id )
Purpose:
Creates a new property as an instance of a property list class.
Description:
H5Pcreate creates a new property as an instance of some property list class. The new property list is initialized with default values for the specified class. The classes are:
H5P_OBJECT_CREATE
Properties for object creation during the object copying process. See H5Pset_copy_object.
H5P_FILE_CREATE
Properties for file creation. See Files in the HDF User's Guide for details about the file creation properties.
H5P_FILE_ACCESS
Properties for file access. See Files in the HDF User's Guide for details about the file creation properties.
H5P_DATASET_CREATE
Properties for dataset creation. See Datasets in the HDF User's Guide for details about dataset creation properties.
H5P_DATASET_ACCESS
Properties for dataset access.
H5P_DATASET_XFER
Properties for raw data transfer. See Datasets in the HDF User's Guide for details about raw data transfer properties.
H5P_MOUNT
Properties for file mounting. With this parameter, H5Pcreate creates and returns a new mount property list initialized with default values.
H5P_GROUP_CREATE
Properties for group creation during the object copying process. See H5Pset_copy_object.
H5P_GROUP_ACCESS
Properties for group access during the object copying process. See H5Pset_copy_object.
H5P_DATATYPE_CREATE
Properties for datatype creation during the object copying process. See H5Pset_copy_object.
H5P_DATATYPE_ACCESS
Properties for datatype access during the object copying process. See H5Pset_copy_object.
H5P_ATTRIBUTE_CREATE
Properties for attribute creation during the object copying process. See H5Pset_copy_object.
H5P_OBJECT_COPY
Properties governing the object copying process. See H5Pset_copy_object.

This property list must eventually be closed with H5Pclose; otherwise, errors are likely to occur.

Parameters:
Returns:
Returns a property list identifier (plist) if successful; otherwise Fail (-1).
Fortran90 Interface: h5pcreate_f
SUBROUTINE h5pcreate_f(classtype, prp_id, hdferr) 
  IMPLICIT NONE
  INTEGER, INTENT(IN) :: classtype       ! The type of the property list 
                                         ! to be created 
                                         ! Possible values are: 
                                         !    H5P_FILE_CREATE_F 
                                         !    H5P_FILE_ACCESS_F
                                         !    H5P_DATASET_CREATE_F
                                         !    H5P_DATASET_XFER_F 
                                         !    H5P_MOUNT_F 
  INTEGER(HID_T), INTENT(OUT) :: prp_id  ! Property list identifier 
  INTEGER, INTENT(OUT) :: hdferr         ! Error code
                                         ! 0 on success and -1 on failure
END SUBROUTINE h5pcreate_f
	

Name: H5Pcreate_class
Signature:
hid_t H5Pcreate_class( hid_t class, const char *name, H5P_cls_create_func_t create, H5P_cls_copy_func_t copy, H5P_cls_close_func_t close )
Purpose:
Creates a new property list class.
Description:
H5Pcreate_class registers a new property list class with the library. The new property list class can inherit from an existing property list class or may be derived from the default "empty" class. New classes with inherited properties from existing classes may not remove those existing properties, only add or remove their own class properties.

The create routine is called when a new property list of this class is being created. The H5P_cls_create_func_t callback function is defined as follows: The parameters to this callback function are defined as follows: The create routine is called after any registered create function is called for each property value. If the create routine returns a negative value, the new list is not returned to the user and the property list creation routine returns an error value.

The copy routine is called when an existing property list of this class is copied. The H5P_cls_copy_func_t callback function is defined as follows: The parameters to this callback function are defined as follows: The copy routine is called after any registered copy function is called for each property value. If the copy routine returns a negative value, the new list is not returned to the user and the property list copy routine returns an error value.

The close routine is called when a property list of this class is being closed. The H5P_cls_close_func_t callback function is defined as follows: The parameters to this callback function are defined as follows: The close routine is called before any registered close function is called for each property value. If the close routine returns a negative value, the property list close routine returns an error value but the property list is still closed.
Parameters:
Returns:
Success: a valid property list class identifier
Failure: a negative value
Fortran90 Interface: h5pcreate_class_f
SUBROUTINE h5pcreate_class_f(parent, name, class, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: parent  ! Parent property list class 
                                        ! identifier
                                        ! Possible values include:
                                        !    H5P_NO_CLASS_F
                                        !    H5P_FILE_CREATE_F
                                        !    H5P_FILE_ACCESS_F
                                        !    H5P_DATASET_CREATE_F
                                        !    H5P_DATASET_XFER_F
                                        !    H5P_MOUNT_F
  CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to create 
  INTEGER(HID_T), INTENT(OUT) :: class  ! Property list class identifier
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                        ! 0 on success and -1 on failure
END SUBROUTINE h5pcreate_class_f
	

Name: H5Pcreate_list
Signature:
hid_t H5Pcreate_list( hid_t class)
Purpose:
Creates a new property list class of a given class.
Description:
H5Pcreate_list creates a new property list of a given class. If a create callback exists for the property list class, it is called before the property list is passed back to the user. If create callbacks exist for any individual properties in the property list, they are called before the class create callback.
Parameter:
Returns:
Success: a valid property list identifier
Failure: a negative value
Fortran90 Interface:
None.

Name: H5Premove_filter
Signature:
herr_t H5Premove_filter(hid_t plist, H5Z_filter_t filter )
Purpose:
Delete one or more filters in the filter pipeline.
Description:
H5Premove_filter removes the specified filter from the filter pipeline in the dataset creation property list plist.

The filter parameter specifies the filter to be removed. Valid values for use in filter are as follows:

H5Z_FILTER_ALL Removes all filters from the permanent filter pipeline.
H5Z_FILTER_DEFLATE Data compression filter, employing the gzip algorithm
H5Z_FILTER_SHUFFLE Data shuffling filter
H5Z_FILTER_FLETCHER32   Error detection filter, employing the Fletcher32 checksum algorithm
H5Z_FILTER_SZIP Data compression filter, employing the SZIP algorithm

Additionally, user-defined filters can be removed with this routine by passing the filter identifier with which they were registered with the HDF5 Library.

Attempting to remove a filter that is not in the permanent filter pipeline is an error.

Note:
This function currently supports only the permanent filter pipeline; plist must be a dataset creation property list.
Parameters:
hid_t plist_id
IN: Dataset creation property list identifier.
H5Z_filter_t filter
IN: Filter to be deleted.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface: h5premove_filter_f
SUBROUTINE h5premove_filter_f(prp_id, filter, hdferr) 

  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id ! Dataset creation property 
                                       ! list identifier
  INTEGER, INTENT(IN) :: filter        ! Filter to be removed
                                       ! Valid values are:
                                       !     H5Z_FILTER_ALL_F
                                       !     H5Z_FILTER_DEFLATE_F
                                       !     H5Z_FILTER_SHUFFLE_F
                                       !     H5Z_FILTER_FLETCHER32_F
                                       !     H5Z_FILTER_SZIP_F
                                       !
  INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                       ! 0 on success, -1 on failure
END SUBROUTINE h5premove_filter_f
	
History:

Name: H5Pequal
Signature:
htri_t H5Pequal( hid_t id1, hid_t id2 )
Purpose:
Compares two property lists or classes for equality.
Description:
H5Pequal compares two property lists or classes to determine whether they are equal to one another.

Either both id1 and id2 must be property lists or both must be classes; comparing a list to a class is an error.

Parameters:
Returns:
Success: TRUE (positive) if equal; FALSE (zero) if unequal
Failure: a negative value
Fortran90 Interface: h5pequal_f
SUBROUTINE h5pequal_f(plist1_id, plist2_id, flag, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: plist1_id ! Property list identifier
  INTEGER(HID_T), INTENT(IN) :: plist2_id ! Property list identifier
  LOGICAL, INTENET(OUT)      :: flag      ! Flag
                                          !    .TRUE. if lists are equal 
                                          !    .FALSE. otherwise 
  INTEGER, INTENT(OUT)       :: hdferr    ! Error code
                                          ! 0 on success and -1 on failure
END SUBROUTINE h5pequal_f
	

Name: H5Pexist
Signature:
htri_t H5Pexist( hid_t id, const char *name )
Purpose:
Queries whether a property name exists in a property list or class.
Description:
H5Pexist determines whether a property exists within a property list or class.
Parameters:
Returns:
Success: a positive value if the property exists in the property object; zero if the property does not exist
Failure: a negative value
Fortran90 Interface: h5pexist_f
SUBROUTINE h5pexist_f(prp_id, name, flag, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier 
  CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to modify
  LOGICAL, INTENT(OUT) :: flag          ! Logical flag
                                        !    .TRUE. if exists 
                                        !    .FALSE. otherwise
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                        ! 0 on success and -1 on failure
END SUBROUTINE h5pexist_f
	

Name: H5Pfill_value_defined
Signature:
herr_t H5Pfill_value_defined(hid_t plist_id, H5D_fill_value_t *status )
Purpose:
Determines whether fill value is defined.
Description:
H5Pfill_value_defined determines whether a fill value is defined in the dataset creation property list plist_id.

Valid values returned in status are as follows:
     H5D_FILL_VALUE_UNDEFINED Fill value is undefined.
H5D_FILL_VALUE_DEFAULT Fill value is the library default.
H5D_FILL_VALUE_USER_DEFINED   Fill value is defined by the application.

Note:
H5Pfill_value_defined is designed for use in concert with the dataset fill value properties functions H5Pget_fill_value and H5Pget_fill_time.

See H5Dcreate for further cross-references.

Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface:
None.
History:

Name: H5Pget
Signature:
herr_t H5Pget( hid_t plid, const char *name, void *value )
Purpose:
Queries the value of a property.
Description:
H5Pget retrieves a copy of the value for a property in a property list. If there is a get callback routine registered for this property, the copy of the value of the property will first be passed to that routine and any changes to the copy of the value will be used when returning the property value from this routine.

This routine may be called for zero-sized properties with the value set to NULL. The get routine will be called with a NULL value if the callback exists.

The property name must exist or this routine will fail.

If the get callback routine returns an error, value will not be modified.

Parameters:
Returns:
Success: a non-negative value
Failure: a negative value
Fortran90 Interface: h5pget_f
SUBROUTINE h5pget_f(plid, name, value, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: plid    ! Property list identifier 
  CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to get
  TYPE,  INTENT(OUT) :: value           ! Property value
                                        ! Supported types are:
                                        !    INTEGER
                                        !    REAL
                                        !    DOUBLE PRECISION
                                        !    CHARACTER(LEN=*)
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                        ! 0 on success and -1 on failure
END SUBROUTINE h5pget_f
	

Name: H5Pget_alignment
Signature:
herr_t H5Pget_alignment(hid_t plist, hsize_t *threshold, hsize_t *alignment )
Purpose:
Retrieves the current settings for alignment properties from a file access property list.
Description:
H5Pget_alignment retrieves the current settings for alignment properties from a file access property list. The threshold and/or alignment pointers may be null pointers (NULL).
Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface: h5pget_alignment_f
SUBROUTINE h5pget_alignment_f(prp_id, threshold,  alignment, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id        ! Property list identifier
  INTEGER(HSIZE_T), INTENT(OUT) :: threshold  ! Threshold value
  INTEGER(HSIZE_T), INTENT(OUT) :: alignment  ! Alignment value
  INTEGER, INTENT(OUT) :: hdferr              ! Error code
                                              ! 0 on success and -1 on failure
END SUBROUTINE h5pget_alignment_f
	

Name: H5Pget_alloc_time
Signature:
herr_t H5Pget_alloc_time(hid_t plist_id, H5D_alloc_time_t *alloc_time )
Purpose:
Retrieves the timing for storage space allocation.
Description:
H5Pget_alloc_time retrieves the timing for allocating storage space for a dataset's raw data. This property is set in the dataset creation property list plist_id.

The timing setting is returned in alloc_time as one of the following values:
     H5D_ALLOC_TIME_DEFAULT   Uses the default allocation time, based on the dataset storage method.
See the alloc_time description in H5Pset_alloc_time for default allocation times for various storage methods.
H5D_ALLOC_TIME_EARLY All space is allocated when the dataset is created.
H5D_ALLOC_TIME_INCR   Space is allocated incrementally as data is written to the dataset.
H5D_ALLOC_TIME_LATE All space is allocated when data is first written to the dataset.

Note:
H5Pget_alloc_time is designed to work in concert with the dataset fill value and fill value write time properties, set with the functions H5Pget_fill_value and H5Pget_fill_time.
Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface: h5pget_alloc_time_f
SUBROUTINE h5pget_alloc_time_f(plist_id, flag, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: plist_id   ! Dataset creation
                                           ! property list identifier
  INTEGER(HSIZE_T), INTENT(OUT) :: flag    ! Allocation time flag
                                           ! Possible values are:
                                           !    H5D_ALLOC_TIME_ERROR_F
                                           !    H5D_ALLOC_TIME_DEFAULT_F
                                           !    H5D_ALLOC_TIME_EARLY_F
                                           !    H5D_ALLOC_TIME_LATE_F
                                           !    H5D_ALLOC_TIME_INCR_F
  INTEGER, INTENT(OUT)       :: hdferr     ! Error code
                                           ! 0 on success and -1 on failure
END SUBROUTINE h5pget_alloc_time_f
	
History:

Name: H5Pget_attr_creation_order
Signature:
herr_t H5Pget_attr_creation_order( hid_t ocpl_id, unsigned *crt_order_flags )

Purpose:
Retrieves tracking and indexing settings for attribute creation order.

Description:
H5Pget_attr_creation_order retrieves the settings for tracking and indexing attribute creation order on an object.

ocpl_id is a dataset or group creation property list identifier. The term ocpl, for object creation property list, is used when different types of objects may be involved.

crt_order_flags returns flags with the following meanings:
     H5P_CRT_ORDER_TRACKED Attribute creation order is tracked but not necessarily indexed.
     H5P_CRT_ORDER_INDEXED     Attribute creation order is indexed (requires H5P_CRT_ORDER_TRACKED).
If crt_order_flags is returned with a value of 0 (zero), attribute creation order is neither tracked nor indexed.

Parameters:
hid_t ocpl_id IN: Object (group or dataset) creation property list identifier
unsigned *crt_order_flags     OUT: Flags specifying whether to track and index attribute creation order

Returns:
Returns a non-negative value if successful; otherwise returns a negative value.

Fortran90 Interface:
None.

History:
Release     C
1.8.0 Function introduced in this release.

Name: H5Pget_attr_phase_change
Signature:
herr_t H5Pget_attr_phase_change( hid_t ocpl_id, unsigned *max_compact, unsigned *min_dense )

Purpose:
Retrieves attribute storage phase change thresholds.

Description:
H5Pget_attr_phase_change retrieves threshold values for attribute storage on an object. These thresholds determine the point at which attribute storage changes from compact storage (i.e., storage in the object header) to dense storage (i.e., storage in a heap and indexed with a B-tree).

In the general case, attributes are initially kept in compact storage. When the number of attributes exceeds max_compact, attribute storage switches to dense storage. If the number of attributes subsequently falls below min_dense, the attributes are returned to compact storage.

If max_compact is set to 0 (zero), dense storage always used.

ocpl_id is a dataset or group creation property list identifier. The term ocpl, for object creation property list, is used when different types of objects may be involved.

Parameters:
hid_t ocpl_id IN: Object (dataset or group) creation property list identifier
unsigned *max_compact   OUT: Maximum number of attributes to be stored in compact storage
(Default: 8)
unsigned *min_dense     OUT: Minimum number of attributes to be stored in dense storage
(Default: 6)

Returns:
Returns a non-negative value if successful; otherwise returns a negative value.

Fortran90 Interface:
None.

History:
Release     C
1.8.0 Function introduced in this release.

Name: H5Pget_btree_ratios
Signature:
herr_t H5Pget_btree_ratios(hid_t plist, double *left, double *middle, double *right )
Purpose:
Gets B-tree split ratios for a dataset transfer property list.
Description:
H5Pget_btree_ratios returns the B-tree split ratios for a dataset transfer property list.

The B-tree split ratios are returned through the non-NULL arguments left, middle, and right, as set by the H5Pset_btree_ratios function.

Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface: h5pget_btree_ratios_f
SUBROUTINE h5pget_btree_ratios_f(prp_id, left, middle, right, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id  
                                  ! Property list identifier
  REAL, INTENT(OUT) :: left       ! B-tree split ratio for left-most nodes
  REAL, INTENT(OUT) :: middle     ! B-tree split ratio for all other nodes
  REAL, INTENT(OUT) :: right      ! The B-tree split ratio for right-most
                                  ! nodes and lone nodes.
  INTEGER, INTENT(OUT) :: hdferr  ! Error code
                                  ! 0 on success and -1 on failure
END SUBROUTINE h5pget_btree_ratios_f
	

Name: H5Pget_buffer
Signature:
hsize_t H5Pget_buffer(hid_t plist, void **tconv, void **bkg )
Purpose:
Reads buffer settings.
Description:
H5Pget_buffer reads values previously set with H5Pset_buffer.
Parameters:
Returns:
Returns buffer size, in bytes, if successful; otherwise 0 on failure.
Fortran90 Interface: h5pget_buffer_f
SUBROUTINE h5pget_buffer_f(plist_id, size, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN)    :: plist_id ! Dataset transfer 
                                            ! property list identifier
  INTEGER(HSIZE_T), INTENT(OUT) :: size     ! Conversion buffer size
  INTEGER, INTENT(OUT)          :: hdferr   ! Error code
                                            ! 0 on success and -1 on failure
END SUBROUTINE h5pget_buffer_f
	
History:

Name: H5Pget_cache
Signature:
herr_t H5Pget_cache(hid_t plist_id, int *mdc_nelmts, int *rdcc_nelmts, size_t *rdcc_nbytes, double *rdcc_w0 )
Purpose:
Queries the meta data cache and raw data chunk cache parameters.
Description:
H5Pget_cache retrieves the maximum possible number of elements in the meta data cache and raw data chunk cache, the maximum possible number of bytes in the raw data chunk cache, and the preemption policy value.

Any (or all) arguments may be null pointers, in which case the corresponding datum is not returned.

Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface: h5pget_cache_f
SUBROUTINE h5pget_cache_f(prp_id, mdc_nelmts, rdcc_nelmts, rdcc_nbytes,
                          rdcc_w0, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id         ! Property list identifier
  INTEGER, INTENT(OUT) :: mdc_nelmts           ! Number of elements (objects)
                                               ! in the meta data cache
  INTEGER(SIZE_T), INTENT(OUT) :: rdcc_nelmts  ! Number of elements (objects)
                                               ! in the meta data cache
  INTEGER(SIZE_T), INTENT(OUT) :: rdcc_nbytes  ! Total size of the raw data
                                               ! chunk cache, in bytes
  REAL, INTENT(OUT) :: rdcc_w0                 ! Preemption policy
  INTEGER, INTENT(OUT) :: hdferr               ! Error code
                                               ! 0 on success and -1 on failure
END SUBROUTINE h5pget_cache_f
	
History:

Name: H5Pget_char_encoding
Signature:
herr_t H5Pget_char_encoding( hid_t plist_id, H5T_cset_t encoding )

Purpose:
Retrieves the character encoding used to create a string.

Description:
H5Pget_char_encoding retrieves the character encoding used to encode strings or object names that are created with the property list plist_id.

Valid values for encoding are defined in H5Tpublic.h and include the following:
     H5T_CSET_ASCII US ASCII
     H5T_CSET_UTF8     UTF-8 Unicode encoding

Parameters:
hid_t plist_id IN: Property list identifier
H5T_cset_t encoding     OUT: String encoding character set

Returns:
Returns a non-negative valule if successful; otherwise returns a negative value.

Fortran90 Interface:
None.

History:
Release     C
1.8.0 Function introduced in this release.

Name: H5Pget_chunk
Signature:
int H5Pget_chunk(hid_t plist, int max_ndims, hsize_t * dims )
Purpose:
Retrieves the size of chunks for the raw data of a chunked layout dataset.
Description:
H5Pget_chunk retrieves the size of chunks for the raw data of a chunked layout dataset. This function is only valid for dataset creation property lists. At most, max_ndims elements of dims will be initialized.
Parameters:
Returns:
Returns chunk dimensionality if successful; otherwise returns a negative value.
Fortran90 Interface: h5pget_chunk_f
SUBROUTINE h5pget_chunk_f(prp_id, ndims, dims, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier 
  INTEGER, INTENT(IN) :: ndims          ! Number of chunk dimensions 
                                        ! to return
  INTEGER(HSIZE_T), DIMENSION(ndims), INTENT(OUT) :: dims    
                                        ! Array containing sizes of
                                        ! chunk dimensions
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                        ! chunk rank on success 
                                        ! and -1 on failure
END SUBROUTINE h5pget_chunk_f
	

Name: H5Pget_class
Signature:
H5P_class_t H5Pget_class(hid_t plist )
Purpose:
Returns the property list class for a property list.
Description:
H5Pget_class returns the property list class for the property list identified by the plist parameter. Valid property list classes are defined in the description of H5Pcreate.
Parameters:
Returns:
Returns a property list class if successful. Otherwise returns H5P_NO_CLASS (-1).
Fortran90 Interface: h5pget_class_f
SUBROUTINE h5pget_class_f(prp_id, classtype, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
  INTEGER, INTENT(OUT) :: classtype    ! The type of the property list 
                                       ! to be created 
                                       ! Possible values are: 
                                       !    H5P_NO_CLASS  
                                       !    H5P_FILE_CREATE_F 
                                       !    H5P_FILE_ACCESS_F 
                                       !    H5PE_DATASET_CREATE_F 
                                       !    H5P_DATASET_XFER_F
                                       !    H5P_MOUNT_F 
  INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                       ! 0 on success and -1 on failure
END SUBROUTINE h5pget_class_f
	

Name: H5Pget_class_name
Purpose:
Retrieves the name of a class.
Signature:
char * H5Pget_class_name( hid_t pcid )
Description:
H5Pget_class_name retrieves the name of a generic property list class. The pointer to the name must be freed by the user after each successful call.
Parameters:
Returns:
Success: a pointer to an allocated string containing the class name
Failure: NULL
Fortran90 Interface: h5pget_class_name_f
SUBROUTINE h5pget_class_name_f(prp_id, name, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id     ! Property list identifier to
                                           ! query 
  CHARACTER(LEN=*), INTENT(INOUT) :: name  ! Buffer to retrieve class name
  INTEGER, INTENT(OUT) :: hdferr           ! Error code, possible values:
                                           ! Success:  Actual length of the 
                                           ! class name
                                           ! If provided buffer "name" is 
                                           ! smaller, than name will be 
                                           ! truncated to fit into
                                           ! provided user buffer
                                           ! Failure: -1   
END SUBROUTINE h5pget_class_name_f
	

Name: H5Pget_class_parent
Signature:
hid_t H5Pget_class_parent( hid_t pcid )
Purpose:
Retrieves the parent class of a property class.
Description:
H5Pget_class_parent retrieves an identifier for the parent class of a property class.
Parameters:
Returns:
Success: a valid parent class object identifier
Failure: a negative value
Fortran90 Interface: h5pget_class_parent_f
SUBROUTINE h5pget_class_parent_f(prp_id, parent_id, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id     ! Property list identifier 
  INTEGER(HID_T), INTENT(OUT) :: parent_id ! Parent class property list 
                                           ! identifier
  INTEGER, INTENT(OUT) :: hdferr           ! Error code
                                           ! 0 on success and -1 on failure
END SUBROUTINE h5pget_class_parent_f
	

Name: H5Pget_copy_object
Signature:
herr_t H5Pget_copy_object( hid_t ocp_plist_id, unsigned *copy_options )
Purpose:
Retrieves the properties to be used when an object is copied.
Description:
H5Pget_copy_object retrieves the properties currently specified in the object copy property list ocp_plist_id, which will be invoked when a new copy is made of an existing object.

copy_options is a bit map indicating the flags, or properties, governing object copying that are set in the property list ocp_plist_id.

The available flags are described in H5Pset_copy_object.

Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface:
None.
History:

Name: H5Pget_create_intermediate_group
Signature:
herr_t H5Pget_create_intermediate_group( hid_t lcpl_id, unsigned *crt_intermed_group )
Purpose:
Determines whether property is set to enable creating missing intermediate groups.
Description:
H5Pget_create_intermediate_group determines whether the link creation property list lcpl_id is set to allow functions that create objects in groups different from the current working group to create intermediate groups that may be missing in the path of a new or moved object.

Functions that create objects in or move objects to a group other than the current working group make use of this property. H5Gcreate_anon and H5Lmove are examles of such functions.

If crt_intermed_group is true, missing intermediate groups will be created; if crt_intermed_group is false, missing intermediate groups will not be created.

Parameters:
Returns:
Returns a non-negative valule if successful; otherwise returns a negative value.
Fortran90 Interface:
None.
History:

Name: H5Pget_data_transform
Signature:
ssize_t H5Pget_data_transform (hid_t plist_id, char *expression, size_t size)
Purpose:
Retrieves a data transform expression.
Description:
H5Pget_data_transform retrieves the data transform expression previously set in the dataset transfer property list plist_id by H5Pset_data_transform.

H5Pget_data_transform can be used to both retrieve the transform expression and to query its size.

If expression is non-NULL, up to size bytes of the data transform expression are written to the buffer. If expression is NULL, size is ignored and the function does not write anything to the buffer. The function always returns the size of the data transform expression.

If 0 is returned for the size of the expression, no data transform expression exists for the property list.

If an error occurs, the buffer pointed to by expression is unchanged and the function returns a negative value.

Parameters:
Returns:
Success: size of the transform expression.
Failure: a negative value.
Fortran90 Interface:
None.

Name: H5Pget_driver
Signature:
hid_t H5Pget_driver( hid_t plist_id )
Purpose:
Returns low-lever driver identifier.
Description:
H5Pget_driver returns the identifier of the low-level file driver associated with the file access property list or data transfer property list plist_id.

Valid driver identifiers with the standard HDF5 library distribution include the following:

           H5FD_CORE
           H5FD_DIRECT
           H5FD_FAMILY
           H5FD_LOG
           H5FD_MPIO
           H5FD_MULTI
           H5FD_SEC2
           H5FD_STDIO   
           H5FD_WINDOWS (Windows only)
If a user defines and registers custom drivers or if additional drivers are defined in an HDF5 distribution, this list will be longer.

The Windows driver, H5FD_WINDOWS, is available only on Windows systems.

The returned driver identifier is only valid as long as the file driver remains registered.

Parameters:
Returns:
Returns a valid low-level driver identifier if successful. Otherwise returns a negative value.
Fortran90 Interface: h5pget_driver_f
SUBROUTINE h5pget_driver_f(prp_id, driver, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
  INTEGER, INTENT(OUT) :: driver       ! Low-level file driver identifier
  INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                       ! 0 on success and -1 on failure
END SUBROUTINE h5pget_driver_f
	
History:

Name: H5Pget_driver_info
Signature:
void *H5Pget_driver_info( hid_t plist_id )
Purpose:
Returns a pointer to file driver information.
Description:
H5Pget_driver_info returns a pointer to file driver-specific information for the low-level driver associated with the file access or data transfer property list plist_id.

The pointer returned by this function points to an “uncopied” struct. Driver-specific versions of that struct are defined for each low-level driver in the relevant source code file H5FD*.c. For example, the struct used for the MULTI driver is H5FD_multi_fapl_t defined in H5FDmulti.c.

If no driver-specific properties have been registered, H5Pget_driver_info returns NULL.

Parameters:
hid_t plist_id
IN: File access or data transfer property list identifier.
Returns:
Returns a pointer to a struct containing low-level driver information. Otherwise returns NULL.

NULL is also returned if no driver-specific properties have been registered. No error is pushed on the stack in this case.

Non-C API(s):
None.
History:

Name: H5Pget_dxpl_mpio
Signature:
herr_t H5Pget_dxpl_mpio( hid_t dxpl_id, H5FD_mpio_xfer_t *xfer_mode )
Purpose:
Returns the data transfer mode.
Description:
H5Pget_dxpl_mpio queries the data transfer mode currently set in the data transfer property list dxpl_id.

Upon return, xfer_mode contains the data transfer mode, if it is non-null.

H5Pget_dxpl_mpio is not a collective function.

Parameters:
Returns:
Returns a non-negative value if successful. Otherwise returns a negative value.
Fortran90 Interface: h5pget_dxpl_mpio_f
SUBROUTINE h5pget_dxpl_mpio_f(prp_id, data_xfer_mode, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id    ! Property list identifier
  INTEGER, INTENT(OUT) :: data_xfer_mode  ! Data transfer mode
                                          ! Possible values are:
                                          !    H5FD_MPIO_INDEPENDENT_F
                                          !    H5FD_MPIO_COLLECTIVE_F
  INTEGER, INTENT(OUT) :: hdferr          ! Error code
                                          ! 0 on success and -1 on failure
END SUBROUTINE h5pget_dxpl_mpio_f
	
History:

Name: H5Pget_dxpl_multi
Signature:
herr_t H5Pget_dxpl_multi( hid_t dxpl_id, const hid_t *memb_dxpl )

Purpose:
Returns multi-file data transfer property list information.
Description:
H5Pget_dxpl_multi returns the data transfer property list information for the multi-file driver.
Parameters:
Returns:
Returns a non-negative value if successful. Otherwise returns a negative value.
Fortran90 Interface:
None.
History:

Name: H5Pget_edc_check
Signature:
H5Z_EDC_t H5Pget_edc_check(hid_t plist)
Purpose:
Determines whether error-detection is enabled for dataset reads.
Description:
H5Pget_edc_check queries the dataset transfer property list plist to determine whether error detection is enabled for data read operations.
Parameters:
Returns:
Returns H5Z_ENABLE_EDC or H5Z_DISABLE_EDC if successful; otherwise returns a negative value.
Fortran90 Interface: h5pget_edc_check_f
SUBROUTINE h5pget_edc_check_f(prp_id, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id  ! Dataset transfer property list 
                                        ! identifier 
  INTEGER, INTENT(OUT)       :: flag    ! EDC flag; possible values
                                        !    H5Z_DISABLE_EDC_F 
                                        !    H5Z_ENABLE_EDC_F 
  INTEGER, INTENT(OUT)       :: hdferr  ! Error code
                                        ! 0 on success and -1 on failure
END SUBROUTINE h5pget_edc_check_f
	
History:

Name: H5Pget_elink_prefix
Signature:
ssize_t H5Pget_elink_prefix( hid_t lapl_id, char *prefix, size_t size )

Purpose:
Retrieves prefix applied to external link paths.

Description:
H5Pget_elink_prefix retrieves the prefix applied to the path of any external links traversed.

When an external link is traversed, the prefix is retrieved from the link access property list lapl_id, returned in the user-allocated buffer pointed to by prefix, and prepended to the filename stored in the external link.

The size in bytes of the prefix, including the NULL terminator, is specified in size. If size is unknown, a preliminary H5Pget_elink_prefix call with the pointer prefix set to NULL will return the size of the prefix without the NULL terminator.

Parameters:
hid_t lapl_id IN: Link access property list identifier
char *prefix     OUT: Prefix applied to external link paths
size_t size IN: Size of prefix, including null terminator

Returns:
If successful, returns a non-negative value specifying the size in bytes of the prefix without the NULL terminator; otherwise returns a negative value.

Fortran90 Interface:
None.

History:
Release     C
1.8.0 Function introduced in this release.

Name: H5Pget_est_link_info
Signature:
herr_t H5Pget_est_link_info( hid_t gcpl_id, unsigned *est_num_entries, unsigned *est_name_len )

Purpose:
Queries data required to estimate required local heap or object header size.

Description:
H5Pget_est_link_info queries a group creation property list, gcpl_id, for its “estimated number of links” and “estimated average name length” settings.

The estimated number of links anticipated to be inserted into a group created with this property list is returned in est_num_entries.

The estimated average length of the anticipated link names is returned in est_name_len.

The values for these two settings are multiplied to compute the initial local heap size (for old-style groups, if the local heap size hint is not set) or the initial object header size for (new-style compact groups; see “Group styles in HDF5”). Accurately setting these parameters will help reduce wasted file space.

A value of 0 (zero) in est_num_entries will prevent a group from being created in the compact format.

See “Group styles in HDF5” in the H5G API introduction for a discussion of the available types of HDF5 group structures.

Parameters:
hid_t gcpl_id IN: Group creation property list identifier
unsigned *est_num_entries     OUT: Estimated number of links to be inserted into group
unsigned *est_name_len OUT: Estimated average length of link names
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.

Fortran90 Interface:
None.

History:
Release     C
1.8.0 Function introduced in this release.

Name: H5Pget_external
Signature:
herr_t H5Pget_external(hid_t plist, unsigned idx, size_t name_size, char *name, off_t *offset, hsize_t *size )
Purpose:
Returns information about an external file.
Description:
H5Pget_external returns information about an external file. The external file is specified by its index, idx, which is a number from zero to N-1, where N is the value returned by H5Pget_external_count. At most name_size characters are copied into the name array. If the external file name is longer than name_size with the null terminator, the return value is not null terminated (similar to strncpy()).

If name_size is zero or name is the null pointer, the external file name is not returned. If offset or size are null pointers then the corresponding information is not returned.

Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface: h5pget_external_f
SUBROUTINE h5pget_external_f(prp_id, idx, name_size, name, offset,bytes, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id   ! Property list identifier
  INTEGER, INTENT(IN) :: idx             ! External file index.
  INTEGER, INTENT(IN) :: name_size       ! Maximum length of name array
  CHARACTER(LEN=*), INTENT(OUT) :: name  ! Name of an external file
  INTEGER, INTENT(OUT) :: offset         ! Offset, in bytes, from the 
                                         ! beginning of the file to the 
                                         ! location in the file where
                                         ! the data starts.
  INTEGER(HSIZE_T), INTENT(OUT) :: bytes ! Number of bytes reserved in 
                                         ! the file for the data
  INTEGER, INTENT(OUT) :: hdferr         ! Error code
                                         ! 0 on success and -1 on failure
END SUBROUTINE h5pget_external_f
	
History:

Name: H5Pget_external_count
Signature:
int H5Pget_external_count(hid_t plist )
Purpose:
Returns the number of external files for a dataset.
Description:
H5Pget_external_count returns the number of external files for the specified dataset.
Parameters:
Returns:
Returns the number of external files if successful; otherwise returns a negative value.
Fortran90 Interface: h5pget_external_count_f
SUBROUTINE h5pget_external_count_f (prp_id, count, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
  INTEGER, INTENT(OUT) :: count        ! Number of external files for 
                                       ! the specified dataset
  INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                       ! 0 on success and -1 on failure
END SUBROUTINE h5pget_external_count_f
	

Name: H5Pget_family_offset
Signature:
herr_t H5Pget_family_offset ( hid_t fapl_id, hsize_t *offset )
Purpose:
Retrieves a data offset from the file access property list.
Description:
H5Pget_family_offset retrieves the value of offset from the file access property list fapl_id so that the user application can retrieve a file handle for low-level access to a particular member of a family of files. 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 data offset returned in offset 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.

Use of this function is only appropriate for an HDF5 file written as a family of files with the FAMILY file driver.

Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface:
None.
History:

Name: H5Pget_fapl_core
Signature:
herr_t H5Pget_fapl_core( hid_t fapl_id, size_t *increment, hbool_t *backing_store )
Purpose:
Queries core file driver properties.
Description:
H5Pget_fapl_core queries the H5FD_CORE driver properties as set by H5Pset_fapl_core.
Parameters:
Returns:
Returns a non-negative value if successful. Otherwise returns a negative value.
Fortran90 Interface: h5pget_fapl_core_f
SUBROUTINE h5pget_fapl_core_f(prp_id, increment, backing_store, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN)  :: prp_id     ! Property list identifier
  INTEGER(SIZE_T), INTENT(OUT) :: increment ! File block size in bytes
  LOGICAL, INTENT(OUT) :: backing_store     ! Flag to indicate that entire
                                            ! file contents are flushed to 
                                            ! a file with the same name as 
                                            ! this core file
  INTEGER, INTENT(OUT) :: hdferr            ! Error code
                                            ! 0 on success and -1 on failure
END SUBROUTINE h5pget_fapl_core_f
	
History:

Name: H5Pget_fapl_direct
Signature:
herr_t H5Pget_fapl_direct( hid_t fapl_id, size_t *alignment, size_t *block_size, size_t *cbuf_size )

Purpose:
Retrieves direct I/O driver settings.

Description:
H5Pget_fapl_direct retrieves the required memory alignment (alignment), file system block size (block_size), and copy buffer size (cbuf_size) settings for the direct I/O driver, H5FD_DIRECT, from the file access property list fapl_id.

See H5Pset_fapl_direct for discussion of these values, requirements, and important considerations.

Parameters:
hid_t fapl_id IN: File access property list identifier
size_t *alignment OUT: Required memory alignment boundary
size_t *block_size     OUT: File system block size
size_t *cbuf_size OUT: Copy buffer size

Returns:
Returns a non-negative value if successful; otherwise returns a negative value.

Fortran90 Interface:
None.

History:
Release     C
1.8.0 Function introduced in this release.

Name: H5Pget_fapl_family
Signature:
herr_t H5Pget_fapl_family ( hid_t fapl_id, hsize_t *memb_size, hid_t *memb_fapl_id )
Purpose:
Returns file access property list information.
Description:
H5Pget_fapl_family returns file access property list for use with the family driver. This information is returned through the output parameters.
Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface: h5pget_fapl_family_f
SUBROUTINE h5pget_fapl_family_f(prp_id, imemb_size, memb_plist, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN)    :: prp_id    ! Property list identifier
  INTEGER(HSIZE_T), INTENT(OUT) :: memb_size ! Logical size, in bytes,
                                             ! of each family member
  INTEGER(HID_T), INTENT(OUT) :: memb_plist  ! Identifier of the file 
                                             ! access property list to be
                                             ! used for each family member
  INTEGER, INTENT(OUT) :: hdferr             ! Error code
                                             ! 0 on success and -1 on failure
END SUBROUTINE h5pget_fapl_family_f
	
History:

Name: H5Pget_fapl_mpio
Signature:
herr_t H5Pget_fapl_mpio( hid_t fapl_id, MPI_Comm *comm, MPI_Info *info )
Purpose:
Returns MPI communicator information.
Description:
If the file access property list is set to the H5FD_MPIO driver, H5Pget_fapl_mpio returns the MPI communicator and information through the comm and info pointers, if those values are non-null.

Neither comm nor info is copied, so they are valid only until the file access property list is either modified or closed.

Parameters:
Returns:
Returns a non-negative value if successful. Otherwise returns a negative value.
Fortran90 Interface: h5pget_fapl_mpio_f
SUBROUTINE h5pget_fapl_mpio_f(prp_id, comm, info, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
  INTEGER, INTENT(OUT) :: comm         ! Buffer to return communicator 
  INTEGER, INTENT(IN) :: info          ! Buffer to return info object as
                                       ! defined in MPI_FILE_OPEN of MPI-2
  INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                       ! 0 on success and -1 on failure
END SUBROUTINE h5pget_fapl_mpio_f
	
History:

Name: H5Pget_fapl_mpiposix
Signature:
herr_t H5Pget_fapl_mpiposix( hid_t fapl_id, MPI_Comm *comm )
Purpose:
Returns MPI communicator information.
Description:
If the file access property list is set to the H5FD_MPIO driver, H5Pget_fapl_mpiposix returns the MPI communicator through the comm pointer, if those values are non-null.

comm is not copied, so it is valid only until the file access property list is either modified or closed.

Parameters:
Returns:
Returns a non-negative value if successful. Otherwise returns a negative value.
Fortran90 Interface: h5pget_fapl_mpiposix_f
SUBROUTINE h5pget_fapl_mpiposix_f(prp_id, comm, use_gpfs, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier
  INTEGER, INTENT(OUT) :: comm          ! Buffer to return communicator
  LOGICAL, INTENT(OUT) :: use_gpfs
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
END SUBROUTINE h5pget_fapl_mpiposix_f
	
History:

Name: H5Pget_fapl_multi
Signature:
herr_t H5Pget_fapl_multi( hid_t fapl_id, const H5FD_mem_t *memb_map, const hid_t *memb_fapl, const char **memb_name, const haddr_t *memb_addr, hbool_t *relax )
Purpose:
Returns information about the multi-file access property list.
Description:
H5Pget_fapl_multi returns information about the multi-file access property list.
Parameters:
Returns:
Returns a non-negative value if successful. Otherwise returns a negative value.
Fortran90 Interface: h5pget_fapl_multi_f
SUBROUTINE h5pget_fapl_multi_f(prp_id, memb_map, memb_fapl, memb_name,
                               memb_addr, relax, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T),INTENT(IN)   :: prp_id    ! Property list identifier

  INTEGER,DIMENSION(0:H5FD_MEM_NTYPES_F-1),INTENT(OUT)          :: memb_map
  INTEGER(HID_T),DIMENSION(0:H5FD_MEM_NTYPES_F-1),INTENT(OUT)   :: memb_fapl
  CHARACTER(LEN=*),DIMENSION(0:H5FD_MEM_NTYPES_F-1),INTENT(OUT) :: memb_name
  REAL, DIMENSION(0:H5FD_MEM_NTYPES_F-1), INTENT(OUT)           :: 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 

  LOGICAL, INTENT(OUT) :: relax
  INTEGER, INTENT(OUT) :: hdferr           ! Error code
                                           ! 0 on success and -1 on failure
END SUBROUTINE h5pget_fapl_multi_f
	
History:

Name: H5Pget_fclose_degree
Signature:
herr_t H5Pget_fclose_degree(hid_t fapl_id, H5F_close_degree_t *fc_degree)
Purpose:
Returns the file close degree.
Description:
H5Pget_fclose_degree returns the current setting of the file close degree property fc_degree in the file access property list fapl_id.

The value of fc_degree determines how aggressively H5Fclose deals with objects within a file that remain open when H5Fclose is called to close that file. fc_degree can have any one of four valid values as described in H5Pset_fclose_degree.

Parameters:
Returns:
Returns a non-negative value if successful. Otherwise returns a negative value.
Fortran90 Interface: h5pget_fclose_degree_f
SUBROUTINE h5pget_fclose_degree_f(fapl_id, degree, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: fapl_id ! File access property list identifier
  INTEGER, INTENT(OUT) :: degree        ! Info about file close behavior
                                        ! Possible values:
                                        !    H5F_CLOSE_DEFAULT_F
                                        !    H5F_CLOSE_WEAK_F
                                        !    H5F_CLOSE_SEMI_F
                                        !    H5F_CLOSE_STRONG_F
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                        ! 0 on success and -1 on failure
END SUBROUTINE h5pget_fclose_degree_f
	
History:

Name: H5Pget_fill_time
Signature:
herr_t H5Pget_fill_time(hid_t plist_id, H5D_fill_time_t *fill_time )
Purpose:
Retrieves the time when fill value are written to a dataset.
Description:
H5Pget_fill_time examines the dataset creation property list plist_id to determine when fill values are to be written to a dataset.

Valid values returned in fill_time are as follows:
     H5D_FILL_TIME_IFSET   Fill values are written to the dataset when storage space is allocated only if there is a user-defined fill value, i.e., one set with H5Pset_fill_value.   (Default)
  H5D_FILL_TIME_ALLOC   Fill values are written to the dataset when storage space is allocated.
  H5D_FILL_TIME_NEVER Fill values are never written to the dataset.

Note:
H5Pget_fill_time is designed to work in coordination with the dataset fill value and dataset storage allocation time properties, retrieved with the functions H5Pget_fill_value and H5Pget_alloc_time.
Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface: h5pget_fill_time_f
SUBROUTINE h5pget_fill_time_f(plist_id, flag, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: plist_id ! Dataset creation property 
                                         ! list identifier
  INTEGER(HSIZE_T), INTENT(OUT) :: flag  ! Fill time flag
                                         ! Possible values are:
                                         !    H5D_FILL_TIME_ERROR_F
                                         !    H5D_FILL_TIME_ALLOC_F
                                         !    H5D_FILL_TIME_NEVER_F
  INTEGER, INTENT(OUT)       :: hdferr   ! Error code
                                         ! 0 on success and -1 on failure
END SUBROUTINE h5pget_fill_time_f
	
History:

Name: H5Pget_fill_value
Signature:
herr_t H5Pget_fill_value(hid_t plist_id, hid_t type_id, void *value )
Purpose:
Retrieves a dataset fill value.
Description:
H5Pget_fill_value returns the dataset fill value defined in the dataset creation property list plist_id.

The fill value is returned through the value pointer and will be converted to the datatype specified by type_id. This datatype may differ from the fill value datatype in the property list, but the HDF5 library must be able to convert between the two datatypes.

If the fill value is undefined, i.e., set to NULL in the property list, H5Pget_fill_value will return an error. H5Pfill_value_defined should be used to check for this condition before H5Pget_fill_value is called.

Memory must be allocated by the calling application.

Note:
H5Pget_fill_value is designed to coordinate with the dataset storage allocation time and fill value write time properties, which can be retrieved with the functions H5Pget_alloc_time and H5Pget_fill_time, respectively.
Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface: h5pget_fill_value_f
SUBROUTINE h5pget_fill_value_f(prp_id, type_id, fillvalue, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier 
  INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier of fill
                                        ! value datatype (in memory) 
  TYPE(VOID), INTENT(IN) :: fillvalue   ! Fillvalue
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                        ! 0 on success and -1 on failure
 
END SUBROUTINE h5pget_fill_value_f
	

Name: H5Pget_filter
Signatures:
H5Z_filter_t H5Pget_filter( hid_t plist, unsigned int idx, unsigned int *flags, size_t *cd_nelmts, unsigned int *cd_values, size_t namelen, char name[] )
 
[1]
H5Z_filter_t H5Pget_filter( hid_t plist_id, unsigned idx, unsigned int *flags, size_t *cd_nelmts, unsigned cd_values[], size_t namelen, char name[], unsigned *filter_config ) [2]

Purpose:
Returns information about a filter in a pipeline.

Description:
H5Pget_filter is a macro that is mapped to either H5Pget_filter1 or H5Pget_filter2, depending on the needs of the application.

Such macros are provided to facilitate application compatibility. For example:

Macro use and mappings are fully described in “API Compatibility Macros in HDF5” we urge you to read that document closely.

When both the HDF5 Library and the application are built and installed with no specific compatibility flags, H5Pget_filter is mapped to the most recent version of the function, currently H5Pget_filter2. If the library and/or application is compiled for Release 1.6 emulation, H5Pget_filter will be mapped to H5Pget_filter1. Function-specific flags are available to override these settings on a function-by-function basis when the application is compiled.

Specific compile-time compatibility flags and the resulting mappings are as follows:

Compatibility setting H5Pget_filter mapping

Global settings
No compatibility flag H5Pget_filter2 
Enable deprecated symbols H5Pget_filter2 
Disable deprecated symbols H5Pget_filter2 
Emulate Release 1.6 interface     H5Pget_filter1 

Function-level macros
H5Pget_filter_vers = 2 H5Pget_filter2
H5Pget_filter_vers = 1 H5Pget_filter1

Interface history:   Signature [1] above is the original H5Pget_filter interface and the only interface available prior to HDF5 Release 1.8.0. This signature and the corresponding function are now deprecated but will remain directly callable as H5Pget_filter1.

Signature [2] above was introduced with HDF5 Release 1.8.0 and is the recommended and default interface. It is directly callable as H5Pget_filter2.

See “API Compatibility Macros in HDF5” for circumstances under which either of these functions might not be available in an installed instance of the HDF5 Library.

Fortran90 Interface: h5pget_filter_f
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
                                          ! pipeline of the filter for which
                                          ! information is sought
  INTEGER, DIMENSION(*), INTENT(OUT) :: cd_values  
                                          ! Auxiliary data for the filter
  INTEGER, INTENT(OUT) :: flags           ! Bit vector specifying certain 
                                          ! general properties of the filter
  INTEGER(SIZE_T), INTENT(INOUT) :: cd_nelmts      
                                          ! Number of elements in cd_values
  INTEGER(SIZE_T), INTENT(IN) :: namelen  ! Anticipated number of characters 
                                          ! in name
  CHARACTER(LEN=*), INTENT(OUT) :: name   ! Name of the filter
  INTEGER, INTENT(OUT) :: filter_id       ! Filter identification number
  INTEGER, INTENT(OUT) :: hdferr          ! Error code
                                          ! 0 on success and -1 on failure
END SUBROUTINE h5pget_filter_f
	

History:
Release     C
1.8.0 The function H5Pget_filter renamed to H5Pget_filter1 and deprecated in this release.
The macro H5Pget_filter and the function H5Pget_filter2 introduced in this release.

Name: H5Pget_filter1
Signature:
H5Z_filter_t H5Pget_filter1( hid_t plist, unsigned int idx, unsigned int *flags, size_t *cd_nelmts, unsigned int *cd_values, size_t namelen, char name[] )

Purpose:
Returns information about a filter in a pipeline.

Notice:
This function is renamed from H5Pget_filter and deprecated in favor of the function H5Pget_filter2 or the new macro H5Pget_filter.

Description:
H5Pget_filter1 returns information about a filter, specified by its filter number, in a filter pipeline, specified by the property list with which it is associated.

If plist is a dataset creation property list, the pipeline is a permanent filter pipeline; if plist is a dataset transfer property list, the pipeline is a transient filter pipeline.

idx is a value between zero and N-1, as described in H5Pget_nfilters. The function will return a negative value if the filter number is out of range.

The structure of the flags argument is discussed in H5Pset_filter.

On input, cd_nelmts indicates the number of entries in the cd_values array, as allocated by the caller; on return,cd_nelmts contains the number of values defined by the filter.

If name is a pointer to an array of at least namelen bytes, the filter name will be copied into that array. The name will be null terminated if namelen is large enough. The filter name returned will be the name appearing in the file, the name registered for the filter, or an empty string.

Note:
This function currently supports only the permanent filter pipeline; plist must be a dataset creation property list.

Parameters:

Returns:
Returns the filter identifier if successful:
H5Z_FILTER_DEFLATE Data compression filter, employing the gzip algorithm
H5Z_FILTER_SHUFFLE Data shuffling filter
H5Z_FILTER_FLETCHER32   Error detection filter, employing the Fletcher32 checksum algorithm
H5Z_FILTER_SZIP Data compression filter, employing the SZIP algorithm
H5Z_FILTER_NBIT Data compression filter, employing the N-bit algorithm
H5Z_FILTER_SCALEOFFSET Data compression filter, employing the scale-offset algorithm
Otherwise returns a negative value.

Fortran90 Interface: h5pget_filter_f
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
                                          ! pipeline of the filter for which
                                          ! information is sought
  INTEGER, DIMENSION(*), INTENT(OUT) :: cd_values  
                                          ! Auxiliary data for the filter
  INTEGER, INTENT(OUT) :: flags           ! Bit vector specifying certain 
                                          ! general properties of the filter
  INTEGER(SIZE_T), INTENT(INOUT) :: cd_nelmts      
                                          ! Number of elements in cd_values
  INTEGER(SIZE_T), INTENT(IN) :: namelen  ! Anticipated number of characters 
                                          ! in name
  CHARACTER(LEN=*), INTENT(OUT) :: name   ! Name of the filter
  INTEGER, INTENT(OUT) :: filter_id       ! Filter identification number
  INTEGER, INTENT(OUT) :: hdferr          ! Error code
                                          ! 0 on success and -1 on failure
END SUBROUTINE h5pget_filter_f
	

History:

Name: H5Pget_filter2
Signature:
H5Z_filter_t H5Pget_filter2( hid_t plist_id, unsigned idx, unsigned int *flags, size_t *cd_nelmts, unsigned cd_values[], size_t namelen, char name[], unsigned *filter_config )

Purpose:
Returns information about a filter in a pipeline.

Description:
H5Pget_filter2 returns information about a filter, specified by its filter number, in a filter pipeline, specified by the property list with which it is associated.

If plist is a dataset creation property list, the pipeline is a permanent filter pipeline; if plist is a dataset transfer property list, the pipeline is a transient filter pipeline.

idx is a value between zero and N-1, as described in H5Pget_nfilters. The function will return a negative value if the filter number is out of range.

The structure of the flags argument is discussed in H5Pset_filter.

On input, cd_nelmts indicates the number of entries in the cd_values array, as allocated by the caller; on return,cd_nelmts contains the number of values defined by the filter.

If name is a pointer to an array of at least namelen bytes, the filter name will be copied into that array. The name will be null terminated if namelen is large enough. The filter name returned will be the name appearing in the file, the name registered for the filter, or an empty string.

filter_config is the bit field described in H5Zget_filter_info.

Note:
This function currently supports only the permanent filter pipeline; plist must be a dataset creation property list.

Parameters:

Returns:
Returns the filter identifier if successful:
H5Z_FILTER_DEFLATE Data compression filter, employing the gzip algorithm
H5Z_FILTER_SHUFFLE Data shuffling filter
H5Z_FILTER_FLETCHER32   Error detection filter, employing the Fletcher32 checksum algorithm
H5Z_FILTER_SZIP Data compression filter, employing the SZIP algorithm
H5Z_FILTER_NBIT Data compression filter, employing the N-bit algorithm
H5Z_FILTER_SCALEOFFSET Data compression filter, employing the scale-offset algorithm
Otherwise returns a negative value.

Fortran90 Interface:
None.

History:
Release     C
1.8.0 Function introduced in this release.

Name: H5Pget_filter_by_id
Signatures:
herr_t H5Pget_filter_by_id( hid_t plist_id, H5Z_filter_t filter_id, unsigned int *flags, size_t *cd_nelmts, unsigned int cd_values[], size_t namelen, char name[] )
 
[1]
herr_t H5Pget_filter_by_id( hid_t plist_id, H5Z_filter_t filter_id, unsigned int *flags, size_t *cd_nelmts, unsigned int cd_values[], size_t namelen, char name[], unsigned int *filter_config ) [2]

Purpose:
Returns information about the specified filter.

Description:
H5Pget_filter_by_id is a macro that is mapped to either H5Pget_filter_by_id1 or H5Pget_filter_by_id2, depending on the needs of the application.

Such macros are provided to facilitate application compatibility. For example:

Macro use and mappings are fully described in “API Compatibility Macros in HDF5” we urge you to read that document closely.

When both the HDF5 Library and the application are built and installed with no specific compatibility flags, H5Pget_filter_by_id is mapped to the most recent version of the function, currently H5Pget_filter_by_id2. If the library and/or application is compiled for Release 1.6 emulation, H5Pget_filter_by_id will be mapped to H5Pget_filter_by_id1. Function-specific flags are available to override these settings on a function-by-function basis when the application is compiled.

Specific compile-time compatibility flags and the resulting mappings are as follows:

Compatibility setting H5Pget_filter_by_id mapping

Global settings
No compatibility flag H5Pget_filter_by_id2 
Enable deprecated symbols H5Pget_filter_by_id2 
Disable deprecated symbols H5Pget_filter_by_id2 
Emulate Release 1.6 interface H5Pget_filter_by_id1 

Function-level macros
H5Pget_filter_by_id_vers = 2     H5Pget_filter_by_id2
H5Pget_filter_by_id_vers = 1 H5Pget_filter_by_id1

Interface history:   Signature [1] above is the original H5Pget_filter_by_id interface and the only interface available prior to HDF5 Release 1.8.0. This signature and the corresponding function are now deprecated but will remain directly callable as H5Pget_filter_by_id1.

Signature [2] above was introduced with HDF5 Release 1.8.0 and is the recommended and default interface. It is directly callable as H5Pget_filter_by_id2.

See “API Compatibility Macros in HDF5” for circumstances under which either of these functions might not be available in an installed instance of the HDF5 Library.

Fortran90 Interface: h5pget_filter_by_id_f
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(SIZE_T), INTENT(INOUT)     :: cd_nelmts  
                                            ! Number of elements in cd_values
  INTEGER, DIMENSION(*), INTENT(OUT) :: cd_values  
                                            ! Auxiliary data for the filter
  INTEGER, INTENT(OUT)          :: flags    ! Bit vector specifying certain 
                                            ! general properties of the filter
  INTEGER(SIZE_T), INTENT(IN)   :: namelen  ! Anticipated number of characters 
                                            ! in name
  CHARACTER(LEN=*), INTENT(OUT) :: name     ! Name of the filter
  INTEGER, INTENT(OUT)          :: hdferr   ! Error code
                                            ! 0 on success and -1 on failure
END SUBROUTINE h5pget_filter_by_id_f
	

History:
Release     C
1.8.0 The function H5Pget_filter_by_id renamed to H5Pget_filter_by_id1 and deprecated in this release.
The macro H5Pget_filter_by_id and the function H5Pget_filter_by_id2 introduced in this release.

Name: H5Pget_filter_by_id1
Signature:
herr_t H5Pget_filter_by_id1( hid_t plist_id, H5Z_filter_t filter_id, unsigned int *flags, size_t *cd_nelmts, unsigned int cd_values[], size_t namelen, char name[] )

Purpose:
Returns information about the specified filter.

Notice:
This function is renamed from H5Pget_filter_by_id and deprecated in favor of the function H5Pget_filter_by_id2 or the new macro H5Pget_filter_by_id.

Description:
H5Pget_filter_by_id1 returns information about the filter specified in filter_id, a filter identifier.

plist_id must identify a dataset creation property list and filter_id will be in a permanent filter pipeline.

The filter_id and flags parameters are used in the same manner as described in the discussion of H5Pset_filter.

Aside from the fact that they are used for output, the parameters cd_nelmts and cd_values[] are used in the same manner as described in the discussion of H5Pset_filter. On input, the cd_nelmts parameter indicates the number of entries in the cd_values[] array allocated by the calling program; on exit it contains the number of values defined by the filter.

On input, the name_len parameter indicates the number of characters allocated for the filter name by the calling program in the array name[]. On exit it contains the length in characters of name of the filter. On exit name[] contains the name of the filter with one character of the name in each element of the array.

If the filter specified in filter_id is not set for the property list, an error will be returned and H5Pget_filter_by_id1 will fail.

Parameters:

Returns:
Returns a non-negative value if successful; otherwise returns a negative value.

Fortran90 Interface: h5pget_filter_by_id_f
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(SIZE_T), INTENT(INOUT)     :: cd_nelmts  
                                            ! Number of elements in cd_values
  INTEGER, DIMENSION(*), INTENT(OUT) :: cd_values  
                                            ! Auxiliary data for the filter
  INTEGER, INTENT(OUT)          :: flags    ! Bit vector specifying certain 
                                            ! general properties of the filter
  INTEGER(SIZE_T), INTENT(IN)   :: namelen  ! Anticipated number of characters 
                                            ! in name
  CHARACTER(LEN=*), INTENT(OUT) :: name     ! Name of the filter
  INTEGER, INTENT(OUT)          :: hdferr   ! Error code
                                            ! 0 on success and -1 on failure
END SUBROUTINE h5pget_filter_by_id_f
	

History:

Name: H5Pget_filter_by_id2
Signature:
herr_t H5Pget_filter_by_id2( hid_t plist_id, H5Z_filter_t filter_id, unsigned int *flags, size_t *cd_nelmts, unsigned int cd_values[], size_t namelen, char name[], unsigned int *filter_config )

Purpose:
Returns information about the specified filter.

Description:
H5Pget_filter_by_id2 returns information about the filter specified in filter_id, a filter identifier.

plist_id must identify a dataset creation property list and filter_id will be in a permanent filter pipeline.

The filter_id and flags parameters are used in the same manner as described in the discussion of H5Pset_filter.

Aside from the fact that they are used for output, the parameters cd_nelmts and cd_values[] are used in the same manner as described in the discussion of H5Pset_filter. On input, the cd_nelmts parameter indicates the number of entries in the cd_values[] array allocated by the calling program; on exit it contains the number of values defined by the filter.

On input, the name_len parameter indicates the number of characters allocated for the filter name by the calling program in the array name[]. On exit it contains the length in characters of name of the filter. On exit name[] contains the name of the filter with one character of the name in each element of the array.

filter_config is the bit field described in H5Zget_filter_info.

If the filter specified in filter_id is not set for the property list, an error will be returned and H5Pget_filter_by_id2 will fail.

Parameters:

Returns:
Returns a non-negative value if successful; otherwise returns a negative value.

Fortran90 Interface:
None.

History:
Release     C
1.8.0 Function introduced in this release.

Name: H5Pget_gc_references
Signature:
herr_t H5Pget_gc_references(hid_t plist, unsigned *gc_ref )
Purpose:
Returns garbage collecting references setting.
Description:
H5Pget_gc_references returns the current setting for the garbage collection references property from the specified file access property list. The garbage collection references property is set by H5Pset_gc_references.
Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface: h5pget_gc_references_f
SUBROUTINE h5pget_gc_references_f (prp_id, gc_reference, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
  INTEGER, INTENT(OUT) :: gc_reference ! The flag for garbage collecting
                                       ! references for the file
  INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                       ! 0 on success and -1 on failure
END SUBROUTINE h5pget_gc_references_f
	

Name: H5Pget_hyper_vector_size
Signature:
herr_t H5Pget_hyper_vector_size(hid_t dxpl_id, size_t *vector_size )
Purpose:
Retrieves number of I/O vectors to be read/written in hyperslab I/O.
Description:
H5Pset_hyper_vector_size 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.

The number of I/O vectors set in the dataset transfer property list dxpl_id is returned in vector_size. Unless the default value is in use, vector_size was previously set with a call to H5Pset_hyper_vector_size.

Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface: h5pget_hyper_vector_size_f
SUBROUTINE h5pget_hyper_vector_size_f(plist_id, size, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: plist_id ! Dataset transfer property list 
                                         ! identifier
  INTEGER(SIZE_T), INTENT(OUT) :: size   ! Vector size 
  INTEGER, INTENT(OUT)       :: hdferr   ! Error code
                                         ! 0 on success and -1 on failure
END SUBROUTINE h5pget_hyper_vector_size_f
	
History:

Name: H5Pget_istore_k
Signature:
herr_t H5Pget_istore_k(hid_t plist, unsigned * ik )
Purpose:
Queries the 1/2 rank of an indexed storage B-tree.
Description:
H5Pget_istore_k queries the 1/2 rank of an indexed storage B-tree. The argument ik may be the null pointer (NULL). This function is only valid for file creation property lists.

See H5Pset_istore_k for details.

Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface: h5pget_istore_k_f
SUBROUTINE h5pget_istore_k_f(prp_id, ik, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
  INTEGER, INTENT(OUT) :: ik           ! 1/2 rank of chunked storage B-tree
  INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                       ! 0 on success and -1 on failure
END SUBROUTINE h5pget_istore_k_f
	
History:

Name: H5Pget_layout
Signature:
H5D_layout_t H5Pget_layout(hid_t plist)
Purpose:
Returns the layout of the raw data for a dataset.
Description:
H5Pget_layout returns the layout of the raw data for a dataset. This function is only valid for dataset creation property lists.

Note that a compact storage layout may affect writing data to the dataset with parallel applications. See note in H5Dwrite documentation for details.

Parameters:
Returns:
Returns the layout type (a non-negative value) of a dataset creation property list if successful. Valid return values are:

Otherwise, returns a negative value indicating failure.

Fortran90 Interface: h5pget_layout_f
SUBROUTINE h5pget_layout_f (prp_id, layout, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
  INTEGER, INTENT(OUT) :: layout       ! Type of storage layout for raw data
                                       ! possible values are:
                                       !    H5D_COMPACT_F
                                       !    H5D_CONTIGUOUS_F
                                       !    H5D_CHUNKED_F
  INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                       ! 0 on success and -1 on failure
END SUBROUTINE h5pget_layout_f 
	

Name: H5Pget_libver_bounds
Signature:
herr_t H5Pget_libver_bounds( hid_t fapl_id, H5_libver_t *low, H5_libver_t *high )

Purpose:
Retrieves library version bounds settings that indirectly control the format versions used when creating objects.

Description:
H5Pget_libver_bounds retrieves the lower and upper bounds on the HDF5 Library versions that indirectly determine the object formats versions used when creating objects in the file.

This property is retrieved from the file access property list specified by fapl_id.

Parameters:
hid_t fapl_id IN: File access property list identifier
H5_libver_t *low     IN: The earliest version of the library that will be used for writing objects. The library version indirectly specifies the earliest object format version that can be used when creating objects in the file.

Currently, HDF_LIBVER_EARLIEST and HDF_LIBVER_LATEST are the only valid values for low.

H5_libver_t *high     IN: The latest version of the library that will be used for writing objects. The library version indirectly specifies the latest object format version that can be used when creating objects in the file.

Currently, HDF_LIBVER_LATEST is the only valid value for high.

Returns:
Returns a non-negative value if successful; otherwise returns a negative value.

Fortran90 Interface:
None.

History:
Release     C
1.8.0 Function introduced in this release.

Name: H5Pget_link_creation_order
Signature:
herr_t H5Pget_link_creation_order( hid_t gcpl_id, unsigned *crt_order_flags )

Purpose:
Queries whether link creation order is tracked and/or indexed in a group.

Description:
H5Pget_link_creation_order queries the group creation property list, gcpl_id, and returns a flag indicating whether link creation order is tracked and/or indexed in a group.

See H5Pset_link_creation_order for a list of valid creation order flags, as passed in crt_order_flags, and their meanings.

Parameters:
hid_t gcpl_id IN: Group creation property list identifier
unsigned *crt_order_flags     OUT: Creation order flag(s)
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.

Fortran90 Interface:
None.

History:
Release     C
1.8.0 Function introduced in this release.

Name: H5Pget_link_phase_change
Signature:
herr_t H5Pget_link_phase_change( hid_t gcpl_id, unsigned *max_compact, unsigned *min_dense )

Purpose:
Queries the settings for conversion between compact and dense groups.

Description:
H5Pget_link_phase_change queries the maximum number of entries for a compact group and the minimum number links to require before converting a group to a dense form.

In the compact format, links are stored as messages in the group’s header. In the dense format, links are stored in a fractal heap and indexed with a version 2 B-tree.

max_compact is the maximum number of links to store as header messages in the group header before converting the group to the dense format. Groups that are in the compact format and exceed this number of links are automatically converted to the dense format.

min_dense is the minimum number of links to store in the dense format. Groups which are in dense format and in which the number of links falls below this number are automatically converted back to the compact format.

In the compact format, links are stored as messages in the group’s header. In the dense format, links are stored in a fractal heap and indexed with a version 2 B-tree.

See H5Pset_link_phase_change for a discussion of traditional, compact, and dense group storage.

Parameters:
hid_t gcpl_id IN: Group creation property list identifier
unsigned *max_compact     OUT: Maximum number of links for compact storage
unsigned *min_dense OUT: Minimum number of links for dense storage
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.

Fortran90 Interface:
None.

History:
Release     C
1.8.0 Function introduced in this release.

Name: H5Pget_local_heap_size_hint
Signature:
herr_t H5Pget_local_heap_size_hint( hid_t gcpl_id, size_t *size_hint )

Purpose:
Queries the local heap size hint for original-style groups.

Description:
H5Pget_local_heap_size_hint queries the group creation property list, gcpl_id, for the local heap size hint, size_hint, for original-style groups, i.e., for groups of the style used prior to HDF5 Release 1.8.0.

See H5Pset_local_heap_size_hint for further discussion.

Parameters:
hid_t gcpl_id IN: Group creation property list identifier
size_t *size_hint     OUT: Hint for size of local heap
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.

Fortran90 Interface:
None.

History:
Release     C
1.8.0 Function introduced in this release.

Name: H5Pget_mdc_config
Signature:
herr_t H5Pget_mdc_config(hid_t plist_id, H5AC_cache_config_t *config_ptr)
Purpose:
Get the current initial metadata cache configuration from the indicated File Access Property List.
Description:
H5Pget_mdc_config gets the initial metadata cache configuration contained in a file access property list and loads it into the instance of H5AC_cache_config_t pointed to by the config_ptr parameter. This configuration is used when the file is opened.

Note that the version field of *config_ptr must be initialized; this allows the library to support old versions of the H5AC_cache_config_t structure.

See the overview of the metadata cache in the special topics section of the user guide for details on the configuration data returned. If you haven't read and understood that documentation, the results of this call will not make much sense.

Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface:

Name: H5Pget_meta_block_size
Signature:
herr_t H5Pget_meta_block_size( hid_t fapl_id, hsize_t *size )
Purpose:
Returns the current metadata block size setting.
Description:
H5Pget_meta_block_size returns the current minimum size, in bytes, of new metadata block allocations. This setting is retrieved from the file access property list fapl_id.

This value is set by H5Pset_meta_block_size and is retrieved from the file access property list fapl_id.

Parameters:
Returns:
Returns a non-negative value if successful. Otherwise returns a negative value.
Fortran90 Interface: h5pget_meta_block_size_f
SUBROUTINE h5pget_meta_block_size_f(plist_id, size, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: plist_id ! File access property list 
                                         ! identifier
  INTEGER(HSIZE_T), INTENT(OUT) :: size  ! Metadata block size
  INTEGER, INTENT(OUT)       :: hdferr   ! Error code
                                         ! 0 on success and -1 on failure
END SUBROUTINE h5pget_meta_block_size_f
	
History:

Name: H5Pget_multi_type
Signature:
herr_t H5Pget_multi_type ( hid_t fapl_id, H5FD_mem_t *type )
Purpose:
Retrieves type of data property for MULTI driver.
Description:
H5Pget_multi_type retrieves the type of data setting from the file access or data transfer property list fapl_id. This enables a user application to specify 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 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 returned in type will be one of those listed in the discussion of the type parameter in the the description of the function H5Pset_multi_type.

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

Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface:
None.
History:

Name: H5Pget_nfilters
Signature:
int H5Pget_nfilters(hid_t plist)
Purpose:
Returns the number of filters in the pipeline.
Description:
H5Pget_nfilters returns the number of filters defined in the filter pipeline associated with the property list plist.

In each pipeline, the filters are numbered from 0 through N-1, where N is the value returned by this function. During output to the file, the filters are applied in increasing order; during input from the file, they are applied in decreasing order.

H5Pget_nfilters returns the number of filters in the pipeline, including zero (0) if there are none.

Note:
This function currently supports only the permanent filter pipeline; plist_id must be a dataset creation property list.
Parameters:
Returns:
Returns the number of filters in the pipeline if successful; otherwise returns a negative value.
Fortran90 Interface: h5pget_nfilters_f
SUBROUTINE h5pget_nfilters_f(prp_id, nfilters, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id   ! Dataset creation property 
                                         ! list identifier 
  INTEGER, INTENT(OUT) :: nfilters       ! The number of filters in 
                                         ! the pipeline
  INTEGER, INTENT(OUT)       :: hdferr   ! Error code
                                         ! 0 on success and -1 on failure
END SUBROUTINE h5pget_nfilters_f
	

Name: H5Pget_nlinks
Signature:
herr_t H5Pget_nlinks( hid_t lapl_id, size_t *nlinks )

Purpose:
Sets the maximum number of link traversals.

Description:
H5Pget_nlinks retrieves the maximum number of soft or user-defined link traversals allowed, nlinks, before the library assumes it has found a cycle and aborts the traversal. This value is retrieved from the link access property list lapl_id.

The limit on the number soft or user-defined link traversals is designed to terminate link traversal if one or more links form a cycle. User control is provided because some files may have legitimate paths formed of large numbers of soft or user-defined links. This property can be used to allow traversal of as many links as desired.

Parameters:
hid_t fapl_id IN: File access property list identifier
size_t *nlinks     OUT: Maximum number of links to traverse

Returns:
Returns a non-negative value if successful; otherwise returns a negative value.

Fortran90 Interface:
None.

History:
Release     C
1.8.0 Function introduced in this release.

Name: H5Pget_nprops
Signature:
int H5Pget_nprops( hid_t id, size_t *nprops )
Purpose:
Queries number of properties in property list or class.
Description:
H5Pget_nprops retrieves the number of properties in a property list or class. If a property class identifier is given, the number of registered properties in the class is returned in nprops. If a property list identifier is given, the current number of properties in the list is returned in nprops.
Parameters:
Returns:
Success: a non-negative value
Failure: a negative value
Fortran90 Interface: h5pget_nprops_f
SUBROUTINE h5pget_nprops_f(prp_id, nprops, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id    ! Property list identifier 
  INTEGER(SIZE_T), INTENT(OUT) :: nprops  ! Number of properties
  INTEGER, INTENT(OUT) :: hdferr          ! Error code
                                          ! 0 on success and -1 on failure
END SUBROUTINE h5pget_nprops_f
	

Name: H5Pget_preserve
Signature:
int H5Pget_preserve(hid_t plist)
Purpose:
Checks status of the dataset transfer property list.
Description:
H5Pget_preserve checks the status of the dataset transfer property list.
Parameters:
Returns:
Returns TRUE or FALSE if successful; otherwise returns a negative value.
Fortran90 Interface: h5pget_preserve_f
SUBROUTINE h5pget_preserve_f(prp_id, flag, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id   ! Dataset transfer property 
                                         ! list identifier 
  LOGICAL, INTENT(OUT)       :: flag     ! Status of for the dataset 
                                         ! transfer property list 
  INTEGER, INTENT(OUT)       :: hdferr   ! Error code
                                         ! 0 on success and -1 on failure
END SUBROUTINE h5pget_preserve_f
	
History:

Name: H5Pget_shared_mesg_index
Signature:
herr_t H5Pget_shared_mesg_index( hid_t fcpl_id, unsigned index_num, unsigned *mesg_type_flags, unsigned *min_mesg_size )

Purpose:
Retrieves the configuration settings for a shared message index.

Description:
H5Pget_shared_mesg_index retrieves the message type and minimum message size settings from the file creation property list fcpl_id for the shared object header message index specified by index_num.

index_num specifies the index. index_num is zero-indexed, so in a file with three indexes, they will be numbered 0, 1, and 2.

mesg_type_flags and min_mesg_size will contain, respectively, the types of messages and the minimum size, in bytes, of messages that can be stored in this index.

Valid message types are described in H5Pset_shared_mesg_index.

Parameters:
hid_t fcpl_id IN: File creation property list identifier.
unsigned index_num IN: Index being configured.
unsigned *mesg_type_flags     OUT: Types of messages that may be stored in this index.
unsigned *min_mesg_size OUT: Minimum message size.

Returns:
Returns a non-negative value if successful; otherwise returns a negative value.

Fortran90 Interface:
None.

History:
Release     C
1.8.0 Function introduced in this release.

Name: H5Pget_shared_mesg_nindexes
Signature:
herr_t H5Pget_shared_mesg_nindexes( hid_t fcpl_id, unsigned *nindexes )

Purpose:
Retrieves number of shared object header message indexes in file creation property list.

Description:
H5Pget_shared_mesg_nindexes retrieves the number of shared object header message indexes in the specified file creation property list fcpl_id.

If the value of nindexes is 0 (zero), shared object header messages are disabled in files created with this property list.

Parameters:
hid_t fcpl_id IN: File creation property list
unsigned *nindexes     OUT: Number of shared object header message indexes available in files created with this property list

Returns:
Returns a non-negative value if successful; otherwise returns a negative value.

Fortran90 Interface:
None.

History:
Release     C
1.8.0 Function introduced in this release.

Name: H5Pget_shared_mesg_phase_change
Signature:
herr_t H5Pget_shared_mesg_phase_change( hid_t fcpl_id, unsigned *max_list, unsigned *min_btree )

Purpose:
Retrieves shared object header message phase change information.

Description:
H5Pget_shared_mesg_phase_change retrieves the threshold values for storage of shared object header message indexes in a file. These phase change thresholds determine the point at which the index storage mechanism changes from a more compact list format to a more performance-oriented B-tree format, and vice-versa.

By default, a shared object header message index is initially stored as a compact list. When the number of messages in an index exceeds the specified max_list threshold, storage switches to a B-tree format for impoved performance. If the number of messages subsequently falls below the min_btree threshold, the index will revert to the list format.

If max_compact is set to 0 (zero), shared object header message indexes in the file will always be stored as B-trees.

fcpl_id specifies the file creation property list.

Parameters:
hid_t fcpl_id IN: File creation property list identifier
unsigned *max_compact OUT: Threshold above which storage of a shared object header message index shifts from list to B-tree
unsigned *min_btree     OUT: Threshold below which storage of a shared object header message index reverts to list format

Returns:
Returns a non-negative value if successful; otherwise returns a negative value.

Fortran90 Interface:
None.

History:
Release     C
1.8.0 Function introduced in this release.

Name: H5Pget_sieve_buf_size
Signature:
herr_t H5Pget_sieve_buf_size( hid_t fapl_id, hsize_t *size )
Purpose:
Returns maximum data sieve buffer size.
Description:
H5Pget_sieve_buf_size retrieves, size, the current maximum size of the data sieve buffer.

This value is set by H5Pset_sieve_buf_size and is retrieved from the file access property list fapl_id.

Parameters:
Returns:
Returns a non-negative value if successful. Otherwise returns a negative value.
Fortran90 Interface: h5pget_sieve_buf_size_f
SUBROUTINE h5pget_sieve_buf_size_f(plist_id, size, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: plist_id ! File access property list 
                                         ! identifier
  INTEGER(SIZE_T), INTENT(OUT) :: size   ! Sieve buffer size 
  INTEGER, INTENT(OUT)       :: hdferr   ! Error code
                                         ! 0 on success and -1 on failure
END SUBROUTINE h5pget_sieve_buf_size_f
	
History:

Name: H5Pget_size
Signature:
int H5Pget_size( hid_t id, const char *name, size_t *size )
Purpose:
Queries the size of a property value in bytes.
Description:
H5Pget_size retrieves the size of a property's value in bytes. This function operates on both property lists and property classes

Zero-sized properties are allowed and return 0.

Parameters:
Returns:
Success: a non-negative value
Failure: a negative value
Fortran90 Interface: h5pget_size_f
SUBROUTINE h5pget_size_f(prp_id, name, size, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier 
  CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to query
  INTEGER(SIZE_T), INTENT(OUT) :: size  ! Size in bytes
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                        ! 0 on success and -1 on failure
END SUBROUTINE h5pget_size_f
	

Name: H5Pget_sizes
Signature:
herr_t H5Pget_sizes(hid_t plist, size_t * sizeof_addr, size_t * sizeof_size )
Purpose:
Retrieves the size of the offsets and lengths used in an HDF5 file.
Description:
H5Pget_sizes retrieves the size of the offsets and lengths used in an HDF5 file. This function is only valid for file creation property lists.
Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface: h5pget_sizes_f
SUBROUTINE h5pget_sizes_f(prp_id, sizeof_addr, sizeof_size, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier
  INTEGER(SIZE_T), DIMENSION(:), INTENT(OUT) :: sizeof_addr
                                        ! Size of an object address in bytes
  INTEGER(SIZE_T), DIMENSION(:), INTENT(OUT) :: sizeof_size 
                                        ! Size of an object in bytes
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                        ! 0 on success and -1 on failure
END SUBROUTINE h5pget_sizes_f
	

Name: H5Pget_small_data_block_size
Signature:
herr_t H5Pget_small_data_block_size(hid_t fapl_id, hsize_t *size )
Purpose:
Retrieves the current small data block size setting.
Description:
H5Pget_small_data_block_size retrieves the current setting for the size of the small data block.

If the returned value is zero (0), the small data block mechanism has been disabled for the file.

Parameters:
Returns:
Returns a non-negative value if successful; otherwise a negative value.
Fortran90 Interface: h5pget_small_data_block_size_f
SUBROUTINE h5pget_small_data_block_size_f(plist_id, size, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: plist_id  ! File access property list 
                                          ! identifier
  INTEGER(HSIZE_T), INTENT(OUT) :: size   ! Small raw data block size
  INTEGER, INTENT(OUT)       :: hdferr    ! Error code
                                          ! 0 on success and -1 on failure
END SUBROUTINE h5pget_small_data_block_size_f
	
History:

Name: H5Pget_sym_k
Signature:
herr_t H5Pget_sym_k(hid_t plist, unsigned * ik, unsigned * lk )
Purpose:
Retrieves the size of the symbol table B-tree 1/2 rank and the symbol table leaf node 1/2 size.
Description:
H5Pget_sym_k retrieves the size of the symbol table B-tree 1/2 rank and the symbol table leaf node 1/2 size. This function is only valid for file creation property lists. If a parameter valued is set to NULL, that parameter is not retrieved. See the description for H5Pset_sym_k for more information.
Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface: h5pget_sym_k_f
SUBROUTINE h5pget_sym_k_f(prp_id, ik, lk, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier
  INTEGER, INTENT(OUT) :: ik            ! Symbol table tree rank
  INTEGER, INTENT(OUT) :: lk            ! Symbol table node size
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                        ! 0 on success and -1 on failure
END SUBROUTINE h5pget_sym_k_f
	
History:

Name: H5Pget_type_conv_cb
Signature:
herr_t H5Pget_type_conv_cb(hid_t plist, H5T_conv_except_func_t *func, void **op_data)
Purpose:
Gets user-defined data type conversion callback function.
Description:
H5Pget_type_conv_cb gets the user-defined data type conversion callback function func in the dataset transfer property list plist.

The parameter op_data is a pointer to user-defined input data for the callback function.

The callback function func defines the actions an application is to take when there is an exception during data type conversion.

Please refer to the function H5Pset_type_conv_cb for more details.

Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface:
None.

Name: H5Pget_userblock
Signature:
herr_t H5Pget_userblock(hid_t plist, hsize_t * size )
Purpose:
Retrieves the size of a user block.
Description:
H5Pget_userblock retrieves the size of a user block in a file creation property list.
Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface: h5pget_userblock_f
SUBROUTINE h5pget_userblock_f(prp_id, block_size, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id   ! Property list identifier
  INTEGER(HSIZE_T), DIMENSION(:), INTENT(OUT) ::  block_size 
                                         ! Size of the user-block in bytes
  INTEGER, INTENT(OUT) :: hdferr         ! Error code
                                         ! 0 on success and -1 on failure
END SUBROUTINE h5pget_userblock_f
	

Name: H5Pget_version
Signature:
herr_t H5Pget_version(hid_t plist, unsigned * super, unsigned * freelist, unsigned * stab, unsigned * shhdr )
Purpose:
Retrieves the version information of various objects for a file creation property list.
Description:
H5Pget_version retrieves the version information of various objects for a file creation property list. Any pointer parameters which are passed as NULL are not queried.
Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface: h5pget_version_f
SUBROUTINE h5pget_version_f(prp_id, boot, freelist, & 
                            stab, shhdr, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id         ! Property list identifier
  INTEGER, DIMENSION(:), INTENT(OUT) :: boot   ! Array to put boot block 
                                               ! version number
  INTEGER, DIMENSION(:), INTENT(OUT) :: freelist  
                                               ! Array to put global
                                               ! freelist version number
  INTEGER, DIMENSION(:), INTENT(OUT) :: stab   ! Array to put symbol table
                                               ! version number
  INTEGER, DIMENSION(:), INTENT(OUT) :: shhdr  ! Array to put shared object 
                                               ! header version number
  INTEGER, INTENT(OUT) :: hdferr               ! Error code
                                               ! 0 on success and -1 on failure
END SUBROUTINE h5pget_version_f
	
History:

Name: H5Pget_vlen_mem_manager
Signature:
herr_t H5Pget_vlen_mem_manager(hid_t plist, H5MM_allocate_t *alloc, void **alloc_info, H5MM_free_t *free, void **free_info )
Purpose:
Gets the memory manager for variable-length datatype allocation in H5Dread and H5Dvlen_reclaim.
Description:
H5Pget_vlen_mem_manager is the companion function to H5Pset_vlen_mem_manager, returning the parameters set by that function.
Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface:
None.

Name: H5Pinsert
Signatures:
herr_t H5Pinsert( hid_t plid, const char *name, size_t size, void *value, H5P_prp_set_func_t set, H5P_prp_get_func_t get, H5P_prp_delete_func_t delete, H5P_prp_copy_func_t copy, H5P_prp_close_func_t close )
 
[1]
herr_t H5Pinsert( hid_t plid, const char *name, size_t size, void *value, H5P_prp_set_func_t set, H5P_prp_get_func_t get, H5P_prp_delete_func_t delete, H5P_prp_copy_func_t copy, H5P_prp_compare_func_t compare, H5P_prp_close_func_t close ) [2]

Purpose:
Registers a temporary property with a property list.

Description:
H5Pinsert is a macro that is mapped to either H5Pinsert1 or H5Pinsert2, depending on the needs of the application.

Such macros are provided to facilitate application compatibility. For example:

Macro use and mappings are fully described in “API Compatibility Macros in HDF5” we urge you to read that document closely.

When both the HDF5 Library and the application are built and installed with no specific compatibility flags, H5Pinsert is mapped to the most recent version of the function, currently H5Pinsert2. If the library and/or application is compiled for Release 1.6 emulation, H5Pinsert will be mapped to H5Pinsert1. Function-specific flags are available to override these settings on a function-by-function basis when the application is compiled.

Specific compile-time compatibility flags and the resulting mappings are as follows:

Compatibility setting H5Pinsert mapping

Global settings
No compatibility flag H5Pinsert2 
Enable deprecated symbols H5Pinsert2 
Disable deprecated symbols H5Pinsert2 
Emulate Release 1.6 interface H5Pinsert1 

Function-level macros
H5Pinsert_vers = 2     H5Pinsert2
H5Pinsert_vers = 1 H5Pinsert1

Interface history:   Signature [1] above is the original H5Pinsert interface and the only interface available prior to HDF5 Release 1.8.0. This signature and the corresponding function are now deprecated but will remain directly callable as H5Pinsert1.

Signature [2] above was introduced with HDF5 Release 1.8.0 and is the recommended and default interface. It is directly callable as H5Pinsert2.

See “API Compatibility Macros in HDF5” for circumstances under which either of these functions might not be available in an installed instance of the HDF5 Library.

Fortran90 Interface: h5pinsert_f
SUBROUTINE h5pinsert_f
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: plist   ! Property list class identifier 
  CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to insert
  INTEGER(SIZE_T), INTENT(IN) :: size   ! Size of the property value	
  TYPE,   INTENT(IN) :: value           ! Property value
                                        ! Supported types are:
                                        !    INTEGER
                                        !    REAL
                                        !    DOUBLE PRECISION
                                        !    CHARACTER(LEN=*)
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                        ! 0 on success and -1 on failure
END SUBROUTINE h5pinsert_f
	

History:
Release     C
1.8.0 The function H5Pinsert renamed to H5Pinsert1 and deprecated in this release.
The macro H5Pinsert and the function H5Pinsert2 introduced in this release.

Name: H5Pinsert1
Signature:
herr_t H5Pinsert1( hid_t plid, const char *name, size_t size, void *value, H5P_prp_set_func_t set, H5P_prp_get_func_t get, H5P_prp_delete_func_t delete, H5P_prp_copy_func_t copy, H5P_prp_close_func_t close )

Purpose:
Registers a temporary property with a property list.

Notice:
This function is renamed from H5Pinsert and deprecated in favor of the function H5Pinsert2 or the new macro H5Pinsert.

Description:
H5Pinsert1 create a new property in a property list. The property will exist only in this property list and copies made from it.

The initial property value must be provided in value and the property value will be set accordingly.

The name of the property must not already exist in this list, or this routine will fail.

The set and get callback routines may be set to NULL if they are not needed.

Zero-sized properties are allowed and do not store any data in the property list. The default value of a zero-size property may be set to NULL. They may be used to indicate the presence or absence of a particular piece of information.

The set routine is called before a new value is copied into the property. The H5P_prp_set_func_t callback function is defined as follows: The parameters to the callback function are defined as follows: The set routine may modify the value pointer to be set and those changes will be used when setting the property's value. If the set routine returns a negative value, the new property value is not copied into the property and the set routine returns an error value. The set routine will be called for the initial value.

Note: The set callback function may be useful to range check the value being set for the property or may perform some transformation or translation of the value set. The get callback would then reverse the transformation or translation. A single get or set callback could handle multiple properties by performing different actions based on the property name or other properties in the property list.

The get routine is called when a value is retrieved from a property value. The H5P_prp_get_func_t callback function is defined as follows:

The parameters to the above callback function are:

The get routine may modify the value to be returned from the query and those changes will be preserved. If the get routine returns a negative value, the query routine returns an error value.

The delete routine is called when a property is being deleted from a property list. The H5P_prp_delete_func_t callback function is defined as follows:

The parameters to the above callback function are:

The delete routine may modify the value passed in, but the value is not used by the library when the delete routine returns. If the delete routine returns a negative value, the property list delete routine returns an error value but the property is still deleted.

The copy routine is called when a new property list with this property is being created through a copy operation. The H5P_prp_copy_func_t callback function is defined as follows:

The parameters to the above callback function are:

The copy routine may modify the value to be set and those changes will be stored as the new value of the property. If the copy routine returns a negative value, the new property value is not copied into the property and the copy routine returns an error value.

The close routine is called when a property list with this property is being closed. The H5P_prp_close_func_t callback function is defined as follows:

The parameters to the callback function are defined as follows: The close routine may modify the value passed in, the value is not used by the library when the close routine returns. If the close routine returns a negative value, the property list close routine returns an error value but the property list is still closed.

Note: There is no create callback routine for temporary property list objects; the initial value is assumed to have any necessary setup already performed on it.

Parameters:

Returns:
Success: a non-negative value
Failure: a negative value

Fortran90 Interface: h5pinsert_f
SUBROUTINE h5pinsert_f
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: plist   ! Property list class identifier 
  CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to insert
  INTEGER(SIZE_T), INTENT(IN) :: size   ! Size of the property value	
  TYPE,   INTENT(IN) :: value           ! Property value
                                        ! Supported types are:
                                        !    INTEGER
                                        !    REAL
                                        !    DOUBLE PRECISION
                                        !    CHARACTER(LEN=*)
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                        ! 0 on success and -1 on failure
END SUBROUTINE h5pinsert_f
	

History:

Name: H5Pinsert2
Signature:
herr_t H5Pinsert2( hid_t plid, const char *name, size_t size, void *value, H5P_prp_set_func_t set, H5P_prp_get_func_t get, H5P_prp_delete_func_t delete, H5P_prp_copy_func_t copy, H5P_prp_compare_func_t compare, H5P_prp_close_func_t close )

Purpose:
Registers a temporary property with a property list.

Description:
H5Pinsert2 create a new property in a property list. The property will exist only in this property list and copies made from it.

The initial property value must be provided in value and the property value will be set accordingly.

The name of the property must not already exist in this list, or this routine will fail.

The set and get callback routines may be set to NULL if they are not needed.

Zero-sized properties are allowed and do not store any data in the property list. The default value of a zero-size property may be set to NULL. They may be used to indicate the presence or absence of a particular piece of information.

The set routine is called before a new value is copied into the property. The H5P_prp_set_func_t callback function is defined as follows: The parameters to the callback function are defined as follows: The set routine may modify the value pointer to be set and those changes will be used when setting the property's value. If the set routine returns a negative value, the new property value is not copied into the property and the set routine returns an error value. The set routine will be called for the initial value.

Note: The set callback function may be useful to range check the value being set for the property or may perform some transformation or translation of the value set. The get callback would then reverse the transformation or translation. A single get or set callback could handle multiple properties by performing different actions based on the property name or other properties in the property list.

The get routine is called when a value is retrieved from a property value. The H5P_prp_get_func_t callback function is defined as follows:

The parameters to the above callback function are:

The get routine may modify the value to be returned from the query and those changes will be preserved. If the get routine returns a negative value, the query routine returns an error value.

The delete routine is called when a property is being deleted from a property list. The H5P_prp_delete_func_t callback function is defined as follows:

The parameters to the above callback function are:

The delete routine may modify the value passed in, but the value is not used by the library when the delete routine returns. If the delete routine returns a negative value, the property list delete routine returns an error value but the property is still deleted.

The copy routine is called when a new property list with this property is being created through a copy operation. The H5P_prp_copy_func_t callback function is defined as follows:

The parameters to the above callback function are:

The copy routine may modify the value to be set and those changes will be stored as the new value of the property. If the copy routine returns a negative value, the new property value is not copied into the property and the copy routine returns an error value.

The compare routine is called when a property list with this property is compared to another property list with the same property. The H5P_prp_compare_func_t callback function is defined as follows:

The parameters to the callback function are defined as follows: The compare routine may not modify the values. The compare routine should return a positive value if value1 is greater than value2, a negative value if value2 is greater than value1 and zero if value1 and value2 are equal.

The close routine is called when a property list with this property is being closed. The H5P_prp_close_func_t callback function is defined as follows:

The parameters to the callback function are defined as follows: The close routine may modify the value passed in, the value is not used by the library when the close routine returns. If the close routine returns a negative value, the property list close routine returns an error value but the property list is still closed.

Note: There is no create callback routine for temporary property list objects; the initial value is assumed to have any necessary setup already performed on it.

Parameters:

Returns:
Success: a non-negative value
Failure: a negative value

Fortran90 Interface:
None.

History:
Release     C
1.8.0 Function introduced in this release.

Name: H5Pisa_class
Signature:
htri_t H5Pisa_class( hid_t plist, hid_t pclass )
Purpose:
Determines whether a property list is a member of a class.
Description:
H5Pisa_class checks to determine whether a property list is a member of the specified class.
Parameters:
Returns:
Success: TRUE (positive) if equal; FALSE (zero) if unequal
Failure: a negative value
Fortran90 Interface: h5pisa_class_f
SUBROUTINE h5pisa_class_f(plist, pclass, flag, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: plist     ! Property list identifier 
  INTEGER(HID_T), INTENT(IN) :: pclass    ! Class identifier
  LOGICAL, INTENT(OUT) :: flag            ! Logical flag
                                          !    .TRUE. if a member
                                          !    .FALSE. otherwise
  INTEGER, INTENT(OUT) :: hdferr          ! Error code
                                          ! 0 on success and -1 on failure
END SUBROUTINE h5pisa_class_f
	

Name: H5Piterate
Purpose:
Iterates over properties in a property class or list.
Signature:
int H5Piterate( hid_t id, int * idx, H5P_iterate_t iter_func, void * iter_data )
Description:

H5Piterate iterates over the properties in the property object specified in id, which may be either a property list or a property class, performing a specified operation on each property in turn.

For each property in the object, iter_func and the additional information specified below are passed to the H5P_iterate_t operator function.

The iteration begins with the idx-th property in the object; the next element to be processed by the operator is returned in idx. If idx is NULL, the iterator starts at the first property; since no stopping point is returned in this case, the iterator cannot be restarted if one of the calls to its operator returns non-zero.

The prototype for the H5P_iterate_t operator is as follows: The operation receives the property list or class identifier for the object being iterated over, id, the name of the current property within the object, name, and the pointer to the operator data passed in to H5Piterate, iter_data.

The valid return values from an operator are as follows:

H5Piterate assumes that the properties in the object identified by id remain unchanged through the iteration. If the membership changes during the iteration, the function's behavior is undefined.

Parameters:
Returns:
Success: the return value of the last call to iter_func if it was non-zero; zero if all properties have been processed
Failure: a negative value
Fortran90 Interface:
None.

Name: H5Pmodify_filter
Signature:
herr_t H5Pmodify_filter(hid_t plist, H5Z_filter_t filter_id, unsigned int flags, size_t cd_nelmts, const unsigned int cd_values[] )
Purpose:
Modifies a filter in the filter pipeline.
Description:
H5Pmodify_filter modifies the specified filter_id in the filter pipeline. plist must be a dataset creation property list and the modified filter will be in a permanent filter pipeline.

The filter_id, flags cd_nelmts[], and cd_values parameters are used in the same manner and accept the same values as described in the discussion of H5Pset_filter.

Note:
This function currently supports only the permanent filter pipeline; plist_id must be a dataset creation property list.
Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface: h5pmodify_filter_f
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
  INTEGER, INTENT(IN)        :: filter      ! Filter to be modified
  INTEGER, INTENT(IN)        :: flags       ! Bit vector specifying certain 
                                            ! general properties of the filter
  INTEGER(SIZE_T), INTENT(IN) :: cd_nelmts  ! Number of elements in cd_values
  INTEGER, DIMENSION(*), INTENT(IN) :: cd_values  
                                            ! Auxiliary data for the filter
  INTEGER, INTENT(OUT)       :: hdferr      ! Error code
                                            ! 0 on success and -1 on failure
END SUBROUTINE h5pmodify_filter_f
	
History:

Name: H5Pregister
Signatures:
herr_t H5Pregister( hid_t class, const char * name, size_t size, void * default, H5P_prp_create_func_t create, H5P_prp_set_func_t set, H5P_prp_get_func_t get, H5P_prp_delete_func_t delete, H5P_prp_copy_func_t copy, H5P_prp_close_func_t close )
 
[1]
herr_t H5Pregister( hid_t class, const char * name, size_t size, void * default, H5P_prp_create_func_t create, H5P_prp_set_func_t set, H5P_prp_get_func_t get, H5P_prp_delete_func_t delete, H5P_prp_copy_func_t copy, H5P_prp_compare_func_t compare, H5P_prp_close_func_t close ) [2]

Purpose:
Returns information about the specified filter.

Description:
H5Pregister is a macro that is mapped to either H5Pregister1 or H5Pregister2, depending on the needs of the application.

Such macros are provided to facilitate application compatibility. For example:

Macro use and mappings are fully described in “API Compatibility Macros in HDF5” we urge you to read that document closely.

When both the HDF5 Library and the application are built and installed with no specific compatibility flags, H5Pregister is mapped to the most recent version of the function, currently H5Pregister2. If the library and/or application is compiled for Release 1.6 emulation, H5Pregister will be mapped to H5Pregister1. Function-specific flags are available to override these settings on a function-by-function basis when the application is compiled.

Specific compile-time compatibility flags and the resulting mappings are as follows:

Compatibility setting H5Pregister mapping

Global settings
No compatibility flag H5Pregister2 
Enable deprecated symbols H5Pregister2 
Disable deprecated symbols H5Pregister2 
Emulate Release 1.6 interface H5Pregister1 

Function-level macros
H5Pregister_vers = 2     H5Pregister2
H5Pregister_vers = 1 H5Pregister1

Interface history:   Signature [1] above is the original H5Pregister interface and the only interface available prior to HDF5 Release 1.8.0. This signature and the corresponding function are now deprecated but will remain directly callable as H5Pregister1.

Signature [2] above was introduced with HDF5 Release 1.8.0 and is the recommended and default interface. It is directly callable as H5Pregister2.

See “API Compatibility Macros in HDF5” for circumstances under which either of these functions might not be available in an installed instance of the HDF5 Library.

Fortran90 Interface: h5pregister_f
SUBROUTINE h5pregister_f
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: class   ! Property list class identifier 
  CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to register
  INTEGER(SIZE_T), INTENT(IN) :: size   ! Size of the property value	
  TYPE,   INTENT(IN) :: value           ! Property value
                                        ! Supported types are:
                                        !    INTEGER
                                        !    REAL
                                        !    DOUBLE PRECISION
                                        !    CHARACTER(LEN=*)
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                        ! 0 on success and -1 on failure
END SUBROUTINE h5pregister_f
	

History:
Release     C
1.8.0 The function H5Pregister renamed to H5Pregister1 and deprecated in this release.
The macro H5Pregister and the function H5Pregister2 introduced in this release.

Name: H5Pregister1
Signature:
herr_t H5Pregister1( hid_t class, const char * name, size_t size, void * default, H5P_prp_create_func_t create, H5P_prp_set_func_t set, H5P_prp_get_func_t get, H5P_prp_delete_func_t delete, H5P_prp_copy_func_t copy, H5P_prp_close_func_t close )

Purpose:
Registers a permanent property with a property list class.

Notice:
This function is renamed from H5Pregister and deprecated in favor of the function H5Pregister2 and or the new macro H5Pregister.

Description:
H5Pregister1 registers a new property with a property list class. The property will exist in all property list objects of class created after this routine finishes. The name of the property must not already exist, or this routine will fail. The default property value must be provided and all new property lists created with this property will have the property value set to the default value. Any of the callback routines may be set to NULL if they are not needed.

Zero-sized properties are allowed and do not store any data in the property list. These may be used as flags to indicate the presence or absence of a particular piece of information. The default pointer for a zero-sized property may be set to NULL. The property create and close callbacks are called for zero-sized properties, but the set and get callbacks are never called.

The create routine is called when a new property list with this property is being created. The H5P_prp_create_func_t callback function is defined as follows:

The parameters to this callback function are defined as follows: The create routine may modify the value to be set and those changes will be stored as the initial value of the property. If the create routine returns a negative value, the new property value is not copied into the property and the create routine returns an error value.

The set routine is called before a new value is copied into the property. The H5P_prp_set_func_t callback function is defined as follows:

The parameters to this callback function are defined as follows: The set routine may modify the value pointer to be set and those changes will be used when setting the property's value. If the set routine returns a negative value, the new property value is not copied into the property and the set routine returns an error value. The set routine will not be called for the initial value, only the create routine will be called.

Note: The set callback function may be useful to range check the value being set for the property or may perform some transformation or translation of the value set. The get callback would then reverse the transformation or translation. A single get or set callback could handle multiple properties by performing different actions based on the property name or other properties in the property list.

The get routine is called when a value is retrieved from a property value. The H5P_prp_get_func_t callback function is defined as follows:

The parameters to the callback function are defined as follows: The get routine may modify the value to be returned from the query and those changes will be returned to the calling routine. If the set routine returns a negative value, the query routine returns an error value.

The delete routine is called when a property is being deleted from a property list. The H5P_prp_delete_func_t callback function is defined as follows:

The parameters to the callback function are defined as follows: The delete routine may modify the value passed in, but the value is not used by the library when the delete routine returns. If the delete routine returns a negative value, the property list delete routine returns an error value but the property is still deleted.

The copy routine is called when a new property list with this property is being created through a copy operation. The H5P_prp_copy_func_t callback function is defined as follows:

The parameters to the callback function are defined as follows: The copy routine may modify the value to be set and those changes will be stored as the new value of the property. If the copy routine returns a negative value, the new property value is not copied into the property and the copy routine returns an error value.

The close routine is called when a property list with this property is being closed. The H5P_prp_close_func_t callback function is defined as follows:

The parameters to the callback function are defined as follows: The close routine may modify the value passed in, but the value is not used by the library when the close routine returns. If the close routine returns a negative value, the property list close routine returns an error value but the property list is still closed.

Parameters:

Returns:
Success: a non-negative value
Failure: a negative value

Fortran90 Interface: h5pregister_f
SUBROUTINE h5pregister_f
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: class   ! Property list class identifier 
  CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to register
  INTEGER(SIZE_T), INTENT(IN) :: size   ! Size of the property value	
  TYPE,   INTENT(IN) :: value           ! Property value
                                        ! Supported types are:
                                        !    INTEGER
                                        !    REAL
                                        !    DOUBLE PRECISION
                                        !    CHARACTER(LEN=*)
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                        ! 0 on success and -1 on failure
END SUBROUTINE h5pregister_f
	

History:
Release     C
1.8.0 Function H5Pregister renamed to H5Pregister1 and deprecated in this release.

Name: H5Pregister2
Signature:
herr_t H5Pregister2( hid_t class, const char * name, size_t size, void * default, H5P_prp_create_func_t create, H5P_prp_set_func_t set, H5P_prp_get_func_t get, H5P_prp_delete_func_t delete, H5P_prp_copy_func_t copy, H5P_prp_compare_func_t compare, H5P_prp_close_func_t close )

Purpose:
Registers a permanent property with a property list class.

Description:
H5Pregister2 registers a new property with a property list class. The property will exist in all property list objects of class created after this routine finishes. The name of the property must not already exist, or this routine will fail. The default property value must be provided and all new property lists created with this property will have the property value set to the default value. Any of the callback routines may be set to NULL if they are not needed.

Zero-sized properties are allowed and do not store any data in the property list. These may be used as flags to indicate the presence or absence of a particular piece of information. The default pointer for a zero-sized property may be set to NULL. The property create and close callbacks are called for zero-sized properties, but the set and get callbacks are never called.

The create routine is called when a new property list with this property is being created. The H5P_prp_create_func_t callback function is defined as follows:

The parameters to this callback function are defined as follows: The create routine may modify the value to be set and those changes will be stored as the initial value of the property. If the create routine returns a negative value, the new property value is not copied into the property and the create routine returns an error value.

The set routine is called before a new value is copied into the property. The H5P_prp_set_func_t callback function is defined as follows:

The parameters to this callback function are defined as follows: The set routine may modify the value pointer to be set and those changes will be used when setting the property's value. If the set routine returns a negative value, the new property value is not copied into the property and the set routine returns an error value. The set routine will not be called for the initial value, only the create routine will be called.

Note: The set callback function may be useful to range check the value being set for the property or may perform some transformation or translation of the value set. The get callback would then reverse the transformation or translation. A single get or set callback could handle multiple properties by performing different actions based on the property name or other properties in the property list.

The get routine is called when a value is retrieved from a property value. The H5P_prp_get_func_t callback function is defined as follows:

The parameters to the callback function are defined as follows: The get routine may modify the value to be returned from the query and those changes will be returned to the calling routine. If the set routine returns a negative value, the query routine returns an error value.

The delete routine is called when a property is being deleted from a property list. The H5P_prp_delete_func_t callback function is defined as follows:

The parameters to the callback function are defined as follows: The delete routine may modify the value passed in, but the value is not used by the library when the delete routine returns. If the delete routine returns a negative value, the property list delete routine returns an error value but the property is still deleted.

The copy routine is called when a new property list with this property is being created through a copy operation. The H5P_prp_copy_func_t callback function is defined as follows:

The parameters to the callback function are defined as follows: The copy routine may modify the value to be set and those changes will be stored as the new value of the property. If the copy routine returns a negative value, the new property value is not copied into the property and the copy routine returns an error value.

The compare routine is called when a property list with this property is compared to another property list with the same property. The H5P_prp_compare_func_t callback function is defined as follows:

The parameters to the callback function are defined as follows: The compare routine may not modify the values. The compare routine should return a positive value if value1 is greater than value2, a negative value if value2 is greater than value1 and zero if value1 and value2 are equal.

The close routine is called when a property list with this property is being closed. The H5P_prp_close_func_t callback function is defined as follows:

The parameters to the callback function are defined as follows: The close routine may modify the value passed in, but the value is not used by the library when the close routine returns. If the close routine returns a negative value, the property list close routine returns an error value but the property list is still closed.

Parameters:

Returns:
Success: a non-negative value
Failure: a negative value

Fortran90 Interface:
None.

History:
Release     C
1.8.0 Function introduced in this release.

Name: H5Premove
Signature:
herr_t H5Premove( hid_t plid; const char *name )
Purpose:
Removes a property from a property list.
Description:
H5Premove removes a property from a property list.

Both properties which were in existence when the property list was created (i.e. properties registered with H5Pregister) and properties added to the list after it was created (i.e. added with H5Pinsert1) may be removed from a property list. Properties do not need to be removed from a property list before the list itself is closed; they will be released automatically when H5Pclose is called.

If a close callback exists for the removed property, it will be called before the property is released.

Parameters:
Returns:
Success: a non-negative value
Failure: a negative value
Fortran90 Interface: h5premove_f
SUBROUTINE h5premove_f(plid, name, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: plid   ! Property list identifier
  CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to remove
  INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                       ! 0 on success and -1 on failure
END SUBROUTINE h5premove_f
	

Name: H5Pset
Signature:
herr_t H5Pset( hid_t plid, const char *name, void *value) )
Purpose:
Sets a property list value.
Description:
H5Pset sets a new value for a property in a property list. If there is a set callback routine registered for this property, the value will be passed to that routine and any changes to the value will be used when setting the property value. The information pointed to by the value pointer (possibly modified by the set callback) is copied into the property list value and may be changed by the application making the H5Pset call without affecting the property value.

The property name must exist or this routine will fail.

If the set callback routine returns an error, the property value will not be modified.

This routine may not be called for zero-sized properties and will return an error in that case.

Parameters:
Returns:
Success: a non-negative value
Failure: a negative value
Fortran90 Interface: h5pset_f
SUBROUTINE h5pset_f(plid, name, value, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: plid    ! Property list identifier 
  CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of property to set
  TYPE,   INTENT(IN) :: value           ! Property value
                                        ! Supported types are:
                                        !    INTEGER
                                        !    REAL
                                        !    DOUBLE PRECISION
                                        !    CHARACTER(LEN=*)
  INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                        ! 0 on success and -1 on failure
END SUBROUTINE h5pset_f
	

Name: H5Pset_alignment
Signature:
herr_t H5Pset_alignment(hid_t plist, hsize_t threshold, hsize_t alignment )
Purpose:
Sets alignment properties of a file access property list.
Description:
H5Pset_alignment sets the alignment properties of a file access property list so that any file object greater than or equal in size to threshold bytes will be aligned on an address which is a multiple of alignment. The addresses are relative to the end of the user block; the alignment is calculated by subtracting the user block size from the absolute file address and then adjusting the address to be a multiple of alignment.

Default values for threshold and alignment are one, implying no alignment. Generally the default values will result in the best performance for single-process access to the file. For MPI IO and other parallel systems, choose an alignment which is a multiple of the disk block size.

Parameters:
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Fortran90 Interface: h5pset_alignment_f
SUBROUTINE h5pset_alignment_f(prp_id, threshold,  alignment, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id       ! Property list identifier
  INTEGER(HSIZE_T), INTENT(IN) :: threshold  ! Threshold value
  INTEGER(HSIZE_T), INTENT(IN) :: alignment  ! Alignment value
  INTEGER, INTENT(OUT) :: hdferr             ! Error code
                                             ! 0 on success and -1 on failure
END SUBROUTINE h5pset_alignment_f
	

Name: H5Pset_alloc_time
Signature:
herr_t H5Pset_alloc_time(hid_t plist_id, H5D_alloc_time_t alloc_time )
Purpose:
Sets the timing for storage space allocation.
Description:
H5Pset_alloc_time sets up the timing for the allocation of storage space for a dataset's raw data. This property is set in the dataset creation property list plist_id.

Timing is specified in alloc_time with one of the following values:
     H5D_ALLOC_TIME_DEFAULT   Allocate dataset storage space at the default time.
(Defaults differ by storage method.)
H5D_ALLOC_TIME_EARLY Allocate all space when the dataset is created.
(Default for compact datasets.)
H5D_ALLOC_TIME_INCR   Allocate space incrementally, as data is written to the dataset.
(Default for chunked storage datasets.)
  • Chunked datasets: Storage space allocation for each chunk is deferred until data is written to the chunk.
  • Contiguous datasets: Incremental storage space allocation for contiguous data is treated as late allocation.
  • Compact datasets: Incremental allocation is not allowed with compact datasets; H5Pset_alloc_time will return an error.
  • H5D_ALLOC_TIME_LATE Allocate all space when data is first written to the dataset.
    (Default for contiguous datasets.)

    Note:
    H5Pset_alloc_time is designed to work in concert with the dataset fill value and fill value write time properties, set with the functions H5Pset_fill_value and H5Pset_fill_time.

    See H5Dcreate for further cross-references.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_alloc_time_f
    SUBROUTINE h5pset_alloc_time_f(plist_id, flag, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: plist_id  ! Dataset creation property
                                              ! list identifier
      INTEGER(HSIZE_T), INTENT(IN) :: flag    ! Allocation time flag
                                              ! Possible values are:
                                              !    H5D_ALLOC_TIME_ERROR_F
                                              !    H5D_ALLOC_TIME_DEFAULT_F
                                              !    H5D_ALLOC_TIME_EARLY_F
                                              !    H5D_ALLOC_TIME_LATE_F
                                              !    H5D_ALLOC_TIME_INCR_F
      INTEGER, INTENT(OUT)       :: hdferr    ! Error code
                                              ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_alloc_time_f
    	
    History:

    Name: H5Pset_attr_creation_order
    Signature:
    herr_t H5Pset_attr_creation_order( hid_t ocpl_id, unsigned crt_order_flags )

    Purpose:
    Sets tracking and indexing of attribute creation order.

    Description:
    H5Pset_attr_creation_order sets flags specifying whether to track and index attribute creation order on an object.

    ocpl_id is a dataset or group creation property list identifier. The term ocpl, for object creation property list, is used when different types of objects may be involved.

    crt_order_flags contains flags with the following meanings:
         H5P_CRT_ORDER_TRACKED Attribute creation order is tracked but not necessarily indexed.
         H5P_CRT_ORDER_INDEXED     Attribute creation order is indexed (requires H5P_CRT_ORDER_TRACKED).
    Default behavior is that attribute creation order is neither tracked nor indexed.

    Parameters:
    hid_t ocpl_id IN: Object creation property list identifier
    unsigned crt_order_flags     IN: Flags specifying whether to track and index attribute creation order
    Default: No flag set; attribute creation order is neither tracked not indexed.

    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.

    Fortran90 Interface:
    None.

    History:
    Release     C
    1.8.0 Function introduced in this release.

    Name: H5Pset_attr_phase_change
    Signature:
    herr_t H5Pset_attr_phase_change( hid_t ocpl_id, unsigned max_compact, unsigned min_dense )

    Purpose:
    Sets attribute storage phase change thresholds.

    Description:
    H5Pset_attr_phase_change sets threshold values for attribute storage on an object. These thresholds determine the point at which attribute storage changes from compact storage (i.e., storage in the object header) to dense storage (i.e., storage in a heap and indexed with a B-tree).

    In the general case, attributes are initially kept in compact storage. When the number of attributes exceeds max_compact, attribute storage switches to dense storage. If the number of attributes subsequently falls below min_dense, the attributes are returned to compact storage.

    If max_compact is set to 0 (zero), dense storage always used.

    ocpl_id is a dataset or group creation property list identifier. The term ocpl, for object creation property list, is used when different types of objects may be involved.

    Parameters:
    hid_t ocpl_id IN: Object (group or dataset) creation property list identifier
    unsigned max_compact IN: Maximum number of attributes to be stored in compact storage
    (Default: 8)
    unsigned min_dense     IN: Minimum number of attributes to be stored in dense storage
    (Default: 6)

    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.

    Fortran90 Interface:
    None.

    History:
    Release     C
    1.8.0 Function introduced in this release.

    Name: H5Pset_btree_ratios
    Signature:
    herr_t H5Pset_btree_ratios(hid_t plist, double left, double middle, double right )
    Purpose:
    Sets B-tree split ratios for a dataset transfer property list.
    Description:
    H5Pset_btree_ratios sets the B-tree split ratios for a dataset transfer property list. The split ratios determine what percent of children go in the first node when a node splits.

    The ratio left is used when the splitting node is the left-most node at its level in the tree; the ratio right is used when the splitting node is the right-most node at its level; and the ratio middle is used for all other cases.

    A node which is the only node at its level in the tree uses the ratio right when it splits.

    All ratios are real numbers between 0 and 1, inclusive.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_btree_ratios_f
    SUBROUTINE h5pset_btree_ratios_f(prp_id, left, middle, right, hdferr)
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: prp_id   
                                      ! Property list identifier
      REAL, INTENT(IN) :: left        ! The B-tree split ratio for left-most nodes
      REAL, INTENT(IN) :: middle      ! The B-tree split ratio for all other nodes
      REAL, INTENT(IN) :: right       ! The B-tree split ratio for right-most
                                      ! nodes and lone nodes.
      INTEGER, INTENT(OUT) :: hdferr  ! Error code
                                      ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_btree_ratios_f
    	

    Name: H5Pset_buffer
    Signature:
    herr_t H5Pset_buffer(hid_t plist, hsize_t size, void *tconv, void *bkg )
    Purpose:
    Sets type conversion and background buffers.
    Description:
    Given a dataset transfer property list, H5Pset_buffer sets the maximum size for the type conversion buffer and background buffer and optionally supplies pointers to application-allocated buffers. If the buffer size is smaller than the entire amount of data being transferred between the application and the file, and a type conversion buffer or background buffer is required, then strip mining will be used.

    Note that there are minimum size requirements for the buffer. Strip mining can only break the data up along the first dimension, so the buffer must be large enough to accommodate a complete slice that encompasses all of the remaining dimensions. For example, when strip mining a 100x200x300 hyperslab of a simple data space, the buffer must be large enough to hold 1x200x300 data elements. When strip mining a 100x200x300x150 hyperslab of a simple data space, the buffer must be large enough to hold 1x200x300x150 data elements.

    If tconv and/or bkg are null pointers, then buffers will be allocated and freed during the data transfer.

    The default value for the maximum buffer is 1 Mb.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_buffer_f
    SUBROUTINE h5pset_buffer_f(plist_id, size, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN)   :: plist_id ! Dataset transfer property 
                                               ! list identifier
      INTEGER(HSIZE_T), INTENT(IN) :: size     ! Conversion buffer size
      INTEGER, INTENT(OUT)         :: hdferr   ! Error code
                                               ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_buffer_f
    	
    History:

    Name: H5Pset_cache
    Signature:
    herr_t H5Pset_cache(hid_t plist_id, int mdc_nelmts, int rdcc_nelmts, size_t rdcc_nbytes, double rdcc_w0 )
    Purpose:
    Sets the meta data cache and raw data chunk cache parameters.
    Description:
    H5Pset_cache sets the number of elements (objects) in the meta data cache and the number of elements, the total number of bytes, and the preemption policy value in the raw data chunk cache.

    The plist_id is a file access property list. The number of elements (objects) in the meta data cache and the raw data chunk cache are mdc_nelmts and rdcc_nelmts, respectively. The total size of the raw data chunk cache and the preemption policy are rdcc_nbytes and rdcc_w0.

    Any (or all) of the H5Pget_cache pointer arguments may be null pointers.

    The rdcc_w0 value should be between 0 and 1 inclusive and indicates how much chunks that have been fully read are favored for preemption. A value of zero means fully read chunks are treated no differently than other chunks (the preemption is strictly LRU) while a value of one means fully read chunks are always preempted before other chunks.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_cache_f
    SUBROUTINE h5pset_cache_f(prp_id, mdc_nelmts,rdcc_nelmts, rdcc_nbytes, rdcc_w0, hdferr)
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: prp_id        ! Property list identifier
      INTEGER, INTENT(IN) :: mdc_nelmts           ! Number of elements (objects)
                                                  ! in the meta data cache
      INTEGER(SIZE_T), INTENT(IN) :: rdcc_nelmts  ! Number of elements (objects)
                                                  ! in the meta data cache
      INTEGER(SIZE_T), INTENT(IN) :: rdcc_nbytes  ! Total size of the raw data
                                                  ! chunk cache, in bytes
      REAL, INTENT(IN) :: rdcc_w0                 ! Preemption policy
      INTEGER, INTENT(OUT) :: hdferr              ! Error code
                                                  ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_cache_f
    	
    History:

    Name: H5Pset_char_encoding
    Signature:
    herr_t H5Pset_char_encoding( hid_t plist_id, H5T_cset_t encoding )

    Purpose:
    Sets the character encoding used to encode a string.

    Description:
    H5Pset_char_encoding sets the character encoding used to encode strings or object names that are created with the property list plist_id.

    Valid values for encoding are defined in H5Tpublic.h and include the following:
         H5T_CSET_ASCII US ASCII
         H5T_CSET_UTF8     UTF-8 Unicode encoding

    Parameters:
    hid_t plist_id IN: Property list identifier
    H5T_cset_t encoding     IN: String encoding character set

    Returns:
    Returns a non-negative valule if successful; otherwise returns a negative value.

    Fortran90 Interface:
    None.

    History:
    Release     C
    1.8.0 Function introduced in this release.

    Name: H5Pset_chunk
    Signature:
    herr_t H5Pset_chunk(hid_t plist, int ndims, const hsize_t * dim )
    Purpose:
    Sets the size of the chunks used to store a chunked layout dataset.
    Description:
    H5Pset_chunk sets the size of the chunks used to store a chunked layout dataset. This function is only valid for dataset creation property lists.

    The ndims parameter currently must be the same size as the rank of the dataset.

    The values of the dim array define the size of the chunks to store the dataset's raw data. The unit of measure for dim values is dataset elements.

    As a side-effect of this function, the layout of the dataset is changed to H5D_CHUNKED, if it is not already so set. (See H5Pset_layout.)

    Note regarding fixed-size datasets:
    Chunk size cannot exceed the size of a fixed-size dataset. For example, a dataset consisting of a 5x4 fixed-size array cannot be defined with 10x10 chunks.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_chunk_f
    SUBROUTINE h5pset_chunk_f(prp_id, ndims, dims, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier 
      INTEGER, INTENT(IN) :: ndims          ! Number of chunk dimensions
      INTEGER(HSIZE_T), DIMENSION(ndims), INTENT(IN) :: dims    
                                            ! Array containing sizes of
                                            ! chunk dimensions
      INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                            ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_chunk_f
    	

    Name: H5Pset_copy_object
    Signature:
    herr_t H5Pset_copy_object( hid_t ocp_plist_id, unsigned copy_options )
    Purpose:
    Sets properties to be used when an object is copied.
    Description:
    H5Pset_copy_object sets properties in the object copy property list ocp_plist_id that will be invoked when a new copy is made of an existing object.

    ocp_plist_id is the object copy property list and specifies the properties governing the copying of the object.

    Several flags, as described in the following table, are available for inclusion in the object copy property list. Note that only the default action for each property is currently available to user applications.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface:
    None.
    History:

    Name: H5Pset_create_intermediate_group
    Signature:
    herr_t H5Pset_create_intermediate_group( hid_t lcpl_id, unsigned crt_intermed_group )
    Purpose:
    Specifies in property list whether to create missing intermediate groups.
    Description:
    H5Pset_create_intermediate_group specifies whether to set the link creation property list lcpl_id so that calls to functions that create objects in groups different from the current working group will create intermediate groups that may be missing in the path of a new or moved object.

    Functions that create objects in or move objects to a group other than the current working group make use of this property. H5Gcreate_anon and H5Lmove are examles of such functions.

    If crt_intermed_group is positive, the H5G_CRT_INTMD_GROUP will be added to lcpl_id (if it is not already there). Missing intermediate groups will be created upon calls to functions such as those listed above that use lcpl_id.

    If crt_intermed_group is non-positive, the H5G_CRT_INTMD_GROUP, if present, will be removed from lcpl_id. Missing intermediate groups will not be created upon calls to functions such as those listed above that use lcpl_id.

    Parameters:
    Returns:
    Returns a non-negative valule if successful; otherwise returns a negative value.
    Example:
    The following call sets the link creation property list lcpl_id such that a call to H5Gcreate_anon or other function using lcpl_id will create any missing groups in the path to the new object:
         herr_t ret_value = H5Pset_create_intermediate_group(lcpl_id, 1) 
    Fortran90 Interface:
    None.
    History:

    Name: H5Pset_data_transform
    Signature:
    herr_t H5Pset_data_transform (hid_t plist_id, const char *expression)
    Purpose:
    Sets a data transform expression.
    Description:
    H5Pset_data_transform sets the data transform to be used for reading and writing data. This function operates on the dataset transfer property lists plist_id.

    The expression parameter is a string containing an algebraic expression, such as (5/9.0)*(x-32) or x*(x-5). When a dataset is read or written with this property list, the transform expression is applied with the x being replaced by the values in the dataset. When reading data, the values in the file are not changed and the transformed data is returned to the user.

    Data transforms can only be applied to integer or floating-point datasets. Order of operations is obeyed and the only supported operations are +, -, *, and /. Parentheses can be nested arbitrarily and can be used to change precedence.

    When writing data back to the dataset, the transformed data is written to the file and there is no way to recover the original values to which the transform was applied.

    Parameters:
    Returns:
    Success: a non-negative value
    Failure: a negative value
    Fortran90 Interface:
    None.

    Name: H5Pset_deflate
    Signature:
    herr_t H5Pset_deflate( hid_t plist, uint level )
    Purpose:
    Sets compression method and compression level.
    Description:
    H5Pset_deflate sets the compression method for a dataset creation property list to H5D_COMPRESS_DEFLATE and the compression level to level, which should be a value from zero to nine, inclusive.

    Lower compression levels are faster but result in less compression.

    This is the same algorithm as used by the GNU gzip program.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_deflate_f
    SUBROUTINE h5pset_deflate_f(prp_id, level, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier 
      INTEGER, INTENT(IN)        :: level  ! Compression level 
      INTEGER, INTENT(OUT)       :: hdferr ! Error code
                                           ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_deflate_f
    	

    Name: H5Pset_driver
    Signature:
    herr_t H5Pset_driver( hid_t plist_id, hid_t new_driver_id, const void *new_driver_info )
    Purpose:
    Sets a file driver.
    Description:
    H5Pset_driver sets the file driver, new_driver_id, for a file access or data transfer property list, plist_id, and supplies an optional struct containing the driver-specific properties, new_driver_info.

    Need new_driver_info struct definition.

    The driver properties will be copied into the property list and the reference count on the driver will be incremented, allowing the caller to close the driver identifier but still use the property list.

    Parameters:
    hid_t plist_id
    IN: File access or data transfer property list identifier.
    hid_t new_driver_id
    IN: Driver identifier.
    const void * new_driver_info
    IN: Optional struct containing driver properties.
    Returns:
    Returns a non-negative value if successful. Otherwise returns a negative value.
    Fortran90 Interface:
    None.
    History:

    Name: H5Pset_dxpl_mpio
    Signature:
    herr_t H5Pset_dxpl_mpio( hid_t dxpl_id, H5FD_mpio_xfer_t xfer_mode )
    Purpose:
    Sets data transfer mode.
    Description:
    H5Pset_dxpl_mpio sets the data transfer property list dxpl_id to use transfer mode xfer_mode. The property list can then be used to control the I/O transfer mode during data I/O operations.

    Valid transfer modes are as follows:

    H5FD_MPIO_INDEPENDENT
    Use independent I/O access (default).
    H5FD_MPIO_COLLECTIVE
    Use collective I/O access.

    Parameters:
    Returns:
    Returns a non-negative value if successful. Otherwise returns a negative value.
    Fortran90 Interface:
    SUBROUTINE h5pset_dxpl_mpio_f(prp_id, data_xfer_mode, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier
      INTEGER, INTENT(IN) :: data_xfer_mode ! Data transfer mode 
                                            ! Possible values are:
                                            !    H5FD_MPIO_INDEPENDENT_F
                                            !    H5FD_MPIO_COLLECTIVE_F
      INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                            ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_dxpl_mpio_f
    	
    History:

    Name: H5Pset_dxpl_mpio_chunk_opt
    Signature:
    herr_t H5Pset_dxpl_mpio_chunk_opt (hid_t dxpl_id, H5FD_mpio_chunk_opt_t opt_mode)
    Purpose:
    Sets a flag specifying linked-chunk I/O or multi-chunk I/O.
    Description:
    H5Pset_dxpl_mpio_chunk_opt specifies whether I/O is to be performed as linked-chunk I/O or as multi-chunk I/O. This function overrides the HDF5 Library's internal algorithm for determining which mechanism to use.

    When an application uses collective I/O with chunked storage, the HDF5 Library normally uses an internal algorithm to determine whether that I/O activity should be conducted as one linked-chunk I/O or as multi-chunk I/O. H5Pset_dxpl_mpio_chunk_opt is provided so that an application can override the library's alogorithm in circumstances where the library might lack the information needed to make an optimal desision.

    H5Pset_dxpl_mpio_chunk_opt works by setting one of the following flags in the parameter opt_mode:

    This function works by setting a corresponding property in the dataset transfer property list dxpl_id.

    The library perform I/O in the specified manner unless it determines that the low-level MPI IO package does not support the requested behavior; in such cases, the HDF5 Library will internally use independent I/O.

    Use of this function is optional.

    Parameters:
    Returns:
    Returns a non-negative value if successful. Otherwise returns a negative value.

    Name: H5Pset_dxpl_mpio_chunk_opt_num
    Signature:
    herr_t H5Pset_dxpl_mpio_chunk_opt_num (hid_t dxpl_id, unsigned num_chunk_per_proc)
    Purpose:
    Sets a numeric threshold for linked-chunk I/O.
    Description:
    H5Pset_dxpl_mpio_chunk_opt_num sets a numeric threshold for the use of linked-chunk I/O.

    The library will calculate the average number of chunks selected by each process when doing collective access with chunked storage. If the number is greater than the threshold set in num_chunk_per_proc, the library will use linked-chunk I/O; otherwise, a separate I/O process will be invoked for each chunk (multi-chunk I/O).

    Parameters:
    Returns:
    Returns a non-negative value if successful. Otherwise returns a negative value.

    Name: H5Pset_dxpl_mpio_chunk_opt_ratio
    Signature:
    herr_t H5Pset_dxpl_mpio_chunk_opt_ratio (hid_t dxpl_id, unsigned percent_proc_per_chunk)
    Purpose:
    Sets a ratio threshold for collective I/O.
    Description:
    H5Pset_dxpl_mpio_chunk_opt_ratio sets a threshold for the use of collective I/O based on the ratio of processes with collective access to a dataset with chunked storage. The decision whether to use collective I/O is made on a per-chunk basis.

    The library will calculate the percentage of the total number of processes, the ratio, that hold selections in each chunk. If that percentage is greater than the threshold set in percent_proc_per_chunk, the library will do collective I/O for this chunk; otherwise, independent I/O will be done for the chunk.

    Parameters:
    Returns:
    Returns a non-negative value if successful. Otherwise returns a negative value.

    Name: H5Pset_dxpl_mpio_collective_opt
    Signature:
    herr_t H5Pset_dxpl_mpio_collective_opt (hid_t dxpl_id, H5FD_mpio_collective_opt_t opt_mode)
    Purpose:
    Sets a flag governing the use of independent versus collective I/O.
    Description:
    H5Pset_dxpl_mpio_collective_opt enables an application to specify that the HDF5 Library will use independent I/O internally when the dataset transfer property list dxpl_id is set for collective I/O, i.e., with H5FD_MPIO_COLLECTIVE specified. This allows the application greater control over low-level I/O while maintaining the collective interface at the application level.

    H5Pset_dxpl_mpio_collective_opt works by setting one of the following flags in the parameter opt_mode:

    This function should be used only when H5FD_MPIO_COLLECTIVE has been set through H5Pset_dxpl_mpio. In such situations, normal behavior would be to use low-level collective I/O functions, but the library will use low-level MPI independent I/O functions when H5FD_MPIO_INDIVIDUAL_IO is set.

    Use of this function is optional.

    Parameters:
    Returns:
    Returns a non-negative value if successful. Otherwise returns a negative value.

    Name: H5Pset_dxpl_multi
    Signature:
    herr_t H5Pset_dxpl_multi( hid_t dxpl_id, const hid_t *memb_dxpl )
    Purpose:
    Sets the data transfer property list for the multi-file driver.
    Description:
    H5Pset_dxpl_multi sets the data transfer property list dxpl_id to use the multi-file driver for each memory usage type memb_dxpl[].

    H5Pset_dxpl_multi can only be used after the member map has been set with H5Pset_fapl_multi.

    Parameters:
    Returns:
    Returns a non-negative value if successful. Otherwise returns a negative value.
    Fortran90 Interface:
    None.
    History:

    Name: H5Pset_edc_check
    Signature:
    herr_t H5Pset_edc_check(hid_t plist, H5Z_EDC_t check)
    Purpose:
    Sets whether to enable error-detection when reading a dataset.
    Description:
    H5Pset_edc_check sets the dataset transfer property list plist to enable or disable error detection when reading data.

    Whether error detection is enabled or disabled is specified in the check parameter. Valid values are as follows:
           H5Z_ENABLE_EDC   (default)
    H5Z_DISABLE_EDC

    The error detection algorithm used is the algorithm previously specified in the corresponding dataset creation property list.  

    This function does not affect the use of error detection when writing data.  

    Note:
    The initial error detection implementation, Fletcher32 checksum, supports error detection for chunked datasets only.
    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_edc_check_f
    SUBROUTINE h5pset_edc_check_f(prp_id, flag, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: prp_id   ! Dataset transfer property 
                                             ! list identifier 
      INTEGER, INTENT(IN)        :: flag     ! EDC flag; possible values
                                             !    H5Z_DISABLE_EDC_F 
                                             !    H5Z_ENABLE_EDC_F 
      INTEGER, INTENT(OUT)       :: hdferr   ! Error code
                                             ! 0 on success and -1 on failure
     
    END SUBROUTINE h5pset_edc_check_f
    	
    History:

    Name: H5Pset_elink_prefix
    Signature:
    herr_t H5Pset_elink_prefix( hid_t lapl_id, const char *prefix )

    Purpose:
    Sets prefix to be applied to external link paths.

    Description:
    H5Pset_elink_prefix sets the prefix to be applied to the path of any external links traversed. The prefix is prepended to the filename stored in the external link.

    The prefix is specified in the user-allocated buffer prefix and set in the link access property list lapl_id. The buffer should not be freed until the property list has been closed.

    Parameters:
    hid_t lapl_id IN: Link access property list identifier
    const char *prefix     IN: Prefix to be applied to external link paths

    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.

    Fortran90 Interface:
    None.

    History:
    Release     C
    1.8.0 Function introduced in this release.

    Name: H5Pset_est_link_info
    Signature:
    herr_t H5Pset_est_link_info( hid_t gcpl_id, unsigned est_num_entries, unsigned est_name_len )

    Purpose:
    Sets estimated number of links and length of link names in a group.

    Description:
    H5Pset_est_link_info inserts two settings into the group creation property list gcpl_id: the estimated number of links that are expected to be inserted into a group created with the property list and the estimated average length of those link names.

    The estimated number of links is passed in est_num_entries.

    The estimated average length of the anticipated link names is passed in est_name_len.

    The values for these two settings are multiplied to compute the initial local heap size (for old-style groups, if the local heap size hint is not set) or the initial object header size for (new-style compact groups; see “Group styles in HDF5”). Accurately setting these parameters will help reduce wasted file space.

    If a group is expected to have many links and to be stored in dense format, set est_num_entries to 0 (zero) for maximum efficiency. This will prevent the group from being created in the compact format.

    See “Group styles in HDF5” in the H5G API introduction for a discussion of the available types of HDF5 group structures.

    Parameters:
    hid_t gcpl_id IN: Group creation property list identifier
    unsigned est_num_entries     IN: Estimated number of links to be inserted into group
    unsigned est_name_len IN: Estimated average length of link names
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.

    Fortran90 Interface:
    None.

    History:
    Release     C
    1.8.0 Function introduced in this release.

    Name: H5Pset_external
    Signature:
    herr_t H5Pset_external(hid_t plist, const char *name, off_t offset, hsize_t size )
    Purpose:
    Adds an external file to the list of external files.
    Description:
    The first call to H5Pset_external sets the external storage property in the property list, thus designating that the dataset will be stored in one or more non-HDF5 file(s) external to the HDF5 file. This call also adds the file name as the first file in the list of external files. Subsequent calls to the function add the named file as the next file in the list.

    If a dataset is split across multiple files, then the files should be defined in order. The total size of the dataset is the sum of the size arguments for all the external files. If the total size is larger than the size of a dataset then the dataset can be extended (provided the data space also allows the extending).

    The size argument specifies the number of bytes reserved for data in the external file. If size is set to H5F_UNLIMITED, the external file can be of unlimited size and no more files can be added to the external files list.

    All of the external files for a given dataset must be specified with H5Pset_external before H5Dcreate is called to create the dataset. If one these files does not exist on the system when H5Dwrite is called to write data to it, the library will create the file.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_external_f
    SUBROUTINE h5pset_external_f(prp_id, name, offset,bytes, hdferr)
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier
      CHARACTER(LEN=*), INTENT(IN) :: name  ! Name of an external file
      INTEGER, INTENT(IN) :: offset         ! Offset, in bytes, from the 
                                            ! beginning of the file to the 
                                            ! location in the file where 
                                            ! the data starts
      INTEGER(HSIZE_T), INTENT(IN) :: bytes ! Number of bytes reserved in 
                                            ! the file for the data
      INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                            ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_external_f
    	

    Name: H5Pset_family_offset
    Signature:
    herr_t H5Pset_family_offset ( hid_t fapl_id, hsize_t offset )
    Purpose:
    Sets offset property for low-level access to a file in a family of files.
    Description:
    H5Pset_family_offset sets the offset property in the file access property list fapl_id so that the user application can retrieve a file handle for low-level access to a particular member of a family of files. 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 value of offset 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.

    Use of this function is only appropriate for an HDF5 file written as a family of files with the FAMILY file driver.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_family_offset_f
    SUBROUTINE h5pset_family_offset_f(prp_id, offset, hdferr)
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN)   :: prp_id   ! Property list identifier
      INTEGER(HSIZE_T), INTENT(IN) :: offset   ! Offset in bytes
      INTEGER, INTENT(OUT)         :: hdferr   ! Error code
                                               ! 0 on success and -1 on failure
     
    END SUBROUTINE h5pset_family_offset_f
    	
    History:

    Name: H5Pset_fapl_core
    Signature:
    herr_t H5Pset_fapl_core( hid_t fapl_id, size_t increment, hbool_t backing_store )
    Purpose:
    Modifies the file access property list to use the H5FD_CORE driver.
    Description:
    H5Pset_fapl_core modifies the file access property list to use the H5FD_CORE driver.

    The H5FD_CORE driver enables an application to work with a file in memory, speeding reads and writes as no disk access is made. File contents are stored only in memory until the file is closed. The backing_store parameter determines whether file contents are ever written to disk.

    increment specifies the increment by which allocated memory is to be increased each time more memory is required.

    While using H5Fcreate to create a core file, if the backing_store is set to 1 (TRUE), the file contents are flushed to a file with the same name as this core file when the file is closed or access to the file is terminated in memory.

    The application is allowed to open an existing file with H5FD_CORE driver. While using H5Fopen to open an existing file, if the backing_store is set to 1 and the flags for H5Fopen is set to H5F_ACC_RDWR, any change to the file contents are saved to the file when the file is closed. If backing_store is set to 0 and the flags for H5Fopen is set to H5F_ACC_RDWR, any change to the file contents will be lost when the file is closed. If the flags for H5Fopen is set to H5F_ACC_RDONLY, no change to the file is allowed either in memory or on file.

    Note:
    Currently this driver cannot create or open family or multi files.
    Parameters:
    Returns:
    Returns a non-negative value if successful. Otherwise returns a negative value.
    Fortran90 Interface: h5pset_fapl_core_f
    SUBROUTINE h5pset_fapl_core_f(prp_id, increment, backing_store, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN)  :: prp_id    ! Property list identifier
      INTEGER(SIZE_T), INTENT(IN) :: increment ! File block size in bytes
      LOGICAL, INTENT(IN) :: backing_store     ! Flag to indicate that entire 
                                               ! file contents are flushed to 
                                               ! a file with the same name as 
                                               ! this core file
      INTEGER, INTENT(OUT) :: hdferr           ! Error code
                                               ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_fapl_core_f
    	
    History:

    Name: H5Pset_fapl_direct
    Signature:
    herr_t H5Pset_fapl_direct( hid_t fapl_id, size_t alignment, size_t block_size, size_t cbuf_size )

    Purpose:
    Sets up use of the direct I/O driver.

    Description:
    H5Pset_fapl_direct sets the file access property list, fapl_id, to use the direct I/O driver, H5FD_DIRECT. With this driver, data is written to or read from the file synchronously without being cached by the system.

    File systems usually require the data address in memory, the file address, and the size of the data to be aligned. The HDF5 Library’s direct I/O driver is able to handle unaligned data, though that will consume some additional memory resources and may slow performance. To get better performance, use the system function posix_memalign to align the data buffer in memory and the HDF5 function H5Pset_alignment to align the data in the file. Be aware, however, that aligned data I/O may cause the HDF5 file to be bigger than the actual data size would otherwise require because the alignment may leave some holes in the file.

    alignment specifies the required alignment boundary in memory.

    block_size specifies the file system block size. A value of 0 (zero) means to use HDF5 Library’s default value of 4KB.

    cbuf_size specifies the copy buffer size.

    Note:
    On an SGI Altix Linux 2.6 system, the memory alignment must be a multiple of 512 bytes, and the file system block size is 4KB. The maximum size for the copy buffer has to be a multiple of the file system block size. The HDF5 Library’s default maximum copy buffer size is 16MB. This copy buffer is used by the library’s internal algorithm to copy data in fragments between an application’s unaligned buffer and the file. The buffer’s size may affect I/O performance.

    Parameters:
    hid_t fapl_id IN: File access property list identifier
    size_t alignment IN: Required memory alignment boundary
    size_t block_size     IN: File system block size
    size_t cbuf_size IN: Copy buffer size

    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.

    Fortran90 Interface:
    None.

    History:
    Release     C
    1.8.0 Function introduced in this release.

    Name: H5Pset_fapl_family
    Signature:
    herr_t H5Pset_fapl_family ( hid_t fapl_id, hsize_t memb_size, hid_t memb_fapl_id )
    Purpose:
    Sets the file access property list to use the family driver.
    Description:
    H5Pset_fapl_family sets the file access property list identifier, fapl_id, to use the family driver.

    memb_size is the size in bytes of each file member and is used only when creating a new file.

    memb_fapl_id is the identifier of the file access property list to be used for each family member.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_fapl_family_f
    SUBROUTINE h5pset_fapl_family_f(prp_id, imemb_size, memb_plist, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN)   :: prp_id    ! Property list identifier
      INTEGER(HSIZE_T), INTENT(IN) :: memb_size ! Logical size, in bytes,
                                                ! of each family member
      INTEGER(HID_T), INTENT(IN) :: memb_plist  ! Identifier of the file 
                                                ! access property list to be
                                                ! used for each family member
      INTEGER, INTENT(OUT) :: hdferr            ! Error code
                                                ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_fapl_family_f
    	
    History:

    Name: H5Pset_fapl_log
    Signature:
    herr_t H5Pset_fapl_log( hid_t fapl_id, const char *logfile, unsigned int flags, size_t buf_size )
    Purpose:
    Sets up the use of the logging driver.
    Description:
    H5Pset_fapl_log modifies the file access property list to use the logging driver H5FD_LOG.

    logfile is the name of the file in which the logging entries are to be recorded.

    The actions to be logged are specified in the parameter flags using the pre-defined constants described in the following table. Multiple flags can be set through the use of an logical OR contained in parentheses. For example, logging read and write locations would be specified as (H5FD_LOG_LOC_READ|H5FD_LOG_LOC_WRITE).


    Flag

    Description

    H5FD_LOG_LOC_READ

    Track the location and length of every read, write, or seek operation.
    H5FD_LOG_LOC_WRITE  
    H5FD_LOG_LOC_SEEK
    H5FD_LOG_LOC_IO Track all I/O locations and lengths. The logical equivalent of the following:
      (H5FD_LOG_LOC_READ | H5FD_LOG_LOC_WRITE | H5FD_LOG_LOC_SEEK)

    H5FD_LOG_FILE_READ

    Track the number of times each byte is read or written.
    H5FD_LOG_FILE_WRITE  
    H5FD_LOG_FILE_IO Track the number of times each byte is read and written. The logical equivalent of the following:
      (H5FD_LOG_FILE_READ | H5FD_LOG_FILE_WRITE)

    H5FD_LOG_FLAVOR

    Track the type, or flavor, of information stored at each byte.

    H5FD_LOG_NUM_READ

    Track the total number of read, write, or seek operations that occur.
    H5FD_LOG_NUM_WRITE
    H5FD_LOG_NUM_SEEK
    H5FD_LOG_NUM_IO Track the total number of all types of I/O operations. The logical equivalent of the following:
      (H5FD_LOG_NUM_READ | H5FD_LOG_NUM_WRITE | H5FD_LOG_NUM_SEEK)

    H5FD_LOG_TIME_OPEN

    Track the time spent in open, read, write, seek, or close operations. Not implemented in this release: open and read
    Partially implemented: write and seek
    Fully implemented: close
    H5FD_LOG_TIME_READ
    H5FD_LOG_TIME_WRITE
    H5FD_LOG_TIME_SEEK
    H5FD_LOG_TIME_CLOSE
    H5FD_LOG_TIME_IO Track the time spent in each of the above operations. The logical equivalent of the following:
      (H5FD_LOG_TIME_OPEN | H5FD_LOG_TIME_READ | H5FD_LOG_TIME_WRITE | H5FD_LOG_TIME_SEEK | H5FD_LOG_TIME_CLOSE)

    H5FD_LOG_ALLOC

    Track the allocation of space in the file.

    H5FD_LOG_ALL

    Track everything. The logical equivalent of the following:
      (H5FD_LOG_ALLOC | H5FD_LOG_TIME_IO | H5FD_LOG_NUM_IO | H5FD_LOG_FLAVOR |H5FD_LOG_FILE_IO | H5FD_LOG_LOC_IO)


    The logging driver can track the number of times each byte in the file is read from or written to (using H5FD_LOG_FILE_READ and H5FD_LOG_FILE_WRITE) and what kind of data is at that location (e.g., meta data, raw data; using H5FD_LOG_FLAVOR). This information is tracked in a buffer of size buf_size, which must be at least the size in bytes of the file to be logged.

    Parameters:
    Returns:
    Returns non-negative if successful. Otherwise returns negative.
    Fortran90 Interface:
    None.
    History:

    Name: H5Pset_fapl_mpio
    Signature:
    herr_t H5Pset_fapl_mpio( hid_t fapl_id, MPI_Comm comm, MPI_Info info )
    Purpose:
    Stores MPI IO communicator information to the file access property list.
    Description:
    H5Pset_fapl_mpio stores the user-supplied MPI IO parameters comm, for communicator, and info, for information, in the file access property list fapl_id. That property list can then be used to create and/or open the file.

    H5Pset_fapl_mpio 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.

    info is the MPI info object to be used for file open as defined in MPI_FILE_OPEN of MPI-2. This function does not create a duplicated info object. Any modification to the info object after this function call returns may have an undetermined effect on the access property list. Users should not modify the info while it is defined in a property list.

    Parameters:
    Returns:
    Returns a non-negative value if successful. Otherwise returns a negative value.
    Fortran90 Interface: h5pset_fapl_mpio_f
    SUBROUTINE h5pset_fapl_mpio_f(prp_id, comm, info, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier
      INTEGER, INTENT(IN) :: comm           ! MPI communicator to be used for 
                                            ! file open as defined in 
                                            ! MPI_FILE_OPEN of MPI-2
      INTEGER, INTENT(IN) :: info           ! MPI info object to be used for 
                                            ! file open as defined in 
                                            ! MPI_FILE_OPEN of MPI-2
      INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                            ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_fapl_mpio_f
    	
    History:

    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:
    Returns:
    Returns a non-negative value if successful. Otherwise returns a negative value.
    Fortran90 Interface: h5pset_fapl_mpiposix_f
    SUBROUTINE h5pset_fapl_mpiposix_f(prp_id, comm, use_gpfs, hdferr)
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier
      INTEGER, INTENT(IN) :: comm           ! MPI communicator to be used 
                                            ! for file open as defined in 
                                            ! MPI_FILE_OPEN of MPI-2
      LOGICAL, INTENT(IN) :: use_gpfs
      INTEGER, INTENT(OUT) :: hdferr        ! Error code
    END SUBROUTINE h5pset_fapl_mpiposix_f
    	
    History:

    Name: H5Pset_fapl_multi
    Signature:
    herr_t H5Pset_fapl_multi( hid_t fapl_id, const H5FD_mem_t *memb_map, const hid_t *memb_fapl, const char * const *memb_name, const haddr_t *memb_addr, hbool_t relax )
    Purpose:
    Sets up use of the multi-file driver.
    Description:
    H5Pset_fapl_multi sets the file access property list fapl_id to use the multi-file driver.

    The multi-file driver enables different types of HDF5 data and metadata to be written to separate files. These files are viewed by the HDF5 library and the application as a single virtual HDF5 file with a single HDF5 file address space. The types of data that can be broken out into separate files include raw data, the superblock, B-tree data, global heap data, local heap data, and object headers. At the programmer's discretion, two or more types of data can be written to the same file while other types of data are written to separate files.

    The array memb_map maps memory usage types to other memory usage types and is the mechanism that allows the caller to specify how many files are created. The array contains H5FD_MEM_NTYPES entries, which are either the value H5FD_MEM_DEFAULT or a memory usage type. The number of unique values determines the number of files that are opened.

    The array memb_fapl contains a property list for each memory usage type that will be associated with a file.

    The array memb_name should be a name generator (a printf-style format with a %s which will be replaced with the name passed to H5FDopen, usually from H5Fcreate or H5Fopen).

    The array memb_addr specifies the offsets within the virtual address space, from 0 (zero) to HADDR_MAX, at which each type of data storage begins.

    If relax is set to TRUE (or 1), then opening an existing file for read-only access will not fail if some file members are missing. This allows a file to be accessed in a limited sense if just the meta data is available.

    Default values for each of the optional arguments are as follows:

    memb_map
    The default member map contains the value H5FD_MEM_DEFAULT for each element.
    memb_fapl
    The default value is H5P_DEFAULT for each element.
    memb_name
    The default string is   %s-X.h5   where   X   is one of the following letters: s    for H5FD_MEM_SUPER
    b    for H5FD_MEM_BTREE
    r    for H5FD_MEM_DRAW
    g    for H5FD_MEM_GHEAP
    l    for H5FD_MEM_LHEAP
    o    for H5FD_MEM_OHDR
    memb_addr
    The default value is HADDR_UNDEF for each element.
    Parameters:
    Returns:
    Returns a non-negative value if successful. Otherwise returns a negative value.
    Example:
    The following code sample sets up a multi-file access property list that partitions data into meta and raw files, each being one-half of the address:
                      H5FD_mem_t mt, memb_map[H5FD_MEM_NTYPES];
                      hid_t memb_fapl[H5FD_MEM_NTYPES];
                      const char *memb[H5FD_MEM_NTYPES];
                      haddr_t memb_addr[H5FD_MEM_NTYPES];
     
                      // The mapping...
                      for (mt=0; mt<H5FD_MEM_NTYPES; mt++) {
                         memb_map[mt] = H5FD_MEM_SUPER;
                      }
                      memb_map[H5FD_MEM_DRAW] = H5FD_MEM_DRAW;
     
                      // Member information
                      memb_fapl[H5FD_MEM_SUPER] = H5P_DEFAULT;
                      memb_name[H5FD_MEM_SUPER] = "%s.meta";
                      memb_addr[H5FD_MEM_SUPER] = 0;
     
                      memb_fapl[H5FD_MEM_DRAW] = H5P_DEFAULT;
                      memb_name[H5FD_MEM_DRAW] = "%s.raw";
                      memb_addr[H5FD_MEM_DRAW] = HADDR_MAX/2;
     
                      hid_t fapl = H5Pcreate(H5P_FILE_ACCESS);
                      H5Pset_fapl_multi(fapl, memb_map, memb_fapl,
                                      memb_name, memb_addr, TRUE);
            
    Fortran90 Interface: h5pset_fapl_multi_f
    SUBROUTINE h5pset_fapl_multi_f(prp_id, memb_map, memb_fapl, memb_name,
                                   memb_addr, relax, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T),INTENT(IN)  :: prp_id     ! Property list identifier
    
      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
      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
      LOGICAL, INTENT(IN)  :: relax
      INTEGER, INTENT(OUT) :: hdferr           ! Error code
                                               ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_fapl_multi_f
    	
    History:

    Name: H5Pset_fapl_sec2
    Signature:
    herr_t H5Pset_fapl_sec2( hid_t fapl_id )
    Purpose:
    Sets the sec2 driver.
    Description:
    H5Pset_fapl_sec2 modifies the file access property list to use the H5FD_SEC2 driver.
    Parameters:
    Returns:
    Returns a non-negative value if successful. Otherwise returns a negative value.
    Fortran90 Interface: h5pset_fapl_sec2_f
    SUBROUTINE h5pset_fapl_sec2_f(prp_id, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN)    :: prp_id  ! Property list identifier
      INTEGER, INTENT(OUT)          :: hdferr  ! Error code
                                               ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_fapl_sec2_f
    	
    History:

    Name: H5Pset_fapl_split
    Signature:
    herr_t H5Pset_fapl_split( hid_t fapl_id, const char *meta_ext, hid_t meta_plist_id, const char *raw_ext, hid_t raw_plist_id )
    Purpose:
    Emulates the old split file driver.
    Description:
    H5Pset_fapl_split is a compatibility function that enables the multi-file driver to emulate the split driver from HDF5 Releases 1.0 and 1.2. The split file driver stored metadata and raw data in separate files but provided no mechanism for separating types of metadata.

    fapl_id is a file access property list identifier.

    meta_ext is the filename extension for the metadata file. The extension is appended to the name passed to H5FDopen, usually from H5Fcreate or H5Fopen, to form the name of the metadata file. If the string %s is used in the extension, it works like the name generator as in H5Pset_fapl_multi.

    meta_plist_id is the file access property list identifier for the metadata file.

    raw_ext is the filename extension for the raw data file. The extension is appended to the name passed to H5FDopen, usually from H5Fcreate or H5Fopen, to form the name of the rawdata file. If the string %s is used in the extension, it works like the name generator as in H5Pset_fapl_multi.

    raw_plist_id is the file access property list identifier for the raw data file.

    If a user wishes to check to see whether this driver is in use, the user must call H5Pget_driver and compare the returned value to the string H5FD_MULTI. A positive match will confirm that the multi driver is in use; HDF5 provides no mechanism to determine whether it was called as the special case invoked by H5Pset_fapl_split.

    Parameters:
    Returns:
    Returns a non-negative value if successful. Otherwise returns a negative value.
    Example:
    /* Example 1: Both metadata and rawdata files are in the same  */
    /*    directory.   Use Station1-m.h5 and Station1-r.h5 as      */
    /*    the metadata and rawdata files.                          */
    hid_t fapl, fid;
    fapl = H5Pcreate(H5P_FILE_ACCESS);
    H5Pset_fapl_split(fapl, "-m.h5", H5P_DEFAULT, "-r.h5", H5P_DEFAULT);
    fid=H5Fcreate("Station1",H5F_ACC_TRUNC,H5P_DEFAULT,fapl);
    
    /* Example 2: metadata and rawdata files are in different      */
    /*    directories.  Use PointA-m.h5 and /pfs/PointA-r.h5 as    */
    /*    the metadata and rawdata files.                          */
    hid_t fapl, fid;
    fapl = H5Pcreate(H5P_FILE_ACCESS);
    H5Pset_fapl_split(fapl, "-m.h5", H5P_DEFAULT, "/pfs/%s-r.h5", H5P_DEFAULT);
    fid=H5Fcreate("PointA",H5F_ACC_TRUNC,H5P_DEFAULT,fapl);
    Fortran90 Interface: h5pset_fapl_split_f
    SUBROUTINE h5pset_fapl_split_f(prp_id, meta_ext, meta_plist, raw_ext, &
                                   raw_plist, hdferr)
      IMPLICIT NONE
      INTEGER(HID_T),INTENT(IN)   :: prp_id     ! Property list identifier
      CHARACTER(LEN=*),INTENT(IN) :: meta_ext   ! Name of the extension for
                                                ! the metafile filename
      INTEGER(HID_T),INTENT(IN)   :: meta_plist ! Identifier of the meta file
                                                ! access property list
      CHARACTER(LEN=*),INTENT(IN) :: raw_ext    ! Name extension for the raw 
                                                ! file filename
      INTEGER(HID_T),INTENT(IN)   :: raw_plist  ! Identifier of the raw file
                                                ! access property list
      INTEGER, INTENT(OUT) :: hdferr            ! Error code
                                                ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_fapl_split_f
    	
    History:

    Name: H5Pset_fapl_stdio
    Signature:
    herr_t H5Pset_fapl_stdio( hid_t fapl_id )
    Purpose:
    Sets the standard I/O driver.
    Description:
    H5Pset_fapl_stdio modifies the file access property list to use the standard I/O driver, H5FD_STDIO.
    Parameters:
    Returns:
    Returns a non-negative value if successful. Otherwise returns a negative value.
    Fortran90 Interface: h5pset_fapl_stdio_f
    SUBROUTINE h5pset_fapl_stdio_f(prp_id, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN)    :: prp_id  ! Property list identifier
      INTEGER, INTENT(OUT)          :: hdferr  ! Error code
                                               ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_fapl_stdio_f
    	
    History:

    Name: H5Pset_fapl_windows
    Signature:
    herr_t H5Pset_fapl_windows( hid_t fapl_id )

    Purpose:
    Sets the Windows I/O driver.

    Description:
    H5Pset_fapl_windows sets the default HDF5 Windows I/O driver on Windows systems.

    Since the HDF5 Library uses this driver, H5FD_WINDOWS, by default on Windows systems, it is not normally necessary for a user application to call H5Pset_fapl_windows. While it is not recommended, there may be times when a user chooses to set a different HDF5 driver, such as the standard I/O driver (H5FD_STDIO) or the sec2 driver (H5FD_SEC2), in a Windows application. H5Pset_fapl_windows is provided so that the application can return to the Windows I/O driver when the time comes.

    Only the Windows driver is tested on Windows systems; other drivers are used at the application’s and the user’s risk.

    Furthermore, the Windows driver is tested and available only on Windows systems; it is not available on non-Windows systems.

    Parameters:
    hid_t fapl_id     IN: File access property list identifier

    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.

    Fortran90 Interface:
    None.

    History:
    Release     C
    1.8.0 Function introduced in this release.

    Name: H5Pset_fclose_degree
    Signature:
    herr_t H5Pset_fclose_degree(hid_t fapl_id, H5F_close_degree_t fc_degree)
    Purpose:
    Sets the file close degree.
    Description:
    H5Pset_fclose_degree sets the file close degree property fc_degree in the file access property list fapl_id

    The value of fc_degree determines how aggressively H5Fclose deals with objects within a file that remain open when H5Fclose is called to close that file.  fc_degree can have any one of four valid values:

    Degree name H5Fclose behavior with no open object in file H5Fclose behavior with open object(s) in file
    H5F_CLOSE_WEAK Actual file is closed. Access to file identifier is terminated; actual file close is delayed until all objects in file are closed
    H5F_CLOSE_SEMI Actual file is closed. Function returns FAILURE
    H5F_CLOSE_STRONG Actual file is closed. All open objects remaining in the file are closed then file is closed
    H5F_CLOSE_DEFAULT The VFL driver chooses the behavior.  Currently, all VFL drivers set this value to H5F_CLOSE_WEAK, except for the MPI-I/O driver, which sets it to H5F_CLOSE_SEMI.
    Parameters:
    Returns:
    Returns a non-negative value if successful. Otherwise returns a negative value.
    Fortran90 Interface: h5pset_fclose_degree_f
    SUBROUTINE h5pset_fclose_degree_f(fapl_id, degree, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: fapl_id  ! File access property list identifier
      INTEGER, INTENT(IN) :: degree          ! Info about file close behavior 
                                             ! Possible values:
                                             !    H5F_CLOSE_DEFAULT_F
                                             !    H5F_CLOSE_WEAK_F
                                             !    H5F_CLOSE_SEMI_F
                                             !    H5F_CLOSE_STRONG_F
      INTEGER, INTENT(OUT) :: hdferr         ! Error code
                                             ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_fclose_degree_f
    	
    History:

    Name: H5Pset_fill_time
    Signature:
    herr_t H5Pset_fill_time(hid_t plist_id, H5D_fill_time_t fill_time )
    Purpose:
    Sets the time when fill values are written to a dataset.
    Description:
    H5Pset_fill_time sets up the timing for writing fill values to a dataset. This property is set in the dataset creation property list plist_id.

    Timing is specified in fill_time with one of the following values:
         H5D_FILL_TIME_IFSET   Write fill values to the dataset when storage space is allocated only if there is a user-defined fill value, i.e., one set with H5Pset_fill_value.   (Default)
      H5D_FILL_TIME_ALLOC Write fill values to the dataset when storage space is allocated.
      H5D_FILL_TIME_NEVER Never write fill values to the dataset.

    Note:
    H5Pset_fill_time is designed for coordination with the dataset fill value and dataset storage allocation time properties, set with the functions H5Pset_fill_value and H5Pset_alloc_time.

    See H5Dcreate for further cross-references.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_fill_time_f
    SUBROUTINE h5pset_fill_time_f(plist_id, flag, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: plist_id ! Dataset creation property
                                             ! list identifier
      INTEGER(HSIZE_T), INTENT(IN) :: flag   ! File time flag
                                             ! Possible values are:
                                             !    H5D_FILL_TIME_ERROR_F
                                             !    H5D_FILL_TIME_ALLOC_F
                                             !    H5D_FILL_TIME_NEVER_F
      INTEGER, INTENT(OUT)       :: hdferr   ! Error code
                                             ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_fill_time_f
    	
    History:

    Name: H5Pset_fill_value
    Signature:
    herr_t H5Pset_fill_value(hid_t plist_id, hid_t type_id, const void *value )
    Purpose:
    Sets the fill value for a dataset.
    Description:
    H5Pset_fill_value sets the fill value for a dataset in the dataset creation property list.

    value is interpreted as being of datatype type_id. This datatype may differ from that of the dataset, but the HDF5 library must be able to convert value to the dataset datatype when the dataset is created.

    The default fill value is 0 (zero), which is interpreted according to the actual dataset datatype.

    Setting value to NULL indicates that the fill value is to be undefined.

    Notes:
    Applications sometimes write data only to portions of an allocated dataset. It is often useful in such cases to fill the unused space with a known fill value. This function allows the user application to set that fill value; the functions H5Dfill and H5Pset_fill_time, respectively, provide the ability to apply the fill value on demand or to set up its automatic application.

    A fill value should be defined so that it is appropriate for the application. While the HDF5 default fill value is 0 (zero), it is often appropriate to use another value. It might be useful, for example, to use a value that is known to be impossible for the application to legitimately generate.

    H5Pset_fill_value is designed to work in concert with H5Pset_alloc_time and H5Pset_fill_time. H5Pset_alloc_time and H5Pset_fill_time govern the timing of dataset storage allocation and fill value write operations and can be important in tuning application performance.

    See H5Dcreate for further cross-references.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_fill_value_f
    SUBROUTINE h5pset_fill_value_f(prp_id, type_id, fillvalue, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier 
      INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier of fill
                                            ! value datatype (in memory)
      TYPE(VOID), INTENT(IN) :: fillvalue   ! Fillvalue
      INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                            ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_fill_value_f
    	

    Name: H5Pset_filter
    Signature:
    herr_t H5Pset_filter(hid_t plist, H5Z_filter_t filter_id, unsigned int flags, size_t cd_nelmts, const unsigned int cd_values[] )
    Purpose:
    Adds a filter to the filter pipeline.
    Description:
    H5Pset_filter adds the specified filter_id and corresponding properties to the end of an output filter pipeline. If plist is a dataset creation property list, the filter is added to the permanent filter pipeline; if plist is a dataset transfer property list, the filter is added to the transient filter pipeline.

    The array cd_values contains cd_nelmts integers which are auxiliary data for the filter. The integer values will be stored in the dataset object header as part of the filter information.

    The flags argument is a bit vector with the following fields specifying certain general properties of the filter:

    H5Z_FLAG_OPTIONAL   If this bit is set then the filter is optional. If the filter fails (see below) during an H5Dwrite operation then the filter is just excluded from the pipeline for the chunk for which it failed; the filter will not participate in the pipeline during an H5Dread of the chunk. This is commonly used for compression filters: if the filter result would be larger than the input, then the compression filter returns failure and the uncompressed data is stored in the file. If this bit is clear and a filter fails, then H5Dwrite or H5Dread also fails.

    This flag should not be set for the Fletcher32 checksum filter as it will bypass the checksum filter without reporting checksum errors to an application.

    The filter_id parameter specifies the filter to be set. Valid filter identifiers are as follows:

    H5Z_FILTER_DEFLATE Data compression filter, employing the gzip algorithm
    H5Z_FILTER_SHUFFLE Data shuffling filter
    H5Z_FILTER_FLETCHER32   Error detection filter, employing the Fletcher32 checksum algorithm
    H5Z_FILTER_SZIP Data compression filter, employing the SZIP algorithm

    Also see H5Pset_edc_check and H5Pset_filter_callback.

    Notes:
    This function currently supports only the permanent filter pipeline; plist must be a dataset creation property list.

    If multiple filters are set for a property list, they will be applied to each chunk in the order in which they were set.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_filter_f
    SUBROUTINE h5pset_filter_f(prp_id, filter, flags, cd_nelmts, cd_values,  hdferr)
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier
      INTEGER, INTENT(IN) :: filter         ! Filter to be added to the pipeline
      INTEGER, INTENT(IN) :: flags          ! Bit vector specifying certain 
                                            ! general properties of the filter
      INTEGER(SIZE_T), INTENT(IN) :: cd_nelmts        
                                            ! Number of elements in cd_values
      INTEGER, DIMENSION(*), INTENT(IN) :: cd_values  
                                            ! Auxiliary data for the filter
      INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                            ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_filter_f
    	
    History:

    Name: H5Pset_filter_callback
    Signature:
    herr_t H5Pset_filter_callback(hid_t plist, H5Z_filter_func_t func, void *op_data)
    Purpose:
    Sets user-defined filter callback function.
    Description:
    H5Pset_filter_callback sets the user-defined filter callback function func in the dataset transfer property list plist.

    The parameter op_data is a pointer to user-defined input data for the callback function and will be passed through to the callback function.

    The callback function func defines the actions an application is to take when a filter fails. The function prototype is as follows:

    typedef H5Z_cb_return_t (H5Z_filter_func_t) (H5Z_filter_t filter_id, void *buf, size_t buf_size, void *op_data)

    where filter_id indicates which filter has failed, buf and buf_size are used to pass in the failed data, and op_data is the required input data for this callback function.

    Valid callback function return values are H5Z_CB_FAIL and H5Z_CB_CONT.  

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface:
    None.
    History:

    Name: H5Pset_fletcher32
    Signature:
    herr_t H5Pset_fletcher32(hid_t plist)
    Purpose:
    Sets up use of the Fletcher32 checksum filter.
    Description:
    H5Pset_fletcher32 sets the Fletcher32 checksum filter in the dataset creation property list plist.  
    Note:
    The initial error detection implementation supports error detection for chunked datasets only.
    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_fletcher32_f
    SUBROUTINE h5pset_fletcher32_f(prp_id, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: prp_id  ! Dataset creation property list 
                                            ! identifier 
      INTEGER, INTENT(OUT)       :: hdferr  ! Error code
                                            ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_fletcher32_f
    	
    History:

    Name: H5Pset_gc_references
    Signature:
    herr_t H5Pset_gc_reference(hid_t plist, unsigned gc_ref )
    Purpose:
    Sets garbage collecting references flag.
    Description:
    H5Pset_gc_references sets the flag for garbage collecting references for the file.

    Dataset region references and other reference types use space in an HDF5 file's global heap. If garbage collection is on and the user passes in an uninitialized value in a reference structure, the heap might get corrupted. When garbage collection is off, however, and the user re-uses a reference, the previous heap block will be orphaned and not returned to the free heap space.

    When garbage collection is on, the user must initialize the reference structures to 0 or risk heap corruption.

    The default value for garbage collecting references is off.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_gc_references_f
    SUBROUTINE h5pset_gc_references_f (prp_id, gc_reference, hdferr)
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
      INTEGER, INTENT(IN) :: gc_reference  ! Flag for garbage collecting
                                           ! references for the file
      INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                           ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_gc_references_f
    	

    Name: H5Pset_hyper_vector_size
    Signature:
    herr_t H5Pset_hyper_vector_size(hid_t dxpl_id, size_t vector_size )
    Purpose:
    Sets number of I/O vectors to be read/written in hyperslab I/O.
    Description:
    H5Pset_hyper_vector_size 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.

    The I/O vectors are hyperslab offset and length pairs and are generated during hyperslab I/O.

    The number of I/O vectors is passed in vector_size to be set in the dataset transfer property list dxpl_id. vector_size must be greater than 1 (one).

    H5Pset_hyper_vector_size is an I/O optimization function; increasing vector_size should provide better performance, but the library will use more memory during hyperslab I/O. The default value of vector_size is 1024.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_hyper_vector_size_f
    SUBROUTINE h5pset_hyper_vector_size_f(plist_id, size, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: plist_id ! Dataset transfer property list 
                                             ! identifier
      INTEGER(SIZE_T), INTENT(IN) :: size    ! Vector size 
      INTEGER, INTENT(OUT)       :: hdferr   ! Error code
                                             ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_hyper_vector_size_f
    	
    History:

    Name: H5Pset_istore_k
    Signature:
    herr_t H5Pset_istore_k(hid_t plist, unsigned ik )
    Purpose:
    Sets the size of the parameter used to control the B-trees for indexing chunked datasets.
    Description:
    H5Pset_istore_k sets the size of the parameter used to control the B-trees for indexing chunked datasets. This function is only valid for file creation property lists.

    ik is one half the rank of a tree that stores chunked raw data. On average, such a tree will be 75% full, or have an average rank of 1.5 times the value of ik.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_istore_k_f
    SUBROUTINE h5pset_istore_k_f (prp_id, ik, hdferr)
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
      INTEGER, INTENT(IN) :: ik            ! 1/2 rank of chunked storage B-tree
      INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                           ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_istore_k_f
    	
    History:

    Name: H5Pset_layout
    Signature:
    herr_t H5Pset_layout(hid_t plist, H5D_layout_t layout )
    Purpose:
    Sets the type of storage used to store the raw data for a dataset.
    Description:
    H5Pset_layout sets the type of storage used to store the raw data for a dataset. This function is only valid for dataset creation property lists.

    Valid values for layout are:

    Note that a compact storage layout may affect writing data to the dataset with parallel applications. See note in H5Dwrite documentation for details.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_layout_f
    SUBROUTINE h5pset_layout_f (prp_id, layout, hdferr)
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
      INTEGER, INTENT(IN) :: layout        ! Type of storage layout for raw data
                                           ! Possible values are:
                                           !    H5D_COMPACT_F
                                           !    H5D_CONTIGUOUS_F
                                           !    H5D_CHUNKED_F
      INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                           ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_layout_f
    	

    Name: H5Pset_libver_bounds
    Signature:
    herr_t H5Pset_libver_bounds( hid_t fapl_id, H5_libver_t low, H5_libver_t high )

    Purpose:
    Sets bounds on library versions, and indirectly format versions, to be used when creating objects.

    Description:
    H5Pset_libver_bounds controls the versions of the object formats that will be used when creating objects in a file. The object format versions are determined indirectly from the HDF5 Library versions specified in the call.

    This property is set in the file access property list specified by fapl_id.

    Parameters:
    hid_t fapl_id IN: File access property list identifier
    H5_libver_t low     IN: The earliest version of the library that will be used for writing objects. The library version indirectly specifies the earliest object format version that can be used when creating objects in the file.

    Currently, low must be one of two pre-defined values:

    Setting low to HDF_LIBVER_EARLIEST will result in objects being created using the earliest possible format for each object. Note that earliest possible is different from earliest, as some features introduced in library versions later than 1.0.0 resulted in updates to object formats. With low=HDF_LIBVER_EARLIEST, if the application creates an object that requires a feature introduced in library versions later than 1.0.0, the earliest possible version that supports the requested feature will be used.

    The upper bound on the range of possible library versions used to create the object is controlled by the high parameter.

    This is the default behavior of the library if H5Pset_libver_bounds is not called.

    Setting low to HDF_LIBVER_LATEST will result in objects being created using the latest available format for each object. This setting means that objects will be created with the latest format versions avalable (within the range of library versions specified in the call), and can take advantage of the latest features and performance enhancements. Objects written with the HDF_LIBVER_LATEST setting for low may be accessible to a smaller range of library versions than would be the case if the HDF_LIBVER_EARLIEST value had been used.

    The upper bound on the range of possible library versions used to create the object is controlled by the high parameter.

    H5_libver_t high     IN: The latest version of the library that will be used for writing objects. The library version indirectly specifies the latest object format version that can be used when creating objects in the file.

    Currently, high must be set to the pre-defined value HDF_LIBVER_LATEST. HDF_LIBVER_LATEST corresponds to the version of the HDF5 Library in use.

    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.

    Fortran90 Interface:
    None.

    History:
    Release     C
    1.8.0 Function introduced in this release.

    Name: H5Pset_link_creation_order
    Signature:
    herr_t H5Pset_link_creation_order( hid_t gcpl_id, unsigned crt_order_flags )

    Purpose:
    Sets creation order tracking and indexing for links in a group.

    Description:
    H5Pset_link_creation_order sets flags in a group creation property list, gcpl_id, for tracking and/or indexing links on creation order.

    The following flags are passed in crt_order_flags:
         H5P_CRT_ORDER_TRACKED   Specifies to track creation order.
      H5P_CRT_ORDER_INDEXED Specifies to index links in the group on creation order.

    If only H5P_CRT_ORDER_TRACKED is set, HDF5 will track link creation order in any group created with the group creation property list gcpl_id. If both H5P_CRT_ORDER_TRACKED and H5P_CRT_ORDER_INDEXED are set, HDF5 will track link creation order in the group and index links on that property.

    Parameters:
    hid_t gcpl_id IN: Group creation property list identifier
    unsigned  crt_order_flags     IN: Creation order flag(s)
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.

    Fortran90 Interface:
    None.

    History:
    Release     C
    1.8.0 Function introduced in this release.

    Name: H5Pset_link_phase_change
    Signature:
    herr_t H5Pset_link_phase_change( hid_t gcpl_id, unsigned max_compact, unsigned min_dense )

    Purpose:
    Sets the parameters for conversion between compact and dense groups.

    Description:
    H5Pset_link_phase_change sets the maximum number of entries for a compact group and the minimum number of links to allow before converting a dense group to back to the compact format.

    max_compact is the maximum number of links to store as header messages in the group header as before converting the group to the dense format. Groups that are in compact format and in which the exceed this number of links rises above this threshold are automatically converted to dense format.

    min_dense is the minimum number of links to store in the dense format. Groups which are in dense format and in which the number of links falls below this theshold are automatically converted to compact format.

    See “Group styles in HDF5” in the H5G API introduction for a discussion of the available types of HDF5 group structures.

    Parameters:
    hid_t gcpl_id IN: Group creation property list identifier
    unsigned max_compact     IN: Maximum number of links for compact storage
    (Default: 8)
    unsigned min_dense IN: Minimum number of links for dense storage
    (Default: 6)
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.

    Fortran90 Interface:
    None.

    History:
    Release     C
    1.8.0 Function introduced in this release.

    Name: H5Pset_local_heap_size_hint
    Signature:
    herr_t H5Pset_local_heap_size_hint( hid_t gcpl_id, size_t size_hint )

    Purpose:
    Sets the local heap size hint for original-style groups.

    Description:
    H5Pset_local_heap_size_hint sets the local heap size hint, size_hint, in the group creation property list, gcpl_id, for original-style groups.

    The original style of HDF5 groups, the only style available prior to HDF5 Release 1.8.0, was well-suited for moderate-sized groups but was not optimized for either very small or very large groups. This style remains the default, but in HDF5 Release 1.8.0, two new grouping styles were introduced: compact groups to accomodate zero to small numbers of members and dense groups for thousands or tens of thousands of members (or millions, if that's what your application requires!).

    The local heap size hint, size_hint, is a performance tuning parameter for original-style groups. As indicated above, an HDF5 group may have zero, a handful, or tens of thousands of members. Since the original style of HDF5 groups stored the metadata for all of these group members in a uniform format in a local heap, the size of that metadata (and hence, the size of the local heap) could vary wildly from group to group. To intelligently allocate space and to avoid unnecessary fragmentation of the local heap, it can be valuable to provide the library with a hint as to its likely eventual size. This can be particularly valuable when it is known that a group will eventually have a great many members. It can also be useful in conserving space in a file when it is known that certain groups will never have any members.

    < < < Suggested values for size_hint? > > >

    Parameters:
    hid_t gcpl_id IN: Group creation property list identifier
    size_t size_hint     IN: Hint for size of local heap
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.

    Fortran90 Interface:
    None.

    History:
    Release     C
    1.8.0 Function introduced in this release.

    Name: H5Pset_mdc_config
    Signature:
    herr_t H5Pset_mdc_config(hid_t plist_id, H5AC_cache_config_t *config_ptr)
    Purpose:
    Set the initial metadata cache configuration in the indicated File Access Property List to the supplied value.
    Description:
    H5Pset_mdc_config attempts to set the initial metadata cache configuration to the supplied value. It will fail if an invalid configuration is detected. This configuration is used when the file is opened.

    See the overview of the metadata cache in the special topics section of the user manual for details on what is being configured. If you haven't read and understood that documentation, you really shouldn't be using this API call.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface:

    Name: H5Pset_meta_block_size
    Signature:
    herr_t H5Pset_meta_block_size( hid_t fapl_id, hsize_t size )
    Purpose:
    Sets the minimum metadata 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.

    Parameters:
    Returns:
    Returns a non-negative value if successful. Otherwise returns a negative value.
    Fortran90 Interface: h5pset_meta_block_size_f
    SUBROUTINE h5pset_meta_block_size_f(plist_id, size, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: plist_id ! File access property list 
                                             ! identifier
      INTEGER(HSIZE_T), INTENT(IN) :: size   ! Metadata block size
      INTEGER, INTENT(OUT)       :: hdferr   ! Error code
                                             ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_meta_block_size_f
    	
    History:

    Name: H5Pset_multi_type
    Signature:
    herr_t H5Pset_multi_type ( hid_t fapl_id, H5FD_mem_t type )
    Purpose:
    Sets type of data property for MULTI driver.
    Description:
    H5Pset_multi_type sets the type of data property in the file access property list fapl_id. This enables a user application to specify 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 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_SUPER Super block data
         H5FD_MEM_BTREE     B-tree data
      H5FD_MEM_DRAW Dataset raw data
      H5FD_MEM_GHEAP Global heap data
      H5FD_MEM_LHEAP Local Heap data
      H5FD_MEM_OHDR Object header data

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

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface:
    None.
    History:

    Name: H5Pset_nbit
    Signature:
    herr_t H5Pset_nbit(hid_t plist_id)
    Purpose:
    Sets up the use of the N-Bit filter.
    Description:
    H5Pset_nbit sets the N-Bit filter, H5Z_FILTER_NBIT, in the dataset creation property list plist_id.

    The HDF5 user can create an N-Bit datatype by writing codes like:

    In memory, one value of the N-Bit datatype in the above example will be stored on a little-endian machine like this:

    byte 3 byte 2 byte 1 byte 0
    ???????? ????SPPP PPPPPPPP PPPP????

    Note: S - sign bit, P - significant bit, ? - padding bit; For signed integer, the sign bit is included in the precision.

    When data of the above datatype are stored on disk using N-bit filter, all padding bits are chopped off and only significant bits are stored. So, the values on disk will be something like:

    1st value 2nd value  
    SPPPPPPPPPPPPPPP SPPPPPPPPPPPPPPP ...

    The N-Bit filter is used effectively for compressing data of an N-Bit datatype as well as a compound and an array datatype with N-Bit fields. However, the datatype classes of the N-Bit datatype or the N-Bit field of the compound datatype or the array datatype are limited to integer or floating-point.

    The N-Bit filter supports complex situations where a compound datatype contains member(s) of compound datatype or an array datatype that has compound datatype as the base type. However, it does not support the situation where an array datatype has variable-length or variable-length string as its base datatype. But the filter does support the situation where variable-length or variable-length string is a member of a compound datatype.

    For all other HDF5 datatypes such as time, string, bitfield, opaque, reference, enum, and variable length, the N-Bit filter allows them to pass through like an no-op.

    Like other I/O filters supported by the HDF5 library, application using the N-Bit filter must store data with chunked storage.

    By nature, the N-Bit filter should not be used together with other I/O filters.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface:
    None.

    Name: H5Pset_nlinks
    Signature:
    herr_t H5Pset_nlinks( hid_t lapl_id, size_t nlinks )

    Purpose:
    Sets maximum number of soft or user-defined link traversals.

    Description:
    H5Pset_nlinks sets the maximum number of soft or user-defined link traversals allowed, nlinks, before the library assumes it has found a cycle and aborts the traversal. This value is set in the link access property list lapl_id.

    The limit on the number soft or user-defined link traversals is designed to terminate link traversal if one or more links form a cycle. User control is provided because some files may have legitimate paths formed of large numbers of soft or user-defined links. This property can be used to allow traversal of as many links as desired.

    Parameters:
    hid_t lapl_id IN: File access property list identifier
    size_t nlinks     IN: Maximum number of links to traverse

    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.

    Fortran90 Interface:
    None.

    History:
    Release     C
    1.8.0 Function introduced in this release.

    Name: H5Pset_preserve
    Signature:
    herr_t H5Pset_preserve(hid_t plist, hbool_t status )
    Purpose:
    Sets the dataset transfer property list status to TRUE or FALSE.
    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.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_preserve_f
    SUBROUTINE h5pset_preserve_f(prp_id, flag, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: prp_id   ! Dataset transfer property 
                                             ! list identifier 
      LOGICAL, INTENT(IN)        :: flag     ! Status for the dataset 
                                             ! transfer property list 
      INTEGER, INTENT(OUT)       :: hdferr   ! Error code
                                             ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_preserve_f
    	
    History:

    Name: H5Pset_scaleoffset
    Signature:
    herr_t H5Pset_scaleoffset(hid_t plist_id, H5Z_SO_scale_type_t scale_type, int scale_factor)
    Purpose:
    Sets up the use of the Scale-Offset filter.
    Description:
    H5Pset_scaleoffset sets the Scale-Offset filter, H5Z_FILTER_SCALEOFFSET, for a dataset.

    Generally speaking, Scale-Offset compression performs a scale and/or offset operation on each data value and truncates the resulting value to a minimum number of bits (MinBits) before storing it. The current Scale-Offset filter supports integer and floating-point datatype.

    For integer datatype, the parameter scale_type should be set to H5Z_SO_INT (2). The parameter scale_factor denotes MinBits. If the user sets it to H5Z_SO_INT_MINBITS_DEFAULT (0) or less than 0, the filter will calculate MinBits. If scale_factor is set to a positive integer, the filter does not do any calculation and just uses the number as MinBits. However, if the user gives a MinBits that is less than what would be generated by the filter, the compression will be lossy. Also, the MinBits supplied by the user cannot exceed the number of bits to store one value of the dataset datatype.

    For floating-point datatype, the filter adopts the GRiB data packing mechanism, which offers two alternate methods: E-scaling and D-scaling. Both methods are lossy compression. If the parameter scale_type is set to H5Z_SO_FLOAT_DSCALE (0), the filter will use the D-scaling method; if it is set to H5Z_SO_FLOAT_ESCALE (1), the filter will use the E-scaling method. Since only the D-scaling method is implemented, scale_type should be set to H5Z_SO_FLOAT_DSCALE or 0.

    When the D-scaling method is used, the original data is "D" scaled--multiplied by 10 to the power of scale_factor, and the "significant" part of the value is moved to the left of the decimal point. Care should be taken in setting the decimal scale_factor so that the integer part will have enough precision to contain the appropriate information of the data value. For example, if scale_factor is set to 2, the number 104.561 will be 10456.1 after "D" scaling. The last digit 1 is not "significant" and is thrown off in the process of rounding. The user should make sure that after "D" scaling and rounding, the data values are within the range that can be represented by the integer (same size as the floating-point type).

    Valid values for scale_type are as follows:
    H5Z_SO_FLOAT_DSCALE (0)     Floating-point type, using variable MinBits method
    H5Z_SO_FLOAT_ESCALE (1)     Floating-point type, using fixed MinBits method
    H5Z_SO_INT (2) Integer type

    The meaning of scale_factor varies according to the value assigned to scale_type:
    scale_type value scale_factor description
    H5Z_SO_FLOAT_DSCALE     Denotes the decimal scale factor for D-scaling and can be positive, negative or zero. This is the current implementation of the library.
    H5Z_SO_FLOAT_ESCALE     Denotes MinBits for E-scaling and must be a positive integer. This is not currently implemented by the library.
    H5Z_SO_INT Denotes MinBits and it should be a positive integer or H5Z_SO_INT_MINBITS_DEFAULT (0). If it is less than 0, the library will reset it to 0 since it is not implemented.

    Like other I/O filters supported by the HDF5 library, application using the Scale-Offset filter must store data with chunked storage.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface:
    None.

    Name: H5Pset_shared_mesg_index
    Signature:
    herr_t H5Pset_shared_mesg_index( hid_t fcpl_id, unsigned index_num, unsigned mesg_type_flags, unsigned min_mesg_size )

    Purpose:
    Configures the specified shared object header message index.

    Description:
    H5Pset_shared_mesg_index is used to configure the specified shared object header message index, setting the types of messages that may be stored in the index and the minimum size of each message.

    fcpl_id specifies the file creation property list.

    index_num specifies the index to be configured. index_num is zero-indexed, so in a file with three indexes, they will be numbered 0, 1, and 2.

    mesg_type_flags and min_mesg_size specify, respectively, the types and minimum size of messages that can be stored in this index.

    Valid message types are as follows:
         H5O_SHMESG_NONE_FLAG No shared messages
         H5O_SHMESG_SDSPACE_FLAG     Simple dataspace message
         H5O_SHMESG_DTYPE_FLAG Datatype message
         H5O_SHMESG_FILL_FLAG Fill value message
         H5O_SHMESG_PLINE_FLAG Filter pipeline message
         H5O_SHMESG_ATTR_FLAG Attribute message
         H5O_SHMESG_ALL_FLAG All message types; i.e., equivalent to the following:
    (H5O_SHMESG_SDSPACE_FLAG | H5O_SHMESG_DTYPE_FLAG | H5O_SHMESG_FILL_FLAG | H5O_SHMESG_PLINE_FLAG | H5O_SHMESG_ATTR_FLAG)

    Parameters:
    hid_t fcpl_id IN: File creation property list identifier.
    unsigned index_num IN: Index being configured.
    unsigned mesg_type_flags     IN: Types of messages that should be stored in this index.
    unsigned min_mesg_size IN: Minimum message size.

    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.

    Fortran90 Interface:
    None.

    History:
    Release     C
    1.8.0 Function introduced in this release.

    Name: H5Pset_shared_mesg_nindexes
    Signature:
    herr_t H5Pset_shared_mesg_nindexes( hid_t plist_id, unsigned nindexes )

    Purpose:
    Sets number of shared object header message indexes.

    Description:
    H5Pset_shared_mesg_nindexes sets the number of shared object header message indexes in the specified file creation property list.

    This setting determines the number of shared object header message indexes that will be available in files created with this property list. These indexes can then be configured with H5Pset_shared_mesg_index.

    If nindexes is set to 0 (zero), shared object header messages are disabled in files created with this property list.

    Parameters:
    hid_t plist_id IN: File creation property list
    unsigned nindexes     IN: Number of shared object header message indexes to be available in files created with this property list

    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.

    Fortran90 Interface:
    None.

    History:
    Release     C
    1.8.0 Function introduced in this release.

    Name: H5Pset_shared_mesg_phase_change
    Signature:
    herr_t H5Pset_shared_mesg_phase_change( hid_t fcpl_id, unsigned max_list, unsigned min_btree )

    Purpose:
    Sets shared object header message storage phase change thresholds.

    Description:
    H5Pset_shared_mesg_phase_change sets threshold values for storage of shared object header message indexes in a file. These phase change thresholds determine the point at which the index storage mechanism changes from a more compact list format to a more performance-oriented B-tree format, and vice-versa.

    By default, a shared object header message index is initially stored as a compact list. When the number of messages in an index exceeds the threshold value of max_list, storage switches to a B-tree for impoved performance. If the number of messages subsequently falls below the min_btree threshold, the index will revert to the list format.

    If max_compact is set to 0 (zero), shared object header message indexes in the file will be created as B-trees and will never revert to lists.

    fcpl_id specifies the file creation property list.

    Parameters:
    hid_t fcpl_id IN: File creation property list identifier
    unsigned max_list IN: Threshold above which storage of a shared object header message index shifts from list to B-tree
    unsigned min_btree     IN: Threshold below which storage of a shared object header message index reverts to list format

    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.

    Fortran90 Interface:
    None.

    History:
    Release     C
    1.8.0 Function introduced in this release.

    Name: H5Pset_shuffle
    Signature:
    herr_t H5Pset_shuffle(hid_t plist_id)
    Purpose:
    Sets up use of the shuffle filter.
    Description:
    H5Pset_shuffle sets the shuffle filter, H5Z_FILTER_SHUFFLE, in the dataset creation property list plist_id.  

    The shuffle filter de-interlaces 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 a second block; etc. For example, given three data elements of a 4-byte datatype stored as 012301230123, shuffling will re-order data as 000111222333. This can be a valuable step in an effective compression algorithm because the bytes in each byte position are often closely related to each other and putting them together can increase the compression ratio.

    As implied above, the primary value of the shuffle filter lies in its coordinated use with a compression filter; it does not provide data compression when used alone. When the shuffle filter is applied to a dataset immediately prior to the use of a compression filter, the compression ratio achieved is often superior to that achieved by the use of a compression filter without the shuffle filter.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_shuffle_f
    SUBROUTINE h5pset_shuffle_f(prp_id, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: prp_id      ! Property list identifier 
      INTEGER, INTENT(OUT)       :: hdferr      ! Error code
                                                ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_shuffle_f
    	
    History:

    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:
    Returns:
    Returns a non-negative value if successful. Otherwise returns a negative value.
    Fortran90 Interface: h5pset_sieve_buf_size_f
    SUBROUTINE h5pset_sieve_buf_size_f(plist_id, size, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: plist_id ! File access property list 
                                             ! identifier
      INTEGER(SIZE_T), INTENT(IN) :: size    ! Sieve buffer size 
      INTEGER, INTENT(OUT)       :: hdferr   ! Error code
                                             ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_sieve_buf_size_f
    	
    History:

    Name: H5Pset_sizes
    Signature:
    herr_t H5Pset_sizes(hid_t plist, size_t sizeof_addr, size_t sizeof_size )
    Purpose:
    Sets the byte size of the offsets and lengths used to address objects in an HDF5 file.
    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 the same as sizeof(hsize_t) in the library (normally 8 bytes). Valid values currently are 2, 4, 8 and 16.
    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_sizes_f
    SUBROUTINE h5pset_sizes_f (prp_id, sizeof_addr, sizeof_size, hdferr)
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: prp_id       ! Property list identifier
      INTEGER(SIZE_T), INTENT(IN) :: sizeof_addr ! Size of an object offset 
                                                 ! in bytes
      INTEGER(SIZE_T), INTENT(IN) :: sizeof_size ! Size of an object length 
                                                 ! in bytes
      INTEGER, INTENT(OUT) :: hdferr             ! Error code
                                                 ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_sizes_f
    	

    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 I/O 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 I/O 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:
    Returns:
    Returns a non-negative value if successful; otherwise a negative value.
    Fortran90 Interface: h5pset_small_data_block_size_f
    SUBROUTINE h5pset_small_data_block_size_f(plist_id, size, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: plist_id ! File access
                                             ! property list identifier
      INTEGER(HSIZE_T), INTENT(IN) :: size   ! Small raw data block size
      INTEGER, INTENT(OUT)       :: hdferr   ! Error code
                                             ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_small_data_block_size_f
    	
    History:

    Name: H5Pset_sym_k
    Signature:
    herr_t H5Pset_sym_k(hid_t plist, unsigned ik, unsigned 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:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_sym_k_f
    SUBROUTINE h5pset_sym_k_f (prp_id, ik, lk, hdferr)
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier
      INTEGER, INTENT(IN) :: ik            ! Symbol table tree rank
      INTEGER, INTENT(IN) :: lk            ! Symbol table node size
      INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                           ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_sym_k_f
    	
    History:

    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 an SZIP compression filter, H5Z_FILTER_SZIP, for a dataset. SZIP is a compression method designed for use with scientific data.

    Before proceeding, be aware that there are factors that affect your rights and ability to use SZIP compression. See the documents at SZIP Compression in HDF5 for important information regarding terms of use and the SZIP copyright notice, for further discussion of SZIP compression in HDF5, and for a list of SZIP-related references.

    In the text below, the term pixel refers to an HDF5 data element. This terminology derives from SZIP compression's use with image data, where pixel referred to an image pixel.

    The SZIP bits_per_pixel value (see Notes, below) is automatically set, based on the HDF5 datatype. SZIP can be used with atomic datatypes that may have size of 8, 16, 32, or 64 bits. Specifically, a dataset with a datatype that is 8-, 16-, 32-, or 64-bit signed or unsigned integer; char; or 32- or 64-bit float can be compressed with SZIP. See Notes, below, for further discussion of the the SZIP bits_per_pixel setting.

    SZIP compression cannot be applied to compound datatypes, array datatypes, variable-length datatypes, enumerations, or any other user-defined datatypes. If an SZIP filter is set up for a dataset containing a non-allowed datatype, H5Pset_szip will succeed but the subsequent call to H5Dcreate will fail; the conflict is detected only when the property list is used.

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


    Option

    Description
    (Mutually exclusive; select one.)

    H5_SZIP_EC_OPTION_MASK  

    Selects entropy coding method.
    H5_SZIP_NN_OPTION_MASK Selects nearest neighbor coding method.


    The following guidelines can be used in determining which option to select: Other factors may affect results, but the above criteria provides a good starting point for optimizing data compression.

    SZIP compresses data block by block, with a user-tunable block size. This block size is passed in the parameter pixels_per_block and must be even and not greater than 32, with typical values being 8, 10, 16, or 32. This parameter affects compression ratio; the more pixel values vary, the smaller this number should be to achieve better performance.

    In HDF5, compression can be applied only to chunked datasets. If pixels_per_block is bigger than the total number of elements in a dataset chunk, H5Pset_szip will succeed but the subsequent call to H5Dcreate will fail; the conflict is detected only when the property list is used.

    To achieve optimal performance for SZIP compression, it is recommended that a chunk's fastest-changing dimension be equal to N times pixels_per_block where N is the maximum number of blocks per scan line allowed by the SZIP library. In the current version of SZIP, N is set to 128.

    H5Pset_szip will fail if SZIP encoding is disabled in the available copy of the SZIP library. H5Zget_filter_info can be employed to avoid such a failure.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Notes:
    The following notes are of interest primarily to those who have used SZIP compression outside of the HDF5 context.

    In non-HDF5 applications, SZIP typically requires that the user application supply additional parameters:

    These values need not be independently supplied in the HDF5 environment as they are derived from the datatype and dataspace, which are already known. In particular, HDF5 sets pixels_in_object to the number of elements in a chunk and bits_per_pixel to the size of the element or pixel datatype. The following algorithm is used to set pixels_per_scanline:

    The HDF5 datatype may have precision that is less than the full size of the data element, e.g., an 11-bit integer can be defined using H5Tset_precision. To a certain extent, SZIP can take advantage of the precision of the datatype to improve compression:

    HDF5 always modifies the options mask provided by the user to set up usage of RAW_OPTION_MASK, ALLOW_K13_OPTION_MASK, and one of LSB_OPTION_MASK or MSB_OPTION_MASK, depending on endianness of the datatype.

    Fortran90 Interface: h5pset_szip_f
    SUBROUTINE h5pset_szip_f(prp_id, hdferr) 
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: prp_id     
                                       ! Dataset creation property list identifier 
      INTEGER, INTENT(IN) :: options_mask      
                                       ! A bit-mask conveying the desired
                                       ! SZIP options
                                       ! Current valid values in Fortran are:
                                       !    H5_SZIP_EC_OM_F
                                       !    H5_SZIP_NN_OM_F
      INTEGER, INTENT(IN) :: pixels_per_block  
                                       ! The number of pixels or data elements 
                                       ! in each data block
      INTEGER, INTENT(OUT)  :: hdferr  ! Error code
                                       ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_szip_f
    	
    History:

    Name: H5Pset_type_conv_cb
    Signature:
    herr_t H5Pset_type_conv_cb(hid_t plist, H5T_conv_except_func_t func, void *op_data)
    Purpose:
    Sets user-defined data type conversion callback function.
    Description:
    H5Pset_type_conv_cb sets the user-defined data type conversion callback function func in the dataset transfer property list plist.

    The parameter op_data is a pointer to user-defined input data for the callback function and will be passed through to the callback function.

    The callback function func defines the actions an application is to take when there is an exception during data type conversion. The function prototype is as follows:

    where except_type indicates what kind of exception has happened, src_id and dst_id are the source and destination data type IDs, src_buf and dst_buf are the source and destination data buffer, and op_data is the required input data for this callback function.

    Valid values for except_type are,

    Valid callback function return values are H5T_CONV_ABORT, H5T_CONV_UNHANDLED and H5T_CONV_HANDLED.

    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface:
    None.

    Name: H5Pset_userblock
    Signature:
    herr_t H5Pset_userblock(hid_t plist, hsize_t size )
    Purpose:
    Sets user 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.).
    Parameters:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface: h5pset_userblock_f
    SUBROUTINE h5pset_userblock_f (prp_id, size, hdferr)
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: prp_id  ! Property list identifier
      INTEGER(HSIZE_T), INTENT(IN) :: size  ! Size of the user-block in bytes
      INTEGER, INTENT(OUT) :: hdferr        ! Error code
                                            ! 0 on success and -1 on failure
    END SUBROUTINE h5pset_userblock_f
    	

    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:
    Returns:
    Returns a non-negative value if successful; otherwise returns a negative value.
    Fortran90 Interface:
    None.

    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:
    Returns:
    Success: a non-negative value
    Failure: a negative value
    Fortran90 Interface: h5punregister_f
    SUBROUTINE h5punregister_f(class, name, hdferr)
      IMPLICIT NONE
      INTEGER(HID_T), INTENT(IN) :: class  ! Property list class identifier
      CHARACTER(LEN=*), INTENT(IN) :: name ! Name of property to remove
      INTEGER, INTENT(OUT) :: hdferr       ! Error code
                                           ! 0 on success and -1 on failure
    END SUBROUTINE h5punregister_f
    	

    HDF5 documents and links 
    Introduction to HDF5 
    HDF5 User Guide 
    And in this document, the HDF5 Reference Manual 
    H5DS   H5IM   H5LT   H5PT   H5TB 
    H5   H5A   H5D   H5E   H5F   H5G   H5I 
    H5L   H5O   H5P   H5R   H5S   H5T   H5Z 
    Tools   Datatypes   Fortran   Compatibility Macros  

    THG Help Desk:
    Describes HDF5 Release 1.8.0, January 2008.