DL Logo

General Definitions

ASFileError

Header: AcroErr.h:307

Syntax

#define ASFileError ( e ) ErrBuildCode( ErrAlways, ErrSysASFile, e )

AVPS_MAC_ROMAN_ENC

Header: PDFLExpT.h:1774

Description

Encoding identifiers (for TE).

Syntax

#define AVPS_MAC_ROMAN_ENC 101

AVPS_WIN_ANSI_ENC

Header: PDFLExpT.h:1776

Syntax

#define AVPS_WIN_ANSI_ENC 102

AcroViewError

Header: AcroErr.h:301

Syntax

#define AcroViewError ( e ) ErrBuildCode( ErrAlways, ErrSysAcroView, e )

BAD_NSELECTOR

Header: PDFLExpT.h:74

Syntax

#define BAD_NSELECTOR ( - 1 )

CosError

Header: AcroErr.h:292

Syntax

#define CosError ( e ) ErrBuildCode( ErrSuppressable, ErrSysCos, e )

CosErrorAlways

Header: AcroErr.h:293

Syntax

#define CosErrorAlways ( e ) ErrBuildCode( ErrAlways, ErrSysCos, e )

CosSyntaxError

Header: AcroErr.h:294

Syntax

#define CosSyntaxError ( e ) ErrBuildCode( ErrSuppressable, ErrSysCosSyntax, e )

DLADD_disableFlattening

Header: PDFLExpT.h:1032

Syntax

#define DLADD_disableFlattening 1

ERR_ERROR_MASK

Header: AcroErr.h:43

Syntax

#define ERR_ERROR_MASK 0x0000ffff

ERR_ERROR_SHIFT

Header: AcroErr.h:47

Syntax

#define ERR_ERROR_SHIFT 0

ERR_GENERAL

Header: AcroErr.h:37

Syntax

#define ERR_GENERAL 1

ERR_NOMEMORY

Header: AcroErr.h:38

Syntax

#define ERR_NOMEMORY 2

ERR_SEVERITY_MASK

Header: AcroErr.h:40

Syntax

#define ERR_SEVERITY_MASK 0xf0000000

ERR_SEVERITY_SHIFT

Header: AcroErr.h:45

Syntax

#define ERR_SEVERITY_SHIFT 28

ERR_SYSTEM_MASK

Header: AcroErr.h:42

Syntax

#define ERR_SYSTEM_MASK 0x00ff0000

ERR_SYSTEM_SHIFT

Header: AcroErr.h:46

Syntax

#define ERR_SYSTEM_SHIFT 16

ERR_UNUSED_MASK

Header: AcroErr.h:41

Syntax

#define ERR_UNUSED_MASK 0x0f000000

ErrBuildCode

Header: AcroErr.h:78

Description

Builds an error code for the specified severity, system, and error number. Error codes are used in exception handling. The ASRaise() method takes an error code for its argument; ASRegisterErrorString() returns an error code. An error code has three components:
Component
Description
Size
Severity
none, warning, severe
4 bits
System
Cos, PDDoc, and so on
8 bits
Error
FileOpen, Syntax, and so on
16 bits

Syntax

#define ErrBuildCode ( xseverity, xsys, xerror )

Parameters

xseverity
The severity of the error. It must be one of ErrorSeverities.
xsys
The error system. It must be one of ErrorSystems.
xerror
The error number in the error system.

Example

myErrorCode = ErrBuildCode(ErrAlways, ErrSysAcroView, avErrActionRestricted);

ErrGetCode

Header: AcroErr.h:134

Description

Gets the error number from an error code.

Syntax

#define ErrGetCode ( xcode )(((( ASUns32 )( xcode ) ) & ERR_ERROR_MASK ) >> ERR_ERROR_SHIFT )

Parameters

xcode
The error code.

Example

errorNumber = ErrGetCode(errorCode);

ErrGetSeverity

Header: AcroErr.h:101

Description

Gets the error severity from an error code. It returns one of ErrorSeverities.

Syntax

#define ErrGetSeverity ( xcode )(((( ASUns32 )( xcode ) ) & ERR_SEVERITY_MASK ) >> ERR_SEVERITY_SHIFT )

Parameters

xcode
The error code.

Example

errorSeverity = ErrGetSeverity(errorCode);

ErrGetSignedCode

Header: AcroErr.h:150

Description

Gets a signed error number from an error code.

Syntax

#define ErrGetSignedCode ( xcode )(( ASInt16 ) ErrGetCode( xcode ) )

Parameters

xcode
The error code.

Example

errorSignedNumber = ErrGetSignedCode(errorCode);

ErrGetSystem

Header: AcroErr.h:118

Description

Gets the error system from an error code. It returns one of ErrorSystems.

Syntax

#define ErrGetSystem ( xcode )(((( ASUns32 )( xcode ) ) & ERR_SYSTEM_MASK ) >> ERR_SYSTEM_SHIFT )

Parameters

xcode
The error code.

Example

errorSystem = ErrGetSystem(errorCode);

FontSvrError

Header: AcroErr.h:304

Syntax

#define FontSvrError ( e ) ErrBuildCode( ErrAlways, ErrSysFontSvr, e )

GenError

Header: AcroErr.h:291

Syntax

#define GenError ( e ) ErrBuildCode( ErrAlways, ErrSysNone, e )

INCL_DOS

Header: PDFLExpT.h

Syntax

#define INCL_DOS

INCL_GPI

Header: PDFLExpT.h

Syntax

#define INCL_GPI

INCL_PM

Header: PDFLExpT.h

Syntax

#define INCL_PM

MDAppError

Header: AcroErr.h:312

Syntax

#define MDAppError ( e ) ErrBuildCode( ErrAlways, ErrSysMDApp, e )

MDSysError

Header: AcroErr.h:311

Syntax

#define MDSysError ( e ) ErrBuildCode( ErrAlways, ErrSysMDSystem, e )

PDDocError

Header: AcroErr.h:295

Syntax

#define PDDocError ( e ) ErrBuildCode( ErrSuppressable, ErrSysPDDoc, e )

PDDocErrorAlways

Header: AcroErr.h:296

Syntax

#define PDDocErrorAlways ( e ) ErrBuildCode( ErrAlways, ErrSysPDDoc, e )

PDFEditError

Header: AcroErr.h:314

Syntax

#define PDFEditError ( e ) ErrBuildCode( ErrAlways, ErrSysPDFEdit, e )

PDFXError

Header: AcroErr.h:313

Syntax

#define PDFXError ( e ) ErrBuildCode( ErrAlways, ErrSysPDFX, e )

PDMetadataError

Header: AcroErr.h:316

Syntax

#define PDMetadataError ( e ) ErrBuildCode( ErrAlways, ErrSysPDMetadata, e )

PDModelError

Header: AcroErr.h:300

Syntax

#define PDModelError ( e ) ErrBuildCode( ErrAlways, ErrSysPDModel, e )

PDPageError

Header: AcroErr.h:297

Syntax

#define PDPageError ( e ) ErrBuildCode( ErrSuppressable, ErrSysPDPage, e )

PDPageErrorAlways

Header: AcroErr.h:298

Syntax

#define PDPageErrorAlways ( e ) ErrBuildCode( ErrAlways, ErrSysPDPage, e )

PDPageErrorSilent

Header: AcroErr.h:299

Syntax

#define PDPageErrorSilent ( e ) ErrBuildCode( ErrSilent, ErrSysPDPage, e )

PDSEditError

Header: AcroErr.h:315

Syntax

#define PDSEditError ( e ) ErrBuildCode( ErrAlways, ErrSysPDSEdit, e )

PageError

Header: AcroErr.h:302

Syntax

#define PageError ( e ) ErrBuildCode( ErrSuppressable, ErrSysPage, e )

PageErrorSilent

Header: AcroErr.h:303

Syntax

#define PageErrorSilent ( e ) ErrBuildCode( ErrSilent, ErrSysPage, e )

RasterError

Header: AcroErr.h:305

Syntax

#define RasterError ( e ) ErrBuildCode( ErrAlways, ErrSysRaster, e )

XtnError

Header: AcroErr.h:310

Syntax

#define XtnError ( e ) ErrBuildCode( ErrAlways, ErrSysXtn, e )

XtnMgrError

Header: AcroErr.h:309

Syntax

#define XtnMgrError ( e ) ErrBuildCode( ErrAlways, ErrSysXtnMgr, e )

__defedPlatformTypes

Header: PDFLExpT.h

Syntax

#define __defedPlatformTypes

kPDFLVersion

Header: PDFInit.h:53

Syntax

#define kPDFLVersion 0x00120003

General Enumerations

ErrOptions

Header: AcroErr.h:153

Description

Value options for ErrSeverity.

Enum Constants

ErrNoError=0
No error occurred.
ErrWarning
Display a warning.
ErrSuppressable
Display a message if the user has not suppresed errors.
ErrSilent
Never display a message.
ErrAlways
Always display a message, even if others are suppressed.

ErrSysOptions

Header: AcroErr.h:184

Description

Value options for ErrSystem.

Enum Constants

ErrSysNone=0
General error and out of memory errors.
ErrSysCos
CosStore, filters errors.
ErrSysCosSyntax
Cos syntax errors.
ErrSysPDDoc
PDDoc and family, Page tree, outlines errors.
ErrSysPDPage
PDPage and family, thumbs, annotations errors.
ErrSysPDModel
Global PD errors.
ErrSysAcroView
AcroView errors.
ErrSysPage
Page parsing and RIPping errors.
ErrSysFontSvr
Font Server errors.
ErrSysRaster
Rasterizer errors.
ErrSysASFile
ASFile I/O errors.
ErrSysXtnMgr
Extension Manager errors.
ErrSysXtn
New error codes added by extensions.
ErrSysMDSystem
Platform-specific system errors.
ErrSysMDApp
Platform-specific application errors.
ErrSysPDFX
PDFX-specific errors.
ErrSysPDFEdit
PDFEdit errors.
ErrSysPDSEdit
PDSEdit (structure) errors.
ErrSysPDMetadata
XAP Metadata errors.
ErrSysLast

OS2Errs

Header: AcroErr.h:2961

Enum Constants

OS2BadFileErr=2
The file does not exist.
OS2BadPathErr=3
The path does not exist.
OS2TooManyErr=4
Too many open files.
OS2AccessErr=5
Access denied.
OS2BadHdlErr=6
Bad file handle.
OS2MemErr=8
Not enough memory.
OS2BadDiskErr=11
Badly formatted disk.
OS2BadDriveErr=15
Invalid drive.
OS2WrPermErr=19
You do not have write permission.
OS2NotDosErr=26
Not an MS-DOS disk.
OS2GeneralErr=31
General failure.
OS2ShareErr=32
Sharing violation.
OS2LockErr=33
Lock violation.
OS2DeviceErr=39
The device does not exist.
OS2ExistsErr=80
The file already exists.

Options

Header: PDFInit.h:56

Description

Flags for PDFLInit

Enum Constants

