PDF_Library.General (PDFL)

Note

UNIX supports only PostScript to a file or printer, as controlled by the (mutually exclusive) emitToFile and emitToPrinter parameters.

File: PDFLPrint.h

Line: 531

Elements

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	psLevel	PostScript level. It applies to a PostScript printer.

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

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

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

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

	doOPP	`1` uses OverPrint Preview, `0` does not. It applies to a printer. The default is `0`.

	userCallbacks	Optional pointer to structure containing pointers to user callback functions

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

_t_PDFLPrintUserParams

Product availability: PDFL

Platform availability: UNIX

Syntax

struct _t_PDFLPrintUserParams {

  ASInt32 size;  


 


  PDPrintParams printParams;  


 


  ASBool emitToFile;  


 


  ASStm printStm;  


 


  ASUns16 paperWidth;  


 


  ASUns16 paperHeight;  


 


  ASInt32 dontEmitListLen;  


 


  char** dontEmitList;  


 


  ASBool emitToPrinter;  


 


  char* command;  


 


  PDFLPrintCancelProc cancelProc;  


 


  void* clientData;  


 


  int startResult;  


 


  PDFLPrintUserCallbacks userCallbacks;  


 


  int nCopies;  


 


  PPDFeaturesP PPDFeatures;  


 


  ASText ppdFileName;  

}

Used to control printing with PDFLPrintDoc.

To print to a PostScript file, set emitToFile to true, fill in printParams, and create a writeable stream.

To print to a printer, set emitToPrinter to true, fill in printParams, and optionally fill in the command.

See Also

Note

UNIX supports only PostScript to a file or printer, as controlled by the (mutually exclusive) emitToFile and emitToPrinter parameters.

File: PDFLPrint.h

Line: 90

Elements

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

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

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

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

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

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

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

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

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

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

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

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

	startResult	Spooler ID from StartDoc

	userCallbacks	Optional pointer to structure containing pointers to user callback functions

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

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

_t_PDFLPrintUserParams

Product availability: PDFL

Platform availability: Windows

Syntax

struct _t_PDFLPrintUserParams {

  ASInt32 size;  


 


  ASBool emitToFile;  


 


  PDPrintParams printParams;  


 


  ASStm printStm;  


 


  ASUns16 paperWidth;  


 


  ASUns16 paperHeight;  


 


  ASInt32 dontEmitListLen;  


 


  char** dontEmitList;  


 


  ASBool emitToPrinter;  


 


  char* inFileName;  


 


  char* outFileName;  


 


  char* deviceName;  


 


  char* driverName;  


 


  char* portName;  


 


  DEVMODEA* pDevMode;  


 


  int startPage;  


 


  int endPage;  


 


  int shrinkToFit;  


 


  int printAnnots;  


 


  int psLevel;  


 


  int nCopies;  


 


  int binaryOK;  


 


  int emitHalftones;  


 


  int reverse;  


 


  int farEastFontOpt;  


 


  int transQuality;  


 


  int doOPP;  


 


  PDFLPrintCancelProc cancelProc;  


 


  void* clientData;  


 


  int startResult;  


 


  ASUns16 inFileNameW;  


 


  ASUns16 outFileNameW;  


 


  ASUns16 deviceNameW;  


 


  ASUns16 driverNameW;  


 


  ASUns16 portNameW;  


 


  DEVMODEW* pDevModeW;  


 


  HDC pDC;  


 


  PDFLPrintUserCallbacks userCallbacks;  


 


  PPDFeaturesP PPDFeatures;  


 


  ASText ppdFileName;  

}

Used to control printing with PDFLPrintDoc.

See PDFLPrint.h for details about printing on specific platforms.

To print to a PostScript file, set emitToFile to true, fill in printParams, and create a writeable stream.

To print to a printer, set emitToPrinter to true, fill in printParams, and optionally fill in the command.

See Also

Note

UNIX supports only PostScript to a file or printer, as controlled by the mutually exclusive emitToFile and emitToPrinter parameters.

File: PDFLPrint.h

Line: 209

Elements

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	psLevel	PostScript level. It applies to a PostScript printer.

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

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

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

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

	farEastFontOpt	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	Transparency flattening quality control. `1` is fastest; `5` is best. It applies to a printer. The default is `3`.

	doOPP	`1` uses OverPrint Preview, `0` does not. It applies to a printer. The default is `0`.

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

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

	startResult	Spooler ID from StartDoc().

	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.

	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.

	deviceNameW	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	The name of the driver (for example, `"winspool"`). See the registry key for `deviceName`. It applies to the printer.

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

	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.

	pDC	(Optional) Allows you to pass a DeviceContext structure. If you do not pass in your own DeviceContext structure PDFL creates its own.

	userCallbacks	Optional pointer to structure containing pointers to user callback functions

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

_t_PDFLPrintUserParamsEx

Product availability: PDFL

Platform availability: Windows

Syntax

struct _t_PDFLPrintUserParamsEx {

  ASInt32 size;  


 


  ASBool emitToFile;  


 


  PDPrintParams printParams;  


 


  ASStm printStm;  


 


  ASUns16 paperWidth;  


 


  ASUns16 paperHeight;  


 


  ASInt32 dontEmitListLen;  


 


  char** dontEmitList;  


 


  ASBool emitToPrinter;  


 


  char* inFileName;  


 


  char* outFileName;  


 


  char* deviceName;  


 


  char* driverName;  


 


  char* portName;  


 


  DEVMODEA* pDevMode;  


 


  int startPage;  


 


  int endPage;  


 


  int shrinkToFit;  


 


  int printAnnots;  


 


  int psLevel;  


 


  int nCopies;  


 


  int binaryOK;  


 


  int emitHalftones;  


 


  int reverse;  


 


  int farEastFontOpt;  


 


  int transQuality;  


 


  int doOPP;  


 


  PDFLPrintCancelProc cancelProc;  


 


  void* clientData;  


 


  int startResult;  


 


  ASUns16 inFileNameW;  


 


  ASUns16 outFileNameW;  


 


  ASUns16 deviceNameW;  


 


  ASUns16 driverNameW;  


 


  ASUns16 portNameW;  


 


  DEVMODEW* pDevModeW;  


 


  HDC pDC;  


 


  PDFLPrintUserCallbacks userCallbacks;  


 


  PPDFeaturesP PPDFeatures;  


 


  ASText ppdFileName;  


 


  ASBool oneJobwithNCopies;  

}

Used to control the emitting of PPD dependent features to a PostScript file when printing with PDFLPrintDoc. These features are emitted only if emitToFile is set to true. Please see PDFLPrintDoc for more details.

This can be used to generate PPD dependent PostScript file on all platforms.

All PPD features in the structure are optional. Set only the ones you want to be emit to the output PostScript file.

The PPD file and its path should be passed in as ppdFileName inside PDFLPrintUserParamsRec.

If the PPD feature specified here does not exist in the passed PPD file, then it will not be outputted in the generated PostScript file. For eg. if Upper is passed as InputSlot and there is no tray as Upper in the PPD file, then the generated PostScript file will not contain an entry setting InputSlot to Upper.

Note: If no PPD file is passed then this structure would be ignored.

Used to control printing with PDFLPrintDoc.

See PDFLPrint.h for details about printing on specific platforms.

