PDFL Library Layer

Parameters

fileSys: ASFileSys

The file system in which the ASPathname is set.

Returns

See Also

Parameters

fileSys: ASFileSys

(May be NULL) The file system in which to set the default temporary path.

pathName: ASPathName

The path name for the new default temporary path, or NULL to reset to the file system default.

Returns

See Also

Parameters

: void

Returns

See Also

Parameters

amount: ASSize_t

The desired amount of memory to free.

Returns

See Also

Parameters

nsel: NSelector

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: ASExtension

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: void *

A user-supplied callback to be called when the notification occurs. Its declaration depends on the notification type.

clientData: void *

A pointer to user-supplied data to pass to proc each time it is called.

Returns

See Also

Parameters

nsel: NSelector

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: ASExtension

Identifies the owner with which the notification was registered.

proc: void *

A user-supplied callback with which the notification was registered.

clientData: void *

A pointer to user-supplied data that was used when the notification was registered.

Returns

See Also

Parameters

proc: ExternalFilePermissionProc

Returns

Parameters

: void

Returns

See Also

Parameters

: void

Returns

See Also

Parameters

: void

Returns

See Also

Parameters

: void

Returns

See Also

Parameters

data: PDFLData

Initialization data for Adobe PDF Library.

Returns

See Also

Parameters

data: PDFLData

Returns

Parameters

key: ThreadLocalKey *

size: ASUns32

Returns

Parameters

: void

Returns

Parameters

: void

Returns

See Also

Parameters

: void

Returns

Parameters

nsel: NSelector

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: ASExtension

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: void *

A user-supplied callback to be called when the notification occurs. Its declaration depends on the notification type.

clientData: void *

A pointer to user-supplied data to pass to proc each time it is called.

Returns

See Also

Parameters

nsel: NSelector

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: ASExtension

The gExtensionID of the client registering the notification.

proc: void *

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: void *

A pointer to user-supplied data to pass to proc each time it is called.

priority: ASInt32

The callbacks are enumerated in priority order, starting with the highest priority.

Returns

Parameters

clientRNG: PDFLClientRNGProc

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

Returns

See Also

Parameters

nsel: NSelector

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: ASExtension

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: void *

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: void *

A pointer to user-supplied data to pass to proc each time it is called.

Returns

See Also

Parameters

proc: PDOCFindOutAutoStatePrefProc

Returns

Parameters

proc: PDOCFindOutLanguageProc

Returns

Parameters

proc: PDOCFindOutUserProc

Returns

Parameters

proc: PDOCFindOutZoomProc

Returns

Used In

Used In

Used In

See Also

See Also

See Also

Used In

See Also

Used In

Fields

size: ASSize_t

The size of the data structure. It must be set to sizeof(PDFLDataRec).

flags: ASUns32

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.

inst: HINSTANCE

(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.

dirList: ASUTF16Val **

List of directories with fonts. @par Example For Windows:

libData.listLen=3L;
libData.dirList=(ASUTF16Val**)malloc(sizeof(ASUTF16Val*)*3);
libData.dirList[0]=(ASUTF16Val*)myFontDir0;
libData.dirList[1]=(ASUTF16Val*)myFontDir1;
libData.dirList[2]=(ASUTF16Val*)myFontDir2;

A list of directories with fonts. @par Example For Windows:
libData.listLen=3L;
libData.dirList=(ASPathName *)malloc(sizeof(ASPathName)*3);
libData.dirList[0]=(ASPathName)"c:\\PSFonts";
libData.dirList[1]=(ASPathName)"c:\\Fonts";
libData.dirList[2]=(ASPathName)"c:\\CMap";

listLen: ASInt32

The number of directories listed in dirList.

allocator: TKAllocatorProcsP

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.

resProcs: TKResourceProcsP

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.

extProcs: TKExtensionProcsP

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

cacheFileList: ASUTF16Val **

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.

systemCacheFile: ASUTF16Val *

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.

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.

commonCacheFile: ASUTF16Val *

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.

cMapDirectory: ASUTF16Val *

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.

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.

unicodeDirectory: ASUTF16Val *

The complete, NULL-terminated path of the directory in which the Unicode mapping files can be found.

pluginDirListLen: ASInt32

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.

pluginDirList: ASUTF16Val **

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.

colorProfileDirListLen: ASInt32

Specifies the number of directories listed in colorProfileDirList.

colorProfileDirList: ASUTF16Val **

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.

initDC: HDC

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)

officeMetricsDirectory: ASUTF16Val *

No longer used, deprecated.

dirList: char **

A list of directories with fonts. @par Example For Windows:
libData.listLen=3L;
libData.dirList=(ASPathName *)malloc(sizeof(ASPathName)*3);
libData.dirList[0]=(ASPathName)"c:\\PSFonts";
libData.dirList[1]=(ASPathName)"c:\\Fonts";
libData.dirList[2]=(ASPathName)"c:\\CMap";

resFile: short

(Mac only)

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

Example libData.resFile = OpenResFile("\\pMyResFileGoesHere")

cacheFileList: char **

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.

systemCacheFile: char *

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.

commonCacheFile: char *

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.

cMapDirectory: char *

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.

unicodeDirectory: char *

The complete, NULL-terminated path of the directory in which the Unicode mapping files can be found.

pluginDirList: char **

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.

colorProfileDirList: char **

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.

Fields

numAllocs: ASUns32

curUsage: ASUns32

highUsage: ASUns32

Fields

size: ASSize_t

The size of the structure. Set it to sizeof(PDFlattenRec).

tilingMode: PDFlattenTilingMode

0 = no tiling; 1 = constant tiling; 2 = adaptive tiling

useTextOutlines: ASBool

Output text outlines instead of native text.

allowShadingOutput: ASBool

Allow shading ouput.

allowLevel3ShadingOutput: ASBool

Allow level 3 shading output.

strokeToFill: ASBool

For converting stroke to outline.

clipComplexRegions: ASBool

Clip complex checkbox.

internalDPI: float

Resolution for flattening the interior of an atomic region.

externalDPI: float

Resolution for flattening edges of atomic regions.

pathDPI: float

Flattener path resolution; the default is 800.

tileSizePts: ASUns32

Target tile size in points.

maxFltnrImageSize: ASUns32

Maximum image size when flattening. The default is 0.

adaptiveThreshold: ASUns32

Adaptive flattening threshold.

preserveOverprint: ASBool

Attempt to preserve overprint.

disableCurveToLineOptmization: ASBool

Disable Curve to Line Optimization.

maxPageFlatteningTime: ASInt32