kPDFLInitIgnoreDefaultDirectories=0x001
Do not search through default font directories.
kReadOnlyInit=0x0002
(obsolete) If it is not necessary to write PDF, there is no need to initialize the font table (which would be much faster!).
kCheckSubFonts=0x0004
Check for substitution fonts at toolkit initialization. If they are not found, return an error.
kDontLoadPlugIns=0x0008
Do not load plug-ins if this is set.
kTestUniform=0x0010
TEST ONLY * * Create the same PDF file for every run. This forces dates to January 1, 1999 at 1:01:01 and file IDs to "[ < 11111111111111111111111111111111 > < 11111111111111111111111111111111 > ]". The resulting PDF files are invalid and should only be used for testing purposes.
kInitPDFEdit=0x0020
Initialize PDFEdit if this is true.
kNewFontWidths=0x0040
PDFLib 10 GM and earlier versions have incorrect widths specified for several of their characters of the 'standard/core 14 fonts', the widths do not always correspond with what the corresponding AFM files specify. Use new and correct font widths for 'standard/core 14 fonts' if this is true.
kPDFLInitIgnoreSystemFonts=0x0080
Do not search through default System font directories. If set, CoolType will not automatically search for any system fonts. If this flag is not set, CoolType will enumerate system fonts on Mac and Windows using the standard APIs. On Unix, CoolType will look in the following locations: /usr/lib/X11/fonts /usr/local/X11R6/lib/X11/fonts /usr/share/X11/fonts
kPDFLInitIgnoreCurrentDirectory=0x0100
flag to specifically ignore the current working directory, but not ignore all default font directories. kPDFLInitIgnoreDefaultDirectories implies this as well.
kPDFLInitDisableMemorySuballocator=0x0200
kPDFLInitPreferSystemFonts=0x0000
If two or more fonts of the same name are loaded from several sources, by default APDFL will prefer fonts which are known to and loaded from the platform font handling mechanism. This switch will cause the preference to be given to fonts loaded from directories other than those controlled by the operating system. kPDFLInitPreferSystemFonts is not really a flag and should be kept at 0.
kPDFLInitPreferLocalFonts=0x0400
kPDFLInitAvoidGDIFontScanner=0x0800
When using this flag, Windows fonts are enumerated as usual, but an attempt is made to read the font files directly before resorting to using GDI/GetFontData(). This can result in a speed improvement for certain tasks, especially when starting the PDFL up many times in parallel. The drawback is that in the light of duplicate fonts, which fonts actually make it on the font list and cached data may differ slightly from the GDI case.
kPDFLInitOnlyUseCustomColorProfilePaths=0x08000
Only look for Color Profiles in the custom path set in the PDFLData. When this flag is used and the PDFLData member colorProfileDirList is set, then only the specified paths are searched (the default paths searched by the Library are ignored).
kPDFLInitFormsExtension=0x10000

PDDoOptions

Header: PDFLExpT.h:1552

Description

Font encoding methods.

Value options for PDEncodingType.

Enum Constants

kPDDoReencode
The encoding method to be used for Type 1 fonts and substituted fonts.
kPDDoNothing
The encoding method to be used for TrueType Windows font or built-in encoding font.
kPDDoXlate
The encoding method to be used for a TrueType custom font or font with Mac OS encoding.

PDIStyles

Header: PDFLExpT.h:1511

Description

Value options for PDPrintMarkStyles.

Enum Constants

kPDInDesignStyle=0
InDesign style.
kPDInDesignJ1Style
InDesign J1 style.
kPDInDesignJ2Style
InDesign J2 style.
kPDIllustratorStyle
Illustrator style.
kPDIllustratorJStyle
Illustrator J style.
kPDQuarkXPressStyle
QuarkXPress style.

PDOptions

Header: PDFLExpT.h:200

Description

Specifies a synthetic font style.

Value options for PDFontStyle.

Enum Constants

PDRoman=0
PDItalic
PDBold
PDBoldItalic

PDOptions

Header: PDFLExpT.h:291

Description

Value options for PDPageTilingMode.

Enum Constants

kPDNoPageTiling=0
Print all pages normally
kPDTileAllPages
Use tiling settings for all pages
kPDTileLargePages
Use tiling only for pages larger than size indicated in PDTileRec of tileInfo

PDOutput_Options

Header: PDFLExpT.h:143

Description

Value options for PDOutputType.

Enum Constants

PDOutput_PS
Emit a PostScript file.
PDOutput_EPSNoPrev
Emit an EPS file with no preview.
PDOutput_EPSMacStdPrev
Emit an EPS file with standard preview.
PDOutput_EPSMacExtPrev#endif
Emit an EPS file with extended preview.

ProcSets

Header: PDFLExpT.h:1754

Description

ProcSet identifiers used to specify which procsets must be downloaded.

Enum Constants

pdfProcSet
PDF only operators.
typeProcSet
AI3 or PDF typography.
imgProcSet
General image support.
imbProcSet
Monochrome images.
imcProcSet
Color images.
imiProcSet
Indexed (color table) images.
ocfProcSet
Make Original Composite Font (OCF) support.
nProcSets
How many are defined.

WinErrs

Header: AcroErr.h:2881

Enum Constants

WinBadFileErr=2
The file does not exist.
WinBadPathErr=3
The path does not exist.
WinTooManyErr=4
There are too many open files.
WinAccessErr=5
Access denied.
WinBadHdlErr=6
Bad file handle.
WinMemErr=8
Not enough memory.
WinBadDiskErr=11
Badly formatted disk.
WinBadDriveErr=15
Invalid drive.
WinWrPermErr=19
You do not have write permission.
WinNotDosErr=26
Not an MS-DOS disk.
WinGeneralErr=31
General failure.
WinShareErr=32
Sharing violation.
WinLockErr=33
Lock violation.
WinDeviceErr=39
Device does not exist.
WinExistsErr=80
File already exists.

avOptions

Header: AcroErr.h:1683

Enum Constants

avErrNoError
No error.
avErrCantOpenMoreThanTenDocs
No more than ten documents can be opened at a time.
avErrPrintJobTooBig
There are too many pages to print.
avErrTooManyChars
There is too much text to display. No more than 32,000 characters can be displayed.
avErrNoText
There is no text.
avErrCantOpenDialog
Acrobat cannot open this file. There is a modal dialog box open.
avErrActionExternal
This action cannot be performed from within an external window.
avErrActionFullScreen
This action cannot be performed during full screen mode.
avErrActionRestricted
This action cannot be performed.
avErrCantOpenPrinting
Acrobat cannot open this file while printing another document.
avErrBadAnnotationCopy
Unregistered copy proc for the annotation object.
avErrBadActionCopy
Unregistered copy proc for the action object.
avErrUpdateInternalError
Unable to determine if a new update for this product exists.
avErrUpdateInternetError
Unable to access the Internet.
avErrUpdateNoWebServices
Web services are currently not available.
avErrBadThreadLinkError
Unable to read the article because it is damaged or missing.
avInvalidPageRange
Invalid page range.
avErrDownloadHelpError
Unable to download the Adobe Reader Help file.
avSAInsufficientPermission
Insufficient permission for this operation.
avSA128EncryptionPresent
The operation failed due to the presence of 128-bit encryption in the PDF file.

cfMacOptions

Header: AcroErr.h:2731

Enum Constants

cfMacNoErr=0
No error ( noErr).
cfMacdirFulErr=-33
The directory is full ( dirFulErr).
cfMacdskFulErr=-34
The document's disk or the disk used for temporary files is full ( dskFulErr).
cfMacnsvErr=-35
There is no such volume available ( nsvErr).
cfMacioErr=-36
A file I/O error has occurred ( ioErr).
cfMaceofErr=-39
The end of file was reached unexpectedly ( eofErr).
cfMacfLckdErr=-45
This file is locked ( fLckdErr).
cfMacvLckdErr=-46
This volume is locked and cannot be written to ( vLckdErr).
cfMacfBsyErr=-47
This file is busy and cannot be deleted ( fBsyErr).
cfMacdupFNErr=-48
Another file already exists under the same name ( dupFNErr).
cfMacopWrErr=-49
This file is already open or in use by another application ( opWrErr).
cfMacvolOffLinErr=-53
This file's volume is not available ( volOffLinErr).
cfMacpermErr=-54
You do not have permission to open this file ( permErr).
cfMacnoMacDskErr=-57
This disk is not a Macintosh disk ( noMacDskErr).
cfMacwrPermErr=-61
You do not have permission to write to this file ( wrPermErr).
cfMacdsMemFullErr=-26
Out of memory (-26). ( dsMemFullErr).
cfMacmemFullErr=-108
Out of memory (-108). ( memFullErr).
cfMacresNotFound=-192
Tried to get a nonexistent resource (-192). ( resNotFound).
cfMacGenPSErr=-8133
PostScript error (-8133).
cfMaciIOAbort=-27
An I/O error has occurred (-27). ( iIOAbort).
cfMaciPrSavPFil=-1
Error saving print file (-1).
cfMacServerLostConnection=-1070
This file's server connection has closed down ( aspParamErr).

cosErrOptions

Header: AcroErr.h:394

Enum Constants

cosErrNoError
No error.
cosErrReadError
Read error.
cosErrWriteError
Write error.
cosErrBadSyntax
Syntax error.
cosErrNeedRebuild
The file needs to be repaired.
cosErrRebuildFailed
Could not repair file.
cosErrCantOpenTempFile
A temporary file could not be opened.
cosErrTempFileFull
The temporary file is full or nearly full. Close or save any modified documents.
cosErrStreamTooShort
The stream source is shorter than specified length.
cosErrBadFilterName
A stream specifies an unknown filter.
cosErrListOverflow
The operation or data is too complex.
cosErrDocTableFull
The Cos document table is full.
cosErrInt16OutOfRange
A number is out of range.
cosErrExpectedNull
A NULL object was expected.
cosErrExpectedDict
A dictionary object was expected.
cosErrExpectedArray
An array object was expected.
cosErrExpectedNumber
A number object was expected.
cosErrExpectedBoolean
A boolean object was expected.
cosErrExpectedName
A name object was expected.
cosErrExpectedString
A string object was expected.
cosErrExpectedStream
A stream object was expected.
cosErrInvalidAssignment
This direct object already has a container.
cosErrAfterSave
Implementation failure: this document is now invalid.
cosErrInvalidObj
The desired operation cannot be performed on this object.
cosErrArrayBounds
Array out-of-bounds error.
cosErrDictKeyNotName
The dictionary key must be a name object.
cosErrNeedFullSave
This file must be saved with a full save.
cosErrEncryptionErr
Error in the encryption filter.
cosErrDCTError
Error in the JPEG data filter.
cosErrCCFError
Error in the CCITT fax data filter.
cosErrLZWError
Error in the LZW data filter.
cosErrFlateError
Error in Flate data filter.
cosErrExpectedDirect
A direct object was expected.
cosErrOldLinFormat
Obsolete linearized (optimized for the Web) format.
cosErrTempTooShort
The temporary file was unexpectedly short.
cosErrCancelSave
The Save operation was cancelled.
cosErrEncryptionNotSupported
Encryption and decryption are not supported.
cosErrNoEncryptionKeySupplied
An encryption key is not supplied for a stream.
cosErrDuplicateFilterName
A filter with the same name is already registered.
cosErrNoDecodeFilter
Attempted to decode without the associated filter.
cosErrNoEncodeFilter
Attempted to encode without the associated filter.
cosErrCryptAuthFailed
Decryption authorization failed during data access.
cosErrExpectedObjectStream
An object stream was expected.
cosErrExpectedIndirect
An indirect object was expected.
cosErrExpectedProc
A procedure was expected.
cosErrExpectedCollection
An object collection was expected.
cosErrNotCompressed
A compressed object was expected.
cosErrCompressed
An object that was not compressed was expected.
cosErrBadRefcount=51
An acquired object was already released.
cosErrObjFreed
An object has been replaced or destroyed.
cosErrMemMgrError
Internal error in the memory manager.
cosErrNeedXrefStm
This file requires a cross-reference stream (PDF 1.5).
cosErrCryptSystem
General Encryption System error (failed to load or initialize).