To print to a PostScript file, set emitToFile to true, fill in printParams, and create a writeable stream.

To print to a printer, set emitToPrinter to true, fill in printParams, and optionally fill in the command.

See Also

Note

UNIX supports only PostScript to a file or printer, as controlled by the mutually exclusive emitToFile and emitToPrinter parameters.

File: PDFLPrint.h

Line: 717

Elements

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	psLevel	PostScript level. It applies to a PostScript printer.

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

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

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

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

	farEastFontOpt	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	Transparency flattening quality control. `1` is fastest; `5` is best. It applies to a printer. The default is `3`.

	doOPP	`1` uses OverPrint Preview, `0` does not. It applies to a printer. The default is `0`.

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

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

	startResult	Spooler ID from StartDoc().

	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.

	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.

	deviceNameW	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	The name of the driver (for example, `"winspool"`). See the registry key for `deviceName`. It applies to the printer.

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

	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.

	pDC	(Optional) Allows you to pass a DeviceContext structure. If you do not pass in your own DeviceContext structure PDFL creates its own.

	userCallbacks	Optional pointer to structure containing pointers to user callback functions

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

_t_PDPrintClient

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDPrintClient {

  ASSize_t size;  


 


  PDDoc pdDoc;  


 


  PDPrintParams params;  


 


  void DocBegin)(const PDPageRange ranges[], ASInt32 numRanges, ASStm stm, const PDResTree docTree, PDPrintClient printClient);  


 


  ASBool DocSetup)(const PDPageRange ranges[], ASInt32 numRanges, ASStm prologStm, PDPrintClient printClient);  


 


  void EndSetup)(ASStm stm, PDPrintClient client);  


 


  void NotifyNewPage)(ASInt32 pageNum, PDPrintClient printClient);  


 


  void PageBegin)(ASStm stm, ASInt32 pageNum, const PDResTree pageTree, PDPrintClient printClient);  


 


  ASBool PageSetup)(ASStm stm, ASInt32 pageNum, PDPrintClient printClient);  


 


  void PageSetupPostResource)(ASStm stm, ASInt32 pageNum, PDPrintClient printClient);  


 


  void PageCleanup)(ASStm stm, ASInt32 pageNum, PDPrintClient printClient);  


 


  void EmitPageContents)(ASStm stm, ASInt32 pageNum, PDPage pdPage, PDPrintClient printClient);  


 


  void PageEnd)(ASStm stm, ASInt32 pageNum, ASBool veryLastPage, PDPrintClient printClient);  


 


  void DocEnd)(ASStm stm, PDPrintClient printClient, PDPrintController controller);  


 


  PDPrintGetFontEncodingMethodProc GetFontEncodingMethod;  


 


  ASInt32 GetFontVMUsage)(PDFont fontP, PDPrintClient printClient);  


 


  void EmitPSFontBegin)(ASStm stm, PDFont fontP, PDPrintClient printClient);  


 


  void EmitPSFontEnd)(ASStm stm, PDFont fontP, PDPrintClient printClient);  


 


  ASBool EmitPSFontEncodingBegin)(ASStm stm, PDFont fontP, PDPrintClient printClient);  


 


  void EmitPSFontEncodingEnd)(ASStm stm, PDFont fontP, PDPrintClient printClient);  


 


  void EmitPSResourceBegin)(ASStm stm, ASAtom resType, const char *resName, CosObj resObj, PDPrintClient printClient);  


 


  void EmitPSResourceEnd)(ASStm stm, ASAtom resType, const char *resName, CosObj resObj, PDPrintClient printClient);  


 


  ASBool ShouldCancel)(PDPrintClient printClient);  


 


  ASBool CancelPrintJob)(PDPrintClient printClient);  


 


  ASInt32 FlushString)(char *data, ASInt32 nData, PDPrintClient printClient);  


 


  ASInt32 EmitPrologString)(const char *s, ASInt32 nData, PDPrintClient printClient);  


 


  PDPrintCanEmitFontProc CanEmitFont;  


 


  PDPrintEmitFontProc EmitFont;  


 


  ASBool UndefineFont)(ASStm stm, PDFont fontP, ASBool vmUndefine, PDPrintClient client);  


 


  ASBool EmitFontProcSet)(ASStm stm, PDFont fontP, PDPrintClient client);  


 


  ASBool EmitGlyphsIncr)(ASStm stm, PDFont fontP, PDPrintStrP srcStr, PDPrintStrP dstStr, ASUns32 *srcBytesUsed, ASUns32 *dstBytesUsed, ASUns32 *glyphCount, ASUns16 *fontIndex, PDPrintClient printClient);  


 


  void GetComponentFontList)(PDFont fontP, PDPrintFontArrayP fontList, PDPrintClient printClient);  


 


  void FlushIncrGlyphList)(ASStm stm, PDPrintClient printClient);  


 


  ASBool OPIhandler)(OPIdict *opi, ASStm stm, void *clientData);  


 


  ASUns32 DataSourceString)(PDFileSpec f, char *buf, ASUns32 bufSize, void *clientData);  


 


  ASInt32 sequentialPageNum;  


 


  void* clientData;  


 


  void* fontDownloadContext;  


 


  ASInt32 vmUsed;  


 


  ASBool ProgressMonitor)(ASInt32 pageNum, ASInt32 totalPages, float current, const char *name, ASInt32 stage, void *progMonClientData);  


 


  void* progMonClientData;  


 


  void GetTimeDate)(ASText timeDate);  


 


  PDHostSepsSpec seps;  


 


  void GetClientPaperSize)(PDPrintClient printClient, ASFixed *height, ASFixed *width);  


 


  ASStm outStm;  

}

A data structure used by PDDocPrintPages. It contains methods to be implemented by the client. Unless otherwise indicated, methods may be NULL, indicating that they do nothing. The methods are called in the order listed in this structure.

File: PDFLExpT.h

Line: 1763

