API: Encodings

Table of Contents HPDF_Encoder_GetType() HPDF_Encoder_GetByteType() HPDF_Encoder_GetUnicode() HPDF_Encoder_GetWritingMode()

HPDF_Encoder_GetType()

HPDF_EncoderType HPDF_Encoder_GetType (HPDF_Encoder encoder);

Description

HPDF_Encoder_GetType() gets the type of an encoding object.

Parameters

encoder - The handle of an encoding object.

Returns

HPDF_Encoder_GetType() returns one of the following values.

Value	Description
HPDF_ENCODER_TYPE_SINGLE_BYTE	This encoder is an encoder for single byte characters.
HPDF_ENCODER_TYPE_DOUBLE_BYTE	This encoder is an encoder for multi byte characters.
HPDF_ENCODER_TYPE_UNINITIALIZED	This encoder is uninitialized. (May be it is an encoder for multi byte characters.)
HPDF_ENCODER_UNKNOWN	Invalid encoder.

HPDF_Encoder_GetByteType()

HPDF_ByteType HPDF_Encoder_GetByteType  (HPDF_Encoder    encoder,
                                         const char     *text,
                                         HPDF_UINT       index);

Description

HPDF_Encoder_GetByteType() returns the type of byte in the text at position index.

Parameters

encoder - The handle of an encoding object.

Returns

HPDF_Encoder_GetByteType() returns one of the following values.

Value	Description
HPDF_BYTE_TYPE_SINGLE	Single byte character.
HPDF_BYTE_TYPE_LEAD	Lead byte of a double-byte character.
HPDF_BYTE_TYPE_TRIAL	Trailing byte of a double-byte character.
HPDF_BYTE_TYPE_UNKNOWN	Invalid encoder or cannot judge the byte type.

HPDF_Encoder_GetUnicode()

HPDF_UNICODE HPDF_Encoder_GetUnicode  (HPDF_Encoder   encoder,
                                       HPDF_UINT16    code);

Description

HPDF_Encoder_GetUnicode() converts a specified character code to unicode.

Parameters

encoder - The handle of an encoding object.
code - A character code to convert.

Returns

HPDF_Encoder_GetUnicode() returns one of the following values.

HPDF_Encoder_GetWritingMode()

HPDF_WritingMode HPDF_Encoder_GetWritingMode (HPDF_Encoder encoder);

Description

HPDF_Encoder_GetWritingMode() returns the writing mode for the encoding object.

Parameters

encoder - The handle of an encoding object.

Returns

HPDF_Encoder_GetWritingMode() returns one of the following values.

Value	Description
HPDF_WMODE_HORIZONTAL	horizontal writing mode
HPDF_WMODE_VERTICAL	vertical writing mode