cosSynErrOptions

Header: AcroErr.h:669

Enum Constants

cosSynErrNoError
No syntax error.
cosSynErrNoHeader
File does not begin with '%PDF-'.
cosSynErrNoEOF
Missing %%EOF.
cosSynErrNoStartXRef
Could not find startxref address.
cosSynErrNoStartAddress
The value of startxref address is not an integer.
cosSynErrBadXref
Missing 'xref'.
cosSynErrBadXrefHeader
Xref header should be two integers.
cosSynErrBadXrefEntry
Error reading xref entry.
cosSynErrBadTrailerStart
The trailer dictionary start is missing ' < '.
cosSynErrBadObjectLabel
The object label is badly formatted.
cosSynErrUnknownName
Unrecognized object name.
cosSynErrUnknownTokenType
Unrecognized token type.
cosSynErrNoEndStream
Missing endstream.
cosSynErrExtraEndStream
Unexpected endstream.
cosSynErrUnterminatedString
Unterminated string.
cosSynErrStringTooLong
The string is too long.
cosSynErrTokenTooLong
The token is too long.
cosSynErrBadCharInHexString
There is a non-hex character in a hex string.
cosSynErrUnexpectedType
Unexpected token type.
cosSynErrImageNeverEnded
End of image was not found.
cosSynErrUnexpectedDict
Unexpected end of dictionary.
cosSynErrUnexpectedArray
Unexpected end of array.
cosSynErrBadDict
There was an error reading the dictionary.
cosSynErrBadObject
There was an error reading the object.
cosSynErrBadArrayDict
Expected a dictionary or array.
cosSynErrBadFRef
Bad foreign object reference.
cosSynErrPStackUnderflow
There was a parse stack underflow while reading the object.
cosSynErrBadLinearized
There was an error reading the linearized hint data.
cosSynErrBadHexCharInName
There was a non-hex character after # in a name.
cosSynErrBadName
There are illegal characters in a name.
cosSynErrBadObjectRef
An object reference is invalid.
cosSynErrBadXrefStream
There is an error in the XRef stream.
cosSynErrPrematureEOF
Unexpected end of file.
cosSynErrBadStreamStart
Expected CR and/or LF after 'stream'.
cosSynErrBadObjStream
There is an error in the object stream.
cosSynErrDictKeyNotName
Dictionary keys must be direct name objects.
cosSynErrExpectedNull
The NULL object was expected.
cosSynErrExpectedNumber
A number was expected.
cosSynErrExpectedInteger
An integer was expected.
cosSynErrExpectedReal
A real number was expected.
cosSynErrExpectedUnsigned
A non-negative integer was expected.
cosSynErrExpectedBoolean
true or false was expected.
cosSynErrExpectedName
A name integer was expected.
cosSynErrExpectedString
A string was expected.
cosSynErrExpectedDict
A dictionary was expected.
cosSynErrExpectedArray
An array was expected.
cosSynErrExpectedStream
A stream was expected.
cosSynErrIllegalStream
A stream was found in an illegal context.
cosSynErrNoLength
The stream is missing a Length key.
cosSynErrExpectedIndirect
An indirect object was expected.
cosSynErrExpectedDirect
A direct object was expected.
cosSynErrIllegalIndRef
Illegal indirect reference.

fileErrOptions

Header: AcroErr.h:2281

Enum Constants

fileErrNoErr
No error.
fileErrGeneral
A file error has occurred.
fileErrObsolete
fileErrDirFull
The directory is full.
fileErrDiskFull
The document's disk or the disk used for temporary files is full.
fileErrNSV
The disk containing this file is not available.
fileErrIO
A file I/O error has occurred.
fileErrRead
A file read error has occurred.
fileErrWrite
A file write error has occurred.
fileErrEOF
The end of file was reached unexpectedly.
fileErrLocked
This file is locked.
fileErrVLocked
This disk is locked and cannot be written to.
fileErrBusy
This file is busy and cannot be deleted.
fileErrExists
Another file already exists under the same name.
fileErrAlreadyOpen
This file is already open or in use by another application.
fileErrPerm
You do not have access to this file.
fileErrWrPerm
You do not have permission to write to this file.
fileErrFNF
This file cannot be found.
fileErrOpenFailed
File open failed.
fileErrBytesNotReady
The bytes are not ready.
fileErrUserRequestedStop
The user requested a stop.
fileErrIOTimeout
A file I/O error has occurred. The file connection timed out.
fileErrReadBlocked
A file I/O error has occurred. The file is blocked while reading.
fileErrNotADir
This operation can only be performed on a folder.
fileErrTempCreate
A uniquely named temporary file could not be created. Please restart the application and try again.
fileErrTooBig
This file is too big for the current operation.

fsErrOptions

Header: AcroErr.h:2198

Enum Constants

fsErrNoError
No error.
fsErrInitFailed
Initialization of the font server module failed.
fsErrNoMMFonts
No Multiple Master fonts were found.
fsErrNoATM
Adobe Type Manager was not found.
fsErrNeedNewATM
A new version of Adobe Type Manager is required.
fsErrNoT1ZapfDingbats
The Type 1 font 'ZapfDingbats' must be installed.
fsErrDownloadFailed
The font download failed.
fsErrDownloadAborted
The font download aborted.
fsErrBadParameter
A bad parameter was passed to the font server.
fsErrMissingFont
No ZapfDingbats or Multiple Master fonts were found.

genErrOptions

Header: AcroErr.h:319

Enum Constants

genErrNoError
No error.
genErrGeneral
An internal error occurred.
genErrNoMemory
Out of memory.
genErrBadParm
Bad parameter.
genErrListOverflow
Operation or data is too complex.
genErrBadUnlock
Attempt to release an unlocked object.
genErrExceptionStackOverflow
Exception stack overflow.
genErrResourceLoadFailed
Failed to load an application resource (internal error).
genErrNameAlreadyRegistered
Attempt to register an object with a name already in use.
genErrMethodNotImplemented
Attempt to call a method that has not been implemented.
genErrCanceled
The user cancelled the operation.
genErrNoValidSerialNoFound
No valid Acrobat serial number was found. Acrobat will now quit.
genErrOutOfRange
The parameter was out of Valid range.
genErrLicense
License management error

mdAppOptions

Header: AcroErr.h:2846

Enum Constants

mdAppErrNoError
No error.
mdAppCantPrintToPDFWriter
Cannot print to Acrobat PDFWriter.
mdAppNoDAsWhilePrint
Please close all Desk Accessories before printing.
mdAppNoPrinter
Printing is not possible until you have chosen a Printer using the Chooser.
mdAppAsstToolboxActive
Background printing is not possible with the Assistant Toolbox system extension and loadable ATM.
mdAppIncorrectTTEmbed
Some data in the embedded font was invalid. Some characters may not display or print correctly.

mdAppOptions

Header: AcroErr.h:3199

Enum Constants

mdAppErrNoError
No error.
mdAppOpenMsgPartFailed
Open Message partially failed.
mdAppOpenMsgFailed
Open Message failed.
mdAppModalWindowOpen
Modal window is open.
mdAppBadPropertyFormat
Bad Property format.
mdAppGetPropertyError
GetProperty error.
mdAppBadPlatformThing
Bad AVWindow Platform Thing.
mdAppSIGBUS
A bus error was caught.
mdAppSIGILL
An illegal instruction was caught.
mdAppSIGSEGV
A segmentation violation was caught.
mdAppSIGUnknown
An unknown signal was caught.
mdAppLPTERM
The print job terminated.
mdAppLPSTOP
The print job stopped.
mdAppBadTmpDir
Bad temporary directory resource.

mdSysOptions

Header: AcroErr.h:3045

Enum Constants

mdSysNoErr=0
No error.
mdSysEDOM=EDOM
The math argument is out of the domain of the function.
mdSysERANGE=ERANGE
The math result cannot be represented.
mdSysEPERM=EPERM
Not the super user.
mdSysENOENT=ENOENT
No such file or directory.
mdSysESRCH=ESRCH
No such process.
mdSysEINTR=EINTR
The system call was interrupted.
mdSysEIO=EIO
I/O error.
mdSysENXIO=ENXIO
No such device or address.
mdSysEBADF=EBADF
Bad file number.
mdSysEAGAIN=EAGAIN
No more processes allowed.
mdSysENOMEM=ENOMEM
Not enough core memory.
mdSysEACCES=EACCES
Permission is denied.
mdSysEEXIST=EEXIST
The file exists.
mdSysENOTDIR=ENOTDIR
Not a directory.
mdSysEISDIR=EISDIR
Is a directory.
mdSysENFILE=ENFILE
File table overflow.
mdSysEMFILE=EMFILE
Too many open files.
mdSysENOSPC=ENOSPC
No space is left on the device.
mdSysEROFS=EROFS
Read-only file system.
Too many links.
mdSysEDQUOT=EDQUOT
The disk quota was exceeded.
mdSysELOOP=ELOOP
There are too many levels of symbolic links.
mdSysEMULTIHOP=EMULTIHOP
A multihop was attempted.
Inactive link to a remote machine.
mdSysOVERFLOW=EOVERFLOW
Stat buffer overflow.
mdSysENAMETOOLONG=ENAMETOOLONG
The file name was too long.
mdSysEFAULT=EFAULT
Illegal address.

pageErrOptions

Header: AcroErr.h:1793

Enum Constants