New parameter to set the maximum allowed time for flattening a page before rasterizing the content. Default value 0 : Enables the two minute limit default value < 0 : Disables the time limit > 0 : Sets the time limit (in seconds)

permitType3Fonts: ASBool

If false, such fonts are rasterized, this is the legacy behavior because many PDF processors don't handle Type 3 fonts correctly. If true, such fonts are preserved instead.

ignoreOverprint: ASBool

DLADD 19Oct2023 - Normally every Page is checked if it has Transparency or Overprint features and when found the Page is Flattened. If false, Pages that have Overprinting are considered for Flattening. If true, Pages that have Overprinting aren't considered for Flattening.

Fields

pubRec: PDTileRec

Used for giving information to and from the user.

imageablePaperWidth: ASUns32

(pts)

imageablePaperHeight: ASUns32

(pts)

unprintablePaperWidth: ASUns32

Unprintable left edge (pts).

unprintablePaperHeight: ASUns32

Unprintable bottom edge (pts).

indent: ASUns32

The amount tile indented within the imageable area (pts).

rotateAngle: ASInt32

The clockwise rotation angle in degrees for tile.

labelTemplate: ASText

The optional label string template has 6 parameters it can fill in. If it is NULL, the label template "$DOC$ $DATE$ $TIME$ $PAGE$ ($ROW$, $COL$)" is used.

Example "page $PAGE$, row=$ROW$, column=$COL$"

driverScale: double

The scale selected by the user in the Print Setup or Printer Properties dialog box.

tileScale: double

The scale for tiled pages.

Fields

allocProc: ASClientAllocProc

Called when the PDF Library needs to allocate memory.

reallocProc: ASClientReallocProc

Called when the PDF Library needs to reallocate a block of memory.

freeProc: ASClientFreeProc

Called when the PDF Library needs to free a block of memory.

memAvailProc: ASClientMemAvailProc

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

clientData: void *

A pointer to data to pass into each of the memory management callbacks.

Fields

progressProc: ASExtensionProgressProc

Called when the PDF Library needs to allocate memory.

reportErrProc: ASExtensionReportErrorProc

Called when the PDF Library needs to reallocate a block of memory.

clientData: void *

A void* of data to pass into each of the memory management callbacks.

Fields

acquireProc: TKResourceAcquireProc

Called when the PDF Library needs to acquire resources.

releaseProc: TKResourceReleaseProc

Called when the PDF Library needs to release resources.

clientData: void *

A pointer to data to pass into every call to the PMSetTextProc() or TKResourceReleaseProc() as the clientData argument.

Parameters

client: PDPrintClient

Control structure for the operation, containing data and callback procedures.

Returns

Exceptions

genErrBadParm

—

@notify PSPrintAfterBeginPageSetup @notify PSPrintAfterBeginProlog @notify PSPrintAfterBeginSetup @notify PSPrintAfterEmitExtGState @notify PSPrintAfterPageTrailer @notify PSPrintAfterTrailer @notify PSPrintBeforeEndComments @notify PSPrintBeforeEndSetup

See Also

Parameters

doc: PDDoc

The PDDoc for the document to print.

userParams: PDFLPrintUserParams

Parameters to control printing.

Returns

Exceptions

cosErrWriteError

pdErrOpNotPermitted

genErrBadParm

—

@notify PSPrintAfterBeginPageSetup @notify PSPrintAfterBeginProlog @notify PSPrintAfterBeginSetup @notify PSPrintAfterEmitExtGState @notify PSPrintAfterPageTrailer @notify PSPrintAfterTrailer @notify PSPrintBeforeEndComments @notify PSPrintBeforeEndSetup

Parameters

doc: PDDoc

The PDDoc for the document to print.

userParams: PDFLPrintUserParamsEx

Parameters to control printing.

Returns

Exceptions

cosErrWriteError

pdErrOpNotPermitted

genErrBadParm

—

@notify PSPrintAfterBeginPageSetup @notify PSPrintAfterBeginProlog @notify PSPrintAfterBeginSetup @notify PSPrintAfterEmitExtGState @notify PSPrintAfterPageTrailer @notify PSPrintAfterTrailer @notify PSPrintBeforeEndComments @notify PSPrintBeforeEndSetup

Parameters

pdDoc: PDDoc

pathName: ASPathName

psParams: PDPrintParams

Returns

Used In

Used In

See Also

Used In

See Also

Used In

See Also

Used In

See Also

Used In

See Also

Used In

Fields

type: ImageInk

Image ink type.

mono: MonoInkList *

Image ink monochrome list. This is defined only if type == ImageInk_Monochrome.

Used In

Fields

name: char *

Name of the colorant.

level: float

Concentration of the colorant.

next: struct _t_monoInkList *

Pointer to next list element.

Used In

Fields

aldImageAsciiTags: TIFFASCIITagList *

TIFF ASCII tags.

aldImageColor: struct OPI13dict::@164170005106075354303133154044037375003257157232

aldImageColorType: ALDImageColorType

Image color type.

aldImageCropFixed: float

The portion of the image to be used.

aldImageCropRect: ASUns32

The portion of the image to be used ([left top right bottom]). REQUIRED.

aldImageDimensions: ASUns32

Included image dimensions. [width height] REQUIRED. /Size in PDF.

aldImageFileName: PDFileSpec

REQUIRED. Image file name.

aldImageGrayMap: ASUns16 *

Changes to the brightness or contrast of the image.

aldImageGrayMapLength: ASUns16

Length of the GrayMap array (2, 16, or 256).

aldImageID: char *

Image identifier.

aldImageOverprint: ASBool

Determines whether the image is to overprint (true) or knock out (false) underlying marks on other separations.

aldImagePosition: float

