Last modified: 20 March 2012
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:
H5P_OBJECT_CREATE
Properties for object creation
H5P_FILE_CREATE
Properties for file creation
H5P_FILE_ACCESS
Properties for file access
H5P_DATASET_CREATE
Properties for dataset creation
H5P_DATASET_ACCESS
Properties for dataset access
H5P_DATASET_XFER
Properties for raw data transfer
H5P_FILE_MOUNT
Properties for file mounting
H5P_GROUP_CREATE
Properties for group creation
H5P_GROUP_ACCESS
Properties for group access
H5P_DATATYPE_CREATE
Properties for datatype creation
H5P_DATATYPE_ACCESS
Properties for datatype access
H5P_STRING_CREATE
Properties for character encoding when encoding strings or object names
H5P_ATTRIBUTE_CREATE
Properties for attribute creation
H5P_OBJECT_COPY
Properties governing the object copying process
H5P_LINK_CREATE
Properties governing link creation
H5P_LINK_ACCESS
Properties governing link traversal when accessing objects

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.

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
    

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