pageErrNoError
No error.
pageErrTooFewOps
Too few operands.
pageErrWrongOpType
Wrong operand type.
pageErrOpTooLarge
The operand is too large.
pageErrBadContents
The page contents object has the wrong type.
pageErrImageExpectedNumber
Expected a number while parsing an image.
pageErrExpectedEndOfColor
Expected the end of color space.
pageErrExpectedHexOrASC85
Expected an AsciiHex or Ascii85 string.
pageErrErrorParsingImage
There was an error while trying to parse an image.
pageErrBadTypeInXTextArray
Bad object type within a text operator array.
pageErrUnexpectedOpInDisplay
An unexpected operator was found in the display list.
pageErrInvalidGRestore
Invalid restore.
pageErrFontNotSet
The font has not been set.
pageErrTooFewPathOps
There are too few operands in the path.
pageErrImageTooBig
The image in the form or Type 3 font is too big.
pageErrParseContextError
An error occurred while parsing a form or Type 3 font.
pageErrBadType3Font
Invalid Type 3 font.
pageErrFontNotInResources
A font is not in the Resources dictionary.
pageErrInvalidDash
Dash arguments are invalid.
pageErrArrayLenWrong
The array length is out of range.
pageErrNumberOutOfRange
A number value is out of range.
pageErrColorOutOfRange
A color value is out of range.
pageErrIllegalOpInTextOutline
There is an illegal operator inside a text outline object.
pageErrWrongNumOpsInCurve
A curve operator has the wrong number of operands.
pageErrSeveralParsingErrors
There were several parsing errors on this page.
pageErrWrongOperand
Wrong operand type. Another type was expected.
pageErrFontNotInResDict
Could not find a font in the Resources dictionary; using Helvetica instead.
pageErrXObjectNotFound
Could not find the XObject.
pageErrFormNotFound
Could not find the form.
pageErrUnknownXObjectType
Unknown XObject type.
pageErrReadLessImageData
Less image data was read than expected.
pageErrUnrecognizedToken
An unrecognized token was found.
pageErrTokenTypeNotRec
The token type was not recognized.
pageErrTooFewArgs
There were too few arguments.
pageErrTooManyArgs
There were too many arguments.
pageErrOperandTooLarge
An operand is too large.
pageErrErrorReadingPage
There was an error reading the page near the contents.
pageErrImageExpectedEI
Expected 'EI' while parsing an image.
pageErrUnknownFilterName
Unknown filter name.
pageErrBadDecodeArray
Bad decode array.
pageErrIllegalOpInPath
Illegal operation inside a path.
pageErrIllegalOpInTextObj
Illegal operation inside a text object.
pageErrReadLessImageColor
Less image color data was read than expected.
pageErrWrongArgsForSetColor
The wrong number of arguments were used for a setcolor operator.
pageErrUnknownColorSpace
Unknown ColorSpace.
pageErrColorSpaceNotFound
Could not find the ColorSpace.
pageErrBadForm
Invalid form.
pageErrIllegalTextOp
Illegal operation outside the text object.
pageErrFormTypeNotAvailable
The form type is not supported.
pageErrOBSOLETE
pageErrRecursiveMachine
Internal error: the machine was called recursively.
pageErrInvalidImageMaskDepth
An image is specified as an image mask with more than 1 bit per pixel.
pageErrBadPattern
Invalid Pattern.
pageErrPatternTypeNotAvailable
The Pattern type is not supported.
pageErrPatternNotFound
Could not find the Pattern.
pageErrBadColorSpace
Invalid color space.
pageErrMissingResource
A resource is missing.
pageErrMissingKey
The dictionary is missing the key.
pageErrEGStateNotFound
Could not find the Extended Graphics State.
pageErrBadEGS
Invalid Extended Graphics State.
pageErrBadFunction
Invalid Function resource.
pageErrBadEPSColorSpace
An image uses a color space which will not separate correctly in some applications.
pageErrBadShading
There is an error in the Shading dictionary.
pageErrBadMaskImage
There is an error in the Masked Image.
pageErrTooManyComps
There were too many color components.
pageErrNotLevel3
A feature requires PostScript 3.
pageErrBadAltXObject
Invalid alternate image for the XObject.
pageErrBadTGroup
Invalid transparency group.
pageErrBadSoftMask
Invalid soft mask.
pageErrBadHalftone
Invalid halftone.
pageErrIllegalColorOp
A color operator was used where it is not permitted.
pageErrRefXObjTargetNotFound
Reference XObject target not found
pageErrRefXObjPageNum
Invalid page number for target document
pageErrRefXObjMissingInvalidID
Missing or Invalid ID in Reference Dictionary
pageErrRefXObjUnmatchedID
Xobject ID does not match with Document ID
pageErrRefXObjMissingInvalidMetadata
Missing or invalid metadata in X-5 compliant file
pageErrRefXObjRecursive
Reference XObject points to itself
pageErrUnableRenderImage
There was an error while trying to render an image
pageErrErrorParsingInlineImage
Inline image L key out-of-range

pdMetadataErrOptions

Header: AcroErr.h:2706

Enum Constants

pdMetadataErrBadXAP
The given metadata was not in the XAP format.
pdMetadataErrBadPDF
XAP metadata processing found a syntax error in the PDF.
pdMetadataErrCouldntCreateMetaXAP
An internal representation of the XAP metadata could not be created.
pdMetadataErrInternalError
An internal error occurred while processing the XAP metadata.

pdModErrOptions

Header: AcroErr.h:1604

Enum Constants

pdModErrNoError
No error.
pdModErrEncTablesFailed
Unable to initialize the font encoding tables.
pdModErrDuplicateCryptName
A security plug-in with this name is already registered.
pdModErrDuplicatePermName
A permission handler with this name is already registered.
pdModErrBadNavigator
This navigator file cannot be read. Ensure that the mimetype file exists and is the first file in the package.
pdModErrNewNavigator
This navigator requires a new version of Acrobat.
pdModErrNavUnknownExtension
This navigator does not have a valid file extension. The only valid file extension for a navigator is either \"nav\" or \"swf\".
pdModErrNavInvalidMimeType
This navigator has an invalid mimetype file. The navigator mimetype must be \"application/vnd.adobe.pdf-navigator\".
pdModErrNavMissingSwf
This navigator is missing its swf file. Check the spelling of the file name (it is case sensitive).
pdModErrNavMissingNavigatorXML
This navigator is missing its navigator xml file.
pdModErrNavMissingLocalesXML
This navigator is missing its locales xml file. Check the spelling of the file name (it is case sensitive).
pdModErrNavMissingStringsXML
This navigator is missing one or more of its localization xml files. Check the spelling of the file name (it is case sensitive).
pdModErrNavInvalidNavigatorXML
This navigator's navigator xml file is malformed. Verify that your xml file is valid per the navigator schema.
pdModErrNavInvalidLocalesXML
This navigator's locales xml file is malformed. Verify that your xml file is valid per the navigator schema.
pdModErrNavInvalidStringsXML
One or more of this navigator's localization xml files is malformed. Verify that your xml file is valid per the navigator schema.

pdOptions

Header: AcroErr.h:935

Enum Constants

pdErrNoError
No error.
pdErrBadFont
Bad font object or font descriptor object.
pdErrEmbeddingFont
An error occurred while trying to embed a font.
pdErrBadRootObj
The root object is missing or invalid.
pdErrBadBaseObj
The base pages object is missing or invalid.
pdErrBadOutlineObj
The outlines object is missing or invalid.
pdErrBadResMetrics
There are invalid or corrupt font metrics in the resource file.
pdErrBadPageObj
A page object is missing or invalid.
pdErrThumbError
An error occurred while processing a thumbnail.
pdErrBadAnnotation
Invalid annotation object.
pdErrBadPageTree
The document's page tree contains an invalid node.
pdErrUnknownProcsets
The information needed to print a page is unavailable.
pdErrUnableToOpenDoc
This file could not be opened.
pdErrIsFileLocked
Unable to open the file for writing. It may be locked or unavailable.
pdErrUnableToWrite
Unable to write the file.
pdErrUnableToRenameTemp
Unable to rename the temporary file to the Save As name.
pdErrUnableToRecover
Unable to recover the original file.
pdErrUnableToRead
Unable to read the file.
pdErrUnknownFileType
This is not a valid PDF document. It cannot be opened.
pdErrAlreadyOpen
This file is already open.
pdErrTooManyPagesForOpen
This file cannot be opened because it contains too many pages.
pdErrNotEnoughSpaceForTempFile
There is not enough temporary disk space for this operation.
pdErrTooManyPagesForInsert
Inserting this file would result in a document with too many pages.
pdErrBookmarksError
There is an error in the bookmarks.
pdErrCannotOpenMoreBkMark
Cannot open more bookmarks.
pdErrUnableToExtractFontErr
Unable to extract embedded font.
pdErrCannotOpenNotes
An error occurred while creating the document notes file.
pdErrNoNotes
This document has no notes.
pdErrCopyPageFailed
The copy of a page failed.
pdErrNeedRebuild
This file is damaged.
pdErrBadFontFlags
The font contains bad /Flags.
pdErrBadFontBBox
The font contains a bad /BBox.
pdErrBadFontWidths
The font contains bad /Widths.
pdErrOldCosFileOBSOLETE
pdErrTrySaveAs
This file can only be saved using Save As.
pdErrAbortNotes
Creation of the notes file was cancelled.
pdErrPagesLockedNotDeleted
One or more pages are in use and could not be deleted.
pdErrNotEnoughMemoryToOpenDoc
There is not enough memory available to open the document.
pdErrUnableToCloseDueToRefs
Unable to close the document due to outstanding references.
pdErrNeedPassword
This document requires a password.
pdErrOpNotPermitted
This operation is not permitted.
pdErrNoCryptHandler
The security plug-in required by this command is unavailable.
pdErrBadThread
Invalid article object.
pdErrBadBead
Invalid article element.
pdErrThreadProcessing
An error occurred while processing articles.
pdErrUnknownAction
Unknown action type.
pdErrBadAction
Invalid action object.
pdErrCantUseNewVersion
This file contains information not understood by the viewer. It cannot be used for this operation.
pdErrOldEncryption
This viewer cannot decrypt this document.
pdErrUnableToExtractFont
Unable to extract the embedded font. Some characters may not display or print correctly.
pdErrUnableToFindFont
Unable to find or create the font. Some characters may not display or print correctly.
pdErrBadAnnotColor
Invalid annotation color (only RGB colors are allowed).
pdErrNeedCryptHandler
Cannot execute this command on an unsecured document.
pdErrBadFontDescMetrics
The font contains bad /FontDescriptor metrics.
pdErrWhileRecoverInsertPages
There was an error while inserting or extracting pages and another error while trying to recover.
pdErrBadBookmark
Invalid bookmark object.
pdErrBadFileSpec
Invalid file specification object.
pdErrAfterSave
This document was successfully saved, but an error occurred after saving the document. Please close and reopen the document.
pdErrUnableToXlateText
Some text in the font and character could not be displayed or printed correctly. The font could not be reencoded.
pdErrTextStringTooShort
Not enough bytes are in the text string for the multibyte character code.
pdErrBadCMap
A font contains a bad CMap /Encoding.
pdErrOldATMVersion
The font cannot be displayed with the installed version of Adobe Type Manager.
pdErrZeroPageFile
This file cannot be opened because it has no pages.
pdErrATMMemory
Adobe Type Manager is running out of memory. The text in the font may not render properly.
pdErrOptMemory
There is not enough memory to optimize this file.
pdErrCancelSave
The Save operation was cancelled.
pdErrCannotMergeWithSubsetFonts
These documents contain subset fonts that have the same name and cannot be merged.
pdErrCannotReopenDoc
This document was successfully saved, but an error occurred after saving the document. Please close and reopen the document.
pdErrNoPDDocForCosDoc
No PDDoc is associated with the CosDoc.
pdErrHostEncodingNotSet
The application has not set the host encoding.
pdErrInvalidEmbeddedFont
An invalid font was removed from the document.
pdErrCannotDeleteAllPages
You cannot delete all pages. At least one page must remain.
pdErrStartLessThanEnd
The starting page number must be less than or the same as the ending page number.
pdErrNotValidPage
There is no page with such a number in this document.
pdErrCannotBeBlankPage
The page number cannot be left blank.
pdErrInvalidPageNumber
Invalid page number.
pdErrExceedEncryptionLength
Exceeds support encryption key length.
pdErrExceedEncryptionVersion
This version of encryption is not supported.
pdErrRequireTrustedMode
Only Adobe certified Acrobat plug-ins are allowed while viewing this document.
pdErrMissingGlyphs
Unable to find a substitution font with all the characters used by the font. Some characters may not be displayed or printed.
pdErrNeedTradChinese
An error has occurred that may be fixed by installing the latest version of the Traditional Chinese Language Support package.
pdErrNeedSimpChinese
An error has occurred that may be fixed by installing the latest version of the Traditional Chinese Language Support package.
pdErrNeedKorean
An error has occurred that may be fixed by installing the latest version of the Korean Language Support package.
pdErrNeedJapanese
An error has occurred that may be fixed by installing the latest version of the Japanese Language Support package.
pdErrMissingSubsetFont
A font required for font substitution is missing.
pdErrCMapNotFound
The encoding (CMap) specified by a font is missing.
pdErrLimitcheck=92
The implementation limit was exceeded.
pdErrPrintAsImageSpoolFileFull
There is insufficient disk space for the print job spool file to hold the entire print job. Try freeing up disk space on the startup volume and print the remaining pages of the document again.
pdErrInvalidMediaBox
Invalid MediaBox.
pdEnumCanceled=97
The enumeration process was cancelled by the callback function.
pdErrFontEmbeddingFailed
Could not embed the font.
pdErrFontEmbeddingCanceled=101
Font embedding was cancelled.
pdErrMultipleDocuments
The operation could not be performed because the objects belong to different documents.
pdErrBadOCObject
Invalid type or value in an Optional Content object.
pdErrNoInlineImage
The operation could not be performed because the image is inline.
pdErrNoCryptFilterHandler
The required Crypt Filter is not registered by the security handler plug-in.
pdErrBadEncryptDict
Bad encryption dictionary.
pdErrNoPermHandler=108
The permission handler required by this command is unavailable.
pdErrDuplicatePermHandler
The permission handler has already been added for this document.
pdErrExceedMaxPermHandlers
The maximum number of permission handlers has been reached for this document.
pdErrBadEncoding=112
The font contains an invalid encoding. Some characters may not display.
pdErrMatrixTooBig
The implementation limit was exceeded. Try decreasing the magnification level.
pdErrNeedExtendedLang=120
An error has occurred that may be fixed by installing the latest version of the Extended Language Support package.
pdErrUnknownCryptFilter
This file is encrypted with an unsupported cryptograhpic algorithm. A later version of Acrobat may be needed in order to open this document.
pdErrNeed3D
An error has occurred that may be fixed by installing the latest version of the 3D Support package.
pdErr3DUnsupported
3D artwork is not supported under this operating system.
pdErrNonFIPSCrypt
Use of non FIPS cryptography is not permitted while in FIPS mode.
pdMsgFontUsage
Determining fonts used in document
pdErrUnableToOpenXFA
Unable to open XFA PDF files.
pdErrInvalidOutputIntentProfile
Unable to parse of process DestProfile from Output Intent
pdMsgAnalyzingPageContent
pdMsgResampleCompressImages
pdMsgRemovingThumbnails
pdMsgRemovingUnusedForms
pdMsgRemovingUnusedImages
pdMsgRemovingUnusedFonts
pdMsgRemoveEmbeddedFonts
pdMsgRemoveEmbeddedBase14Fonts
pdMsgRemovePieceInfo
pdMsgRemoveFileAttachments
pdMsgRemoveComments
pdMsgRemoveAnnotations
pdMsgRemovingMetadata
pdMsgRemovingDocInfo
pdMsgRemovingJavaScriptActions
pdMsgRemovingStructureTree
pdMsgPreparingEmbeddingFonts
pdMsgCreatingPDFontRepresentations
pdErrBadRegex
pdErrLinearizeSaveCircularRecursionFound
pdErrNotAnXFADoc
pdErrXFANotAllowed
pdErrXFAFormsAddOnNotLoaded
pdErrNotAnAcroFormsDataImportType
pdErrNotAnAcroFormsDataExportType
pdErrNotAnXFADataExportType
pdErrNotAnAcroFormsDoc
pdErrXFAFormsExtensionNotLoaded
pdErrContainsFormsData

