Last modified: 24 June 2013
Name: H5Tset_cset
Signature:
herr_t H5Tset_cset( hid_t dtype_id, H5T_cset_t cset )

Purpose:
Sets character set to be used in a string or character datatype.

Description:
H5Tset_cset sets the character set to be used in a dataset with a string or character datatype.

Valid values for cset include the following:
         H5T_CSET_ASCII      Character set is US ASCII.
  H5T_CSET_UTF8   Character set is UTF-8, enabling UTF-8 Unicode encoding.

For example, if the character set for the datatype dtype_id is set to H5T_CSET_UTF8, string or character data of datatype dtype_id will be encoded using the UTF-8 Unicode character set.

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

Parameters:
hid_t dtype_id IN: Identifier of datatype to modify.
H5T_cset_t cset     IN: Character set type.

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

Fortran90 Interface: h5tset_cset_f
SUBROUTINE h5tset_cset_f(type_id, cset, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: type_id 
                                  ! Datatype identifier 
  INTEGER, INTENT(IN) :: cset     ! Character set type of a string datatype  
                                  ! Possible values are:
                                  !    H5T_CSET_ASCII_F = 0
                                  !    H5T_CSET_UTF8_F = 1
  INTEGER, INTENT(OUT) :: hdferr  ! Error code
END SUBROUTINE h5tset_cset_f
    

History:
Release     Change
1.8.0 UTF-8 Unicode encoding introduced in this release.