Elements

	size	The size of the structure.

	pdDoc	The document to print.

	params	A control structure describing how to print the document.

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

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

	EndSetup	(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	(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	(Optional) A callback for PDPrintClient. It is called before a page begins printing.

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

	PageSetupPostResource	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	(Optional) A callback for PDPrintClient. It mirrors PageSetup; PageCleanup is called before we clean our dictionaries.

	EmitPageContents	(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	(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	(Optional) A callback for PDPrintClient. It ends processing a document for printing.

	GetFontEncodingMethod	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	(Optional) A callback for PDPrintClient. It asks the client what the VM usage is for the font.

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

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

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

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

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

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

	ShouldCancel	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	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	(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	(Optional) A callback for PDPrintClient. It emits a prolog string. It defaults to a method that calls FlushString().

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

	EmitGlyphsIncr	A callback for PDPrintClient. It emits glyphs incrementally.

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

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

	sequentialPageNum	The current page, starting at `1`.

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

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

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

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

	GetTimeDate	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	Pro product only.

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

	outStm	Output stream for creating postscript file.

_t_PPDFeatures

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PPDFeatures {

  ASUns32 size;  


 


  ASText InputSlot;  


 


  ASText OutputBin;  


 


  ASText Duplex;  


 


  ASText StapleLocation;  


 


  ASText StapleX;  


 


  ASText StapleY;  


 


  ASText StapleOrientation;  


 


  ASText StapleWhen;  

}

This can be used to generate PPD dependent PostScript file on all platforms.

All PPD features in the structure are optional. Set only the ones you want to be emit to the output PostScript file.

The PPD file and its path should be passed in as ppdFileName inside PDFLPrintUserParamsRec.

Note: If no PPD file is passed then this structure would be ignored.

File: PDFLPrint.h

Line: 1026

Elements

	size	Size of the data structure. It must be set to `sizeof(PPDFeaturesRec)`.

	InputSlot	Optional. Specifies the Input Tray of the printer. For eg. Upper

	OutputBin	Optional. Specifies the Onput Tray of the printer. For eg. Left

	Duplex	Optional. Specifies the Duplex mode. For eg. DuplexTumble

	StapleLocation	Optional. Specifies the location for stapling. For eg. SinglePortrait. Either `StapleLocation` should be used or both `StapleX` and `StapleY` to specify the location for stapling.

	StapleX	Optional. Specifies the StapleX. For eg. Left. Also read the comment on `StapleLocation`

	StapleY	Optional. Specifies the StapleY. For eg. Top. Also read the comment on `StapleLocation`

	StapleOrientation	Optional. Specifies the orientation of the stapling. For eg. 45

	StapleWhen	Optional. Specifies when to staple. For eg. EndOfPage

_t_SearchQueryDataRec

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_SearchQueryDataRec {

  ASSize_t size;  


 


  ASText query;  


 


  SearchType type;  


 


  SearchMatchOption match;  


 


  SearchWordOptions options;  


 


  SearchScope scope;  


 


  ASPathName path;  


 


  ASFileSys fs;  


 


  ASUns16 maxDocs;  


 


  ASUns32 startPage;  


 


  ASUns32 proximityRange;  

}

File: SrchType.h

Line: 162

Elements

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

	query	The text to be searched.

	type	The location to search in.

	match	How the query text should be matched in the document.

	options	The search options.

	scope	The content in the PDFs that should be searched. It should be an `OR` of values specified in SearchScope.

	path	The path of the folder or index. It is required only when `type` is kSearchFolder or kSearchIndex.

	fs	The ASFileSys of the folder or index. It is required only when `type` is kSearchFolder or kSearchIndex.

	maxDocs	The maximum number of documents to display in the Results window. If more documents than this have hits, only the first `maxDocs` are displayed. `maxDocs` must be no greater than `999`.

	startPage	The page number to start the search; `0` is the first page.

	proximityRange	The range of words for proximity searches.

_t_SecErrorInfo

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_SecErrorInfo {

  ASSize_t size;  


 


  ASText text;  


 


  void* reserved;  

}

If a function returns -1 or less, you can call a GetLastError appropriate to the context and retrieve information about the last error. That call may return NULL which basically means "Unknown Error". Note that in the presence of threads, the error information may become inaccurate.

File: DirectoryHFT.h

Line: 52

Elements

	size	The size of this structure.

	text	The description of the error.

	reserved	Adobe use only. It must be set to `NULL` by external developers.

_t_TermProcs

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_TermProcs {

  PDFLTermType termProc;  

}

File: PDFLInitCommon.h

Line: 47

_t_textList

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_textList {

  char* name;  


 


  _t_textList next;  

}

List structure used in TIFFASCIITagList.

File: PDFLExpT.h

Line: 1436

Elements

	name	Tag name.

	next	Pointer to next list element.

_t_TIFFASCIITagList

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_TIFFASCIITagList {

  ASInt32 tagNumber;  


 


  TextList tagText;  


 


  _t_TIFFASCIITagList next;  

}

TIFF ASCII tags.

File: PDFLExpT.h

Line: 1444

Elements

	tagNumber	The tag number

	tagText	Tag text list.

	next	For OPI 1.3, the `TextList` contains only one element.

_t_TKAllocatorProcs

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_TKAllocatorProcs {

  ASClientAllocProc allocProc;  


 


  ASClientReallocProc reallocProc;  


 


  ASClientFreeProc freeProc;  


 


  ASClientMemAvailProc memAvailProc;  


 


  void* clientData;  

}

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

See Also

File: PDFInit.h

Line: 164

Elements

	allocProc	Called when the PDF Library needs to allocate memory.

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

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

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

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

_t_TKExtensionProcs

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_TKExtensionProcs {

  ASExtensionProgressProc progressProc;  


 


  ASExtensionReportErrorProc reportErrProc;  


 


  void* clientData;  

}

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

See Also

File: PDFInit.h

Line: 359

Elements

	progressProc	Called when the PDF Library needs to allocate memory.

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

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

_t_TKResourceProcs

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_TKResourceProcs {

  TKResourceAcquireProc acquireProc;  


 


  TKResourceReleaseProc releaseProc;  


 


  void* clientData;  

}

Structure for resource acquisition callbacks used by the PDF Library.

See Also

PDFontPSGetComponentFontList

File: PDFInit.h

Line: 258

Elements

	acquireProc	Called when the PDF Library needs to acquire resources.

	releaseProc	Called when the PDF Library needs to release resources.

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

ImageInks

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct ImageInks {

  ImageInk type;  


 


  MonoInkList mono;  

}

Image inks.

File: PDFLExpT.h

Line: 1540

Elements

	type	Image ink type.

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

OPI13dict

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct OPI13dict {

  TIFFASCIITagList aldImageAsciiTags;  


 


  float c;  


 


  float m;  


 


  float y;  


 


  float k;  


 


  char* name;  


 


  struct OPI13dict::@5 aldImageColor;  


 


  ALDImageColorType aldImageColorType;  


 


  float aldImageCropFixed[4];  


 


  ASUns32 aldImageCropRect[4];  


 


  ASUns32 aldImageDimensions[2];  


 


  PDFileSpec aldImageFileName;  


 


  ASUns16 aldImageGrayMap;  


 


  ASUns16 aldImageGrayMapLength;  


 


  char* aldImageID;  


 


  ASBool aldImageOverprint;  


 


  float aldImagePosition[8];  


 


  float aldImageResolution[2];  


 


  float aldImageTint;  


 


  ASBool aldImageTransparency;  


 


  ASUns32 aldImageType[2];  


 


  char* aldObjectComments;  


 


  unsigned aldimageasciitags;  


 


  unsigned aldimagecolor;  


 


  unsigned aldimagecolortype;  


 


  unsigned aldimagecropfixed;  


 


  unsigned aldimagecroprect;  


 


  unsigned aldimagedimensions;  


 


  unsigned aldimagefilename;  


 


  unsigned aldimagegraymap;  


 


  unsigned aldimageid;  


 


  unsigned aldimageoverprint;  


 


  unsigned aldimageposition;  


 


  unsigned aldimageresolution;  


 


  unsigned aldimagetint;  


 


  unsigned aldimagetransparency;  


 


  unsigned aldimagetype;  


 


  unsigned aldobjectcomments;  


 


  struct OPI13dict::@6 defined;  

}

OPI 1.3 dictionary.

File: PDFLExpT.h

Line: 1454

Elements

	aldImageAsciiTags	TIFF ASCII tags.

	aldImageColorType	Image color type.

	aldImageCropFixed	The portion of the image to be used.

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

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

	aldImageFileName	REQUIRED. Image file name.

	aldImageGrayMap	Changes to the brightness or contrast of the image.

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

	aldImageID	Image identifier.

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

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

	aldImageResolution	Image resolution (`[horiz vert]`).

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

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

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

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

OPI20dict

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct OPI20dict {

  float imageCropRect[4];  


 


  float imageDimensions[2];  


 


  PDFileSpec imageFileName;  


 


  ImageInks imageInks;  


 


  ASBool imageOverprint;  


 


  ASUns32 includedImageDimensions[2];  


 


  float includedImageQuality;  


 


  char* mainImage;  


 


  TIFFASCIITagList tiffAsciiTags;  


 


  unsigned imagecroprect;  


 


  unsigned imagedimensions;  


 


  unsigned imagefilename;  


 


  unsigned imageinks;  


 


  unsigned imageoverprint;  


 


  unsigned includedimagedimensions;  


 


  unsigned includedimagequality;  


 


  unsigned mainimage;  


 


  unsigned tiffasciitags;  


 


  struct OPI20dict::@7 defined;  

}

OPI 2.0 dictionary.

File: PDFLExpT.h

Line: 1548

Elements

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

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

	imageFileName	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	The colorants to be applied to the image.

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

	includedImageDimensions	Included image dimensions.

	includedImageQuality	The quality of the included image.

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

OPIdict

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct OPIdict {

  OPIversion version;  


 


  OPI13dict dict13;  


 


  OPI20dict dict20;  


 


  union OPIdict::@8 dict;  

}

OPI dictionary.

File: PDFLExpT.h

Line: 1599

Elements

	version	OPI version (`1.3` or `2.0`).

PDFlattenRec

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct PDFlattenRec {

  ASSize_t size;  


 


  PDFlattenTilingMode tilingMode;  


 


  ASBool useTextOutlines;  


 


  ASBool allowShadingOutput;  


 


  ASBool allowLevel3ShadingOutput;  


 


  ASBool strokeToFill;  


 


  ASBool clipComplexRegions;  


 


  float internalDPI;  


 


  float externalDPI;  


 


  float pathDPI;  


 


  ASUns32 tileSizePts;  


 


  ASUns32 maxFltnrImageSize;  


 


  ASUns32 adaptiveThreshold;  


 


  ASBool preserveOverprint;  

}

Controls tile flattening. It is primarily of interest to resource limited (embedded) systems developers.

See Also

PDPrintParams

File: PDFLExpT.h

Line: 323

Elements

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

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

	useTextOutlines	Output text outlines instead of native text.

	allowShadingOutput	Allow shading ouput.

	allowLevel3ShadingOutput	Allow level 3 shading output.

	strokeToFill	For converting stroke to outline.

	clipComplexRegions	Clip complex checkbox.

	internalDPI	Resolution for flattening the interior of an atomic region.

	externalDPI	Resolution for flattening edges of atomic regions.

	pathDPI	Flattener path resolution; the default is `800`.

	tileSizePts	Target tile size in points.

	maxFltnrImageSize	Maximum image size when flattening. The default is `0`.

	adaptiveThreshold	Adaptive flattening threshold.

	preserveOverprint	Attempt to preserve overprint.

PDPrintFontArray

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct PDPrintFontArray {

  ASUns32 count;  


 


  ASBool usesDisplayCTFont;  


 


  PDPrintFontP arr;  

}

An array of font pointers for use in PDFontPSGetComponentFontList.

See Also

File: PDFLExpT.h

Line: 276

Elements

	count	The number of fonts in `arr`.

	usesDisplayCTFont	Whether to use the Display CT Font.

	arr	The font array.

PDPrintFontRec

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct PDPrintFontRec {

  const char* name;  


 


  const char* encoding;  


 


  const char* cidFontName;  


 


  ASInt16 style;  


 


  PDFontStyle syntheticStyle;  


 


  ASBool used;  


 


  ASBool emitted;  


 


  ASInt32 baseLineAdj;  


 


  ASUns32 flags;  

}

File: PDFLExpT.h

Line: 236

Elements

	name	The font name.

	encoding	The font encoding.

	cidFontName	CID font name.

	style	Gothic or Mincho.

	syntheticStyle	Roman, Italic, Bold, or BoldItalic.

	used	Set to `true` if glyphs from this component are used.

	emitted	Set to `true` if this component is emmitted.

	baseLineAdj	Baseline adjustment.

	flags	Flags bits.

PDPrintParamsRec

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct PDPrintParamsRec {

  ASSize_t size;  


 


  PDPageRange ranges;  


 


  ASInt32 numRanges;  


 


  ASBool shrinkToFit;  


 


  ASBool expandToFit;  


 


  ASBool rotateAndCenter;  


 


  PDPrintWhat printWhat;  


 


  PDPrintWhatAnnot printWhatAnnot;  


 


  ASBool emitPS;  


 


  ASInt32 psLevel;  


 


  PDOutputType outputType;  


 


  PDInclusion incBaseFonts;  


 


  PDInclusion incEmbeddedFonts;  


 


  PDInclusion incType1Fonts;  


 


  PDInclusion incType3Fonts;  


 


  PDInclusion incTrueTypeFonts;  


 


  PDInclusion incCIDFonts;  


 


  PDInclusion incProcsets;  


 


  PDInclusion incOtherResources;  


 


  ASInt32 fontPerDocVM;  


 


  ASBool emitShowpage;  


 


  ASBool emitTTFontsFirst;  


 


  ASBool setPageSize;  


 


  ASBool emitDSC;  


 


  ASBool setupProcsets;  


 


  ASBool emitColorSeps;  


 


  ASBool binaryOK;  


 


  ASBool useSubFileDecode;  


 


  ASBool emitRawData;  


 


  ASBool TTasT42;  


 


  float scale;  


 


  ASBool emitExternalStreamRef;  


 


  ASBool emitHalftones;  


 


  ASBool emitPSXObjects;  


 


  ASBool centerCropBox;  


 


  ASBool emitSeparableImagesOnly;  


 


  ASBool emitDeviceExtGState;  


 


  ASFixedRect boundingBox;  


 


  ASBool useFontAliasNames;  


 


  ASBool emitPageRotation;  


 


  ASBool reverse;  


 


  ASFixedRect tCropBox;  


 


  ASBool emitPageClip;  


 


  ASBool emitTransfer;  


 


  ASBool emitBG;  


 


  ASBool emitUCR;  


 


  PDFarEastFont farEastFontOpt;  


 


  ASBool suppressCJKSubstitution;  


 


  ASBool suppressCSA;  


 


  ASBool hostBased;  


 


  ASAtom hostBasedOutputCS;  


 


  PDDuplexEnum duplex;  


 


  PDPageTilingMode doTiling;  


 


  PDTileEx tileInfo;  


 


  ASBool rotate;  


 


  ASBool hostBasedCM;  


 


  char destProfile[256];  


 


  ASAtom destCSAtom;  


 


  ASBool saveVM;  


 


  ASBool doOPP;  


 


  ASInt32 suppressOPPWhenNoSpots;  


 


  ASBool optimizeForSpeed;  


 


  ASBool brokenCRDs;  


 


  ASBool useMaxVM;  


 


  ASInt32 lastWidth;  


 


  ASInt32 lastHeight;  


 


  ASUns32 bitmapResolution;  


 


  ASUns32 gradientResolution;  


 


  ASUns32 transparencyQuality;  


 


  PDOCContext ocContext;  


 


  ASBool applyOCGPrintOverrides;  


 


  ASBool useFullResolutionJP2KData;  


 


  ASBool emitInRipSeps;  


 


  PDPageMarkFlags whichMarks;  


 


  ASBool westernMarksStyle;  


 


  ASBool doProofing;  


 


  char proofProfile[256];  


 


  ASBool inkBlack;  


 


  ASBool paperWhite;  


 


  ASBool useExecForm;  


 


  PDFlatten flattenInfo;  


 


  ASBool negative;  


 


  ASEnum8 mirrorprint;  


 


  ASUns32 numCollatedCopies;  


 


  ASBool emitFlatness;  


 


  ASInt32 trapType;  


 


  ASBool TTasCIDT2;  


 


  ASInt32 markStyle;  


 


  float lineWidth;  


 


  ASBool macQDPrinter;  


 


  ASPathName customMarksFileName;  


 


  ASBool grayToK;  

}

A data structure indicating how a document should be printed.

See Also

PDFLPrintDoc

Note

All fields in the PDPrintParams structure apply to PostScript file creation. PDPrintParams are ignored when printing to non-PostScript devices.

File: PDFLExpT.h

Line: 480

Elements

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

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

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

	shrinkToFit	`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	`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	`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	Print the document, the document and comments, or document form fields only.

	printWhatAnnot	Annotation flags which modify PDPrintWhat to enable Pro product behavior.

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

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

	outputType	Print PostScript or EPS with or without a preview.

	incBaseFonts	Embed the base fonts. The default value is kIncludeNever.

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

	incType1Fonts	Embed Type 1 fonts. The default value is kIncludeOncePerDoc.

	incType3Fonts	Embed Type 3 fonts. The default value is kIncludeOnEveryPage.

	incTrueTypeFonts	Embed TrueType fonts. The default value is kIncludeOncePerDoc.

	incCIDFonts	Embed CID fonts. The default value is kIncludeOncePerDoc.

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

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

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

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

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

	setPageSize	(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	Write DSC (Document Structuring Conventions) comments. The default value is `true`.

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

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

	binaryOK	`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	Add `SubFileDecode` filter to work around stream problems [`false`]. The `SubFileDecode` filter will always be emitted when you print as binary.

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

	TTasT42	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	The document-wide scale factor. `100.0` = full size. The default value is `100`.

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

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

	emitPSXObjects	Emit PostScript XObjects into the PostScript stream [`false`].

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

	emitSeparableImagesOnly	If emitting EPS, include only CMYK and gray images.

	emitDeviceExtGState	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	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	Used when printing with system fonts. The default value is `false`.

	emitPageRotation	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	If set to `true`, reverse the order of page output.

	tCropBox	Temporary crop box to represent the selected region.

	emitPageClip	Emit page clip.

	emitTransfer	Emit transfer.

	emitBG	Emit black generation.

	emitUCR	Emit undercolor removal.

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

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

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

	hostBased	For separator, do host-based color management.

	hostBasedOutputCS	The output color space when `hostBased` color management is `true`.

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

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

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

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

	hostBasedCM	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	If `hostBase` 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	An ASAtom representing the device color space (DeviceGray, DeviceRGB, and so on).

	saveVM	`true` means try to save VM when printing to PostScript.

	doOPP	Do the overprint preview operation.

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

	optimizeForSpeed	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	If `true`, do not set rendering intent in PostScript stream due to broken non-default CRDs.

	useMaxVM	If `true`, store all possible resources in VM.

	lastWidth	Used when `setPageSize` is `true` to prevent unneeded `setpagedevice` calls.

	lastHeight	Used when `setPageSize` is `true` to prevent unneeded `setpagedevice` calls.

	bitmapResolution	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	DPI for gradients interior to the object (not edges). It can generally be lower than the `bitmapResolution`. The default is `150`.

	transparencyQuality	The transparency level. The range is `0-100`.

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

	applyOCGPrintOverrides	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	Determines whether to use the maximum available JPEG2000 resolution.

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

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

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

	doProofing	When `true`, print using proofing settings.

	proofProfile	Description string for the proofing profile.

	inkBlack	Proofing settings: simulate ink black.

	paperWhite	Proofing settings: simulate paper white.

	useExecForm	When `true`, emit `execform` calls when emitting Form XObjects.

	flattenInfo	A structure containing parameters that control tile flattening.

	negative	When `true`, invert the plate.

	mirrorprint	One of the following constants: `kPDPrintFlipNone = 0x01` `kPDPrintFlipX = 0x02` `kPDPrintFlipY = 0x04` `kPDPrintFlipXY = 0x08` Mirroring is done in the PostScript output stream.

	numCollatedCopies	Enables collation for the viewer.

	emitFlatness	Honors the flatness settings over `gstate` flatness.

	trapType	The trap type: `kPDPrintTrapNone = 0x01`. `kPDPrintTrapOnHost = 0x02` is not supported in Acrobat 7. `kPDPrintTrapInRIP = 0x04`.

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

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

	lineWidth	The line weight to use for printer marks.

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

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

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

PDPrintStr

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct PDPrintStr {

  char* str;  


 


  ASUns32 len;  


 


  ASRealPoint displacements;  


 


  ASUns32 numGlyphs;  


 


  ASUns32 flags;  

}

A structure for controlling the printing of glyphs.

See Also

PDFontPSEmitGlyphsIncr

File: PDFLExpT.h

Line: 186

Elements

	str	The string.

	len	Byte length.

	displacements	Displacements.

	numGlyphs	The number of glyphs.

	flags	Flags. Reserved for internal use.

SpellCheckParam

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct SpellCheckParam {

  ASInt16 scVersion;  


 


  ASInt16 scFlags;  


 


  char scName[kSpellMaxName];  


 


  SCEnableProc scEnableProc;  


 


  SCGetTextProc scGetTextProc;  


 


  SCCompletionProc scCompletionProc;  


 


  AVDoc scAVDoc;  


 


  ASInt32 scPageNum;  


 


  ASInt32 scIndex;  


 


  char* scInBuffer;  


 


  char* scOutBuffer;  


 


  void* scClientData;  


 


  ASText scInBufferASText;  


 


  ASConstText scOutBufferAStext;  


 


  SCChangeProc scChangeProc;  


 


  ASConstText scChangeText;  


 


  ASInt32 scChangeStart;  


 


  ASInt32 scChangeEnd;  


 


  ASConstText scMenuTitle;  

}

Spell Check parameters This parameter block is used for communication between the Spelling plug-in and a client plug-in. The client must allocate it, initialize all fields, and pass it to the Spelling plug-in when adding a domain with SpellAddDomain. Spelling passes it back to the client when the SCEnableProc(), SCGetTextProc(), and SCCompletionProc() are called.

It is passed to the client's SCGetTextProc() from the Spelling plug-in when it needs to request a text buffer from the client. After the user has completed the spell check on the scInBuffer, this same parameter block is passed to the client's SCCompletionProc() with the result of the spell check in scOutBuffer. When the SCGetTextProc() is called, scPageNum, scIndex and scAVDoc are filled in by the Spelling plugin.

The SCGetTextProc should fill in scInBuffer and clear scOutBuffer if it is not already NULL.

When the spell check is completed, SCCompletionProc() is called with scOutBuffer if the user made changes to scInBuffer.

Note that the spelling client is responsible for all memory allocated including the scOutBuffer returned from the Spelling plug-in. The client is responsible for all parameters except where indicated.

File: Speller_Sel.h

Line: 252

Elements

	scVersion	Version number of this structure (kSCparam_LATEST_VERSION).

	scFlags	Domain control flags; see SpellDomainFlags. It should normally be set to kSpellFlagAllDomain.

	scName	This name will be returned by SpellDomainNames().

	scAVDoc	(Passed by Spelling plug-in) The active AVDoc during this Spell Check session.

	scPageNum	(Passed by Spelling plug-in) The 0-based PDDoc page number of `scAVDoc`.

	scIndex	(Passed by Spelling plug-in) The 0-based index of this domain item. The Spelling plug-in will set `scIndex` to zero to start or restart, and request the first text buffer from this domain on `scPageNum`. The Spelling plug-in will increment `scIndex` after each call to `scGetTextProc`. The client can increment `scIndex` if desired to track non-sequential domain items.

	scInBuffer	The text buffer from the client to the Spelling plug-in when scGetTextProc() is called by the Spelling plug-in.

	scOutBuffer	(Passed by Spelling plug-in) The buffer returned from the Spelling plug-in to scCompletionProc(). Note that the client must release this memory.

	scClientData	Can be used by the client to store private state data. The client is responsible for allocating memory where necessary.

	scInBufferASText	The text buffer from the client to the Spelling plug-in when `scGetTextProc` is called by the Spelling plug-in. Note that the client must release this memory.

	scOutBufferAStext	Returned buffer from Spelling PI to scCompletionProc().

	scChangeProc	This optional callback will be invoked each time `scOutBufferAStext` is about to change.

	scChangeText	New text that will replace the text from scChangeStart to `scChangeEnd`.

	scChangeStart	Character offset of the start of the change when scChangeProc() is called

	scChangeEnd	Character offset of the end of the change when scChangeProc() is called

	scMenuTitle	The menu title in case this is the only enabled domain (for example, "In Form Fields..." or "In Comments...").

tagConsultantAgent

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct tagConsultantAgent {

  ASSize_t Size;  


 


  PDFObjType pFindObjects;  


 


  ASUns32 NumFindObjects;  


 


  ConsAgentPostProcessCallback PostProcess;  


 


  ConsAgentObjFoundCallback ObjFound;  


 


  ASBool WantSubclasses;  


 


  CosObj pFindObjectIDs;  


 


  ASUns32 NumFindObjectIDs;  


 


  ConsAgentObjFoundCallback ObjIDFound;  

}

File: ConsExpT.h

Line: 175

Elements

	Size	The size of the data structure. Set it to `sizeof(Agent)`.

	pFindObjects	An array of object types of interest.

	NumFindObjects	The number of object types in the `pFindObjects` array.

	PostProcess	A callback procedure for post-processing.

	ObjFound	A callback procedure for when an object is found.

	WantSubclasses	Indicates if the Agent also wants to be called back for subclasses of types in `pFindObjects`.

tagPDFObjID

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct tagPDFObjID {

  CosID objID;  


 


  CosGeneration objGen;  

}

During traversal, the Consultant checks the Agent's list of object types of interest to see if the Agent is interested in the current object, and it calls the callback function pointers when objects of interest are found and when traversal is complete.

All Agents should be C++ classes derived from the ConsultantAgentObj class (found in agentobj.h) which can be converted (via a C++ cast operator) to a pointer to this structure type. Wherever the Consultant HFT calls for a (struct Agent*), you can pass the class with no conversion.

File: ConsExpT.h

Line: 169

WebDriverVector

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct WebDriverVector {

  ASUns32 WDVRev;  


 


  ASUns32 nReserved;  


 


  WDAppSupportPredicate doYouSupport;  


 


  WDFollowLinkFunction followLink;  


 


  WDBecomeDriverFunction becomeDriver;  


 


  WDBringFrontFunction bringFront;  


 


  WDOptionsFunction options;  


 


  WDIsDriverBusyFunction isDriverBusy;  


 


  WDFollowLinkWithParamsFunction followLinkWithParams;  

}

A data structure containing callbacks that implement a Weblink driver.

See Also

RegisterWebDriver

File: WLHFT.h

Line: 348

Elements

	WDVRev	Driver version number.

	nReserved	Currently unused.

WWWOpenURLParamsRec

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

struct WWWOpenURLParamsRec {

  ASSize_t size;  


 


  const char* cFrame;  

}

A parameter block specifying the target frame of a URL.

File: WLHFT.h

Line: 74

Elements

	size	Should be initialized to `sizeof(WWWOpenURLParamsRec)`.

	cFrame	The name of the frame to open.

Callbacks Detail

ASClientAllocProc

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

void * (*ASClientAllocProc)(void *clientData, ASSize_t size)

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

File: PDFInit.h

Line: 109

ASClientFreeProc

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

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

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

File: PDFInit.h

Line: 140

ASClientMemAvailProc

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

ASSize_t (*ASClientMemAvailProc)(void *clientData)

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

File: PDFInit.h

Line: 154

ASClientReallocProc

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

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

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

File: PDFInit.h

Line: 126

ConsAgentObjFoundCallback

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

ConsultantAgentAction (*ConsAgentObjFoundCallback)(struct tagConsultantAgent *, CosObj, const PDFObjType *, ASUns32, ConsStack, CosObj *)

Returns a set of flags instructing the Consultant as to how to handle the current object. The Consultant calls this method when it recognizes the current object as a type which an Agent has declared to be interesting.

File: ConsExpT.h

Line: 141

ConsAgentPercentDoneCallback

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

void (*ConsAgentPercentDoneCallback)(ASReal fPercentDone)

The Consultant calls this method with progress updates. It can display a progress bar.

File: ConsExpT.h

Line: 149

ConsAgentPostProcessCallback

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

void (*ConsAgentPostProcessCallback)(struct tagConsultantAgent *)

The Consultant calls this method when it is ready to finish a cycle. You should perform any document modifications assigned to your Agent at this point.

File: ConsExpT.h

Line: 114

DirConnection_close

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

void (*DirConnection_close)(DirConnection inConnection)

Closes the specified directory connection.

File: DirectoryHFT.h

Line: 324

DirConnection_customSearch

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

SecRetCode (*DirConnection_customSearch)(DirConnection inConnection, DirSearchCriteria inSearchCriteria, ASText inGroup, DirResults outResults)

File: DirectoryHFT.h

Line: 288

DirConnection_customUISearch

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

SecRetCode (*DirConnection_customUISearch)(DirConnection inConnection, ASText inGroup, DirResults outResults)

Pops up a custom user interface that allows the user to set search criteria and execute the search.

File: DirectoryHFT.h

Line: 301

DirConnection_getDirInfo

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

SecRetCode (*DirConnection_getDirInfo)(DirConnection inConnection, DirectoryInfo outDirInfo)

Retrieves information about the directory associated with the connection.

File: DirectoryHFT.h

Line: 332

DirConnection_getGroups

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

SecRetCode (*DirConnection_getGroups)(DirConnection inConnection, DirGroupList outGroupList)

Retrieves the list of groups that this connection supports.

File: DirectoryHFT.h

Line: 170

DirConnection_list

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

SecRetCode (*DirConnection_list)(DirConnection inConnection, ASText inGroup, DirResults outResults)

TBD

File: DirectoryHFT.h

Line: 319

DirConnection_setCustomOutputOptions

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

SecRetCode (*DirConnection_setCustomOutputOptions)(DirConnection inConnection, DirAttributes inRequestedAttrs, DirAttributes outUnsupportedAttrs)

TBD

File: DirectoryHFT.h

Line: 215

DirConnection_setStandardOutputOptions

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

SecRetCode (*DirConnection_setStandardOutputOptions)(DirConnection inConnection, DirAttributes inRequestedAttrs, DirAttributes outUnsupportedAttrs)

Special case: The ATTR_Certificates attribute is intended to encompass all certificate attributes a directory might have. If ATTR_Certificates is requested, it may have to be translated into several attributes depending on the directory.

File: DirectoryHFT.h

Line: 203

DirConnection_standardSearch

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

SecRetCode (*DirConnection_standardSearch)(DirConnection inConnection, DirSearchCriteria inSearchCriteria, ASText inGroup, DirResults outResults)

TBD

File: DirectoryHFT.h

Line: 272

ExternalFilePermissionProc

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

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

File: PDFLExpT.h

Line: 90

PDDoExtGStateProc

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

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

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.

See Also

File: PDFLExpT.h

Line: 1682

PDFLClientRNGProc

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

ASSize_t (*PDFLClientRNGProc)(ASSize_t len, ASUns8P buffer)

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.

See Also

PDFLibraryRegisterRNG

File: PDFLExpT.h

Line: 109

PDFLGetCoreHFTType

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

HFT (*PDFLGetCoreHFTType)()

File: PDFLInitCommon.h

Line: 35

PDFLInitThreadLocalDataType

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

void * (*PDFLInitThreadLocalDataType)(ThreadLocalKey *key, ASUns32 size)

File: PDFLInitCommon.h

Line: 36

PDFLInitType

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 (*PDFLInitType)(PDFLData data)

File: PDFLInitCommon.h

Line: 34

PDFLPrintCancelProc

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*PDFLPrintCancelProc)(PDDoc pdDoc, void *clientData)

This is called once per page of a document being printed.

In addition to giving the ability to cancel the print job, a developer can use this callback to return control briefly to an application to handle events, update UI elements, and so on. The library pauses printing until the return from this procedure, because it is single-threaded.

File: PDFLPrint.h

Line: 69

PDFLTermType

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

void (*PDFLTermType)()

File: PDFLInitCommon.h

Line: 37

PDPrintCanEmitFontProc

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*PDPrintCanEmitFontProc)(PDFont fontP, PDPrintClient printClient)

(Optional) A callback for PDPrintClient. It 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. Only used for PostScript printing.

If it is NULL, the default is to assume that any font can be emitted.

See Also

File: PDFLExpT.h

Line: 1740

PDPrintEmitFontProc

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*PDPrintEmitFontProc)(ASStm stm, PDFont fontP, PDPrintClient printClient, ASUns32 flags)

(Required) A callback for PDPrintClient. It emits 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().

See Also

File: PDFLExpT.h

Line: 1722

PDPrintGetFontEncodingMethodProc

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 (*PDPrintGetFontEncodingMethodProc)(PDFont fontP, PDPrintClient printClient)

(Required for PostScript printing) A callback for PDPrintClient. It asks the client which encoding method should be used for the font.

See Also

TKResourceReleaseProc
PDFLInit

File: PDFLExpT.h

Line: 1705

SCChangeProc

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*SCChangeProc)(SpellCheckParamPtr scp)

Called by the Spelling plug-in each time scOutBufferAStext is about to change. An SCChangeProc() is optional.

See Also

SCEnableProc
SCGetTextProc
SpellAddDomain
SpellRemoveDomain
SCCompletionProc

Exceptions

None

File: Speller_Sel.h

Line: 206

SCCompletionProc

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*SCCompletionProc)(SpellCheckParamPtr scp)