pdPErrOptions

Header: AcroErr.h:1566

Enum Constants

pdPErrNoError
No error.
pdPErrPageDimOutOfRange
The dimensions of this page are out of range.
pdPErrBadType3Font
Invalid Type 3 font.
pdPErrType3TooComplex
The Type 3 font is too complex to print.
pdPErrFormTooComplex
The form is too complex to print.
pdPErrUnableToCreateRasterPort
The creation of a raster port failed.
pdPErrIncorrectPsOutputType
pdPErrUnableToOpenPrinter

pdfxErrOptions

Header: AcroErr.h:2504

Enum Constants

pdfxErrNoError
No error.
pdfxErrWrongCallbacks
The size of the passed callbacks struct is wrong (version).
pdfxErrDuringCallback
There was an attempt to call a PDFXInstance function during a callback proc.
pdfxErrCannotLaunchAcrobat
PDFX could not launch Acrobat.
pdfxErrCannotFindEWH
Could not find the External Window Handler plug-in.

pdsErrOptions

Header: AcroErr.h:2669

Enum Constants

pdsErrRequiredMissing
A required field was missing from a dictionary.
pdsErrBadPDF
An incorrect structure was found in the PDF file.
pdsErrWrongTypeEntry
The dictionary entry has the wrong Cos type.
pdsErrWrongTypeParameter
The wrong type parameter was supplied to a PDS procedure.
pdsErrAlreadyExists
There is already a table entry with the same name.
pdsErrCantDo
Some software required to perform this operation is not present in this version of Acrobat.
pdsErrBadStructureTree

peErrOptions

Header: AcroErr.h:2533

Enum Constants

peErrNoError
No error.
peErrUnknownPDEColorSpace
Unknown PDEColorSpace value.
peErrWrongPDEObjectType
Incorrect PDEObject type.
peErrUnknownResType
Unknown PDEObject resource type.
peErrPStackUnderflow
PDFEdit parse stack underflow while reading object.
peErrCantCreateFontSubset
Unable to create embedded font subset.
peErrBadBlockHeader
Bad block header for Type 1 embedded stream.
peErrCantGetAttrs
Unable to get attributes for the font.
peErrCantGetWidths
Unable to get widths for the font.
peErrFontToEmbedNotOnSys
Unable to find the font to embed on this system.
peErrCantEmbedFont
This font is licensed and cannot be embedded.
peErrCantGetImageDict
Unable to get the image dictionary.
peErrCantReadImage
Unable to read the image data.
peErrCantGetShading
Unable to get the shading resource.
peErrWrongOpType
Wrong operand type.
peErrTooFewPathOps
There were too few operands in the path.
peErrErrorParsingImage
There was an error while trying to parse an image.
peErrReadLessImageColor
Less image color data was read than expected.
peErrReadLessImageData
Less image data was read than expected.
peErrBadResMetrics
There are invalid or corrupt font metrics in the resource file.
peErrBadType3Font
Invalid Type 3 font.
peErrInvalidUnicodeAttribute
Invalid Unicode attribute or attribute not set.
peErrIllegalUTFText
Invalid Unicode text.
peErrToUnicodeUsesPUA
Private User Area of Unicode used
peErrBadFont
Font embedding failed because of invalid or corrupt font.
peErrOpValueDoesNotFitInFixed
Operand value will not fit in ASFixed range.

rasErrOptions

Header: AcroErr.h:2252

Enum Constants

rasErrNoError
No error.
rasErrInitFailed
Initialization of the rasterizer module failed.
rasErrCreatePort
Creation of the rasterizer port failed.
rasErrDraw
A rasterizer error occurred.
rasErrGPUFailed
GPU drawing failed; reverted to CPU.

xmErrOptions

Header: AcroErr.h:2418

Enum Constants

xmErrNoError
No error.
xmErrOutOfDateHFT
The plug-in was compiled with an out-of-date HFT.
xmErrNoPLUGResource
The plug-in lacks a PLUG resource of ID 1.
xmErrPluginIncompatible
The plug-in is incompatible with this version of the viewer.
xmErrInitializationFailed
The plug-in failed to initialize.
xmErrFormsExtensionIsNotLicensed
The Forms Extension is not licensed for use.
xmErrDuplicatePluginName
Two plug-ins are attempting to register with the same name.
xmErrCannotReplaceSelector
There was an attempt to replace an unreplaceable selector.
xmErrCalledObsoleteProc
An unimplemented function was called.
xmErrPluginLoadFailed
The plug-in failed to load.
xmErrNotPrivileged
Adobe Reader cannot load this plug-in.
xmErr68KOnly
Only the 68K Viewer can load this plug-in.
xmErrPPCOnly
Only the PowerPC Viewer can load this plug-in.
xmErrPlugInNotTrusted
This is not a trusted plug-in.
xmErrPlugInNotCarbonized
This plugin cannot load on Mac OS X.
xmErrPluginResourceMismatch
The currently selected language resources are not supported by this plugin.

General Typedefs

ErrSeverity

Header: AcroErr.h:181

Description

For value options see ErrOptions.

Syntax

typedef ASEnum8 ErrSeverity;

ErrSystem

Header: AcroErr.h:284

Description

For value options see ErrSysOptions.

Syntax

typedef ASEnum8 ErrSystem;

NSelector

Header: PDFLExpT.h:73

Syntax

typedef Int32 NSelector;

Used By

PDEncodingType

Header: PDFLExpT.h:1563

Description

Font encoding methods.

For value options see PDDoOptions.

Syntax

typedef ASInt32 PDEncodingType;

PlatformBitmapPtr

Header: PDFLExpT.h:46

Syntax

typedef HBITMAP PlatformBitmapPtr;

PlatformBitmapPtr

Header: PDFLExpT.h:48

Syntax

typedef HPS PlatformBitmapPtr;

PlatformBitmapPtr

Header: PDFLExpT.h:52

Syntax

typedef void *PlatformBitmapPtr;

PlatformWindowPtr

Header: PDFLExpT.h:44

Syntax

typedef HWND PlatformWindowPtr;

PlatformWindowPtr

Header: PDFLExpT.h:51

Syntax

typedef void *PlatformWindowPtr;

TextServer

Header: PDFLExpT.h:1509

Description

Text server.

Syntax

typedef struct _t_TextServer *TextServer;

ThreadLocalKey

Header: PDFInit.h:425

Syntax

typedef DWORD ThreadLocalKey;

ThreadLocalKey

Header: PDFInit.h:618

Syntax

typedef TaskStorageIndex ThreadLocalKey;

ThreadLocalKey

Header: PDFInit.h:787

Syntax

typedef pthread_key_t ThreadLocalKey;

General Callback Signatures

ASClientAllocProc

Header: PDFInit.h:168

Description

Called when the PDF Library needs to allocate memory. The callback should allocate the requested amount of memory and return it as a void *.

Syntax

ASClientAllocProc(void *clientData, ASSize_t size);

Parameters

clientData
The clientData specified in the TKAllocatorProcs structure.
size
The amount of memory to be allocated.

Returns

A pointer to the allocated block of memory.

Used In

ASClientFreeProc

Header: PDFInit.h:199

Description

Called when the PDF Library needs to free memory. The callback should free the requested block of memory.

Syntax

