HDF5  1.13.0
Functions
General Property List Operations
H5P

Functions

herr_t H5Pclose (hid_t plist_id)
 Terminates access to a property list. More...
 
hid_t H5Pcopy (hid_t plist_id)
 Copies an existing property list to create a new property list. More...
 
hid_t H5Pcreate (hid_t cls_id)
 Creates a new property list as an instance of a property list class. More...
 

Detailed Description

Function Documentation

◆ H5Pclose()

herr_t H5Pclose ( hid_t  plist_id)

Terminates access to a property list.

Parameters
[in]plist_idProperty list identifier
Returns
Returns a non-negative value if successful; otherwise returns a negative value.

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.

Since
1.0.0

◆ H5Pcopy()

hid_t H5Pcopy ( hid_t  plist_id)

Copies an existing property list to create a new property list.

Parameters
[in]plist_idProperty list identifier
Returns
Returns a property list identifier if successful; otherwise returns H5I_INVALID_HID.

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.

Since
1.0.0

◆ H5Pcreate()

hid_t H5Pcreate ( hid_t  cls_id)

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

Parameters
[in]cls_idThe class of the property list to create.
Returns
Returns a property list identifier if successful; otherwise returns H5I_INVALID_HID.

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:

Class Identifier 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
H5P_VOL_INITIALIZE vol initialize Properties for VOL initialization

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

Version
1.12.0 The H5P_VOL_INITIALIZE property list class was added
1.8.15 For each class, the class name returned by H5Pget_class_name() was added. The list of possible Fortran values was updated.
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
Since
1.0.0