An SCCompletionProc() must be provided for each domain a plug-in registers with SpellAddDomain(). It is called by the Spelling plug-in when the user has completed the spell check.

See Also

SCEnableProc
SCGetTextProc
SpellAddDomain
SpellRemoveDomain

Note

In the current version of the Spelling plug-in, this value is ignored.

File: Speller_Sel.h

Line: 188

SCEnableProc

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*SCEnableProc)(SpellCheckParamPtr scp)

Called by the Spelling plug-in to determine whether the Spelling menu items and toolbar button should be enabled. An SCEnableProc() must be provided for each domain a plug-in registers with SpellAddDomain().

See Also

SCCompletionProc
SCGetTextProc
SpellAddDomain
SpellRemoveDomain

File: Speller_Sel.h

Line: 145

SCGetTextProc

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*SCGetTextProc)(SpellCheckParamPtr scp)

This procedure is called by Spelling to request a text buffer to be checked by the user in the Spelling dialog box.

See Also

SCCompletionProc
SCEnableProc
SpellAddDomain
SpellRemoveDomain

File: Speller_Sel.h

Line: 167

SCInitProc

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*SCInitProc)(void *clientData)

File: Speller_Sel.h

Line: 125

SCRTFChangeProc

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*SCRTFChangeProc)(void *vReserved, ASConstText astNewText, ASInt32 nStartIndex, ASInt32 nEndIndex, void *vData)