void ASClientFreeProc(void *clientData, void *p);

Parameters

clientData
A pointer to the clientData specified in the TKAllocatorProcs structure.
p
A pointer to memory to free.

Used In

ASClientMemAvailProc

Header: PDFInit.h:213

Description

Called when the PDF Library needs to determine the amount of available free memory.

Syntax

ASSize_t ASClientMemAvailProc(void *clientData);

Parameters

clientData
A pointer to the clientData specified in the TKAllocatorProcs structure.

Returns

The amount of available free memory.

Used In

ASClientReallocProc

Header: PDFInit.h:185

Description

Called when the PDF Library needs to reallocate memory. The callback should reallocate the requested amount of memory and return it as a void *.

Syntax

ASClientReallocProc(void *clientData, void *p, ASSize_t size);

Parameters

clientData
A pointer to the clientData specified in the TKAllocatorProcs structure.
p
A pointer to memory to reallocate.
size
The amount of memory requested.

Returns

A pointer to the allocated block of memory.

Used In

ExternalFilePermissionProc

Header: PDFLExpT.h:87

Syntax

ASBool ExternalFilePermissionProc(CosDoc dP, ASFileSys *fileSys, ASPathName *path);

Used By

PDDoExtGStateProc

Header: PDFLExpT.h:1812

Description

A callback method that is called when an ExtGState object is encountered. This method is called for each key/value pair in the ExtGState object. If this method returns true, then the key/value will be emitted into the print job. If this method returns false, then nothing will be emitted for this key/value. If emitHalftones is false, then this method will not be called for the HT key.

Related Methods

Syntax

ASBool PDDoExtGStateProc(ASAtom egsKey, CosObj egsValue, PDPrintClient printClient);

Parameters

egsKey
A key in ExtGState.
egsValue
The ExtGState value for egsKey.
printClient
The object passed to PDDocPrintPages().

Returns

true to emit this key/value pair, false to ignore the key/value.

PDFLClientRNGProc

Header: PDFLExpT.h:106

Description

A callback for PDFLibraryRegisterRNG(). It is called once to provide random data for encryption. Normally an operating system supplied source of highly random numbers is used ( /dev/urandom on Mac OS and Unix, CryptGenRandom() on Windows). For some supported Unix environments, the /dev/urandom device does not exist. While it is preferable to install this device, the PDFLibraryRegisterRNG() function is provided for the client to register an alternate source for strong random data.

Syntax

ASSize_t PDFLClientRNGProc(ASSize_t len, ASUns8P buffer);

Parameters

len
The length (in bytes) of the request.
buffer
The buffer for the client to fill in.

Returns

The number of bytes actually filled in the buffer.

Used By

PDOCFindOutAutoStatePrefProc

Header: PDFLExpT.h:2500

Description

Declare the type PDOCFindOutAutoStatePrefProc, which is a callback that lets the client set the AutoState preference.

Syntax

ASBool PDOCFindOutAutoStatePrefProc();

Used By

PDOCFindOutLanguageProc

Header: PDFLExpT.h:2494

Description

Declare the type PDOCFindOutLanguageProc, which is a callback that lets the client set the current user interface language level.

Syntax

char *PDOCFindOutLanguageProc();

Used By

PDOCFindOutUserProc

Header: PDFLExpT.h:2497

Description

Declare the type PDOCFindOutUserProc, which is a callback that lets the client set the current user interface user level.

Syntax

ASText PDOCFindOutUserProc(ASAtom indTtlOrOrg);

Used By

PDOCFindOutZoomProc

Header: PDFLExpT.h:2491

Description

Declare the type PDOCFindOutZoomProc, which is a callback that lets the client set the current user interface zoom level.

Syntax

float PDOCFindOutZoomProc(PDDoc pdDoc);

Used By

TKResourceAcquireProc

Header: PDFInit.h:290

Description

A callback in the TKResourceProcs structure in the Adobe PDF Library. It acquires the specified resource and uses it to fill in the rdStm parameter.

Related Methods

Syntax

void *TKResourceAcquireProc(char *resourceName, ASInt32 resType, void *registry, ASInt32 *size, void *clientData, ASStm *rdStm);

Parameters

resourceName
The name of the resource to acquire.
resType
    One of the following from the resType enum:
  • resCMapData
  • resCharTypeData
  • resCharRangeData
  • resFontPropData
  • resCJKNoteFontNormal
  • resCJKNoteFontBold
  • resCJKNoteFontOblique
  • resFontData
  • resCMapLastID
registry
One of the following:
Value
Description
Adobe-Japan1
Japanese
Adobe-Korea1
Korean
Adobe-CNS1
Traditional Chinese
Adobe-GB1
Simplified Chinese
size
(Filled by the callback) The size of the ASStm returned.
clientData
A pointer to the clientData specified in the TKResourceProcs structure.
rdStm
(Filled by the callback) An ASStm for the data requested.

Returns

A void * of data that you want returned to you in TKResourceReleaseProc(). This data can be used to determine what Resource to release. You can return NULL from TKResourceAcquireProc().

Used In

TKResourceReleaseProc

Header: PDFInit.h:307

Description

A callback in the TKResourceProcs structure in the Adobe PDF Library. It releases the resources previously acquired and closes the ASStm passed in as rdStm.

Related Methods

Syntax

void TKResourceReleaseProc(ASStm rdStm, void *data, void *clientData);

Parameters

rdStm
An ASStm for the resource to release and close with ASStmClose().
data
The clientData returned from PMSetTextProc().
clientData
A pointer to the clientData specified in the TKResourceProcs structure.

Used In

General Structures

_t_PDFLData

Header: PDFInit.h:426

Syntax

