Last modified: 25 June 2013
Name: H5Pset_char_encoding
Signature:
herr_t H5Pset_char_encoding( hid_t plist_id, H5T_cset_t encoding )

Purpose:
Sets the character encoding used to encode link and attribute names.

Description:
H5Pset_char_encoding sets the character encoding used for the names of objects, links, and attributes created with the property list plist_id.

Valid values for encoding include the following:
     H5T_CSET_ASCII US ASCII
     H5T_CSET_UTF8     UTF-8 Unicode

For example, if the character set for the property list plist_id is set to H5T_CSET_UTF8, link names pointing to objects created with plist_id will be encoded using the UTF-8 Unicode character set. Similarly, names of links or attributes created with plist_id will be encoded as UTF-8 Unicode.

Note that H5Pset_char_encoding sets the character set used for an HDF5 link or attribute name while H5Tset_cset sets the character set used in a character or string datatype.

Parameters:
hid_t plist_id IN: Property list identifier
H5T_cset_t encoding     IN: String encoding character set

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

Fortran90 Interface: h5pset_char_encoding_f
SUBROUTINE h5pset_char_encoding_f(plist_id, encoding, hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: plist_id
                                  ! Property list identifier
  INTEGER, INTENT(IN) :: encoding ! String encoding character set:
                                  !   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 h5pset_char_encoding_f
    

History:
Release     C
1.8.0 Function introduced in this release.