Callback proc for SpellCheckRTF. This proc is called each time the user changes something in the original input buffer. This allows the caller of SpellCheckRTF() to track text changes to a rich text buffer and overlay the plain text change onto the rich text spans to perserve formatting.

See Also

SpellCheckRTF

File: Speller_Sel.h

Line: 221

SCTermProc

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

void (*SCTermProc)(void *clientData)

File: Speller_Sel.h

Line: 127

TKResourceAcquireProc

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

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

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.

See Also

File: PDFInit.h

Line: 233

TKResourceReleaseProc

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax

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

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.

See Also

PMSetTextProc
PDFLInit

File: PDFInit.h

Line: 249

Method Detail

ASAtomGetCount

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 ASAtomGetCount()

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.

Returns

The number of ASAtom objects currently allocated.

See Also

ASAtomExistsForString
PDFLInit
PDFLTerm

File: PDFLProcs.h

Line: 130

ASFileSysGetDefaultTempPath

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASPathName ASFileSysGetDefaultTempPath(ASFileSys fileSys)

Gets the default temporary path that was set by ASFileSysSetDefaultTempPath().

Parameters

fileSys —

The file system in which the ASPathname is set.

Returns

The ASPathName if the operation was successful, NULL otherwise.

See Also

ASFileSysSetDefaultTempPath