struct _t_PDFLData {
ASSize_t size;
The size of the data structure. It must be set to sizeof(PDFLDataRec).
ASUns32 flags;
Currently kPDFLInitIgnoreDefaultDirectories, kPDFLInitIgnoreSystemFonts and kDontLoadPlugIns flags are supported. When kPDFLInitIgnoreDefaultDirectories flag is set, the initialization process does not search through the default font directories(currently Adobe font directories installed by some Adobe applications), but only in those specified in dirList. When kPDFLInitIgnoreSystemFonts flag is set, the initialization process does not search through default System fonts also. When kDontLoadPlugIns flag is set, plug-ins are ignored during initialization process.
HINSTANCE inst;

(Windows only)

The location of resources for the Library. For a static library, you link them into your application and use NULL for inst. For a DLL version of the library, call LoadLibrary on the DLL and set inst equal to the HINSTANCE returned:

libData.inst = LoadLibrary("PDFL50.DLL");

If you are linking the static library into a DLL, pass the HINSTANCE passed into DllMain or WinMain for inst, and link the resources into the DLL.

Free the HINSTANCE with FreeLibrary after you call PDFLTerm.

ASUTF16Val **dirList;
List of directories with fonts.
ASInt32 listLen;
The number of directories listed in dirList.
TKAllocatorProcsP allocator;
The structure containing function pointers for memory allocation callbacks. The library manages its own memory. Most applications linking with the library should pass NULL for this member. Applications wishing more control over memory allocation can fill out this structure and will be responsible for providing and freeing memory, as well as reporting available memory as requested by the library.
TKResourceProcsP resProcs;
The structure containing function pointers for resource management callbacks. The library manages its own resources. Most applications linking with the library should pass NULL for this member. Applications wishing more control over resource allocation can fill out this structure and will be responsible for providing and freeing resources requested by the library.
The structure containing function pointers for ASExtension callbacks used by the PDF Library.
ASUTF16Val **cacheFileList;
A list of font cache file names. It is parallel to dirList, but contains separately configurable target files for CoolType cache files for use in cases where the specified font directory may not be writable by the client. If same font cache file name is provided for different font directories, font cache file created for the earlier font directory will get overwritten. Either cacheFileList or any/all of its subsidiary pointers may be NULL, in which case CoolType will default to the font directory passed in dirList.
ASUTF16Val *systemCacheFile;
A separately configurable target file where CoolType should store the system font cache file. It may be NULL, in which case CoolType will choose a default path.
ASUTF16Val *commonCacheFile;
Separately configurable target file where CoolType should store the common font cache file. It may be NULL, in which case CoolType will choose a default path.
ASUTF16Val *cMapDirectory;
The complete NULL-terminated path of the directory where CoolType can find CMap files. This directory will be the preferred location for CMaps that are associated with the system fontset. If CMaps with the same name are found in this directory and common fonts directory, the copy in this directory will be preferred. It may be NULL, in which case CoolType will only associate CMaps present in the common fonts directory with the system font set.
ASUTF16Val *unicodeDirectory;
The complete, NULL-terminated path of the directory in which the Unicode mapping files can be found.
ASInt32 pluginDirListLen;
    Specifies the number of directories listed in pluginDirList. With regards to loading plug-ins, PDF Library behavior is now as follows:
  • If pluginDirListLen > 0, then PDF Library will only look for plug-ins in the paths passed in pluginDirList. It will not search the earlier locations, (for example, "pdfplug_ins" folder on Windows, "PDFPlug-Ins" on Mac OS, and the list of directories passed in dirList on Unix.
  • If pluginDirListLen 0 or is not a part of the PDFLDataRec structure passed by the PDF Library client, then PDF Library will search the earlier locations for plug-ins.
ASUTF16Val **pluginDirList;

An array of plug-in directories.

If a PDF Library client wants PDFL to load headless PDF Library plug-ins from desired locations, the client can pass a list of paths in pluginDirList. The 2 fields pluginDirList and pluginDirListLen are similar to the existing fields dirList and listLen.

Clients can pass an array of plug-in directories in the field pluginDirList:

  • On Windows, pluginDirList is an array of ASUTF16Val paths. Each path should be NULL-terminated.
  • On Mac OS, the paths passed in pluginDirList should be NULL-terminated UTF-8 POSIX strings. Hence, the type of pluginDirList on Mac is char * *.
  • On Unix, the paths passed in pluginDirList should be simple NULL-terminated char strings.
ASInt32 colorProfileDirListLen;
Specifies the number of directories listed in colorProfileDirList.
ASUTF16Val **colorProfileDirList;

An array of color profile directories.

If a PDF Library client wants to search for color profiles from custom directories, the client can pass a list of paths in colorProfileDirList. The 2 fields colorProfileDirList and colorProfileDirListLen are similar to the existing fields dirList and listLen.

If the client does not set this parameter then PDF Library will search for the color profiles from default locations such as Creative Suites and Acrobat installation directories. If the clients sets this parameter then PDF Library will search for the color profiles from it's default directory as well as from the custom directories specified by the client through parameter colorProfileDirList. However the order of searching for these profiles from default and custom directories is not fixed.

  • On Windows, colorProfileDirList is an array of ASUTF16Val paths. Each path should be NULL-terminated.
  • On Mac OS, the paths passed in colorProfileDirList should be NULL-terminated UTF-8 POSIX strings. Hence, the type of colorProfileDirList on Mac is char * *.
  • On Unix, the paths passed in colorProfileDirList should be simple NULL-terminated char strings.
HDC initDC;
A valid Device Context or NULL. In most cases it should be set to NULL. It means APDFL will create a compatible DC (PlatformRenderData::InitPlatformGlyphCode) and will delete it later (PlatformRenderData::CleanupPlatformGlyphCode). This parameter should be set to a valid DC if APDFL is used in a printer driver on 64-bit Vista. It is because the spooler on 64-bit Vista should not call CreateDC() if a print job was requested from a 32bit app. (See http://msdn.microsoft.com/en-us/library/aa505681.aspx)
ASUTF16Val *officeMetricsDirectory;
No longer used, deprecated.
} PDFLDataRec, *PDFLData;

_t_PDFLData

Header: PDFInit.h:621

Description

PDFLData structure.

Syntax

struct _t_PDFLData {
ASSize_t size;
The size of the data structure. It must be set to sizeof(PDFLDataRec).
ASUns32 flags;
Currently kPDFLInitIgnoreDefaultDirectories, kPDFLInitIgnoreSystemFonts and kDontLoadPlugIns flags are supported. When kPDFLInitIgnoreDefaultDirectories flag is set, the initialization process does not search through the default font directories(currently Adobe font directories installed by some Adobe applications), but only in those specified in dirList. When kPDFLInitIgnoreSystemFonts flag is set, the initialization process does not search through default System fonts also. When kDontLoadPlugIns flag is set, plug-ins are ignored during initialization process.
char **dirList;
A list of directories with fonts.
ASInt32 listLen;
The number of directories listed in dirList.
TKAllocatorProcsP allocator;
The structure containing function pointers for memory allocation callbacks. The library manages its own memory. Most applications linking with the library should pass NULL for this member. Applications wishing more control over memory allocation can fill out this structure and will be responsible for providing and freeing memory, as well as reporting available memory as requested by the library.
short resFile;

(Mac only)

The resources location, if they are not in the application itself. Set them using OpenResFile:

TKResourceProcsP resProcs;
The structure containing function pointers for resource management callbacks. The library manages its own resources. Most applications linking with the library should pass NULL for this member. Applications wishing more control over resource allocation can fill out this structure and will be responsible for providing and freeing resources requested by the library.
The structure containing function pointers for ASExtension callbacks used by the PDF Library.
char **cacheFileList;
A list of font cache file names. It is parallel to dirList, but contains separately configurable target files for CoolType cache files for use in cases where the specified font directory may not be writable by the client. If same font cache file name is provided for different font directories, font cache file created for the earlier font directory will get overwritten. Either cacheFileList or any/all of its subsidiary pointers may be NULL, in which case CoolType will default to the font directory passed in dirList.
char *systemCacheFile;
Separately configurable target file where CoolType should store the system font cache file. It may be NULL, in which case CoolType will choose a default path.
char *commonCacheFile;
Separately configurable target file where CoolType should store the common font cache file. It may be NULL, in which case CoolType will choose a default path.
char *cMapDirectory;
The complete NULL-terminated path of the directory where CoolType can find CMap files. This directory will be the preferred location for CMaps that are associated with the system fontset. If CMaps with the same name are found in this directory and common fonts directory, the copy in this directory will be preferred. May be NULL, in which case CoolType will only associate CMaps present in common fonts directory with the system font set.
char *unicodeDirectory;
The complete, NULL-terminated path of the directory in which the Unicode mapping files can be found.
ASInt32 pluginDirListLen;
    Specifies the number of directories listed in pluginDirList. With regards to loading plug-ins, PDF Library behavior is now as follows:
  • If pluginDirListLen > 0, then PDF Library will only look for plug-ins in the paths passed in pluginDirList. It will not search the earlier locations, (for example, "pdfplug_ins" folder on Windows, "PDFPlug-Ins" on Mac OS, and the list of directories passed in dirList on Unix.
  • If pluginDirListLen 0 or is not a part of the PDFLDataRec structure passed by the PDF Library client, then PDF Library will search the earlier locations for plug-ins.
char **pluginDirList;

An array of plug-in directories.

If a PDF Library client wants PDFL to load headless PDF Library plug-ins from desired locations, the client can pass a list of paths in pluginDirList. The 2 fields pluginDirList and pluginDirListLen are similar to the existing fields dirList and listLen.

Clients can pass an array of plug-in directories in the field pluginDirList:

  • On Windows, pluginDirList is an array of ASUTF16Val paths. Each path should be NULL-terminated.
  • On Mac OS, the paths passed in pluginDirList should be NULL-terminated UTF-8 POSIX strings. Hence, the type of pluginDirList on Mac is char * *.
  • On Unix, the paths passed in pluginDirList should be simple NULL-terminated char strings.
ASInt32 colorProfileDirListLen;
Specifies the number of directories listed in colorProfileDirList.
char **colorProfileDirList;

An array of color profile directories.

If a PDF Library client wants to search for color profiles from custom directories, the client can pass a list of paths in colorProfileDirList. The 2 fields colorProfileDirList and colorProfileDirListLen are similar to the existing fields dirList and listLen.

If the client does not set this parameter then PDF Library will search for the color profiles from default locations such as Creative Suites and Acrobat installation directories. If the clients sets this parameter then PDF Library will search for the color profiles from it's default directory as well as from the custom directories specified by the client through parameter colorProfileDirList. However the order of searching for these profiles from default and custom directories is not fixed.

  • On Windows, colorProfileDirList is an array of ASUTF16Val paths. Each path should be NULL-terminated.
  • On Mac OS, the paths passed in colorProfileDirList should be NULL-terminated UTF-8 POSIX strings. Hence, the type of colorProfileDirList on Mac is char * *.
  • On Unix, the paths passed in colorProfileDirList should be simple NULL-terminated char strings.
} PDFLDataRec, *PDFLData;

_t_PDFLData

Header: PDFInit.h:790

Description

PDFLData structure.

Syntax

struct _t_PDFLData {
ASSize_t size;
The size of the data structure. It must be set to sizeof(PDFLDataRec).
ASUns32 flags;
Currently kPDFLInitIgnoreDefaultDirectories, kPDFLInitIgnoreSystemFonts and kDontLoadPlugIns flags are supported. When kPDFLInitIgnoreDefaultDirectories flag is set, the initialization process does not search through the default font directories(currently Adobe font directories installed by some Adobe applications), but only in those specified in dirList. When kPDFLInitIgnoreSystemFonts flag is set, the initialization process does not search through default System fonts also. When kDontLoadPlugIns flag is set, plug-ins are ignored during initialization process.
char **dirList;
A list of directories with fonts.
ASInt32 listLen;
The number of directories listed in dirList.
TKAllocatorProcsP allocator;
The structure containing function pointers for memory allocation callbacks. The library manages its own memory. Most applications linking with the library should pass NULL for this member. Applications wishing more control over memory allocation can fill out this structure and will be responsible for providing and freeing memory, as well as reporting available memory as requested by the library.
TKResourceProcsP resProcs;
The structure containing function pointers for resource management callbacks. The library manages its own resources. Most applications linking with the library should pass NULL for this member. Applications wishing more control over resource allocation can fill out this structure and will be responsible for providing and freeing resources requested by the library.
The structure containing function pointers for ASExtension callbacks used by the PDF Library.
char **cacheFileList;
A list of font cache file names. It is parallel to dirList, but contains separately configurable target files for CoolType cache files for use in cases where the specified font directory may not be writable by the client. If same font cache file name is provided for different font directories, font cache file created for the earlier font directory will get overwritten. Either cacheFileList or any/all of its subsidiary pointers may be NULL, in which case CoolType will default to the font directory passed in dirList.
char *systemCacheFile;
Separately configurable target file where CoolType should store the system font cache file. It may be NULL, in which case CoolType will choose a default path.
char *commonCacheFile;
Separately configurable target file where CoolType should store the common font cache file. It may be NULL, in which case CoolType will choose a default path.
char *unicodeDirectory;
The complete, NULL-terminated path of the directory in which the Unicode mapping files can be found.
char *cMapDirectory;
The complete NULL-terminated path of the directory where CoolType can find CMap files. This directory will be the preferred location for CMaps that are associated with the system fontset. If CMaps with the same name are found in this directory and common fonts directory, the copy in this directory will be preferred. May be NULL, in which case CoolType will only associate CMaps present in common fonts directory with the system font set.
ASInt32 pluginDirListLen;
char **pluginDirList;

An array of plug-in directories.

If a PDF Library client wants PDFL to load headless PDF Library plug-ins from desired locations, the client can pass a list of paths in pluginDirList. The 2 fields pluginDirList and pluginDirListLen are similar to the existing fields dirList and listLen.

Clients can pass an array of plug-in directories in the field pluginDirList:

  • On Windows, pluginDirList is an array of ASUTF16Val paths. Each path should be NULL-terminated.
  • On Mac OS, the paths passed in pluginDirList should be NULL-terminated UTF-8 POSIX strings. Hence, the type of pluginDirList on Mac is char * *.
  • On Unix, the paths passed in pluginDirList should be simple NULL-terminated char strings.
ASInt32 colorProfileDirListLen;
Specifies the number of directories listed in colorProfileDirList.
char **colorProfileDirList;

An array of color profile directories.

If a PDF Library client wants to search for color profiles from custom directories, the client can pass a list of paths in colorProfileDirList. The 2 fields colorProfileDirList and colorProfileDirListLen are similar to the existing fields dirList and listLen.

If the client does not set this parameter then PDF Library will search for the color profiles from default locations such as Creative Suites and Acrobat installation directories. If the clients sets this parameter then PDF Library will search for the color profiles from it's default directory as well as from the custom directories specified by the client through parameter colorProfileDirList. However the order of searching for these profiles from default and custom directories is not fixed.

  • On Windows, colorProfileDirList is an array of ASUTF16Val paths. Each path should be NULL-terminated.
  • On Mac OS, the paths passed in colorProfileDirList should be NULL-terminated UTF-8 POSIX strings. Hence, the type of colorProfileDirList on Mac is char * *.
  • On Unix, the paths passed in colorProfileDirList should be simple NULL-terminated char strings.
ASUTF16Val *officeMetricsDirectory;
No longer used, deprecated.
} PDFLDataRec, *PDFLData;

_t_PDFLMemStats

Header: PDFLExpT.h:77

Syntax

struct _t_PDFLMemStats {
ASUns32 numAllocs;
ASUns32 curUsage;
ASUns32 highUsage;
} PDFLMemStats;

_t_TKAllocatorProcs

Header: PDFInit.h:222

Description

A structure for memory allocation callbacks used by the PDF Library.

Syntax

struct _t_TKAllocatorProcs {
ASClientAllocProc allocProc;
Called when the PDF Library needs to allocate memory.
ASClientReallocProc reallocProc;
Called when the PDF Library needs to reallocate a block of memory.
ASClientFreeProc freeProc;
Called when the PDF Library needs to free a block of memory.
ASClientMemAvailProc memAvailProc;
Called when the PDF Library needs to determine the amount of memory available.
void *clientData;
A pointer to data to pass into each of the memory management callbacks.
} TKAllocatorProcs, *TKAllocatorProcsP;

Used In

_t_TKExtensionProcs

Header: PDFInit.h:405

Description

A structure containing function pointers for ASExtension callbacks used by the PDF Library.

Syntax

struct _t_TKExtensionProcs {
Called when the PDF Library needs to allocate memory.
Called when the PDF Library needs to reallocate a block of memory.
void *clientData;
A void * of data to pass into each of the memory management callbacks.
} TKExtensionProcs, *TKExtensionProcsP;

Used In

_t_TKResourceProcs

Header: PDFInit.h:314

Description

Structure for resource acquisition callbacks used by the PDF Library.

Syntax

struct _t_TKResourceProcs {
TKResourceAcquireProc acquireProc;
Called when the PDF Library needs to acquire resources.
TKResourceReleaseProc releaseProc;
Called when the PDF Library needs to release resources.
void *clientData;
A pointer to data to pass into every call to the PMSetTextProc() or TKResourceReleaseProc() as the clientData argument.
} TKResourceProcs, *TKResourceProcsP;

Used In

General Functions

ASAtomGetCount

Header: PDFLProcs.h:128

Description

Gets the number of ASAtom objects that have been allocated. The maximum number of ASAtom objects is 0xFFFFFFFF. (This was a 16-bit value in Acrobat 4.x, and changed to a 32-bit value in Acrobat 5.0).

ASAtom objects cannot be deleted or freed. Use this method to determine if it is necessary to re-initialize the library before creating more ASAtom objects.

Syntax

ASInt32 ASAtomGetCount(void);

Returns

The number of ASAtom objects currently allocated.

ASPurgeMemory

Header: PDFLProcs.h:111

Description

Attempts to free memory from the PDF Library caches.

The caches in the PDF Library can grow in complex and unexpected ways. A client can manage memory use with the PDFLInit memory callbacks, or by explicitly calling this function after certain functions, such as PDDocClose().

To manage memory use with the memory callbacks, a client can call ASPurgeMemory() during the allocation callback if it is low on memory, or to limit the amount of memory used by the library. Use this approach only with extreme caution and extensive testing. The run-time memory requirements are very document-specific.

Related Methods

Syntax

ASSize_t ASPurgeMemory(ASSize_t amount);

Parameters

amount
The desired amount of memory to free.

Returns

The approximate amount of memory freed.

AVExtensionMgrRegisterNotification

Header: PDFLProcs.h:597

Description

Registers a user-supplied procedure to call when the event of the specified type occurs. This is exactly the same as the AVAppRegisterNotification() method. All of the PD level notifications are available with the Adobe PDF Library.

Syntax

void AVExtensionMgrRegisterNotification(NSelector nsel, ASExtension owner, void *proc, void *clientData);

Parameters

nsel
Notification type. It must be one of the notification selectors. The notification selector is the name of the notification with the characters NSEL appended. For example, the selector for PDDocDidPrintPage() is PDDocDidPrintPageNSEL. Only the PD-level notifications are available with the Adobe PDF Library.
owner
Identifies the owner. For the Adobe PDF Library, if there is only one owner of the PDFEdit subsystem, owner should be zero. If there are multiple owners, each should specify a nonzero, non-negative owner. (A negative owner is reserved for the implementation).
proc
A user-supplied callback to be called when the notification occurs. Its declaration depends on the notification type.
clientData
A pointer to user-supplied data to pass to proc each time it is called.

AVExtensionMgrUnregisterNotification

Header: PDFLProcs.h:617

Description

Unregisters a user-supplied procedure to call when the specified event occurs. This is exactly the same as the AVAppUnregisterNotification() method.

Syntax

void AVExtensionMgrUnregisterNotification(NSelector nsel, ASExtension owner, void *proc, void *clientData);

Parameters

nsel
Notification type. It must be one of the notification selectors. The notification selector is the name of the notification with the characters NSEL appended. For example, the selector for PDDocDidOpen() is PDDocDidOpenNSEL.
owner
Identifies the owner with which the notification was registered.
proc
A user-supplied callback with which the notification was registered.
clientData
A pointer to user-supplied data that was used when the notification was registered.

CosSetExternalFilePermissionProc

Header: PDFLProcs.h:825

Syntax

void CosSetExternalFilePermissionProc(ExternalFilePermissionProc proc);

PDFLGetFlags

Header: PDFLProcs.h:723

Description

Gets the flags set when the PDF Library was initialized. Currently kPDFLInitIgnoreDefaultDirectories, kPDFLInitIgnoreSystemFonts and kDontLoadPlugIns flags are supported.

When kPDFLInitIgnoreDefaultDirectories flag is set, the initialization process does not search through the default font directories (currently Adobe font directories installed by some Adobe applications), but only searches for fonts in those directories specified in dirList. A default directory could appear as follows:

C:\\Program Files\\Common Files\\Adobe\\PDFL\\[ version number ]\\Fonts

C:\\Program Files\\Common Files\\Adobe\\PDFL\\[ version number ]\\CMaps

When kPDFLInitIgnoreSystemFonts flag is set, the initialization process does not search through default System fonts also.

When the kDontLoadPlugIns flag is set, plug-ins are ignored during initialization process.

Syntax

ASUns32 PDFLGetFlags(void);

Returns

The initialization flags value.

PDFLGetInitCount

Header: PDFLProcs.h:701

Description

Gets the number of times the PDF Library has been initialized.

Syntax

ASUns32 PDFLGetInitCount(void);

Returns

The number of times the PDF Library has been initialized.

PDFLGetVersion

Header: PDFLProcs.h:672

Description

Gets the value of the Adobe PDF Library version (kPDFLVersion). The most significant 16 bits are the major version number; the least significant 16 bits are the minor version number. The major version number indicates whether any incompatible API changes have been made. The minor version number indicates that the API has changed, but in a compatible fashion.

Note: Obsolete in PDF Library 6.0. Use HFTGetVersion() instead.

Related Methods

Syntax

ASUns32 PDFLGetVersion(void);

Returns

Adobe PDF Library version (kPDFLVersion).

PDFLTerm

Header: PDFLProcs.h:682

Description

Terminates the Adobe PDF Library. Call this method after you are completely done using the library. Call this once to terminate and release memory used by the library. After the library has been shut down, the process should terminate.

Syntax

void PDFLTerm(void);

PDFLibraryRegisterNotification

Header: PDFLProcs.h:62

Description

Registers a user-supplied procedure to call when the specified event occurs. This is exactly the same as the AVAppRegisterNotification method. All of the PD level notifications are available with the Adobe PDF Library.

Syntax

void PDFLibraryRegisterNotification(NSelector nsel, ASExtension owner, void *proc, void *clientData);

Parameters

nsel
Notification type. It must be one of the notification selectors. The notification selector is the name of the notification with the characters NSEL appended. For example, the selector for PDDocDidPrintPage() is PDDocDidPrintPageNSEL. Only the PD-level notifications are available with the Adobe PDF Library.
owner
Identifies the owner. For the Adobe PDF Library, if there is only one owner of the PDFEdit subsystem, owner should be zero. If there are multiple owners, each should specify a nonzero, non-negative owner. (A negative owner is reserved for the implementation).
proc
A user-supplied callback to be called when the notification occurs. Its declaration depends on the notification type.
clientData
A pointer to user-supplied data to pass to proc each time it is called.

PDFLibraryRegisterNotificationEx

Header: PDFLProcs.h:822

Description

Registers a user-supplied procedure to call when the specified event occurs.

Many notifications appear in Will/Did pairs (for example, AVDocWillPerformAction() and AVDocDidPerformAction()). It is possible that an operation may fail after the Will notification and before the Did notification. When this occurs, the Did notification is still broadcast, but the err parameter in the Did notification is nonzero, and represents the error that occurred. When err is nonzero, the other parameters are not necessarily valid. Always check err in a Did notification before using the other parameters.

When calling AVAppUnregisterNotification() to un-register for a notification, you must pass the proc, clientData, and owner that were used when the notification was registered using AVAppRegisterNotification(). You must use the same callback that was used to register; you cannot use a newly created callback. To accomplish this, call ASCallbackCreateNotification() once before registering, and use the value returned from this call both to register and un-register; do not call ASCallbackCreateNotification() a second time when un-registering. You will then need to destroy the pointer to the callback using the ASCallbackDestroy() method.

Syntax

void PDFLibraryRegisterNotificationEx(NSelector nsel, ASExtension owner, void *proc, void *clientData, ASInt32 priority);

Parameters

nsel
The notification type. It must be one of the notification selectors. The notification selector is the name of the notification with the characters NSEL appended. For example, the selector for AVDocDidOpen() is AVDocDidOpenNSEL.
owner
The gExtensionID of the client registering the notification.
proc
A user-supplied callback to call when the notification occurs. Its declaration depends on the notification type. Remember to use ASCallbackCreateNotification() to convert proc to a callback before passing it to AVAppRegisterNotification().
clientData
A pointer to user-supplied data to pass to proc each time it is called.
priority
The callbacks are enumerated in priority order, starting with the highest priority.

PDFLibraryRegisterRNG

Header: PDFLProcs.h:838

Description

Registers a user-supplied random number generator. By default, the PDF Library obtains high-quality random values from the operating system ( CryptGenRandom() on Windows, and /dev/random on Mac OS and many UNIX operating systems). This method allows an alternate handler to be used. The random numbers returned should be of high quality, and it is the responsibility of the developer to ensure this. A NULL parameter will reset to default behavior.

Related Methods

Syntax

void PDFLibraryRegisterRNG(PDFLClientRNGProc clientRNG);

Parameters

clientRNG
A client-supplied function that supplies the strong random values.

PDFLibraryUnregisterNotification

Header: PDFLProcs.h:87

Description

Unregisters a user-supplied procedure to call when the specified event occurs. This is exactly the same as the AVAppUnregisterNotification() method.

Syntax

void PDFLibraryUnregisterNotification(NSelector nsel, ASExtension owner, void *proc, void *clientData);

Parameters

nsel
Notification type. It must be one of the notification selectors. The notification selector is the name of the notification with the characters NSEL appended. For example, the selector for PDDocDidOpen() is PDDocDidOpenNSEL.
owner
Identifies the owner. For the PDF Library, if there is only one owner of the PDFEdit subsystem, owner should be zero. If there are multiple owners, each should specify a nonzero, non-negative owner. (A negative owner is reserved for the implementation).
proc
A user-supplied callback to be called when the notification occurs. Its declaration depends on the notification type. You must use the same callback that you called AVExtensionMgrRegisterNotification() with.
clientData
A pointer to user-supplied data to pass to proc each time it is called.

PDOCRegisterFindOutAutoStatePrefProc

Header: PDFLProcs.h:858

Description

Registers a callback to the client user interface that can tell the core what the current AutoState preference is.

Syntax

void PDOCRegisterFindOutAutoStatePrefProc(PDOCFindOutAutoStatePrefProc proc);

PDOCRegisterFindOutLanguageProc

Header: PDFLProcs.h:848

Description

Registers a callback to the client user interface that can tell the core what the current language is.

Syntax

void PDOCRegisterFindOutLanguageProc(PDOCFindOutLanguageProc proc);

PDOCRegisterFindOutUserProc

Header: PDFLProcs.h:853

Description

Registers a callback to the client user interface that can tell the core what the current user is.

Syntax

void PDOCRegisterFindOutUserProc(PDOCFindOutUserProc proc);

PDOCRegisterFindOutZoomProc

Header: PDFLProcs.h:843

Description

Registers a callback to the client user interface that can tell the core what the current zoom level is.

Syntax

void PDOCRegisterFindOutZoomProc(PDOCFindOutZoomProc proc);