PDFEdit_Layer.PDSysEncoding (Acrobat)

	Typedef
	PDSysEncoding A PDEElement that provides system encoding for a PDF file.

	Enumeration
	`PDSysEncodingCodePage`

	Method
	PDSysEncoding PDSysEncodingCreateFromBaseName(INASAtom baseEncName, IN const char** diffEnc) Create an encoding object from the base name.
	PDSysEncoding PDSysEncodingCreateFromCMapName(INASAtom cmapName) Create an encoding object from a PDF CMap name.
	PDSysEncoding PDSysEncodingCreateFromCMapStream(INCosObj cmapStream) Creates an encoding object from a given PDF CMap stream.
	PDSysEncoding PDSysEncodingCreateFromCodePage(INASInt32 codePage, INASInt16 wMode) Create an encoding object from a code page.
	ASInt16 PDSysEncodingGetWMode(INPDSysEncoding sysEnc) Returns writing mode. 0 for horizontal writing and 1 for vertical writing.
	ASBool PDSysEncodingIsIdentity(INPDSysEncoding sysEnc) Returns true for Identity-H or Identity-V encoding, false otherwise.
	ASBool PDSysEncodingIsMultiByte(INPDSysEncoding sysEnc) Returns true for CMap encoding, false otherwise.

Typedefs Detail

PDSysEncoding

Product availability: All

Platform availability: All

Syntax

typedef struct _t_PDSysEncoding* PDSysEncoding;

A PDEElement that provides system encoding for a PDF file.

File: PEExpT.h

Line: 410

Enumeration Detail

PDSysEncodingCodePage

Product availability: All

Platform availability: All

Syntax

enum PDSysEncodingCodePage {

  kPDCodePageWinEastEuropeanRoman = 1250,


 


  kPDCodePageWinCyrillic = 1251,


 


  kPDCodePageWinGreek = 1253,


 


  kPDCodePageWinTurkish = 1254,


 


  kPDCodePageWinHebrew = 1255,


 


  kPDCodePageWinArabic = 1256,


 


  kPDCodePageWinBaltic = 1257,


 


  kPDCodePageMacCentralEuropean = -9994,


 


  kPDCodePageMacCroatian = -9993,


 


  kPDCodePageMacRomanian = -9992,


 


  kPDCodePageMacCyrillic = -9991,


 


  kPDCodePageMacUkrainian = -9990,


 


  kPDCodePageMacGreek = -9989,


 


  kPDCodePageMacTurkish = -9988,


 


  kPDCodePageMacHebrew = -9987,


 


  kPDCodePageMacArabic = -9986

}

File: PEExpT.h

Line: 2143

Method Detail

PDSysEncodingCreateFromBaseName

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





PDSysEncoding PDSysEncodingCreateFromBaseName(INASAtom baseEncName, IN const char** diffEnc)

Create an encoding object from the base name.

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

Parameters

	`baseEncName` —	IN/OUT The base encoding. See Section 5.5.5 in the PDF Reference.

	`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

genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00050000

File: PEWProcs.h

Line: 2316

PDSysEncodingCreateFromCMapName

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





PDSysEncoding PDSysEncodingCreateFromCMapName(INASAtom cmapName)

Create an encoding object from a PDF CMap name.

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

Parameters

cmapName —

The CMap name.

Returns

An object of type PDSysEncoding.

Exceptions

genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00050000

File: PEWProcs.h

Line: 2327

PDSysEncodingCreateFromCMapStream

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





PDSysEncoding PDSysEncodingCreateFromCMapStream(INCosObj cmapStream)

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.

Parameters

cmapStream —

The CMap stream from which to create the encoding object.

Returns

The encoding object to be created.

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00090000

File: PEWProcs.h

Line: 3577

PDSysEncodingCreateFromCodePage

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





PDSysEncoding PDSysEncodingCreateFromCodePage(INASInt32 codePage, INASInt16 wMode)

Create an encoding object from a code page.

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

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

genErrBadParm

Since

PI_PDFEDIT_WRITE_VERSION >= 0x00060000

File: PEWProcs.h

Line: 2587

PDSysEncodingGetWMode

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt16 PDSysEncodingGetWMode(INPDSysEncoding sysEnc)

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

Parameters

sysEnc —

IN/OUT An object of type PDSysEncoding.

Returns

0 for horizontal writing and 1 for vertical writing.

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00050000

File: PERProcs.h

Line: 2493

PDSysEncodingIsIdentity

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool PDSysEncodingIsIdentity(INPDSysEncoding sysEnc)

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

Parameters

sysEnc —

IN/OUT An object of type PDSysEncoding.

Returns

See above.

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00050000

File: PERProcs.h

Line: 2505

PDSysEncodingIsMultiByte

()

Product availability: Acrobat, PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool PDSysEncodingIsMultiByte(INPDSysEncoding sysEnc)

Returns true for CMap encoding, false otherwise.

Parameters

sysEnc —

IN/OUT An object of type PDSysEncoding.

Returns

See above.

Exceptions

peErrWrongPDEObjectType

Since

PI_PDFEDIT_READ_VERSION >= 0x00050000

File: PERProcs.h

Line: 2516

Acrobat API Reference	All Layers \| All Objects \| Index \| Samples \| Frames No Frames
PDSysEncoding	Typedefs \| Enumerations \| Methods

	kPDCodePageWinEastEuropeanRoman = 1250,

	kPDCodePageWinCyrillic = 1251,

	kPDCodePageWinGreek = 1253,

	kPDCodePageWinTurkish = 1254,

	kPDCodePageWinHebrew = 1255,

	kPDCodePageWinArabic = 1256,

	kPDCodePageWinBaltic = 1257,

	kPDCodePageMacCentralEuropean = -9994,

	kPDCodePageMacCroatian = -9993,

	kPDCodePageMacRomanian = -9992,

	kPDCodePageMacCyrillic = -9991,

	kPDCodePageMacUkrainian = -9990,

	kPDCodePageMacGreek = -9989,

	kPDCodePageMacTurkish = -9988,

	kPDCodePageMacHebrew = -9987,

	kPDCodePageMacArabic = -9986

Layer	PDFEdit_Layer
Object	PDSysEncoding