File: PDFLProcs.h

Line: 163

ASFileSysSetDefaultTempPath

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool ASFileSysSetDefaultTempPath(ASFileSys fileSys, ASPathName pathName)

Sets the default temporary path for the specified file system to the specified path name. The method copies the passed pathname object on success; the client is responsible for releasing the object when it is no longer needed, using ASFileSysReleasePath().

Pass a pathname of NULL to reset the default temporary path to the file system default.

Parameters

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

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

Returns

false if the path provided is not writable, true otherwise.

See Also

ASFileSysGetDefaultTempPath

File: PDFLProcs.h

Line: 151

ASPurgeMemory

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASSize_t ASPurgeMemory(ASSize_t amount)

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.

Parameters

amount —

The desired amount of memory to free.

Returns

The approximate amount of memory freed.

See Also

PDFLInit
PDFLTerm

File: PDFLProcs.h

Line: 113

AVExtensionMgrRegisterNotification

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





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

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.

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.

See Also

AVExtensionMgrUnregisterNotification
AVAppRegisterNotification

File: PDFLProcs.h

Line: 611

AVExtensionMgrUnregisterNotification

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





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

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

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.

See Also

AVExtensionMgrRegisterNotification
AVAppUnregisterNotification

File: PDFLProcs.h

Line: 631

