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, H5