The location on the page of the cropped image ([llx lly ulx uly urx ury lrx lry]. REQUIRED.

aldImageResolution: float

Image resolution ([horiz vert]).

aldImageTint: float

The concentration of the color in which the image is to be rendered.

aldImageTransparency: ASBool

Specifies whether white pixels in the image are to be treated as transparent.

aldImageType: ASUns32

Specifies the number of samples per pixel and bits per sample in the image ([samplesPerPixel bitsPerSample]).

aldObjectComments: char *

A human-readable comment, typically containing instructions or suggestions to the operator of the OPI server on how to handle the image.

defined: struct OPI13dict::@021265151007226160124004164366313351272373363105

Used In

Fields

imageCropRect: float

The portion of the image to be used ([left top right bottom]). OPTIONAL.

imageDimensions: float

The dimensions of the included image ([width height]). OPTIONAL.

imageFileName: PDFileSpec

The external file containing the image. The following values are required if imageCropRect and imageDimensions are defined: 0 <= left < right <= width
0 <= top < bottom <= height

REQUIRED.

imageInks: ImageInks

The colorants to be applied to the image.

imageOverprint: ASBool

Specifies whether the image is to overprint (true) or knock out (false) underlying marks on other separations.

includedImageDimensions: ASUns32

Included image dimensions.

includedImageQuality: float

The quality of the included image.

mainImage: char *

The path name of the file containing the full-resolution image.

tiffAsciiTags: TIFFASCIITagList *

defined: struct OPI20dict::@375101161202225025025114144164376116222125162175

Used In

Fields

version: OPIversion

OPI version (1.3 or 2.0).

dict: union OPIdict::@311243253320231056061260114214213233170330263070

Used In

Used In

Fields

size: ASSize_t

CanEmitFont: PDPrintCanEmitFontProc

Fields

size: ASInt32

Size of the data structure. Must be set to sizeof(PDFLPrintUserParamsRec).

Size of the data structure. It must be set to sizeof(PDFLPrintUserParamsRec).

printParams: PDPrintParams

PDPrintParams structure. Used for both creating a PostScript file and printing to a printer.

PDPrintParams structure. It is used for both creating a PostScript file and printing to a printer.

PDPrintParams structure. It is used both for creating a PostScript file and printing to a printer.

emitToFile: ASBool

Create a PostScript file. You set either this parameter or emitToPrinter, but not both.

Create a PostScript file. Set either this parameter or emitToPrinter, but not both.

printStm: ASStm

Writable ASStm that points to a file stream or proc stream. It applies to both a PostScript printer and a file.

Writable ASStm that points to file stm or proc stm. It applies to both a PostScript printer and a file.

paperWidth: ASUns16

Width of paper in points. The default value is 612. Applies to a PostScript printer.

Width of paper in points. The default value is 612. It applies to a PostScript printer.

Width of paper in points. The default value is 612. It applies to a PostScript printer.

paperHeight: ASUns16

Height of paper in points. The default value is 792. Applies to a PostScript printer.

Height of paper in points. The default value is 792. It applies to a PostScript printer.

Height of paper in points. The default value is 792. It applies to a PostScript printer.

dontEmitListLen: ASInt32

Number of fonts that should not be downloaded. Applies to both a PostScript printer and a file.

Number of fonts that should not be downloaded. It applies to both a PostScript printer and a file.

dontEmitList: char **

List of fonts (T1, TrueType, CID) that should not be downloaded. Applies to both a PostScript printer and a file.

List of fonts (T1, TT, CID) that should not be downloaded. It applies to both a PostScript printer and a file.

List of fonts (T1, TrueType, CID) that should not be downloaded. It applies to both a PostScript printer and a file.

emitToPrinter: ASBool

Output PDF file to a PostScript printer. Set either this parameter or emitToFile, but not both.

Output a PDF file to a PostScript printer. Set either this parameter or emitToFile, but not both.

command: char *

Optional command line arguments. It is used only if
emitToPrinter is true. For example, "lp" or
"lpr" applies to a PostScript printer.

cancelProc: PDFLPrintCancelProc

Optional PDFLPrintCancelProc. It applies to both a a PostScript printer and a file.

Optional PDFLPrintCancelProc. It applies to both a PostScript printer and a file.

clientData: void *

Optional pointer to data passed to cancelProc. Applies to both a PostScript printer and a file.

Optional pointer to data passed to cancelProc. It applies to both a PostScript printer and a file.

startResult: int

Spooler ID from StartDoc

Spooler ID from StartDoc().

userCallbacks: PDFLPrintUserCallbacks

Optional pointer to structure containing pointers to user callback functions

nCopies: int

(Optional) Number of copies to print. It applies to a PostScript file.

Number of copies to print. It applies to a printer and to a PostScript file.

The number of copies to print. It applies to a printer and to a PostScript file.

PPDFeatures: PPDFeaturesP

Optional pointer to a structure where you can add additional PPD features like staple, input tray, output tray, duplex mode etc. for output to PostScript file. For more details, see _t_PPDFeatures

ppdFileName: ASText

(Optional)The name and path of the PPD file from which the PPD features will be emitted to a PostScript file. Use this field alongwith PPDFeaturesP PPDFeatures. For more details, see _t_PPDFeatures.

progressProc: PDFLPrintProgressProc

progressClientData: void *

transQuality: int

Transparency flattening quality control. 1 is fastest; 5 is best. It applies to a printer. The default is 3.

Transparency flattening quality control. 1 is fastest; 5 is
best. It applies to a printer. The default is 3.

inFileName: char *

Deprecated. Use the Unicode version inFileNameW.

Used for the Windows DOCINFO structure (lpszDocName)
that points to a NULL-terminated string that specifying the name of
the document. In case of printing/exporting to Postscript, this field sets
the Title DSC comment in the generated Postscript file. inFileNameW has precedence over the deprecated inFileName. If neither is provided, the Title DSC comment is filled with the name of pdf document.

outFileName: char *

Deprecated. Use the Unicode version outFileNameW.

Used for the Windows DOCINFO structure (lpszOutput). It points to a NULL-terminated string that specifies the name of an output file. If this pointer is NULL, the output will be sent to the device identified by deviceName, driverName, and portName. It applies to a printer.

deviceName: char *

Deprecated. Use the Unicode version deviceNameW.

The name of the device on which to print (for example, "Distiller Assistant
v3.01"). Available devices can be found in the Windows Registry at HKEY_CURRENT_USER\Software\Microsoft\Windows NT\CurrentVersion\Devices. It applies to a printer.

driverName: char *

Deprecated. Use the Unicode version driverNameW.

The name of the driver (for example, "winspool"). See the registry key
for deviceName. It applies to the printer.

portName: char *

Deprecated. Use the Unicode version portNameW.

The name of the port (for example, "Ne00"). See the registry key for deviceName. It applies to the printer.

pDevMode: DEVMODEA *

Deprecated. Use the Unicode version pDevModeW.

(Optional) Allows you to pass a DEVMODE structure in if you have one.

If you do not pass in your own DEVMODE structure, PDFL creates its own by calling OpenPrinter(), DocumentProperties(), and ClosePrinter().

PDFL never calls SetPrinter() and has no facility to offer the features provided by SetPrinter() (for example, pause/resume, deleting jobs, changing printer status, etc.). DocumentProperties() is called only in the case where the client does not provide a DEVMODE.

Note: If you provide your own DEVMODE, you will certainly want to call DocumentProperties() to populate it and/or display the print dialog box.

startPage: int

Page to start printing with, using zero-based numbering. It applies to a printer.

The page on which to start printing, using zero-based numbering. It applies to a printer.

endPage: int

Page on which to finish printing. It applies to a printer.

The page on which to finish printing. It applies to a printer.

shrinkToFit: int

1 turns on shrink to fit, 0 turns it off. It applies to a PostScript printer.

printAnnots: int

1 turns on printing annotations, 0 turns it off. It applies to a printer.

1 turns on printing annots, 0 turns it off. It applies to a printer.

psLevel: int

PostScript level. It applies to a PostScript printer.

binaryOK: int

1 turns on binary data, 0 turns it off. It applies to a PostScript printer.

emitHalftones: int

1 turns on emit half-tones, 0 turns it off. It applies to a PostScript printer.

1 turns on emit half-tones, 0 turns them off. It applies to a PostScript printer.

reverse: int

1 reverses print order, 0 does regular order. It applies to a printer.

farEastFontOpt: int

One of PDFarEastFont.The default value is PDPDFarEastFont_Download_All. It applies to a PostScript printer. PDPDFarEastFont_Print_As_Image will not be honored.

doOPP: int

1 uses OverPrint Preview, 0 does not. It applies to a printer.

The default is 0.

inFileNameW: ASUns16 *

Used for the Windows DOCINFO structure (lpszDocName)
that points to a NULL-terminated string that specifying the name of
the document. In case of printing/exporting to Postscript, this field sets
the Title DSC comment in the generated Postscript file. inFileNameW has precedence over the deprecated inFileName. If neither is provided, the Title DSC comment is filled with the name of pdf document.

outFileNameW: ASUns16 *

Used for the Windows DOCINFO structure (lpszOutput). It points to a NULL-terminated string that specifies the name of an output file. If this pointer is NULL, the output will be sent to the device identified by deviceName, driverName, and portName. It applies to a printer.

deviceNameW: ASUns16 *

The name of the device to print to (for example, "Distiller Assistant
v3.01"). Available devices can be found in the Windows Registry at HKEY_CURRENT_USER\Software\Microsoft\Windows NT\CurrentVersion\Devices. It applies to a printer.

driverNameW: ASUns16 *

The name of the driver (for example, "winspool"). See the registry key for deviceName. It applies to the printer.

portNameW: ASUns16 *

The name of the port (for example, "Ne00"). See the registry key for deviceName. It applies to the printer.

pDevModeW: DEVMODEW *

(Optional) Allows you to pass a DEVMODE structure in if you have one.

If you do not pass in your own DEVMODE structure, PDFL creates its own by calling OpenPrinter(), DocumentProperties(), and ClosePrinter().

PDFL never calls SetPrinter() and has no facility to offer the features provided by SetPrinter() (for example, pause/resume, deleting jobs, changing printer status, etc.). DocumentProperties() is called only in the case where the client does not provide a DEVMODE.

Note: If you provide your own DEVMODE, call DocumentProperties() to populate it or display the print dialog box.

pDC: HDC

(Optional) Allows you to pass a DeviceContext structure.

If you do not pass in your own DeviceContext structure PDFL creates its own.

Note: you should provide your own DeviceContext only if you register to the PDPageDirectDrawToPlatform notification and wish to draw extra content to a page after PDFL has finished printing it.

forceGDIPrint: ASBool

Optional value used for Postscript printing that allows printing with the code path used by the nonps printer instead of the code used by the PS printer

hDC: HDC

Optional device handle used to allow the device handle used in the user's sample with StartDoc and EndDoc to be passed to the library to be used in StartPage and EndPage.

useCustomPaperSize: ASBool

Force the use of the paper size provided in the PDFLPrintUserParamsRec paperWidth and paperHeight parameters instead of searching for best fit size provided by printer. PDPrintParamsRec setPageSize must also be set for this option.

printRecord: void *

DO NOT USE: Classic (non-Carbon) printing is no longer supported.

printSession: PMPrintSession

Carbon print session - may be NULL. It applies to a printer.

printSettings: PMPrintSettings

Carbon print settings - may be NULL. It applies to a printer.

pageFormat: PMPageFormat

Carbon page format - may be NULL. It applies to a printer.

See Also

Fields

size: ASInt32

Size of the data structure. Must be set to sizeof(PDFLPrintUserParamsRec).

emitToFile: ASBool

Create a PostScript file. You set either this parameter or emitToPrinter, but not both.

printParams: PDPrintParams

PDPrintParams structure. It is used for both creating a PostScript file and printing to a printer.

printStm: ASStm

Writable ASStm that points to file stm or proc stm. It applies to both a PostScript printer and a file.

paperWidth: ASUns16

Width of paper in points. The default value is 612. It applies to a PostScript printer.

paperHeight: ASUns16

Height of paper in points. The default value is 792. It applies to a PostScript printer.

dontEmitListLen: ASInt32

Number of fonts that should not be downloaded. It applies to both a PostScript printer and a file.

dontEmitList: char **

List of fonts (T1, TT, CID) that should not be downloaded. It applies to both a PostScript printer and a file.

emitToPrinter: ASBool

Output PDF file to a PostScript printer. Set either this parameter or emitToFile, but not both.

inFileName: char *

Deprecated. Use the Unicode version inFileNameW.

Used for the Windows DOCINFO structure (lpszDocName) that points to a NULL-terminated string that specifying the name of the document. In case of printing/exporting to Postscript, this field sets the Title DSC comment in the generated Postscript file. inFileNameW has precedence over the deprecated inFileName. If neither is provided, the Title DSC comment is filled with the name of pdf document.

outFileName: char *

Deprecated. Use the Unicode version outFileNameW.

Used for the Windows DOCINFO structure (lpszOutput). It points to a NULL-terminated string that specifies the name of an output file. If this pointer is NULL, the output will be sent to the device identified by deviceName, driverName, and portName. It applies to a printer.

deviceName: char *

Deprecated. Use the Unicode version deviceNameW.

The name of the device on which to print (for example, "Distiller Assistant
v3.01"). Available devices can be found in the Windows Registry at HKEY_CURRENT_USER\Software\Microsoft\Windows NT\CurrentVersion\Devices. It applies to a printer.

driverName: char *

Deprecated. Use the Unicode version driverNameW.

The name of the driver (for example, "winspool"). See the registry key for deviceName. It applies to the printer.

portName: char *

Deprecated. Use the Unicode version portNameW.

The name of the port (for example, "Ne00"). See the registry key for deviceName. It applies to the printer.

pDevMode: DEVMODEA *

Deprecated. Use the Unicode version pDevModeW.

(Optional) Allows you to pass a DEVMODE structure in if you have one.

If you do not pass in your own DEVMODE structure, PDFL creates its own by calling OpenPrinter(), DocumentProperties(), and ClosePrinter().

PDFL never calls SetPrinter() and has no facility to offer the features provided by SetPrinter() (for example, pause/resume, deleting jobs, changing printer status, etc.). DocumentProperties() is called only in the case where the client does not provide a DEVMODE.

Note: If you provide your own DEVMODE, you will certainly want to call DocumentProperties() to populate it and/or display the print dialog box.

startPage: int

Page to start printing with, using zero-based numbering. It applies to a printer.

endPage: int

Page on which to finish printing. It applies to a printer.

shrinkToFit: int

1 turns on shrink to fit, 0 turns it off. It applies to a PostScript printer.

printAnnots: int

1 turns on printing annotations, 0 turns it off. It applies to a printer.

psLevel: int

PostScript level. It applies to a PostScript printer.

nCopies: int

Number of copies to print. It applies to a printer and to a PostScript file.

binaryOK: int

1 turns on binary data, 0 turns it off. It applies to a PostScript printer.

emitHalftones: int

1 turns on emit half-tones, 0 turns it off. It applies to a PostScript printer.

reverse: int

1 reverses print order, 0 does regular order. It applies to a printer.

farEastFontOpt: int

One of PDFarEastFont.The default value is PDPDFarEastFont_Download_All. It applies to a PostScript printer. PDPDFarEastFont_Print_As_Image will not be honored.

transQuality: int

Transparency flattening quality control. 1 is fastest; 5 is best. It applies to a printer. The default is 3.

doOPP: int

1 uses OverPrint Preview, 0 does not. It applies to a printer.

The default is 0.

cancelProc: PDFLPrintCancelProc

Optional PDFLPrintCancelProc. It applies to both a PostScript printer and a file.

clientData: void *

Optional pointer to data passed to cancelProc. It applies to both a PostScript printer and a file.

startResult: int

Spooler ID from StartDoc().

inFileNameW: ASUns16 *

Used for the Windows DOCINFO structure (lpszDocName) that points to a NULL-terminated string that specifying the name of the document. In case of printing/exporting to Postscript, this field sets the Title DSC comment in the generated Postscript file. inFileNameW has precedence over the deprecated inFileName. If neither is provided, the Title DSC comment is filled with the name of pdf document.

outFileNameW: ASUns16 *

Used for the Windows DOCINFO structure (lpszOutput). It points to a NULL-terminated string that specifies the name of an output file. If this pointer is NULL, the output will be sent to the device identified by deviceName, driverName, and portName. It applies to a printer.

deviceNameW: ASUns16 *

The name of the device to print to (for example, "Distiller Assistant
v3.01"). Available devices can be found in the Windows Registry at HKEY_CURRENT_USER\Software\Microsoft\Windows NT\CurrentVersion\Devices. It applies to a printer.

driverNameW: ASUns16 *

The name of the driver (for example, "winspool"). See the registry key for deviceName. It applies to the printer.

portNameW: ASUns16 *

The name of the port (for example, "Ne00"). See the registry key for deviceName. It applies to the printer.

pDevModeW: DEVMODEW *

(Optional) Allows you to pass a DEVMODE structure in if you have one.

If you do not pass in your own DEVMODE structure, PDFL creates its own by calling OpenPrinter(), DocumentProperties(), and ClosePrinter().

PDFL never calls SetPrinter() and has no facility to offer the features provided by SetPrinter() (for example, pause/resume, deleting jobs, changing printer status, etc.). DocumentProperties() is called only in the case where the client does not provide a DEVMODE.

Note: If you provide your own DEVMODE, call DocumentProperties() to populate it or display the print dialog box.

pDC: HDC

(Optional) Allows you to pass a DeviceContext structure.

If you do not pass in your own DeviceContext structure PDFL creates its own.

Note: you should provide your own DeviceContext only if you register to the PDPageDirectDrawToPlatform notification and wish to draw extra content to a page after PDFL has finished printing it.

userCallbacks: PDFLPrintUserCallbacks

Optional pointer to structure containing pointers to user callback functions

forceGDIPrint: ASBool

Optional value used for Postscript printing that allows printing with the code path used by the nonps printer instead of the code used by the PS printer

hDC: HDC

Optional device handle used to allow the device handle used in the user's sample with StartDoc and EndDoc to be passed to the library to be used in StartPage and EndPage.

PPDFeatures: PPDFeaturesP

Optional pointer to a structure where you can add additional PPD features like staple, input tray, output tray, duplex mode etc. for output to PostScript file. For more details, see _t_PPDFeatures

ppdFileName: ASText

(Optional)The name and path of the PPD file from which the PPD features will be emitted to a PostScript file. Use this field alongwith PPDFeaturesP PPDFeatures. For more details, see _t_PPDFeatures.

progressProc: PDFLPrintProgressProc

progressClientData: void *

useCustomPaperSize: ASBool

Force the use of the paper size provided in the PDFLPrintUserParamsRec paperWidth and paperHeight parameters instead of searching for best fit size provided by printer. PDPrintParamsRec setPageSize must also be set for this option.

oneJobwithNCopies: ASBool

Fields

size: ASSize_t

The size of the structure.

pdDoc: PDDoc

The document to print.

params: PDPrintParams

A control structure describing how to print the document.

DocBegin: void(*)

(Optional) A callback for PDPrintClient. Begin processing a document for printing.

DocSetup: ASBool(*)

(Optional) A callback for PDPrintClient. Set up a document for printing.

EndSetup: void(*)

(Optional) A callback for PDPrintClient. End the setup for printing a document.

One task that might be performed here is to broadcast a notification for each range of pages that will be printed, as in this pseudo code:

for i = 0 to numRanges-1 ... {

NOTIFY( PDDocWillPrintPages)(doc, fromPage, toPage, psLevel, binaryOK);

for pageNum = ranges[ i]-> startPage to ranges[ i]-> lastPage ...

}

NotifyNewPage: void(*)

(Optional) A callback for PDPrintClient. It is called once for each page printed.

A client can use this notification to update the page number in the message pane, for example.

PageBegin: void(*)

(Optional) A callback for PDPrintClient. It is called before a page begins printing.

BeforePageSetup: ASBool(*)

(Optional) A callback for PDPrintClient. It is called before a page is printed to set it up. (And before the %BeginpageSetup DCS)

PageSetup: ASBool(*)

(Optional) A callback for PDPrintClient. It is called before a page is printed to set it up.

PageSetupPostResource: void(*)

A callback for PDPrintClient. PageSetupPostResource() is called from PDPrintPageBegin() after the resource tree has been processed (all fonts and other resources emitted into the PostScript stream).

PageCleanup: void(*)

(Optional) A callback for PDPrintClient. It mirrors PageSetup; PageCleanup is called before we clean our dictionaries.

EmitPageContents: void(*)

(Optional) A callback for PDPrintClient. It emits the page contents for printing. It broadcasts a notification that the page has been printed:

NOTIFY( PDDocDidPrintPage) (doc, page, stm, error)

There is a default callback for PostScript printing.

PageEnd: void(*)

(Optional) A callback for PDPrintClient. It is called after a page has printed. It broadcasts a notification that the page has printed:

NOTIFY( PDDocDidPrintPages) (doc, fromPage, toPage, error);

DocEnd: void(*)

In order for the Mac platform to emit color comments, the controller needs to be passed to the DocEnd client callback. The client then calls PDPrintFillColorUsageBuf() to fill in the data for the injection point used by the print manager to emit the custom color comments.

(Optional) A callback for PDPrintClient. It ends processing a document for printing.

GetFontEncodingMethod: PDPrintGetFontEncodingMethodProc

This routine is called to ask the client what encoding method should be used for the font. This cannot be NULL for PostScript printing.

GetFontVMUsage: ASInt32(*)

(Optional) A callback for PDPrintClient. It asks the client what the VM usage is for the font.

EmitPSFontBegin: void(*)

(Optional) A callback for PDPrintClient. It is called before a font is emitted (outside DSC comments).

EmitPSFontEnd: void(*)

(Optional) A callback for PDPrintClient. It is called after a font is emitted (outside DSC comments).

EmitPSFontEncodingBegin: ASBool(*)

(Optional) A callback for PDPrintClient. It is called before a font encoding is emitted.

EmitPSFontEncodingEnd: void(*)

(Optional) A callback for PDPrintClient. It is called after a font encoding is emitted.

EmitPSResourceBegin: void(*)

(Optional) A callback for PDPrintClient. It is called before a PostScript resource is emitted.

EmitPSResourceEnd: void(*)

(Optional) A callback for PDPrintClient. It is called after a PostScript resource is emitted.

ShouldCancel: ASBool(*)

A callback for PDPrintClient. ShouldCancel is called at least once per page. It should return true if the print job should be cancelled (typically, the user hit a key combination to cancel printing).

CancelPrintJob: ASBool(*)

A callback for PDPrintClient. CancelPrintJob is called to actually cause the print job to be cancelled. It should stop further printing and preferably should remove the incomplete print job.

FlushString: ASInt32(*)

(Required) A callback for PDPrintClient. It is called when the ASStm buffer is full. Buffered data should be sent to the printer, driver, file, or other destination. Not used for non-PostScript printing.

EmitPrologString: ASInt32(*)

(Optional) A callback for PDPrintClient. It emits a prolog string.

It defaults to a method that calls FlushString().

CanEmitFont: PDPrintCanEmitFontProc

This routine is called to determine whether a font can be emitted into the print job. This is used to determine whether a font is a document-included resource. It is only used for PostScript.

OPTIONAL: The default is to assume that any font can be emitted.

EmitFont: PDPrintEmitFontProc

REQUIRED. This routine is called to emit a font. For Type0 fonts that require font substition, this routine may emit multiple font definitions. The caller can get the list of fonts used by calling GetFontComponentList().

UndefineFont: ASBool(*)

(Required) UndefineFont() is called to remove the font from the list of fonts that have been downloaded and to undefine the font from PostScript VM. It may be called during a page, at the end of the page, or between pages. After this routine is called, if the font is required again, the EmitFont() routine will be called.

EmitFontProcSet: ASBool(*)

(Optional) A callback for PDPrintClient. EmitFontProcSet() is
called while emitting the document prolog. It should emit
any procsets required to download the font. The routine
will be called once for each font in the document. However,
each procset only needs to be downloaded once per document.

@param stm IN/OUT The stream where the procset should be written.

@param fontP IN/OUT The PDFont for the font.
@param printClient IN/OUT The PDPrintClient from which this is
invoked.
@return false if the PDPrintClient fontDownloadContext is not
specified; true otherwise.

EmitGlyphsIncr: ASBool(*)

A callback for PDPrintClient. It emits glyphs incrementally.

GetComponentFontList: void(*)

(Required) A callback for PDPrintClient. GetComponentFontList() is called to get the list of component font names used for substitution. For fonts that do not require substitution or are substituted by only one font, the list returned should only have one element. For a Type 0 font that requires several fonts for font substitution, the list will have multiple fonts. The font names returned are the names used by the font definitions downloaded to PostScript. The font definitions themselves are downloaded by a call to the EmitFont() routine.

FlushIncrGlyphList: void(*)

(Required) A callback for PDPrintClient. FlushIncrGlyphList() is called to flush the list of glyphs that have been incrementally download since the calls to EmitFont or the last call of FlushIncrGlyphList. This routine will be called if the caller generates PostScript code that would flush glyphs procedures that have been downloaded to the PostScript interpreter. For example, if at the beginning of each page, a save is executed and then at the end of a page, a restore is executed, any glyph procedures downloaded after the beginning of the page will be removed when the restore is executed.

The call to FlushIncrGlyphList() indicates that all the glyphs need to be redownloaded, by calls to EmitGlyphsIncr().

OPIhandler: ASBool(*)

(Optional) A callback for PDPrintClient. If this method is supplied, then during PostScript printing, it will be called when a form or image containing an OPI dictionary is encountered. If it returns true, then the client is presumed to have taken care of the entire form or image, and PDFL will emit nothing. Otherwise, PDFL will generate OPI comments based on the dictionary.

Note: The method may not store the OPIdict pointer or any pointers within it.

DataSourceString: ASUns32(*)

(Optional) If this method is supplied, and the emitExternalStreamRef parameter in the PDPrintParamsRec is true, then during PostScript printing this method will be called when an external stream is encountered. If the method is not supplied, or if it returns NULL, then the simple path name will be written as the DataSource for the stream; otherwise, the returned string will be written as the DataSource.

The DataSource is used thus:

/ DataSource (xxxxx) (r) file

where xxxxx is the returned string or the simple path name.

Note: The method may not store the PDFileSpec pointer or any pointers (strings) within it.

sequentialPageNum: ASInt32

The current page, starting at 1.

clientData: void *

Data for the client's use. This data is passed to the OPIhandler and DataSourceString methods.

fontDownloadContext: void *

For the client's use to hold a font download context for the EmitFontProcSet.

vmUsed: ASInt32

The amount of virtual memory used. It is incremented by routines that download fonts and resources.

ProgressMonitor: ASBool(*)

Optional. If ProgressMonitor, then during PostScript printing, it will be called when page uses the flattener to print.

progMonClientData: void *

GetTimeDate: void(*)

For use in the Exchange product, when emitting the time/date of the print job (the PageInfo mark for separations), this callback takes an ASText object and the client side fills in the timeDate with a localized representation of the current date and time. This could be called from the Tiling code as well.

seps: PDHostSepsSpec

Pro product only. @product_exclude RDR @product_exclude STD

GetClientPaperSize: void(*)

For internal use of PDFL. SDK clients must set this parameter to NULL.

outStm: ASStm

Output stream for creating postscript file.

Used In

Fields

name: const char *

The font name.

encoding: const char *

The font encoding.

cidFontName: const char *

CID font name.

style: ASInt16

Gothic or Mincho.

syntheticStyle: PDFontStyle

Roman, Italic, Bold, or BoldItalic.

used: ASBool

Set to true if glyphs from this component are used.

emitted: ASBool

Set to true if this component is emmitted.

baseLineAdj: ASInt32

Baseline adjustment.

flags: ASUns32

Flags bits.

Used In

Fields

size: ASSize_t

The size of the data structure. It must be set to sizeof(PDPrintParams).

ranges: PDPageRange *

Ranges of pages to print. Use NULL to print the entire document.

numRanges: ASInt32

The number of ranges of pages to print in ranges. The default value is 0.

shrinkToFit: ASBool

true if the page is scaled to fit the printer page size, false otherwise. This field overrides the scale. The default value is false.

expandToFit: ASBool

true if small pages are to be scaled up to fit the printer page size, false otherwise. It overrides the scale. The default value is false.

rotateAndCenter: ASBool

true if the page is to be rotated to fit the printer's orientation and centered in the printer's page size; false otherwise.The default value is false. Rotation and centering (true) only occur, however, if the page contents are too wide to fit on a narrow page (or vice versa) and the page contents are less than an inch smaller than the target page in one direction.

printWhat: PDPrintWhat

Print the document, the document and comments, or document form fields only.

printWhatAnnot: PDPrintWhatAnnot

Annotation flags which modify PDPrintWhat to enable Pro product behavior.

emitPS: ASBool

If true, emit a PostScript file. The default value is true.

psLevel: ASInt32

PostScript level: 1, 2, or 3. The default value is 2.

outputType: PDOutputType

Print PostScript or EPS with or without a preview.

Note: EPS preview generation is not currently available on UNIX.

incBaseFonts: PDInclusion

Embed the base fonts. The default value is kIncludeNever.

incEmbeddedFonts: PDInclusion

Embed fonts that are embedded in the PDF file. This overrides the incType1Fonts, incTrueTypeFonts, and incCIDFonts fields. The default value is kIncludeOncePerDoc.

incType1Fonts: PDInclusion

Embed Type 1 fonts. The default value is kIncludeOncePerDoc.

incType3Fonts: PDInclusion

Embed Type 3 fonts. The default value is kIncludeOnEveryPage.

Note: This parameter must always be set to kIncludeOnEveryPage. PDF files exist with Type 3 fonts that contain different encodings on different pages.

incTrueTypeFonts: PDInclusion

Embed TrueType fonts. The default value is kIncludeOncePerDoc.

incCIDFonts: PDInclusion

Embed CID fonts. The default value is kIncludeOncePerDoc.

incProcsets: PDInclusion

Include Procsets in the file. The default value is kIncludeOncePerDoc.

Note: This is not honored anymore: its value is always false. Procsets are always emitted at the document level.

incOtherResources: PDInclusion

Include all other types of resources in the file. The default value is kIncludeOncePerDoc.

fontPerDocVM: ASInt32

The amount of VM available for font downloading at the document level. It is ignored if it is less than or equal to 0.

Note: This must be set to 0 for the toolkit; it is only used by the viewer.

emitShowpage: ASBool

Emit save and restore showpage in PostScript files. The default value is true.

emitTTFontsFirst: ASBool

Emit TrueType fonts before any other fonts. The default value is false.

setPageSize: ASBool

(PostScript level 2 only) Set the page size on each page. Use the media box for outputting to PostScript files, use the crop box for EPS files. Default is false.

emitDSC: ASBool

Write DSC (Document Structuring Conventions) comments. The default value is true.

Note: This is not honored anymore: its value is always true.

setupProcsets: ASBool

If procsets are included, also include init/term code. The default value is true.

Note: This must be set to true for the toolkit.

emitColorSeps: ASBool

Emit images for Level-1 separations. The default value is false.

Note: This will be honored only when printing to a printer.

binaryOK: ASBool

true if binary data is permitted in the PostScript file, false otherwise. It is overridden by the printer's "Output Protocol" device settings. The default value is true.

useSubFileDecode: ASBool

Add SubFileDecode filter to work around stream problems [false]. The SubFileDecode filter will always be emitted when you print as binary.

emitRawData: ASBool

true if adding no unnecessary filters when emitting image data, false otherwise. The default value is true.

TTasT42: ASBool

If including TrueType fonts, convert to Type 42 fonts instead of Type 1 fonts. The default value is false. This parameter is valid only for the Export to PS workflow and not for printing to a printer.

scale: float

The document-wide scale factor. 100.0 = full size. The default value is 100.

emitExternalStreamRef: ASBool

If an Image resource uses an external stream, emit code that points to the external file. The default value is false.

Note: This must be set to false.

emitHalftones: ASBool

Preserve any halftone screening in the PDF file. The default value is false.

emitPSXObjects: ASBool

Emit PostScript XObjects into the PostScript stream [false].

centerCropBox: ASBool

true if CropBox output is centered on the page when the CropBox < MediaBox, false otherwise. The default value is true.

emitSeparableImagesOnly: ASBool

If emitting EPS, include only CMYK and gray images.

emitDeviceExtGState: ASBool

When emitting the extended graphics state, include the device-dependent parameters (overprint, black generation, undercolor removal, transfer, halftone, halftone phase, smoothness, flatness, rendering intent) in addition to the device-independent parameters (font, line width, line cap, line join, miter limit, dash pattern). If this flag is false, only the device-independent parameters will be emitted. This flag overrides emitHalftones; if this is false, then halftones are not emitted. [true]

boundingBox: ASFixedRect

If all zeroes, it is ignored. Otherwise, it is used for %BoundingBox DSC comment and in centerCropBox calculations and for setpagedevice. The default value is [0 0 0 0].

useFontAliasNames: ASBool

Used when printing with system fonts. The default value is false.

emitPageRotation: ASBool

Emit a concat at the beginning of each page so that the page is properly rotated. Used when emitting EPS. The default value is false.

reverse: ASBool

If set to true, reverse the order of page output.

tCropBox: ASFixedRect *

Temporary crop box to represent the selected region.

emitPageClip: ASBool

Emit page clip.

emitTransfer: ASBool

Emit transfer.

emitBG: ASBool

Emit black generation.

emitUCR: ASBool

Emit undercolor removal.

farEastFontOpt: PDFarEastFont

GDI to PS or download CJK fonts. PDPDFarEastFont_Print_As_Image will not be honored.

suppressCJKSubstitution: ASBool

If true, do not perform CJK substitution on the printer. This will work only when farEastFontOpt is PDPDFarEastFont_Download_None.

suppressCSA: ASBool

Do not emit CSAs for 4-component (CMYK) colors. This will take precedence over the hostbasedCM settings.

hostBased: ASBool

For separator, do host-based color management.

hostBasedOutputCS: ASAtom

The output color space when hostBased color management is true.

duplex: PDDuplexEnum

Sets the duplex mode if the device supports duplex printing. The default value is kPDDuplexOff.

doTiling: PDPageTilingMode

Determines whether to tile none, all, or only large pages.

tileInfo: PDTileEx

If non-NULL, tiling is desired with these parameters.

rotate: ASBool

Enable the auto-rotating behavior from past versions of Acrobat.

hostBasedCM: ASBool

Do hostBased color management using the destination profile. The default is false, which means doing CSA generation for profiles instead of converting all colors on the host.

destProfile: char

If hostBasedCM color management is true, use this profile. It should be the name of the profile like "U.S. Web Coated (SWOP) v2" and not the name of the file.

destCSAtom: ASAtom

An ASAtom representing the device color space (DeviceGray, DeviceRGB, and so on).

saveVM: ASBool

true means try to save VM when printing to PostScript.

doOPP: ASBool

Do the overprint preview operation.

suppressOPPWhenNoSpots: ASInt32

When true, suppress OPP for pages that do not contain spot colors

optimizeForSpeed: ASBool

If true, do it fast; false means PostScript code must be page-independent. If it is set to true, font downloads are forced from kIncludeOnEveryPage to kIncludeOncePerDoc.

brokenCRDs: ASBool

If true, do not set rendering intent in PostScript stream due to broken non-default CRDs.

Note: This is not honored anymore: its value is always false.

useMaxVM: ASBool

If true, store all possible resources in VM.

lastWidth: ASInt32

Used when setPageSize is true to prevent unneeded setpagedevice calls.

lastHeight: ASInt32

Used when setPageSize is true to prevent unneeded setpagedevice calls.

bitmapResolution: ASUns32

DPI for bitmaps. The default is 300. This will only work when you set useFullResolutionJP2KData to false; it should not be less then 50.

gradientResolution: ASUns32

DPI for gradients interior to the object (not edges). It can generally be lower than the bitmapResolution. The default is 150.

transparencyQuality: ASUns32

The transparency level. The range is 0-100.

ocContext: PDOCContext

The optional-content context to use for visibility state information, or NULL to use the document's current states in the default context.

applyOCGPrintOverrides: ASBool

Print-specific visiblity state settings are always applied from the optional-content group. applyOCGPrintOverrides is no longer honored. It is always considered as true whatever may be the value passed to it.

useFullResolutionJP2KData: ASBool

Determines whether to use the maximum available JPEG2000 resolution.

emitInRipSeps: ASBool

When true, it requests that separations, one sheet per ink, be generated in the RIP (printer). It is available only in Acrobat Professional. @product_exclude RDR @product_exclude STD

whichMarks: PDPageMarkFlags

Page mark indication. It is a bit-wise OR of the PDPageMarkFlags values.

It applies to print separations, which are available only in Acrobat Professional.

@product_exclude RDR @product_exclude STD

westernMarksStyle: ASBool

When true, use western style for page marks. It applies to print separations, which are available only in Acrobat Professional. Obsoleted by markStyle below. @product_exclude RDR @product_exclude STD

doProofing: ASBool

When true, print using proofing settings.

proofProfile: char

Description string for the proofing profile.

inkBlack: ASBool

Proofing settings: simulate ink black.

paperWhite: ASBool

Proofing settings: simulate paper white.

useExecForm: ASBool

When true, emit execform calls when emitting Form XObjects.

flattenInfo: PDFlatten

A structure containing parameters that control tile flattening.

negative: ASBool

When true, invert the plate.

mirrorprint: ASEnum8

One of the following constants: kPDPrintFlipNone = 0x01
kPDPrintFlipX = 0x02
kPDPrintFlipY = 0x04
kPDPrintFlipXY = 0x08

Mirroring is done in the PostScript output stream.

numCollatedCopies: ASUns32

Enables collation for the viewer.

emitFlatness: ASBool

Honors the flatness settings over gstate flatness.

trapType: ASInt32

The trap type:

• kPDPrintTrapNone = 0x01.

• kPDPrintTrapOnHost = 0x02 is not supported in Acrobat 7.

• kPDPrintTrapInRIP = 0x04.

TTasCIDT2: ASBool

This parameter is obsolete from PDFL 10.0. When this is set, emit TrueType fonts as CIDType2 instead of as CIDFontType0.

markStyle: ASInt32

Specify the style to use for page marks. The PDPrintMarkStyles enum contains possible styles. It applies to print separations, which are available only in Acrobat Pro. @product_exclude RDR @product_exclude STD

lineWidth: float

The line weight to use for printer marks.

macQDPrinter: ASBool

true if the printer is a Mac QuickDraw printer, false otherwise.

customMarksFileName: ASPathName

If markStyle == -1, this should be a valid file name pointing to a valid .mrk file for custom printer marks.

pAGMPI: void *

disableFlattening: ASBool

Disable flattening of the PDF file; transparency data will be ignored. Also note the preprocessor define below.

doNotDownloadFauxFonts: ASBool

grayToK: ASBool

convert Gray to K (any Gray to CMYK (0,0,0,K))

suppressSnapToDevice: ASBool

suppressElement: ASUns32

maxFlatSeconds: ASUns32

testTilingMode: ASInt32

Provide a means for all 4 page rotations to be tiling-exercised at once.