GetRequestedHFT

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool GetRequestedHFT(const char* table, ASUns32 requiredVer, ASUns32* resultingVer, HFT* resultHFT)

Parameters

	`table`

	`requiredVer`

	`resultingVer`

	`resultHFT`

Returns

File: PDFLInitCommon.h

Line: 74

PDDocPrintPages

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDDocPrintPages(PDPrintClient client)

Prints a range of pages from a document, controlled by a structure of data and callbacks.

Parameters

client —

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

See Also

PDFLInit
PDFLPrintDoc

Exceptions

genErrBadParm

Notifications

PSPrintAfterBeginPageSetup
PSPrintAfterBeginProlog
PSPrintAfterBeginSetup
PSPrintAfterEmitExtGState
PSPrintAfterPageTrailer
PSPrintAfterTrailer
PSPrintBeforeEndComments
PSPrintBeforeEndSetup

Note

This low-level method should be avoided; use the higher-level PDFLPrintDoc() instead.

File: PDFLProcs.h

Line: 191

PDFLGetCoreHFT

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





HFT PDFLGetCoreHFT()

Gets the Core HFT.

Returns

The Core HFT object.

See Also

File: PDFInit.h

Line: 931

PDFLGetFlags

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASUns32 PDFLGetFlags()

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.

