DL Logo

PDSysEncoding Typedefs

PDSysEncoding

Header: PEExpT.h:399

Description

A PDEElement that provides system encoding for a PDF file.

Related Methods

Syntax

typedef struct _t_PDSysEncoding *PDSysEncoding;

Returned From

Used By

PDSysEncoding Functions

PDSysEncodingCreateFromBaseName

Header: PEWProcs.h:2106

Description

Create an encoding object from the base name.

Call PDERelease() to dispose of the returned PDSysEncoding object when finished with it.

Related Methods

Syntax

PDSysEncoding PDSysEncodingCreateFromBaseName(IN ASAtom baseEncName, IN const char **diffEnc);

Parameters

baseEncName
IN/OUT The base encoding. See the description of Base Encoding in the Character Encoding section of the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 9.6.6, page 262. You can find this document on the web store of the International Standards Organization (ISO).
diffEnc
IN/OUT An array of 256 const char * describing the differences from the encoding specified by baseEncName. It may be NULL.

Returns

An object of type PDSysEncoding.

Exceptions

PDSysEncodingCreateFromCMapName

Header: PEWProcs.h:2117

Description

Create an encoding object from a PDF CMap name.

Call PDERelease() to dispose of the returned PDSysEncoding object when finished with it.

Related Methods

Syntax

PDSysEncoding PDSysEncodingCreateFromCMapName(IN ASAtom cmapName);

Parameters

cmapName
The CMap name.

Returns

An object of type PDSysEncoding.

Exceptions

PDSysEncodingCreateFromCMapStream

Header: PEWProcs.h:3234

Description

Creates an encoding object from a given PDF CMap stream.

Call PDERelease() to dispose of the returned PDSysEncoding object when it is no longer needed.

Related Methods

Syntax

PDSysEncoding PDSysEncodingCreateFromCMapStream(IN CosObj cmapStream);

Parameters

cmapStream
The CMap stream from which to create the encoding object.

Returns

The encoding object to be created.

PDSysEncodingCreateFromCodePage

Header: PEWProcs.h:2355

Description

Create an encoding object from a code page.

Call PDERelease() to dispose of the returned PDSysEncoding object when finished with it.

Related Methods

Syntax

PDSysEncoding PDSysEncodingCreateFromCodePage(IN ASInt32 codePage, IN ASInt16 wMode);

Parameters

codePage
The code page character-mapping construct. See Code Page Values.
wMode
0 for horizontal writing, 1 for vertical writiing.

Returns

An object of type PDSysEncoding.

Exceptions

PDSysEncodingGetWMode

Header: PERProcs.h:2277

Description

Returns writing mode. 0 for horizontal writing and 1 for vertical writing.

Syntax

ASInt16 PDSysEncodingGetWMode(IN PDSysEncoding sysEnc);

Parameters

sysEnc
IN/OUT An object of type PDSysEncoding.

Returns

0 for horizontal writing and 1 for vertical writing.

Exceptions

PDSysEncodingIsIdentity

Header: PERProcs.h:2288

Description

Returns true for Identity-H or Identity-V encoding, false otherwise.

Syntax

ASBool PDSysEncodingIsIdentity(IN PDSysEncoding sysEnc);

Parameters

sysEnc
IN/OUT An object of type PDSysEncoding.

Returns

See above.

Exceptions

PDSysEncodingIsMultiByte

Header: PERProcs.h:2298

Description

Returns true for CMap encoding, false otherwise.

Syntax

ASBool PDSysEncodingIsMultiByte(IN PDSysEncoding sysEnc);

Parameters

sysEnc
IN/OUT An object of type PDSysEncoding.

Returns

See above.

Exceptions

PDSysEncodingSetIsUTF16

Header: PEWProcs.h:3847

Syntax

void PDSysEncodingSetIsUTF16(IN PDSysEncoding sysEnc, IN ASBool isUTF16);

Parameters

sysEnc
IN/OUT An object of type PDSysEncoding.
isUTF16
A boolean value specifying if the encoding is UTF-16

Exceptions