Last modified: 8 April 2015
Name: H5Pcreate

Signature:
hid_t H5Pcreate( hid_t cls_id )

Purpose:
Creates a new property list as an instance of a property list class.

Description:
H5Pcreate creates a new property list as an instance of some property list class. The new property list is initialized with default values for the specified class. The classes are as follows; see the function index at the top of this page for a list of functions related to each class:

H5Pcreate Class Identifier H5Pget_class_name Class Name Comments
H5P_ATTRIBUTE_CREATE attribute create Properties for attribute creation
H5P_DATASET_ACCESS dataset access Properties for dataset access
H5P_DATASET_CREATE dataset create Properties for dataset creation
H5P_DATASET_XFER data transfer Properties for raw data transfer
H5P_DATATYPE_ACCESS datatype access Properties for datatype access
H5P_DATATYPE_CREATE datatype create Properties for datatype creation
H5P_FILE_ACCESS file access Properties for file access
H5P_FILE_CREATE file create Properties for file creation
H5P_FILE_MOUNT file mount Properties for file mounting
H5P_GROUP_ACCESS group access Properties for group access
H5P_GROUP_CREATE group create Properties for group creation
H5P_LINK_ACCESS link access Properties governing link traversal when accessing objects
H5P_LINK_CREATE link create Properties governing link creation
H5P_OBJECT_COPY object copy Properties governing the object copying process
H5P_OBJECT_CREATE object create Properties for object creation
H5P_STRING_CREATE string create Properties for character encoding when encoding strings or object names

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


Parameters:
hid_t cls_id     IN: The class of the property list to create. Valid values are listed in the “Description” above.

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_ATTRIBUTE_CREATE_F
                                         !    H5P_DATASET_ACCESS_F
                                         !    H5P_DATASET_CREATE_F
                                         !    H5P_DATASET_XFER_F
                                         !    H5P_DATATYPE_ACCESS_F
                                         !    H5P_DATATYPE_CREATE_F
                                         !    H5P_FILE_ACCESS_F
                                         !    H5P_FILE_CREATE_F
                                         !    H5P_FILE_MOUNT_F
                                         !    H5P_GROUP_ACCESS_F
                                         !    H5P_GROUP_CREATE_F
                                         !    H5P_LINK_ACCESS_F
                                         !    H5P_LINK_CREATE_F
                                         !    H5P_OBJECT_COPY_F
                                         !    H5P_OBJECT_CREATE_F
                                         !    H5P_STRING_CREATE_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
    
See Also:
H5Pget_class_name
“Using Identifiers”

History:
Release     Change
1.8.0 The following property list classes were added at this release:
        H5P_DATASET_ACCESS 
        H5P_GROUP_CREATE 
        H5P_GROUP_ACCESS 
        H5P_DATATYPE_CREATE 
        H5P_DATATYPE_ACCESS 
        H5P_ATTRIBUTE_CREATE                   
1.8.15 For each class, the class name returned by H5Pget_class_name was added.
The list of possible Fortran values was updated.