Returns

The initialization flags value.

See Also

File: PDFLProcs.h

Line: 728

PDFLGetInitCount

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASUns32 PDFLGetInitCount()

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

Returns

The number of times the PDF Library has been initialized.

See Also

PSPrintAfterBeginPageSetup
PSPrintAfterBeginProlog
PSPrintAfterBeginSetup
PSPrintAfterEmitExtGState
PSPrintAfterPageTrailer
PSPrintAfterTrailer
PSPrintBeforeEndComments
PSPrintBeforeEndSetup

File: PDFLProcs.h

Line: 706

PDFLGetVersion

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASUns32 PDFLGetVersion()

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.

Returns

Adobe PDF Library version (kPDFLVersion).

See Also

PDFLTerm

Note

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

File: PDFLProcs.h

Line: 686

PDFLibraryRegisterNotification

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





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

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.

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.

See Also

AVExtensionMgrRegisterNotification
AVAppRegisterNotification
PDFLibraryUnregisterNotification

File: PDFLProcs.h

Line: 63

PDFLibraryRegisterNotificationEx

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





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

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.

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.

File: PDFLProcs.h

Line: 829

PDFLibraryRegisterRNG

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDFLibraryRegisterRNG(PDFLClientRNGProc clientRNG)

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.

Parameters

clientRNG —

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

See Also

PDFLClientRNGProc

File: PDFLProcs.h

Line: 845

PDFLibraryUnregisterNotification

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





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

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

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.

See Also

PDFLibraryRegisterNotification
AVAppUnregisterNotification

File: PDFLProcs.h

Line: 89

PDFLInit

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 PDFLInit(PDFLData data)

Initializes the Adobe PDF Library. This method must be called before any other Library calls can be made, printing or otherwise.

Parameters

data —

Initialization data for Adobe PDF Library.

Returns

0 if initialization was successful, or an error code if it was not. Use ASGetErrorString() to convert any error code to a string.

See Also

PDFLGetFlags
PDFLGetInitCount
PDFLTerm

File: PDFInit.h

Line: 909

PDFLInitCommon

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 PDFLInitCommon(PDFLData data, InitProcsP procs, os_size_t sizeHFTLocTab)

Parameters

	`data`

	`procs`

	`sizeHFTLocTab`

Returns

File: PDFLInitCommon.h

Line: 57

PDFLInitHFT

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 PDFLInitHFT(PDFLData data)

Parameters

data

Returns

File: PDFInit.h

Line: 916

PDFLInitHFT

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





ASInt32 PDFLInitHFT(PDFLData data)

Parameters

data

Returns

File: PDFLInitHFT.c

Line: 38

PDFLInitThreadLocalData

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void* PDFLInitThreadLocalData(ThreadLocalKey* key, ASUns32 size)

Parameters

	`key`

	`size`

Returns

File: PDFInit.h

Line: 924

PDFLPrintDoc

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDFLPrintDoc(PDDoc doc, PDFLPrintUserParams userParams)

Prints a PDF document or pages from a PDF document allowing the caller to specify options such as page size, rotation, and shrink-to-fit.

Parameters

	`doc` —	The PDDoc for the document to print.

	`userParams` —	Parameters to control printing.

Exceptions

cosErrWriteError
pdErrOpNotPermitted
genErrBadParm

Notifications

Note

Users of the PDFLPrintDoc() method do not have to create the PDPrintClient() callbacks. That detail is handled by the library.

File: PDFLProcs.h

Line: 752

PDFLPrintDocEx

()

Product availability: PDFL

Platform availability: Windows

Syntax





void PDFLPrintDocEx(PDDoc doc, PDFLPrintUserParamsEx userParams)

Prints a PDF document or pages from a PDF document allowing the caller to specify options such as page size, rotation, and shrink-to-fit.

Parameters

	`doc` —	The PDDoc for the document to print.

	`userParams` —	Parameters to control printing.

Exceptions

cosErrWriteError
pdErrOpNotPermitted
genErrBadParm

Notifications

PSPrintAfterBeginPageSetup
PSPrintAfterBeginProlog
PSPrintAfterBeginSetup
PSPrintAfterEmitExtGState
PSPrintAfterPageTrailer
PSPrintAfterTrailer
PSPrintBeforeEndComments
PSPrintBeforeEndSetup

Note

Users of the PDFLPrintDoc() method do not have to create the PDPrintClient() callbacks. That detail is handled by the library.

File: PDFLProcs.h

Line: 784

PDFLPrintPDF

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDFLPrintPDF(PDDoc pdDoc, ASPathName pathName, PDPrintParams psParams)

Deprecated: use PDFLPrintDoc() instead.

Parameters

	`pdDoc`

	`pathName`

	`psParams`

File: PDFLProcs.h

Line: 759

PDFLTerm

()

Product availability: PDFL

Platform availability: Macintosh, Windows, UNIX

Syntax





void PDFLTerm()

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.

See Also