Last modified: 7 April 2015

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.

H5Pget_class_name
Returns this Class Name (Class Identifier)
Property List
Class
Expanded Name of the
Property List Class
The Class Identifier Used
with H5Pcreate
Comments
attribute create acpl Attribute Creation Property List H5P_ATTRIBUTE_CREATE  
dataset access dapl Dataset Access Property List H5P_DATASET_ACCESS  
dataset create dcpl Dataset Creation Property List H5P_DATASET_CREATE  
data transfer dxpl Data Transfer Property List H5P_DATASET_XFER  
datatype access     H5P_DATATYPE_ACCESS This class can be created, but there
are no properties in the class currently.
datatype create     H5P_DATATYPE_CREATE This class can be created, but there
are no properties in the class currently.
file access fapl File Access Property List H5P_FILE_ACCESS  
file create fcpl File Creation Property List H5P_FILE_CREATE  
file mount fmpl File Mount Property List H5P_FILE_MOUNT  
group access     H5P_GROUP_ACCESS This class can be created, but there
are no properties in the class currently.
group create gcpl Group Creation Property List H5P_GROUP_CREATE  
link access lapl Link Access Property List H5P_LINK_ACCESS  
link create lcpl Link Creation Property List H5P_LINK_CREATE  
object copy ocpypl Object Copy Property List H5P_OBJECT_COPY  
object create ocpl Object Creation Property List H5P_OBJECT_CREATE  
string create strcpl String Creation Property List H5P_STRING_CREATE  

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, size, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: prp_id     ! Property list identifier to
                                           ! query
  INTEGER, INTENT(OUT) :: size             ! Actual length of the class name
                                           !  NOTE: If provided buffer "name" is smaller,
                                           !  than name will be truncated to fit into
                                           !  provided user buffer.
  CHARACTER(LEN=*), INTENT(INOUT) :: name  ! Buffer to retrieve class name
  INTEGER, INTENT(OUT) :: hdferr           ! Error code
                                           ! 0 on success and -1 on failure
END SUBROUTINE h5pget_class_name_f
	
See Also:
H5Pcreate

History:
Release Change
1.8.15 Fortran subroutine was updated.
Class name table was added to the Description.