Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5P_GET_CHAR_ENCODING

Retrieves the character encoding used to create a link or attribute name

Procedure:

H5P_GET_CHAR_ENCODING ( plist_id, encoding )

Signature:

herr_t H5Pget_char_encoding(
            hid_t plist_id,
            H5T_cset_t* encoding
        )

  

Fortran90 Interface: h5get_char_encoding_f

SUBROUTINE h5pget_char_encoding_f(plist_id, encoding, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: plist_id 
                                   ! Property list identifier
  INTEGER, INTENT(OUT) :: encoding ! Valid values for encoding are:
                                   !  H5T_CSET_ASCII_F -> US ASCII
                                   !  H5T_CSET_UTF8_F -> UTF-8 Unicode encoding
  INTEGER, INTENT(OUT) :: hdferr   ! Error code:
                                   ! 0 on success and -1 on failure
END SUBROUTINE h5pget_char_encoding_f
        


  

Parameters:
hid_t plist_idIN: Link creation or attribute creation property list identifier
H5T_cset_t encoding    OUT: String encoding character set

Description:

H5P_GET_CHAR_ENCODING retrieves the character encoding used to encode link or attribute 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_ASCIIUS ASCII
H5T_CSET_UTF8    UTF-8 Unicode encoding

Note that H5P_GET_CHAR_ENCODING retrieves the character set used for an HDF5 link or attribute name while H5T_GET_CSET retrieves the character set used in a character or string datatype.

See Also:

Returns:

Returns a non-negative value if successful; otherwise returns a negative value.

Example:

Coming Soon!

History:
Release    C
1.8.0Function introduced in this release.

--- Last Modified: November 28, 2018 | 09:03 AM