PDF Library Supplement to the Core API Reference - Datalogics

cPDF LibrarySupplement to theAcrobat Core APIReferenceTechnical Note #5414Version: PDF Library 6.0ADOBE SYSTEMS INCORPORATEDCorporate Headquarters345 Park AvenueSan Jose, CA 95110-2704(408) 536-6000http://partners.adobe.comAugust 2003

Copyright 2003 Adobe Systems Incorporated. All rights reserved. Adobe® PDF Library Supplement to the Core API Reference.If this guide is distributed with software that includes an end user agreement, this guide, as well as the software described in it, is furnished under licenseand may be used or copied only in accordance with the terms of such license. Except as permitted by any such license, no part of this guide may bereproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without the priorwritten permission of Adobe Systems Incorporated. Please note that the content in this guide is protected under copyright law even if it is not distributedwith software that includes an end user license agreement.Please remember that existing artwork or images that you may want to include in your project may be protected under copyright law. The unauthorizedincorporation of such material into your new work could be a violation of the rights of the copyright owner. Please be sure to obtain any permissionrequired from the copyright owner.Any references to company names in sample templates are for demonstration purposes only and are not intended to refer to any actual organization.PostScript is a registered trademark of Adobe Systems Incorporated. All instances of the name PostScript in the text are references to the PostScriptlanguage as defined by Adobe Systems Incorporated unless otherwise stated. The name PostScript also is used as a product trademark for Adobe Systems’implementation of the PostScript language interpreter.Except as otherwise stated, any reference to a "PostScript printing device,” "PostScript display device,” or similar item refers to a printing device, displaydevice or item (respectively) that contains PostScript technology created or licensed by Adobe Systems Incorporated and not to devices or items thatpurport to be merely compatible with the PostScript language.Adobe, the Adobe logo, Acrobat, Acrobat Capture, the Adobe PDF logo, Distiller, PostScript, the PostScript logo and Reader are either registeredtrademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries.Apple, Macintosh, and Power Macintosh are trademarks of Apple Computer, Inc., registered in the United States and other countries. PowerPC is aregistered trademark of IBM Corporation in the United States. ActiveX, Microsoft, Windows, and Windows NT are either registered trademarks ortrademarks of Microsoft Corporation in the United States and/or other countries. UNIX is a registered trademark of The Open Group. All other trademarksare the property of their respective owners.This publication and the information herein is furnished AS IS, is subject to change without notice, and should not be construed as a commitment by AdobeSystems Incorporated. Adobe Systems Incorporated assumes no responsibility or liability for any errors or inaccuracies, makes no warranty of any kind(express, implied, or statutory) with respect to this publication, and expressly disclaims any and all warranties of merchantability, fitness for particularpurposes, and noninfringement of third party rights.Portions include software under the following terms:Portions derived from the RSA DataSecurity, Inc. MD5 Message-Digest Algorithm.Portions of the software were developed by the University of California, Berkeley.The author of this software is David M. Gay. Copyright (c) 1991 by AT&T. Permission to use, copy, modify, and distribute this software for any purposewithout fee is hereby granted, provided that this entire notice is included in all copies of any software which is or includes a copy or modification of thissoftware and in all copies of the supporting documentation for such software. THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS ORIMPLIED WARRANTY. IN PARTICULAR, NEITHER THE AUTHOR NOR AT&T MAKES ANY REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THEMERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR PURPOSE.Portions of the software were developed at Cygnus Solutions.Portions copyright (c) 1995-2003 International Business Machines Corporation and others. All rights reserved. Permission is hereby granted, free ofcharge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction,including without limitation the rights to use, copy, modify, merge, publish, distribute, and/or sell copies of the Software, and to permit persons towhom the Software is furnished to do so, provided that the above copyright notice(s) and this permission notice appear in all copies of the Softwareand that both the above copyright notice(s) and this permission notice appear in supporting documentation. THE SOFTWARE IS PROVIDED "AS IS",WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR APARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED INTHIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROMLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR INCONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. Except as contained in this notice, the name of a copyright holder shall not beused in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization of the copyright holder.Portions copyright (c) 1994 Hewlett-Packard Company. Permission to use, copy, modify, distribute and sell this software and its documentation for anypurpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and thispermission notice appear in supporting documentation. Hewlett-Packard Company makes no representations about the suitability of this software forany purpose. It is provided "as is" without express or implied warranty.Copyright (c) 1996 Silicon Graphics Computer Systems, Inc. Permission to use, copy, modify, distribute and sell this software and its documentation forany purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and thispermission notice appear in supporting documentation. Silicon Graphics makes no representations about the suitability of this software for anypurpose. It is provided "as is" without express or implied warranty.Contains an implementation of the LZW algorithm licensed under U.S. Patent 4,558,302.Adobe Systems Incorporated, 345 Park Avenue, San Jose, California 95110, USA. Notice to U.S. Government End Users. The Software and Documentationare “Commercial Items,” as that term is defined at 48 C.F.R. ß2.101, consisting of “Commercial Computer Software” and “Commercial Computer SoftwareDocumentation,” as such terms are used in 48 C.F.R. ß12.212 or 48 C.F.R. ß227.7202, as applicable. Consistent with 48 C.F.R. ß12.212 or 48 C.F.R. ßß227.7202-1 through 227.7202-4, as applicable, the Commercial Computer Software and Commercial Computer Software Documentation are being licensed to U.S.Government end users (a) only as Commercial Items and (b) with only those rights as are granted to all other end users pursuant to the terms andconditions herein. Unpublished-rights reserved under the copyright laws of the United States.Adobe Systems Incorporated, 345 Park Avenue, San Jose, CA 95110-2704, USA. For U.S. Government End Users, Adobe agrees to comply with all applicableequal opportunity laws including, if appropriate, the provisions of Executive Order 11246, as amended, Section 402 of the Vietnam Era VeteransReadjustment Assistance Act of 1974 (38 USC 4212), and Section 503 of the Rehabilitation Act of 1973, as amended, and the regulations at 41 CFR Parts 60-1 through 60-60, 60-250, and 60-741. The affirmative action clause and regulations contained in the preceding sentence shall be incorporated by reference.

PDF Library-specific MethodsASAtomGetCountASInt32 ASAtomGetCount (void);DescriptionGets the number of ASAtoms that have been allocated. The maximum number ofASAtoms is 0xFFFFFFFF. (This was a 16-bit value in Acrobat 4.x, and changed to a 32-bitvalue in Acrobat 5.)ASAtoms cannot be deleted or freed. Use this method to determine if it is necessary to reinitializethe library before creating more ASAtoms.ParametersNoneReturn ValueNumber of ASAtoms currently allocated.Header FilePDFLCalls.hRelated MethodsASAtomExistsForStringPDFLInitPDFLTermPDF Library Supplement to the Acrobat Core API Reference 3

PDF Library-specific MethodsASFileSysGetDefaultTempPathASFileSysGetDefaultTempPathASPathName ASFileSysGetDefaultTempPath (ASFileSys fileSys);DescriptionGets the default temporary path that was set by ASFileSysSetDefaultTempPath.ParametersfileSysThe file system in which the ASPathname is set.Return ValueThe ASPathName if the operation was successful, NULL otherwise.Header FilePDFLCalls.hRelated MethodsASFileSysSetDefaultTempPathPDF Library Supplement to the Acrobat Core API Reference 4

PDF Library-specific MethodsASFileSysSetDefaultTempPathASFileSysSetDefaultTempPathASBool ASFileSysSetDefaultTempPath (ASFileSys fileSys,ASPathName pathName);DescriptionSets the default temporary path for the specified file system to the specified pathname. Themethod copies the passed pathname object on success; the client is responsible forreleasing 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.ParametersfileSyspathName(May be NULL) The file system in which to set the default temporarypath.The pathname for the new default temporary path, or NULL to reset tothe file system default.Return Valuefalse if the path provided is not writable, true otherwise.Header FilePDFLCalls.hRelated MethodsASFileSysGetDefaultTempPathPDF Library Supplement to the Acrobat Core API Reference 5

PDF Library-specific MethodsASGetRamFileSysASGetRamFileSysASFileSys ASGetRamFileSys (void);DescriptionGets the in-memory file system implementation for a platform.N OTE:This API is available only in the thread-safe version of the PDFL Library.ParametersNone.Return ValueThe platform's in-memory file system.Header FileASCalls.hRelated MethodsASRamFileSysSetLimitKBPDF Library Supplement to the Acrobat Core API Reference 6

PDF Library-specific MethodsASGetTempFileSysASGetTempFileSysASFileSys ASGetTempFileSys (void);DescriptionGets the file system to be used for temporary files. The default temporary file system is thedefault file system as returned by ASGetDefaultFileSys.N OTE:This API is available only in the thread-safe version of the PDFL Library.ParametersNone.Return ValueThe file system to be used for temporary files.Header FileASCalls.hRelated MethodsASGetRamFileSysASSetTempFileSysPDF Library Supplement to the Acrobat Core API Reference 7

PDF Library-specific MethodsASPurgeMemoryASPurgeMemoryASSize_t ASPurgeMemory (ASSize_t amount);DescriptionAttempts to free memory from the PDF Library caches.The caches in the PDF Library can grow in complex and unexpected ways. A client canmanage memory use with the PDFLInit memory callbacks, or by explicitly calling thisfunction after certain functions, such as PDDocClose.To manage memory use with the memory callbacks, a client can call ASPurgeMemoryduring the allocation callback if it is low on memory, or to limit the amount of memory usedby the library. Use this approach only with extreme caution and extensive testing. The runtimememory requirements are very document-specific.ParametersamountThe desired amount of memory to free.Return ValueThe approximate amount of memory freed.NotificationsNoneHeader FilePDFLCalls.hRelated MethodsPDFLInitPDFLTermPDF Library Supplement to the Acrobat Core API Reference 8

PDF Library-specific MethodsASRamFileSysSetLimitKBASRamFileSysSetLimitKBvoid ASRamFileSysSetLimitKB (ASInt32 limit);DescriptionSets the in-memory file system size limit, in kilobytes.N OTE:This API is available only in the thread-safe version of the PDFL Library.ParameterslimitThe in-memory file system size limit, in kilobytes.Return ValueNone.Header FileASCalls.hRelated MethodsASGetRamFileSysPDF Library Supplement to the Acrobat Core API Reference 9

PDF Library-specific MethodsASSetTempFileSysASSetTempFileSysvoid ASSetTempFileSys (ASFileSys fileSys);DescriptionSets the file system to be used for temporary files.N OTE:This API is available only in the thread-safe version of the PDFL Library.ParametersfileSysThe file system that will become the temporary file system for theplatform.Return ValueNone.Header FileASCalls.hRelated MethodsASGetRamFileSysASGetTempFileSysPDF Library Supplement to the Acrobat Core API Reference 10

PDF Library-specific MethodsAVExtensionMgrRegisterNotificationAVExtensionMgrRegisterNotificationvoid AVExtensionMgrRegisterNotification (NSelector nsel,ASExtension owner, void* proc, void* clientData);DescriptionRegisters 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 PDlevel notifications are available with the Adobe PDF Library.ParametersnselownerprocclientDataNotification type. Must be one of the notification selectors. Thenotification selector is the name of the notification with thecharacters NSEL appended. For example, the selector forPDDocDidPrintPage is PDDocDidPrintPageNSEL.Only the PD-level notifications are available with the Adobe PDFLibrary.Identifies the owner.For the Adobe PDF Library, if there is only one owner of the PDFEditsubsystem, owner should be zero. If there are multiple owners, eachshould specify a nonzero, non-negative owner. (A negative owneris reserved for the implementation.)User-supplied callback to call when the notification occurs. Itsdeclaration depends on the notification type (see the Notificationssection in the Acrobat Core API Reference).Pointer to user-supplied data to pass to proc each time it is called.Return ValueNoneHeader FilePDFLCalls.hRelated MethodsAVExtensionMgrUnregisterNotificationAVAppRegisterNotificationPDF Library Supplement to the Acrobat Core API Reference 11

PDF Library-specific MethodsAVExtensionMgrRegisterNotificationExamplevoid myWillPrintDoc(PDDoc doc, ASStm stm, ASInt32 level,void* clientData);ASCallback myWillPrintDocCB = ASCallbackCreateNotification(PDDocWillPrintDoc, myWillPrintDoc);AVExtensionMgrRegisterNotification (PDDocWillPrintDocNSEL,(ASExtension)1, myWillPrintDocCB, NULL);PDF Library Supplement to the Acrobat Core API Reference 12

PDF Library-specific MethodsAVExtensionMgrUnregisterNotificationAVExtensionMgrUnregisterNotificationvoid AVExtensionMgrUnregisterNotification (NSelector nsel,ASExtension owner, void* proc, void* clientData);DescriptionUnregisters a user-supplied procedure to call when the specified event occurs. This isexactly the same as the AVAppUnregisterNotification method, as documented inthe Acrobat Core API Reference.ParametersnselownerprocclientDataNotification type. Must be one of the notification selectors. Thenotification selector is the name of the notification with thecharacters NSEL appended. For example, the selector forPDDocDidOpen is PDDocDidOpenNSEL.Identifies the owner with which the notification was registered.User-supplied callback with which the notification was registered.Pointer to user-supplied data that was used when the notificationwas registered.Return ValueNoneHeader FilePDFCalls.hRelated MethodsAVExtensionMgrRegisterNotificationAVAppUnregisterNotificationExampleAVExtensionMgrUnregisterNotification (PDDocWillPrintDocNSEL,(ASExtension)1, myWillPrintDocCB, NULL);PDF Library Supplement to the Acrobat Core API Reference 13

PDF Library-specific MethodsPDDocPrintPagesPDDocPrintPagesvoid PDDocPrintPages (PDPrintClient client);DescriptionPrints a range of pages from a document, controlled by a structure of data and callbacks.ParametersN OTE:This low-level method should be avoided; use the higher-level PDFLPrintDocinstead.clientControl structure for the operation, containing data and callbackprocedures.Return ValueNoneKnown ExceptionsgenErrBadParmNotificationsPSPrintAfterBeginPageSetupPSPrintAfterBeginPrologPSPrintAfterBeginSetupPSPrintAfterEmitExtGStatePSPrintAfterPageTrailerPSPrintAfterTrailerPSPrintBeforeEndCommentsPSPrintBeforeEndSetupHeader FilePDFLCalls.hRelated MethodsPDFLInitPDFLPrintDocPDF Library Supplement to the Acrobat Core API Reference 14

PDF Library-specific MethodsPDFLGetCoreHFTPDFLGetCoreHFTHFT PDFLGetCoreHFT (void);DescriptionGets the Core HFT.ParametersNoneReturn ValueThe Core HFT object.Header FilePDFInit.hRelated MethodsPDFLInitPDF Library Supplement to the Acrobat Core API Reference 15

PDF Library-specific MethodsPDFLGetFlagsPDFLGetFlagsASUns32 PDFLGetFlags (void);DescriptionGets the flags set when the PDF Library was initialized. The only flag currently supported iskPDFLInitIgnoreDefaultDirectories.When this flag is set, the initialization process does not search through the default fontdirectories, but only searches for fonts in those directories specified in dirList.ParametersNoneReturn ValueThe initialization flags value.Header FilePDFInit.hRelated MethodsPDFLInitPDF Library Supplement to the Acrobat Core API Reference 16

PDF Library-specific MethodsPDFLGetInitCountPDFLGetInitCountASUns32 PDFLGetInitCount (void);DescriptionGets the number of times the PDF Library has been initialized.ParametersNoneReturn ValueThe number of times the PDF Library has been initialized.Header FilePDFInit.hRelated MethodsPDFLInitPDF Library Supplement to the Acrobat Core API Reference 17

PDF Library-specific MethodsPDFLGetVersionPDFLGetVersionDescriptionParametersNoneASUns32 PDFLGetVersion (void);N OTE: Obsolete in PDF Library 6.0. Use HFTGetVersion instead.Gets the value of the Adobe PDF Library version—kPDFLVersion. The most significant16 bits are the major version number; the least significant 16 bits are the minor versionnumber. The major version number indicates whether any incompatible API changes havebeen made. The minor version number indicates the API has changed, but in a compatiblefashion.Return ValueAdobe PDF Library version—kPDFLVersion.Header FilePDFInit.hRelated MethodsPDFLTermPDF Library Supplement to the Acrobat Core API Reference 18

PDF Library-specific MethodsPDFLibraryRegisterNotificationPDFLibraryRegisterNotificationvoid PDFLibraryRegisterNotification (NSelector nsel,ASExtension owner, void *proc, void *clientData);DescriptionRegisters a user-supplied procedure to call when the specified event occurs. This is exactlythe same as the AVAppRegisterNotification method. All of the PD levelnotifications are available with the Adobe PDF Library.ParametersnselownerprocclientDataNotification type. Must be one of the notification selectors. Thenotification selector is the name of the notification with thecharacters NSEL appended. For example, the selector forPDDocDidPrintPage is PDDocDidPrintPageNSEL.Only the PD-level notifications are available with the Adobe PDFLibrary.Identifies the owner.For the Adobe PDF Library, if there is only one owner of the PDFEditsubsystem, owner should be zero. If there are multiple owners, eachshould specify a nonzero, non-negative owner. (A negative owneris reserved for the implementation.)User-supplied callback to call when the notification occurs. Itsdeclaration depends on the notification type (see the Notificationssection in the Acrobat Core API Reference).Pointer to user-supplied data to pass to proc each time it is called.Return ValueNoneHeader FilePDFLHFT.hRelated MethodsAVExtensionMgrRegisterNotificationAVAppRegisterNotificationPDFLibraryUnregisterNotificationPDF Library Supplement to the Acrobat Core API Reference 19

PDF Library-specific MethodsPDFLibraryUnregisterNotificationPDFLibraryUnregisterNotificationvoid PDFLibraryUnregisterNotification (NSelector nsel,ASExtension owner, void* proc, void* clientData);DescriptionUnregisters a user-supplied procedure to call when the specified event occurs. This isexactly the same as the AVAppUnregisterNotification method, as documented inthe Acrobat Core API Reference.ParametersnselownerprocclientDataNotification type. Must be one of the notification selectors. Thenotification selector is the name of the notification with thecharacters NSEL appended. For example, the selector forPDDocDidOpen is PDDocDidOpenNSEL.Identifies the owner.For the Adobe PDF Library, if there is only one owner of the PDFEditsubsystem, owner should be zero. If there are multiple owners, eachshould specify a nonzero, non-negative owner. (A negative owneris reserved for the implementation.)User-supplied callback to call when the notification occurs. Itsdeclaration depends on the notification type (see the Notificationssection in the Acrobat Core API Reference).You must use the same callback that you calledAVExtensionMgrRegisterNotification with.Pointer to user-supplied data to pass to proc each time it is called.Return ValueNoneHeader FilePDFLHFT.hRelated MethodsPDFLibraryRegisterNotificationAVAppUnregisterNotificationPDF Library Supplement to the Acrobat Core API Reference 20

PDF Library-specific MethodsPDFLInitPDFLInitASInt32 PDFLInit (PDFLData data);DescriptionInitializes the Adobe PDF Library. This method must be called before any other Library callscan be made, printing or otherwise.ParametersdataInitialization data for Adobe PDF Library.Return Value0 if initialization was successful, or an error code if it was not. Use ASGetErrorString toconvert any error code to a string.Header FilePDFInit.hRelated MethodsPDFLGetFlagsPDFLGetInitCountPDFLTermPDF Library Supplement to the Acrobat Core API Reference 21

PDF Library-specific MethodsPDFLPrintDocPDFLPrintDocvoid PDFLPrintDoc (PDDoc doc,PDFLPrintUserParamsRec userParams);DescriptionPrints a PDF document or pages from a PDF document allowing the caller to specifyoptions such as page size, rotation, and shrink-to-fit.ParametersN OTE:Users of the PDFLPrintDoc method do not have to create the PDPrintClientcallbacks. That detail is handled by the library.docuserParamsThe PDDoc for the document to print.Parameters to control printing.Return ValueNoneKnown ExceptionscosErrWriteErrorpdErrOpNotPermittedgenErrBadParmNotificationsPSPrintAfterBeginPageSetupPSPrintAfterBeginPrologPSPrintAfterBeginSetupPSPrintAfterEmitExtGStatePSPrintAfterPageTrailerPSPrintAfterTrailerPSPrintBeforeEndCommentsPSPrintBeforeEndSetupHeader FilePDFLPrint.hRelated MethodsPDFLPrintDocExamplePDFLPrintDoc(doc, userParams);PDF Library Supplement to the Acrobat Core API Reference 22

PDF Library-specific MethodsPDFLTermPDFLTermvoid PDFLTerm (void);DescriptionTerminates the Adobe PDF Library. Call this method after you are completely done usingthe library. Call this once to terminate and release memory used by the library. After thelibrary has been shut down, the process should terminate.ParametersNoneReturn ValueNoneHeader FilePDFInit.hRelated MethodsPDFLInitPDF Library Supplement to the Acrobat Core API Reference 23

PDF Library-specific MethodsPDFontDownloadContextCreatePDFontDownloadContextCreatePDFontDownloadContext PDFontDownloadContextCreate(PDPrintClient client);DescriptionCreates a font download context object. This object keeps track of the fonts downloadedduring a print job and whether or not substitution fonts have already been downloaded.Also tracks the font download parameters, such as binaryOK and “emit TrueType as Type42.” For use in the PDFontStreamPS method.ParametersclientThe client record to pass to PDDocPrintPages.Return ValueThe newly-created context.Header FilePDFLCalls.hRelated MethodsPDDocPrintPagesPDFontDownloadContextDestroyPDFontStreamPSPDF Library Supplement to the Acrobat Core API Reference 24

PDF Library-specific MethodsPDFontDownloadContextDestroyPDFontDownloadContextDestroyvoid PDFontDownloadContextDestroy(PDFontDownloadContext context);DescriptionDestroys a font download context object. Call this method after PDDocPrintPagesreturns.ParameterscontextThe context to destroy.Return ValueNoneHeader FilePDFLCalls.hRelated MethodsPDDocPrintPagesPDFontDownloadContextCreatePDF Library Supplement to the Acrobat Core API Reference 25

PDF Library-specific MethodsPDFontPSEmitGlyphsIncrPDFontPSEmitGlyphsIncrASBool PDFontPSEmitGlyphsIncr (ASStm stm, PDFont fontP,PDPrintStrP srcStr, PDPrintStrP dstStr,ASUns32* srcBytesUsedP, ASUns32* dstBytesUsedP,ASUns32* glyphCount, ASUns16* fontIndexP,PDPrintClient printClient );DescriptionEmit glyphs incrementally. This is the default EmitGlyphsIncr callback procedure forthe PDPrintClient structure.ParametersstmfontPsrcStrdstStrsrcBytesUsedPdstBytesUsedPglyphCountfontIndexPprintClientThe stream.The font.Source string.Destination string.Source bytes used.Destination bytes used.Number of glyphs.Font index.Control structure.Return Valuetrue if successful; false otherwise.Header FilePDFLCalls.hRelated MethodsPDDocPrintPagesPDFontPSFlushIncrGlyphListPDFontPSGetComponentFontListPDF Library Supplement to the Acrobat Core API Reference 26

PDF Library-specific MethodsPDFontPSFlushIncrGlyphListPDFontPSFlushIncrGlyphListvoid PDFontPSFlushIncrGlyphList (ASStm stm,PDPrintClient printClient);DescriptionFlush the incremental glyphs list from a stream. This is the defaultFlushIncrGlyphList callback procedure for the PDPrintClient structure.ParametersstmprintClientThe stream.Control structure.Return ValueNoneHeader FilePDFLCalls.hRelated MethodsPDFontPSEmitGlyphsIncrPDFontPSGetComponentFontListPDF Library Supplement to the Acrobat Core API Reference 27

PDF Library-specific MethodsPDFontPSGetComponentFontListPDFontPSGetComponentFontListvoid PDFontPSGetComponentFontList(PDFont fontP,PDPrintFontArrayP pdFontArr, PDPrintClient printClient);DescriptionGet the component font list. This is the default GetComponentFontList callbackprocedure for the PDPrintClient structure.ParametersfontPpdFontArrprintClientThe font.Font array.Control structure.Return ValueNoneHeader FilePDFLCalls.hRelated MethodsPDFontPSEmitGlyphsIncrPDFontPSFlushIncrGlyphListPDF Library Supplement to the Acrobat Core API Reference 28

PDF Library-specific MethodsPDFontStreamPSPDFontStreamPSASBool PDFontStreamPS (PDFont fontP, ASStm stm,PDFontDownloadContext context);DescriptionEmits a font into a specified stream. The font is in a format suitable for downloading to aPostScript VM. For example, a TrueType font is converted into a Type 1 or Type 42 font.For use in the EmitFont callback for PDDocPrintPages.ParametersfontPstmcontextThe font to emit.The ASStm into which the font is emitted.A context created by PDFontDownloadContextCreate.Return Valuetrue if successful, false otherwise.Header FilePDFLCalls.hRelated MethodsPDDocPrintPagesPDFontDownloadContextCreatePDF Library Supplement to the Acrobat Core API Reference 29

PDF Library-specific MethodsPDFontWasExtractedPDFontWasExtractedASBool PDFontWasExtracted (PDFont fontP);DescriptionTests whether or not the specified font is embedded in the PDF file and has already beenextracted to display or print the file.ParametersfontPThe font to test.Return Valuetrue if the font is embedded in the PDF file and has been extracted, false otherwise.Header FilePDFLCalls.hRelated MethodsPDFontDownloadContextCreatePDFontWasFauxedPDF Library Supplement to the Acrobat Core API Reference 30

PDF Library-specific MethodsPDFontWasFauxedPDFontWasFauxedASBool PDFontWasFauxed (PDFont font);DescriptionTests whether or not the specified font is embedded in the PDF file or is installed in theuser’s system. If this is the case, the correct font can be used for display and printing.If the font is not embedded or installed, the Acrobat viewer has used a multiple master fontto create a substitute font, called a faux font.ParametersfontPThe font to test.Return Valuetrue if the font has been substituted, false otherwise.Header FilePDFLCalls.hRelated MethodsPDFontWasExtractedPDF Library Supplement to the Acrobat Core API Reference 31

PDF Library-specific MethodsPDPageDrawContentsPlacedToWindowPDPageDrawContentsPlacedToWindowvoid PDPageDrawContentsPlacedToWindow (PDPage page,void* window, void* displayContext, ASBool isDPS,ASFixedMatrix* matrix, ASFixedRect* updateRect,ASCancelProc cancelProc, void* cancelProcClientData);DescriptionDraws the page to the window or display context. The window and display context areimplementation dependent.This method is the same as PDPageDrawContentsToWindow, except that it raises anexception if the pdPermCopy (see PDPerms) permission is not set in the document.ParameterspagewindowdisplayContextisDPSmatrixupdateRectcancelProccancelProcClientDataThe page to draw into window.The platform window to which to render.In Mac OS, the window is a WindowPtr or GrafPtr orCGrafPtr.In Windows, the window is an HWND.The platform display context to which to render.In Mac OS, currently unused.In Windows, displayContext is an HDC.Currently unused. Always set to false.Pointer to the matrix to concatenate onto the default pagematrix. It is useful for converting from page to windowcoordinates and for scaling.Pointer to the rectangle to draw, defined in user spacecoordinates. Any objects outside of updateRect will not bedrawn. All objects are drawn if updateRect is NULL.A method called to check whether drawing should be canceled.If the method returns true, drawing is stopped, nothing iserased, and the window contains whatever was drawn up to thecurrent state.Pointer to user-supplied data to pass to cancelProc eachtime it is called. Should be NULL if cancelProc is NULL.Return ValueNonePDF Library Supplement to the Acrobat Core API Reference 32

PDF Library-specific MethodsPDPageDrawContentsPlacedToWindowKnown ExceptionsRaises pdErrOpNotPermitted if the pdPermCopy permission in PDPermReqObj forthe document is not set.Header FilePDFLCalls.hRelated MethodsPDPageDrawContentsToWindowPDF Library Supplement to the Acrobat Core API Reference 33

PDF Library-specific MethodsPDPageDrawContentsToMemoryPDPageDrawContentsToMemoryASInt32 PDPageDrawContentsToMemory (PDPage page,ASUns32 flags, ASFixedMatrix* matrix,ASFixedRect* updateRect, ASUns32 smoothFlags,ASAtom csAtom, ASInt32 bpc, ASFixedRect* destRect,char* buffer, ASInt32 bufferSize, CancelProc cancelProc,void* cancelProcData);DescriptionRenders a page to memory. The width of the image is calculated as follows:width = abs(ASFixedRoundToInt16(destRect.right) -ASFixedRoundToInt16(destRect.left));width = ((((width * bpc * nComps)+31) / 32) * 4) * 8 / (bpc * nComps);nComps = 1 for DeviceGray3 for DeviceRGB,4 for DeviceCMYKbpc = bits per componentParameterspageflagsmatrixThe page to render.A bit field of PDPageDrawFlags. Must be an OR of thefollowing flags:● kPDPageDoLazyErase—If set, erases the bitmap if thefirst object drawn does not cover the page's entire cropbox.● kPDPageUseAnnotFaces—If set, draws annotationsthat have a default face, such as the visible fields in anAcrobat form. Text and link annotations are not drawn.● kPDPageIsPrinting— If set, then Form annotationsare rendered as if they are being printed. This means thatform fields marked as “Hidden but printable” arerendered, but fields marked as “Visible but doesn’t print”will not be rendered. If not set, then Form annotations arerendered as if they are being viewed. This means thatform fields marked as “Hidden but printable” are notrendered, but fields marked as “Visible but doesn’t print”will be.Pointer to the matrix to be concatenated onto the defaultpage matrix.PDF Library Supplement to the Acrobat Core API Reference 34

PDF Library-specific MethodsPDPageDrawContentsToMemoryupdateRectsmoothFlagscsAtombpcdestRectbufferbufferSizecancelProccancelProcDataPointer to the rectangle to draw, defined in user spacecoordinates. Any objects outside of updateRect will not bedrawn. All objects are drawn if updateRect is NULL.A bit field of PDPageDrawSmoothFlags. Must be an OR ofthe following flags:● kPDPageDrawSmoothText● kPDPageDrawSmoothLineArt● kPDPageDrawSmoothImageThe color space in which the bitmap data is represented. Itmust be one of DeviceGray, DeviceRGB, orDeviceCMYK.The number of bits per color component in the bitmap data.8 is the only valid value for DeviceCMYK and DeviceRGBcolor space.1, 8, and 24 are valid for DeviceGray.Pointer to the rectangle of the bitmap. Defined in devicespace coordinates.Pointer to the bitmap data. If NULL, this function returns thesize of buffer needed for the bitmap.The size of the buffer.A method to call to check whether drawing should becanceled. If the method returns true, drawing is stopped;nothing is erased, and the buffer contains whatever wasdrawn up to the current state.User-supplied data to pass to CancelProc each time it iscalled.Return ValueThe size of the bitmap in bytes.Header FilePDFLCalls.hRelated MethodsPDPageDrawContentsPlacedWithParamsPDF Library Supplement to the Acrobat Core API Reference 35

PDF Library-specific MethodsPDPageEmitPSOrientPDPageEmitPSOrientDescriptionvoid PDPageEmitPSOrient (PDPage pdPage, ASInt16 paperHeight,ASInt16 paperWidth, ASStm stm, PDPrintParams params);N OTE:Obsolete in PDFL 6.0. Do not use.Header FilePDFLCalls.hRelated MethodsPDFLPrintDocPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 36

PDF Library-specific MethodsPDPageGetSizePDPageGetSizevoid PDPageGetSize (PDPage page, ASFixed* width,ASFixed* height);DescriptionReturns the width and height of the page, which could be rotated or defaulted.ParameterspagewidthheightThe page whose size is being obtained.(Filled by the method) Width of the page.(Filled by the method) Height of the page.Return ValueNoneHeader FilePDFLCalls.hPDF Library Supplement to the Acrobat Core API Reference 37

PDF Library-specific MethodsPDPrefGetAntialiasLevelPDPrefGetAntialiasLevelASInt16 PDPrefGetAntialiasLevel (void);DescriptionReturns the antialias level, in pixels.ParametersNoneReturn ValueThe antialias level set by PDPrefSetAntialiasLevel.Header FilePDFLCalls.hRelated MethodsPDPrefSetAntialiasLevelPDF Library Supplement to the Acrobat Core API Reference 38

PDF Library-specific MethodsPDPrefGetBlackPointCompensationPDPrefGetBlackPointCompensationASBool PDPrefGetBlackPointCompensation (void);DescriptionReturns the black-point compensation flag.ParametersNoneReturn Valuetrue if black-point compensation is done.Header FilePDFLCalls.hRelated MethodsPDPrefSetBlackPointCompensationPDF Library Supplement to the Acrobat Core API Reference 39

PDF Library-specific MethodsPDPrefGetGreekLevelPDPrefGetGreekLevelASInt16 PDPrefGetGreekLevel (void);DescriptionReturns the greek level.ParametersNoneReturn ValueThe greek level set by PDPrefSetGreekLevel.Header FilePDFLCalls.hRelated MethodsPDPrefSetGreekLevelPDF Library Supplement to the Acrobat Core API Reference 40

PDF Library-specific MethodsPDPrefGetSuppressICCSpacesPDPrefGetSuppressICCSpacesASBool PDPrefGetSuppressICCSpaces (ASUns32 nComponents);DescriptionReturns the value of the suppress flag for ICC-based spaces with the specified number ofcomponents.ParametersnComponentsThe number of ICC-based space components that are suppressed ornot, according to the flag value.Return ValueThe suppress flag value.Header FilePDFLCalls.hRelated MethodsPDPrefSetSuppressICCSpacesPDF Library Supplement to the Acrobat Core API Reference 41

PDF Library-specific MethodsPDPrefGetUseOutputIntentsPDPrefGetUseOutputIntentsASBool PDPrefGetUseOutputIntents (void);DescriptionReturns the value of the Output Intent flag. When this flag is true, the system overridesworking space with the Output Intent, if it is present.ParametersNone.Return ValueThe Output Intent flag value.Header FilePDFLCalls.hRelated MethodsPDPrefSetUseOutputIntentsPDF Library Supplement to the Acrobat Core API Reference 42

PDF Library-specific MethodsPDPrefSetAntialiasLevelPDPrefSetAntialiasLevelvoid PDPrefSetAntialiasLevel (ASInt16 antialiasPixelLevel);DescriptionSets the default smooth text and smooth images global flags for subsequent renderingmethods.If the function PDPageDrawContentsToMemory is used for drawing, thesmoothFlags value passed to that function supercedes the preference value for theduration of the call.ParametersantialiasPixelLevelThe anitalias level, in pixels. An OR of the followingflags:● PDPrefAASmoothText● PDPrefAASmoothLineArt● PDPrefAASmoothImageReturn ValueNoneHeader FilePDFLCalls.hRelated MethodsPDPrefGetAntialiasLevelPDF Library Supplement to the Acrobat Core API Reference 43

PDF Library-specific MethodsPDPrefSetBlackPointCompensationPDPrefSetBlackPointCompensationvoid PDPrefGetBlackPointCompensation (ASBool kbpc);DescriptionSets the black-point compensation flag, which controls whether to adjust for differences inblack points when converting colors between color spaces. When enabled, the full dynamicrange of the source space is mapped into the full dynamic range of the destination space.When disabled, the dynamic range of the source space is simulated in the destination space(which can result in blocked or gray shadows).Parameterskbpctrue to enable black-point compensation, false otherwise.Return ValueNone.Header FilePDFLCalls.hRelated MethodsPDPrefGetBlackPointCompensationPDF Library Supplement to the Acrobat Core API Reference 44

PDF Library-specific MethodsPDPrefSetGreekLevelPDPrefSetGreekLevelvoid PDPrefSetGreekLevel (ASInt16 greekPixelLevel);DescriptionSets the greek level. The greek level is a text height below which text characters are notrendered. Instead, text-like glyphs that have no meaning but look good at very small sizeare used. This is known as "greeking".ParametersgreekPixelLevelThe greek level, in pixels.Return ValueNoneHeader FilePDFLCalls.hRelated MethodsPDPrefGetGreekLevelPDF Library Supplement to the Acrobat Core API Reference 45

PDF Library-specific MethodsPDPrefSetSuppressICCSpacesPDPrefSetSuppressICCSpacesvoid PDPrefSetSuppressICCSpaces (ASUns32 nComponents,ASBool value);DescriptionSpecifies use of a default colorspace rather an ICC-based colorspace.ParametersnComponentsvalueThe number of ICC colorspace components.When true, use DefaultCMYK, DefaultRGB, or DefaultGraycolorspace instead of an ICC-based colorspace with the samenumber of components.Return ValueNoneHeader FilePDFLCalls.hRelated MethodsPDPrefGetSuppressICCSpacesPDF Library Supplement to the Acrobat Core API Reference 46

PDF Library-specific MethodsPDPrefSetUseLocalFontsPDPrefSetUseLocalFontsvoid PDPrefSetUseLocalFonts (ASBool useLocalFonts);DescriptionEnables or disables use of local fonts.ParametersuseLocalFontsWhen true, use local fonts. when false, use global fonts.Return ValueNoneHeader FilePDFLCalls.hRelated MethodsNonePDF Library Supplement to the Acrobat Core API Reference 47

PDF Library-specific MethodsPDPrefSetUseOutputIntentsPDPrefSetUseOutputIntentsvoid PDPrefSetUseLocalFonts (ASBool flag);DescriptionSets the Output Intent flag.ParametersflagWhen true, use Output Intent to override a working space, if it is present.Return ValueNoneHeader FilePDFLCalls.hRelated MethodsPDPrefGetUseOutputIntentsPDF Library Supplement to the Acrobat Core API Reference 48

PDF Library-specific MethodsPDPrefSetWorkingCMYKPDPrefSetWorkingCMYKvoid PDPrefSetWorkingCMYK (void* profile,ASUns32 profileLength);DescriptionSets the current CMYK working space to a given ICC profile. A CMYK working space in PDF isdefined as a profile to substitute for a corresponding /DeviceCMYK space.ParametersprofileprofileLengthA pointer to a buffer containing the ICC color profile.The length in bytes of the profile.Return ValueNoneHeader FilePDFLCalls.hRelated MethodsPDPrefSetWorkingGrayPDPrefSetWorkingRGBPDF Library Supplement to the Acrobat Core API Reference 49

PDF Library-specific MethodsPDPrefSetWorkingGrayPDPrefSetWorkingGrayvoid PDPrefSetWorkingGray (void* profile,ASUns32 profileLength);DescriptionSets the current gray working space to a given ICC profile. A Gray working space in PDF isdefined as a profile to substitute for a corresponding /DeviceGray space. When renderingwith overprint preview, the gray substitution is suppressed, to avoid converting grayscaleto "rich black."ParametersprofileprofileLengthA pointer to a buffer containing the ICC color profile.The length in bytes of the profile.Return ValueNoneHeader FilePDFLCalls.hRelated MethodsPDPrefSetWorkingCMYKPDPrefSetWorkingRGBPDF Library Supplement to the Acrobat Core API Reference 50

PDF Library-specific MethodsPDPrefSetWorkingRGBPDPrefSetWorkingRGBvoid PDPrefSetWorkingRGB (void* profile,ASUns32 profileLength);DescriptionSet the current RGB working space to a given ICC profile. An RGB working space in PDF isdefined as a profile to substitute for a corresponding /DeviceRGB space.ParametersprofileprofileLengthA pointer to a buffer containing the ICC color profile.The length in bytes of the profile.Return ValueNoneHeader FilePDFLCalls.hRelated MethodsPDPrefSetWorkingCMYKPDPrefSetWorkingGrayPDF Library Supplement to the Acrobat Core API Reference 51

PDF Library-specific CallbacksASExtensionProgressProcACCB1 void ACCB2 ASExtensionProgressProc(ASExtension extension, ASExtensionPhase phase,void* clientData);DescriptionCalled periodically during plug-in loading with the ASExtension currently being loaded.N OTE:Extensions to the PDF Library are very similar to plugins to the Adobe Acrobatapplication. However, Adobe does not currently supply any extensions or supporttheir creation.ParametersextensionphaseclientDataThe plug-in.The context of the load, which determines the sequence ofoperations during the load operation. One of these constants:ASExtensionPhase_LOADINGASExtensionPhase_EXPORTINGASExtensionPhase_IMPORTINGASExtensionPhase_INITIALIZINGASExtensionPhase_UNLOADINGA pointer to the client data.Return ValueNoneHeader FilePDFInit.hRelated CallbacksASExtensionReportErrorProcRelated MethodsNonePDF Library Supplement to the Acrobat Core API Reference 52

PDF Library-specific CallbacksASExtensionReportErrorProcASExtensionReportErrorProcACCB1 void ACCB2 ASExtensionReportErrorProc(ASExtension extension, ASExtensionPhase phase,ASInt32 error, void* clientData);DescriptionCalled during ASExtension initialization whenever an error occurs.ParametersextensionphaseerrorclientDataThe plug-in.Phase.The error code.A pointer to the client data.Return ValueNoneHeader FilePDFInit.hRelated CallbacksASExtensionProgressProcRelated MethodsNonePDF Library Supplement to the Acrobat Core API Reference 53

PDF Library-specific CallbacksASMemAllocProcASMemAllocProcACCB1 void* ACCB2 ASMemAllocProc (void* clientData,ASSize_t size);DescriptionCalled when the PDF Library needs to allocate memory. Callback should allocate therequested amount of memory and return it as a void*.ParametersclientDatasizeThe clientData specified in the TKAllocatorProcsstructure.The amount of memory to be allocated.Return ValuePointer to the allocated block of memory.Header FilePDFInit.hRelated CallbacksASMemAvailProcASMemFreeProcASMemReallocProcRelated MethodsPDFLInitExamplevoid* StdMemAllocProc(void* clientData, void* p, ASSize_t size){return malloc(p, size);}PDF Library Supplement to the Acrobat Core API Reference 54

PDF Library-specific CallbacksASMemAvailProcASMemAvailProcACCB1 ASSize_t* ACCB2 ASMemAvailProc (void* clientData);DescriptionCalled when the PDF Library needs to determine the amount of available free memory.ParametersclientDataA pointer to the clientData specified in theTKAllocatorProcs structure.Return ValueAmount of available free memory.Header FilePDFInit.hRelated CallbacksASMemAllocProcASMemFreeProcASMemReallocProcRelated MethodsPDFLInitExampleos_size_t sys_memavail(void){MEMORYSTATUS ms;ms.dwLength = sizeof(ms);GlobalMemoryStatus(&ms);return ms.dwAvailPhys + ms.dwAvailPageFile;}PDF Library Supplement to the Acrobat Core API Reference 55

PDF Library-specific CallbacksASMemFreeProcASMemFreeProcACCB1 void* ACCB2 ASMemFreeProc (void* clientData, void* p);DescriptionCalled when the PDF Library needs to free memory. Callback should free the requestedblock of memory.ParametersclientDatapA pointer to the clientData specified in theTKAllocatorProcs structure.A pointer to memory to free.Return ValueNoneHeader FilePDFInit.hRelated CallbacksASMemAllocProcASMemAvailProcASMemReallocProcRelated MethodsPDFLInitExamplevoid StdMemFreeProc(void* clientData, void* p){free(p);}PDF Library Supplement to the Acrobat Core API Reference 56

PDF Library-specific CallbacksASMemReallocProcASMemReallocProcACCB1 void* ACCB2 ASMemReallocProc (void* clientData, void* p,ASSize_t size);DescriptionCalled when the PDF Library needs to reallocate memory. Callback should reallocate therequested amount of memory and return it as a void*.ParametersclientDatapsizeA pointer to the clientData specified in theTKAllocatorProcs structure.A pointer to memory to reallocate.The amount of memory requested.Return ValuePointer to allocated block of memory.Header FilePDFInit.hRelated CallbacksASMemAllocProcASMemAvailProcASMemFreeProcRelated MethodsPDFLInitExamplevoid* StdMemReallocProc(void* clientData, void* p, ASSize_t size){return realloc(p, size);}PDF Library Supplement to the Acrobat Core API Reference 57

PDF Library-specific CallbacksCancelPrintJobCancelPrintJobACCB1 ASBool ACCB2 CancelPrintJob (PDPrintClient printClient);DescriptionCallback for PDPrintClient. CancelPrintJob is called to actually cause the print jobto be cancelled. It should stop further printing and preferably should remove theincomplete print job.ParametersprintClientThe PDPrintClient from which this is invoked.Return ValueReturns true if the print job was successfully cancelled.Header FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 58

PDF Library-specific CallbacksDataSourceStringDataSourceStringACCB1 ASUns32 ACCB2 DataSourceString (PDFileSpec f, char* buf,ASUns32 bufSize, void* clientData);Description(Optional) If this method is supplied, and the emitExternalStreamRef parameter inthe PDPrintParamsRec is true, then during PostScript printing this method will becalled when an external stream is encountered. If the method is not supplied, or if it returnsNULL, then the “simple pathname” 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) filewhere xxxxx is the returned string or the simple pathname.N OTE:The method may not store the PDFFileSpec pointer or any pointers (strings)within it.ParametersfbufbufSizeclientDataAn object of type PDFileSpec.(Filled by the callback) The buffer.The buffer size in bytes.A pointer to the client data.Return ValueLength of the string written info buf.Header FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 59

PDF Library-specific CallbacksDocBeginDocBeginACCB1 void ACCB2 DocBegin (const PDPageRange ranges[],ASInt32 numRanges, ASStm stm, const PDResTree docTree,PDPrintClient printClient);Description(Optional) Callback for PDPrintClient. Begin processing a document for printing.ParametersrangesnumRangesstmdocTreeprintClientRanges of pages in document to print.Number of page ranges in document to print.The PostScript print stream.Must be NULL.The PDPrintClient from which this is invoked.Return ValueNoneHeader FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 60

PDF Library-specific CallbacksDocEndDocEndACCB1 void ACCB2 DocEnd (ASStm stm,PDPrintClient printClient);Description(Optional) Callback for PDPrintClient. End processing a document for printing.ParametersstmprintClientThe PostScript print stream.The PDPrintClient from which this is invoked.Return ValueNoneHeader FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 61

PDF Library-specific CallbacksDocSetupDocSetupACCB1 ASBool ACCB2 DocSetup (const PDPageRange ranges[],ASInt32 numRanges, ASStm prologStm,PDPrintClient printClient);Description(Optional) Callback for PDPrintClient. Set up a document for printing.ParametersrangesnumRangesprologStmprintClientRanges of pages in document to print.Number of page ranges in document to print.The prolog stream.The PDPrintClient from which this is invoked.Return Valuefalse if you don’t want PDDocPrintPages to emit procsets and other resources.Header FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 62

PDF Library-specific CallbacksEmitFontProcSetEmitFontProcSetACCB1 ASBool ACCB2 EmitFontProcSet(ASStm stm, PDFont fontP,PDPrintClient printClient);Description(Optional) Callback for PDPrintClient. EmitFontProcSet is called while emittingthe document prolog. It should emit any procsets required to download the font. Theroutine will be called once for each font in the document. However, each procset onlyneeds to be downloaded once per document.ParametersstmfontPprintClientThe stream where the procset should be written.PDFont for the font.The PDPrintClient from which this is invoked.Return Valuefalse if fontDownloadContext is not specified in the PDPrintClient; trueotherwise.Header FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 63

PDF Library-specific CallbacksEmitGlyphsIncrEmitGlyphsIncrACCB1 ASBool ACCB2 EmitGlyphsIncr (ASStm stm, PDFont fontP,PDPrintStrP srcStr, PDPrintStrP dstStr,ASUns32* srcBytesUsed, ASUns32* dstBytesUsed,ASUns32* glyphCount, ASUns16* fontIndex,PDPrintClient printClient);DescriptionCallback for PDPrintClient. Emit glyphs incrementally.ParametersstmfontPsrcStrdstStrsrcBytesUsedPdstBytesUsedPglyphCountfontIndexPprintClientThe PostScript print stream for this page.PDFont for the font.Source string.Destination string.Source bytes used.Destination bytes used.Number of glyphs.Font index.The PDPrintClient from which this is invoked.Return Valuetrue if the glyphs successfully download, false otherwise.Header FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDFontPSEmitGlyphsIncrPDF Library Supplement to the Acrobat Core API Reference 64

PDF Library-specific CallbacksEmitPageContentsEmitPageContentsACCB1 void ACCB2 EmitPageContents (ASStm stm, ASInt32 pageNum,PDPage pdPage, PDPrintClient printClient);Description(Optional) Callback for PDPrintClient. Emit the page contents for printing. Broadcast anotification that the page has been printed:ParametersNOTIFY(PDDocDidPrintPage)(doc, page, stm, error)There is a default callback for PostScript printing.stmpageNumpdPageprintClientThe PostScript print stream for this page.The number of the page whose contents is emitted.The PDPage to print.The PDPrintClient from which this is invoked.Return ValueNoneHeader FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 65

PDF Library-specific CallbacksEmitPrologStringEmitPrologStringACCB1 ASInt32 ACCB2 EmitPrologString (const char* s,ASInt32 nData, PDPrintClient printClient);Description(Optional) Callback for PDPrintClient. Emits prolog string.Defaults to a method that calls FlushString.ParameterssnDataprintClientPointer to the prolog string to emit.Length of s in bytes.The PDPrintClient from which this is invoked.Return ValueIf successful, result is greater than zero. If unsuccessful, result is negative.Header FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 66

PDF Library-specific CallbacksEmitPSFontBeginEmitPSFontBeginACCB1 void ACCB2 EmitPSFontBegin (ASStm stm, PDFont fontP,PDPrintClient printClient);Description(Optional) Callback for PDPrintClient. Called before a font is emitted (outside DSCcomments).ParametersstmfontPprintClientThe PostScript print stream for the current page.The font to emit.The PDPrintClient from which this is invoked.Return ValueNoneHeader FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 67

PDF Library-specific CallbacksEmitPSFontEncodingBeginEmitPSFontEncodingBeginACCB1 ASBool ACCB2 EmitPSFontEncodingBegin (ASStm stm,PDFont fontP, PDPrintClient printClient);Description(Optional) Callback for PDPrintClient. Called before a font encoding is emitted.ParametersstmfontPprintClientThe PostScript print stream for the current page.The font whose encoding is emitted.The PDPrintClient from which this is invoked.Return ValueMust be true.Header FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 68

PDF Library-specific CallbacksEmitPSFontEncodingEndEmitPSFontEncodingEndACCB1 void ACCB2 EmitPSFontEncodingEnd (ASStm stm,PDFont fontP, PDPrintClient printClient);Description(Optional) Callback for PDPrintClient. Called after a font encoding is emitted.ParametersstmfontPprintClientThe PostScript print stream for the current page.The font whose encoding was emitted.The PDPrintClient from which this is invoked.Return ValueNoneHeader FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 69

PDF Library-specific CallbacksEmitPSFontEndEmitPSFontEndACCB1 void ACCB2 EmitPSFontEnd (ASStm stm, PDFont fontP,PDPrintClient printClient);Description(Optional) Callback for PDPrintClient. Called after a font is emitted (outside DSCcomments).ParametersstmfontPprintClientThe PostScript print stream for the current page.The font that was emitted.The PDPrintClient from which this is invoked.Return ValueNoneHeader FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 70

PDF Library-specific CallbacksEmitPSResourceBeginEmitPSResourceBeginACCB1 void ACCB2 EmitPSResourceBegin (ASStm stm,ASAtom resType, char* resName, CosObj resObj,PDPrintClient printClient);Description(Optional) Callback for PDPrintClient. Called before a PostScript resource is emitted.ParametersstmresTyperesNameresObjprintClientThe PostScript print stream for the current page.An ASAtom representing the name of the resource type, such asColorSpace or XObject, as defined in section 3.7.2 of the PDFReference.Name of the resource in the current page.The resource’s Cos object.The PDPrintClient from which this is invoked.Return ValueNoneHeader FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 71

PDF Library-specific CallbacksEmitPSResourceEndEmitPSResourceEndACCB1 void ACCB2 EmitPSResourceEnd (ASStm stm, ASAtom resType,char* resName, CosObj resObj, PDPrintClient printClient);Description(Optional) Callback for PDPrintClient. Called after a PostScript resource is emitted.ParametersstmresTyperesNameresObjprintClientThe PostScript print stream for the current page.An ASAtom representing the name of the resource type, such asColorSpace or XObject as defined in section 3.7.2 of the PDFReference.Name of the resource in the current page.The resource’s Cos object.The PDPrintClient from which this is invoked.Return ValueNoneHeader FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 72

PDF Library-specific CallbacksEndSetupEndSetupACCB1 void ACCB2 EndSetup (ASStm stm,PDPrintClient printClient);Description(Optional) 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 ofpages that will be printed, as in this pseudo code:Parametersfor i = 0 to numRanges-1 ...{NOTIFY(PDDocWillPrintPages)(doc, fromPage, toPage, psLevel,binaryOK);for pageNum = ranges[i]->startPage to ranges[i]->lastPage ...}stmprintClientThe PostScript print stream.The PDPrintClient from which this is invoked.Return ValueNoneHeader FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 73

PDF Library-specific CallbacksFlushIncrGlyphListFlushIncrGlyphListACCB1 void ACCB2 FlushIncrGlyphList (ASStm stm,PDPrintClient printClient);Description(Required) Callback for PDPrintClient. FlushIncrGlyphList is called to flush thelist of glyphs that have been incrementally download since the calls to EmitFont or thelast call of FlushIncrGlyphList. This routine will be called if the caller generatesPostScript code that would flush glyphs procedures that have been downloaded to thePostScript interpreter. For example, if at the beginning of each page a “save” is executedand then at the end of a page a “restore” is executed, any glyph procedures downloadedafter 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.ParametersstmprintClientThe PostScript print stream.The PDPrintClient from which this is invoked.Return ValueNoneHeader FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 74

PDF Library-specific CallbacksFlushStringFlushStringACCB1 ASInt32 ACCB2 FlushString (char* data, ASInt32 nData,PDPrintClient printClient);Description(Required) Callback for PDPrintClient. Called when the ASStm buffer is full. Buffereddata should be sent to the printer, driver, file, or other destination. Not used for non-PostScript printing.ParametersdatanDataprintClientPointer to data to send.Length of data, in bytes.The PDPrintClient from which this is invoked.Return ValueNoneHeader FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 75

PDF Library-specific CallbacksGetComponentFontListGetComponentFontListACCB1 void ACCB2 GetComponentFontList (PDFont fontP,PDPrintFontArray fontList, PDPrintClient printClient);Description(Required) Callback for PDPrintClient. GetComponentFontList is called to get thelist of component font names used for substitution. For fonts that do not requiresubstitution or are substituted by only one font, the list returned should only have oneelement. For a Type 0 font that requires several fonts for font substitution, the list will havemultiple fonts. The fontnames returned are the names used by the font definitionsdownloaded to PostScript. The font definitions themselves are downloaded by a call to theEmitFont routine.ParametersfontPfontListprintClientThe font.Font array.The PDPrintClient from which this is invoked.Return ValueNoneHeader FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 76

PDF Library-specific CallbacksGetFontVMUsageGetFontVMUsageACCB1 ASInt32 ACCB2 GetFontVMUsage (ASStm stm,PDPrintClient printClient);Description(Optional) Callback for PDPrintClient. Asks client what the VM usage is for the font.ParametersstmprintClientThe PostScript print stream.The PDPrintClient from which this is invoked.Return ValueVM usage, in bytes.Header FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 77

PDF Library-specific CallbacksNotifyNewPageNotifyNewPageACCB1 void ACCB2 NotifyNewPage (ASInt32 pageNum,PDPrintClient printClient);Description(Optional) Callback for PDPrintClient. Called once for each page printed.A client can use this notification to update the page number in the message pane, forexample.ParameterspageNumprintClientThe number of the page to print.The PDPrintClient from which this is invoked.Return ValueNoneHeader FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 78

PDF Library-specific CallbacksOPIhandlerOPIhandlerACCB1 ASBool ACCB2 OPIhandler (OPIDict* opi, ASStm stm,void* clientData);Description(Optional) Callback for PDPrintClient. If supplied, it is called during PostScript printingwhen a form or image containing an OPI dictionary is encountered. If it returns true, theclient is presumed to have taken care of the entire form or image, and PDPrint emitsnothing. Otherwise, PDPrint generates OPI comments based on the dictionary.N OTE:The method may not store the OPIdict pointer or any pointers within it.ParametersopistmclientDataThe OPI dictionary.The PostScript print stream.A pointer to the client data.Return Valuetrue if the client has taken care of the entire form or image, false otherwise.Header FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 79

PDF Library-specific CallbacksPageBeginPageBeginACCB1 void ACCB2 PageBegin (ASStm stm, ASInt32 pageNum,const PDResTree pageTree, PDPrintClient printClient);Description(Optional) Callback for PDPrintClient. Called before a page begins printing.ParametersstmpageNumpageTreeprintClientThe PostScript print stream for the current page.The number of the page being printed.Must be NULL.The PDPrintClient from which this is invoked.Return ValueNoneHeader FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 80

PDF Library-specific CallbacksPageCleanupPageCleanupACCB1 void ACCB2 PageCleanup (ASStm stm, ASInt32 pageNum,PDPrintClient printClient);Description(Optional) Callback for PDPrintClient. Mirrors PageSetup, PageCleanup is calledbefore we clean our dictionariesParametersstmpageNumprintClientThe PostScript print stream for the current page.The number of the page being printed.The PDPrintClient from which this is invoked.Return ValueNoneHeader FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 81

PDF Library-specific CallbacksPageEndPageEndACCB1 void ACCB2 PageEnd (ASStm stm, ASInt32 pageNum,ASBool veryLastPage, PDPrintClient printClient);Description(Optional) Callback for PDPrintClient. Called after a page has printed. Broadcastsnotification that page has printed:ParametersNOTIFY(PDDocDidPrintPages)(doc, fromPage, toPage, error);stmpageNumveryLastPageprintClientThe PostScript print stream for the current page.The number of the page just printed.true only for the last page of the very last range, false otherwise.The PDPrintClient from which this is invoked.Return ValueNoneHeader FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 82

PDF Library-specific CallbacksPageSetupPageSetupACCB1 ASBool ACCB2 PageSetup (ASStm stm, ASInt32 pageNum,PDPrintClient printClient);Description(Optional) Callback for PDPrintClient. Called before a page is printed to set it up.ParametersstmpageNumprintClientThe PostScript print stream for the current page.The number of the page to set up.The PDPrintClient from which this is invoked.Return Valuetrue on success; otherwise, an error is raised.Header FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 83

PDF Library-specific CallbacksPageSetupPostResourcePageSetupPostResourceACCB1 void ACCB2 PageSetupPostResource (ASStm stm,ASInt32 pageNum, PDPrintClient printClient);DescriptionCallback for PDPrintClient. PageSetupPostResource is called fromPDPrintPageBegin after the resource tree has been processed (all fonts and otherresources emitted into the PostScript stream).ParametersstmpageNumprintClientThe PostScript print stream for the current page.The number of the page to set up.The PDPrintClient from which this is invoked.Return ValueNoneHeader FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 84

PDF Library-specific CallbacksPDFLPrintCancelProcPDFLPrintCancelProcACCB1 ASBool ACCB2 PDFLPrintCancelProc (PDDoc pdDoc,void* clientData);DescriptionThis 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 toreturn 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 singlethreaded.ParameterspdDocclientDataThe document being printed.A pointer to the client data that was passed in thePDFLPrintUserParamsRec with the call to PDFLPrintDoc.Return Valuetrue to cancel the print job, false otherwise.Header FilePDFLExpT.hRelated CallbacksASCancelProcCancelProcRelated DataPDFLPrintUserParamsRecRelated MethodsNonePDF Library Supplement to the Acrobat Core API Reference 85

PDF Library-specific CallbacksPDPrintCanEmitFontProcPDPrintCanEmitFontProcACCB1 ASBool ACCB2 PDPrintCanEmitFontProc (PDFont fontP,PDPrintClient printClient);Description(Optional) Callback for PDPrintClient. Called to determine whether a font can beemitted into the print job. This is used to determine whether a font is a document-includedresource. Only used for PostScript printing.If NULL, the default is to assume that any font can be emitted.ParametersfontPprintClientThe font to check.The PDPrintClient from which this is invoked.Return Valuetrue if client can emit specified font, false otherwise.Header FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 86

PDF Library-specific CallbacksPDPrintEmitFontProcPDPrintEmitFontProcACCB1 ASBool ACCB2 PDPrintEmitFontProc (ASStm stm,PDFont fontP, PDPrintClient printClient);Description(Required) Callback for PDPrintClient. Emits a font. For Type0 fonts that require fontsubstition this routine may emit multiple font definitions. The caller can get the list of fontsused by calling GetFontComponentList.ParametersstmfontPprintClientThe PostScript print stream for the current page.Font to emit.The PDPrintClient from which this is invoked.Return Valuetrue if font emitted; false otherwise.Header FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 87

PDF Library-specific CallbacksPDPrintEmitPrologResourceProcPDPrintEmitPrologResourceProcACCB1 void ACCB2 PDPrintEmitPrologResourceProc (ASStm stm,ASInt32 resID, PDPrintClient printClient);Description(Required) Callback for PDPrintClient. Takes a resID and creates the PostScriptprolog.ParametersstmresIDprintClientThe PostScript print stream for the current page.PostScript procset resource ID.The PDPrintClient from which this is invoked.Return ValueNoneHeader FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 88

PDF Library-specific CallbacksPDPrintGetFontEncodingMethodProcPDPrintGetFontEncodingMethodProcACCB1 ASInt32 ACCB2 PDPrintGetFontEncodingMethodProc(PDFont fontP, PDPrintClient printClient);Description(Required for PostScript printing) Callback for PDPrintClient. Asks client which encodingmethod should be used for the font.ParametersfontPprintClientThe font whose encoding method is determined.The PDPrintClient from which this is invoked.Return ValueEncoding method, which must be one of the following:●●●Header FilePDFLExpT.hkPDDoReencode — Use for Type 1 fonts and substituted fonts.kPDDoNothing — Use for TrueType Windows font or built-in encoding font.kPDDoXlate — Use for a TrueType custom font or font with Macintosh encoding.Related MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 89

PDF Library-specific CallbacksShouldCancelShouldCancelACCB1 ASBool ACCB2 ShouldCancel(PDPrintClient printClient);DescriptionCallback for PDPrintClient. ShouldCancel is called at least once per page. It shouldreturn true if the print job should be cancelled (typically, the user hit key combination tocancel printing).ParametersprintClientThe PDPrintClient from which this is invoked.Return Valuetrue if the print job should be cancelled, false otherwise.Header FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 90

PDF Library-specific CallbacksTKResourceAcquireProcTKResourceAcquireProcACCB1 void* ACCB2 TKResourceAcquireProc (char* resourceName,ASInt32 resType, void* registry, ASInt32* size,void* clientData, ASStm* rdStm);DescriptionCallback in TKResourceProcs structure in the Adobe PDF Library. Acquires thespecified resource and use it to fill in the rdStm parameter.ParametersresourceNameresTyperegistrysizeclientDatardStmName of resource to acquire.One of the following from the resType enum:resCMapDataresCharTypeDataresCharRangeDataresFontPropDataresCJKNoteFontNormalresCJKNoteFontBoldresCJKNoteFontObliqueresFontDataresCMapLastIDOne of the following.● Adobe-Japan1—Japanese● Adobe-Korea1—Korean● Adobe-CNS1—Traditional Chinese● Adobe-GB1—Simplified Chinese(Filled by the callback) Size of the ASStm returned.A pointer to the clientData specified in theTKResourceProcs structure.(Filled by the callback) An ASStm for the data requested.Return ValueA void* of data that you want returned to you in TKResourceReleaseProc. Thisdata can be used to determine what Resource to release. You can return NULL fromTKResourceAcquireProc.Header FilePDFInit.hPDF Library Supplement to the Acrobat Core API Reference 91

PDF Library-specific CallbacksTKResourceAcquireProcRelated CallbacksTKResourceReleaseProcRelated MethodsPDFLInitPDF Library Supplement to the Acrobat Core API Reference 92

PDF Library-specific CallbacksTKResourceReleaseProcTKResourceReleaseProcACCB1 void ACCB2 TKResourceReleaseProc (ASStm rdStm,void* data, void* clientData);DescriptionCallback in TKResourceProcs structure in the Adobe PDF Library. Releases theresources previously acquired and closes the ASStm passed in as rdStm.ParametersrdStmdataclientDataAn ASStm for the resource to release and close with ASStmClose.The clientData returned from PMSetTextProc.A pointer to the clientData specified in theTKResourceProcs structure.Return ValueNoneHeader FilePDFInit.hRelated CallbacksPMSetTextProcRelated MethodsPDFLInitPDF Library Supplement to the Acrobat Core API Reference 93

PDF Library-specific CallbacksUndefineFontUndefineFontACCB1 ASBool ACCB2 UndefineFont (ASStm stm, PDFont fontP,ASBool vmUndefine, PDPrintClient client)Description(Required) UndefineFont is called to remove the font from the list of fonts that havebeen downloaded and to undefine the font from PostScript VM. It may be called during apage, at the end of the page, or between pages. After this routine is called, if the font isrequired again, the EmitFont routine will be called.ParametersstmfontPvmUndefineprintClientStream to which the PostScript code to undefine the font will bewritten.PDFont for the font to be removed.If true and this is a level 2 or greater PostScript interpreter,PostScript code will be emitted to undefine the font. If false, thenit will just be removed from the list of fonts that have already beendownloaded.The PDPrintClient from which this is invoked.Return Valuetrue on success.Header FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDF Library Supplement to the Acrobat Core API Reference 94

PDF Library-specific DeclarationsASExtensionPhaseenum{ASExtensionPhase_LOADING,ASExtensionPhase_EXPORTING,ASExtensionPhase_IMPORTING,ASExtensionPhase_INITIALIZING,ASExtensionPhase_UNLOADING};typedef ASInt16 ASExtensionPhase;DescriptionSelector indicating what phase of loading is happening.Header FilePDFInit.hRelated MethodsNoneMembersASExtensionPhase_LOADINGASExtensionPhase_EXPORTINGASExtensionPhase_IMPORTINGASExtensionPhase_INITIALIZINGASExtensionPhase_UNLOADINGLoading phase.Exporting phase.Importing phase.Initializing phase.Unloading phase.PDF Library Supplement to the Acrobat Core API Reference 95

PDF Library-specific DeclarationsASRealASRealtypedef float ASReal;DescriptionReal number values.Header FileASExpT.hRelated StructuresASRealPointPDF Library Supplement to the Acrobat Core API Reference 96

PDF Library-specific DeclarationsASRealPointASRealPointtypedef struct _t_ASRealPoint {ASReal h, v;} ASRealPoint;DescriptionReal number coordinate values.Header FileASExpT.hRelated StructuresPDPrintStrPDF Library Supplement to the Acrobat Core API Reference 97

PDF Library-specific DeclarationsOPIDictOPIDicttypedef struct {OPIversion version; /* 1.3 or 2.0 */union {OPI13dict *dict13;OPI20dict *dict20;} dict;} OPIdict;DescriptionUsed to specify an OPI dictionary.Header FilePDFLExpT.hRelated CallbacksOPIhandlerPDF Library Supplement to the Acrobat Core API Reference 98

PDF Library-specific DeclarationsPDDuplexEnumPDDuplexEnumenum {kPDDuplexOff,kPDDuplexOnTumbleShort,kPDDuplexOnTumbleLong};typedef ASEnum8 PDDuplexEnum;DescriptionDuplex values.Header FilePDFLExpT.hRelated StructuresPDPrintParamsPDF Library Supplement to the Acrobat Core API Reference 99

PDF Library-specific DeclarationsPDFarEastFontPDFarEastFontenum {PDPDFarEastFont_Download_All,PDPDFarEastFont_Download_None,PDPDFarEastFont_Print_As_Image};typedef ASEnum8 PDFarEastFont;DescriptionCJK font related option for PostScript printing.Header FilePDFLExpT.hMembersPDPDFarEastFont_Download_AllPDPDFarEastFont_Download_NonePDPDFarEastFont_Print_As_ImageDownload all CJK fonts to printer.Download only embedded fonts toprinter.GDI/QuickDraw on PostScript option.PostScript should use this to print CJKPDF Library Supplement to the Acrobat Core API Reference 100

PDF Library-specific DeclarationsPDFlattenPDFlattenPDFlattenRectypedef struct {PDFlattenTilingMode tilingMode;ASBooluseTextOutlines;ASBoolallowShadingOutput;ASBoolallowLevel3ShadingOutput;floatinternalDPI;floatexternalDPI;floatpathDPI;ASUns32tileSizePts;ASUns32maxFltnrImageSize;ASUns32adaptiveThreshold;ASBoolpreserveOverprint;} PDFlattenRec, *PDFlatten;DescriptionControls tile flattening. Primarily of interest to resource limited (embedded) systemsdevelopers.Header FilePDFLExpT.hMemberstilingModeuseTextOutlinesallowShadingOutputallowLevel3ShadingOutputinternalDPIexternalDPI0 = no tiling; 1 = constant tiling; 2 = adaptivetiling.Output text outlines instead of native text.Allow shading ouput.Allow level 3 shading output.Resolution for flattening interior of atomic region.Resolution for flattening edges of atomic regions.pathDPI Flattener path resolution, default is 800.tileSizePtsTarget tile size in points.maxFltnrImageSize Maximum image size when flattening. Default is 0.PDF Library Supplement to the Acrobat Core API Reference 101

PDF Library-specific DeclarationsPDFlattenadaptiveThresholdpreserveOverprintAdaptive flattening threshold.Attempt to preserve overprint.Related TypesPDPrintParamsPDF Library Supplement to the Acrobat Core API Reference 102

PDF Library-specific DeclarationsPDFlattenTilingModePDFlattenTilingModetypedef ASInt32 PDFlattenTilingMode;enum {kPDNoTiling = 0,kPDConstantTiling,kPDAdaptiveTiling,_MAX_FLATTENTILINGMODE = PDMAXENUM};DescriptionSupport for tiled flattening.Header FilePDFLExpT.hMemberskPDNoTilingkPDConstantTilingkPDAdaptiveTilingNo tiling.Constant tiling.Adaptive tiling.PDF Library Supplement to the Acrobat Core API Reference 103

PDF Library-specific DeclarationsPDFLDataPDFLDataWindowstypedef struct _t_PDFLData {ASSize_t size;ASUns32 flags;HINSTANCE inst;char** dirList;ASInt32 listLen;TKAllocatorProcsP allocator;TKResourceProcsP resProcs;TKExtensionProcsP extProcs;} PDFLDataRec, *PDFLData;Mac OStypedef struct _t_PDFLData {ASSize_t size;ASUns32 flags;FSSpec** dirList;ASInt32 listLen;TKAllocatorProcsP allocator;short resFile;TKResourceProcsP resProcs;TKExtensionProcsP extProcs;} PDFLDataRec, *PDFLData;UNIXtypedef struct _t_PDFLData {ASSize_t size;ASUns32 flags;char** dirList;ASInt32 listLen;TKAllocatorProcsP allocator;TKResourceProcsP resProcs;TKExtensionProcsP extProcs;} PDFLDataRec, *PDFLData;Description(Present only in Adobe PDF Library 1.0 or later)Structure for PDFLInit.Header FilePDFInit.hPDF Library Supplement to the Acrobat Core API Reference 104

PDF Library-specific DeclarationsPDFLDataRelated MethodsPDFLGetFlagsPDFLInitMemberssizeflagsinst(Windowsonly)dirListlistLenallocatorresFile(MacOS only)Size of the data structure. Must be set to sizeof(PDFLDataRec).The only flag currently supported iskPDFLInitIgnoreDefaultDirectories. When this flag is set,the initialization process does not search through the default fontdirectories, but only in those specified in dirList.Location of resources for the Library. For a static library, you link theminto your application and use NULL for inst. For a DLL version of thelibrary, call LoadLibrary on the DLL and set inst equal to theHINSTANCE returned:libData.inst = LoadLibrary("PDFL50.DLL");If you are linking the static library into a DLL, pass the HINSTANCEpassed into DllMain or WinMain for inst and link the resources intothe DLL.Free the HINSTANCE with FreeLibrary after you call PDFLTerm.List of directories with fonts. Here is an example for Windows:libData.listLen=3L;libData.dirList=(ASPathName *)malloc(sizeof(ASPathName)*3);libData.dirList[0]=(ASPathName)"c:\\PSFonts";libData.dirList[1]=(ASPathName)"c:\\Fonts";libData.dirList[2]=(ASPathName)"c:\\CMap";Number of directories listed in dirList.The structure containing function pointers for memory allocationcallbacks. The library manages its own memory. Most applicationslinking with the library should pass NULL for this member. Applicationswishing more control over memory allocation can fill out this structureand will be responsible for providing and freeing memory as well asreporting available memory as requested by the library.Resources location, if they are not in the application itself. Set themusing OpenResFile:libData.resFile = OpenResFile("\pMyResFileGoesHere")PDF Library Supplement to the Acrobat Core API Reference 105

PDF Library-specific DeclarationsPDFLDataresProcsextProcsThe structure containing function pointers for resource managementcallbacks. The library manages its own resources. Most applicationslinking with the library should pass NULL for this member. Applicationswishing more control over resource allocation can fill out this structureand will be responsible for providing and freeing resources requestedby the library.The structure containing function pointers for ASExtension callbacksused by the PDF Library.PDF Library Supplement to the Acrobat Core API Reference 106

PDF Library-specific DeclarationsPDFLPrintUserParamsRecPDFLPrintUserParamsRecUnixtypedef struct {ASInt32 size;PDPrintParams printParams;ASBool emitToFile;ASStm printStm;ASUns16 paperWidth;ASUns16 paperHeight;ASInt32 dontEmitListLen;char** dontEmitList;ASBool emitToPrinter;char* command;PDFLPrintCancelProc cancelProc;void* clientData;} PDFLPrintUserParamsRec, *PDFLPrintUserParams;Windowstypedef struct {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;DEVMODE* pDevMode;int startPage;int endPage;int shrinkToFit;int printAnnots;int psLevel;int nCopies;int binaryOK;int emitHalftones;PDF Library Supplement to the Acrobat Core API Reference 107

PDF Library-specific DeclarationsPDFLPrintUserParamsRecint reverse;int farEastFontOpt;int transQuality;int doOPP;PDFLPrintCancelProc cancelProc;void* clientData;} PDFLPrintUserParamsRec, *PDFLPrintUserParams;MacOStypedef struct {ASInt32 size;ASBool emitToFile;PDPrintParams printParams;ASStm printStm;ASUns16 paperWidth;ASUns16 paperHeight;ASInt32 dontEmitListLen;char** dontEmitList;ASBool emitToPrinter;void* printRecord;void* printession;void* printSettings;void* pageFormat;PDFLPrintCancelProc cancelProc;void* clientData;} PDFLPrintUserParamsRec, *PDFLPrintUserParams;DescriptionUsed to control printing with PDFLPrintDoc. See PDFLPrint.h for details on printingon specific platforms.N OTE:Header FilePDFLPrint.hUNIX supports only PostScript, to file or printer, as controlled by the (mutuallyexclusive) emitToFile and emitToPrinter parameters.Related CallbacksPDFLPrintCancelProcRelated MethodsPDFLPrintDocPDF Library Supplement to the Acrobat Core API Reference 108

PDF Library-specific DeclarationsPDFLPrintUserParamsRecMembersUnixsizeprintParamsemitToFileprintStmpaperWidthpaperHeightdontEmitListLendontEmitListemitToPrintercommandcancelProcclientDataSize of the data structure. Must be set tosizeof(PDFLPrintUserParamsRec).PDPrintParams structure. Used for both creating aPostScript file and printing to a printer.Create a PostScript file. You set either this parameter oremitToPrinter, but not both.Writable ASStm that points to file stm or proc stm. Applies toboth PostScript printer and file.Width of paper in points. The default value is 612. Applies toPostScript printer.Height of paper in points. The default value is 792. Applies toPostScript printer.Number of fonts that should not be downloaded. Applies toboth PostScript printer and file.List of fonts (T1, TT, CID) that should not be downloaded.Applies to both PostScript printer and file.Output PDF file to a PostScript printer. You set either thisparameter or emitToFile, but not both.Optional command line arguments; used only ifemitToPrinter is true. For example, “lp” or “lpr.” Applies toPostScript printer.Optional PDFLPrintCancelProc. Applies to bothPostScript printer and file.Optional pointer to data passed to cancelProc. Applies toboth PostScript printer and file.WindowssizeemitToFileprintParamsSize of the data structure. Must be set tosizeof(PDFLPrintUserParamsRec).Create a PostScript file. You set either this parameter oremitToPrinter, but not both.PDPrintParams structure. Applies to PostScript file.PDF Library Supplement to the Acrobat Core API Reference 109

PDF Library-specific DeclarationsPDFLPrintUserParamsRecWindowsprintStmpaperWidthpaperHeightdontEmitListLendontEmitListemitToPrinterinFileNameoutFileNamedeviceNamedriverNameportNameWritable ASStm that points to file stm or proc stm. Applies toPostScript file.Width of paper in points. The default value is 612. Applies toprinter.Height of paper in points. The default value is 792. Applies toprinter.Number of fonts that should not be downloaded. Applies toPostScript printer or file.List of fonts (T1, TT, CID) that should not be downloaded. Appliesto PostScript printer or file.Output PDF file to either a PostScript printer or a non-PostScriptprinter. Set either this parameter or emitToFile, but notboth.Used for the Windows DOCINFO structure — lpszDocNamethat points to a null-terminated string that specifies the name ofthe document. Applies to printer.Used for the Windows DOCINFO structure — lpszOutput. Itpoints to a null-terminated string that specifies the name of anoutput file. If this pointer is NULL, the output will be sent to thedevice identified by deviceName, driverName, andportName. Applies to printer.Name of device to print to. For example, “Distiller Assistantv3.01”. Available devices can be found in the Windows Registry atHKEY_CURRENT_USER\Software\Microsoft\WindowsNT\CurrentVersion\Devices. Applies to printer.Name of driver. For example, “winspool”. See registry key fordeviceName. Applies to printer.Name of Port. For example, “Ne00” See registry key fordeviceName. Applies to printer.PDF Library Supplement to the Acrobat Core API Reference 110

PDF Library-specific DeclarationsPDFLPrintUserParamsRecWindowspDevModestartPageendPageshrinkToFitprintAnnotspsLevelnCopiesbinaryOKemitHalftonesreversefarEastFontOpttransQualitydoOPPcancelProcclientData(Optional) Allows you to pass a DEVMODE structure in if you haveone. Applies to printer. If you do not pass in your own DEVMODEstructure, PDFL creates its own by calling OpenPrinter(),DocumentProperties(), and ClosePrinter(). PDFLnever calls SetPrinter() and has no facility to offer thefeatures provided by SetPrinter() (e.g., pause/resume,deleting jobs, changing printer status, etc.).DocumentProperties() is called only in the case where theclient doesn’t provide a DEVMODE.N OTE: If you provide your own DEVMODE, you will certainly wantto call DocumentProperties() to populate it and/ordisplay the print dialog.Page to start printing with, 0-based. Applies to printer.Page to finish printing on. Applies to printer.1 turns on shrink to fit, 0 turns it off. Applies to PostScriptprinter.1 turns on printing annots, 0 turns it off. Applies to printer.PostScript level. Applies to PostScript printer.Number of copies to print. Applies to printer.1 turns on binary data, 0 turns it off. Applies to PostScript printer.1 turns on emit half-tones, 0 turns it off. Applies to PostScriptprinter.1 reverses print order, 0 does regular order. Applies to printer.One of PDFarEastFont.The default value isPDPDFarEastFont_Download_All. Applies to PostScriptprinter.Transparency flattening quality control. 1 is fastest; 5 is best.Applies to printer.1 uses OverPrint Preview, 0 does not. Applies to printer.Optional PDFLPrintCancelProc. Applies to all.Optional pointer to data passed to cancelProc. Applies to all.PDF Library Supplement to the Acrobat Core API Reference 111

PDF Library-specific DeclarationsPDFLPrintUserParamsRecMacintoshsizeemitToFileprintParamsprintStmpaperWidthpaperHeightdontEmitListLendontEmitListemitToPrinterprintRecordprintSessionprintSettingspageFormatcancelProcclientDataSize of the data structure. Must be set tosizeof(PDFLPrintUserParamsRec).Create a PostScript file. You set either this parameter oremitToPrinter, but not both.PDPrintParams structure. Applies to PostScript file.Writable ASStm that points to file stm or proc stm.Width of paper in points. The default value is 612. Applies toprinter.Height of paper in points. The default value is 792. Applies toprinter.Number of fonts that should not be downloaded. Applies toPostScript printer and file.List of fonts (T1, TT, CID) that should not be downloaded.Applies to PostScript printer and file.Output PDF file to either a PostScript or a non-PostScriptprinter. You set either this parameter or emitToFile, butnot both.Classic print record handle (THPrint) - may be NULL Applies toprinter.Carbon print session - may be NULL . Applies to printer.Carbon print settings - may be NULL. Applies to printer.Carbon page format - may be NULL. Applies to printer.Optional PDFLPrintCancelProc. Applies to all.Optional pointer to data passed to cancelProc. Applies toall.PDF Library Supplement to the Acrobat Core API Reference 112

PDF Library-specific DeclarationsPDFontDownloadContextPDFontDownloadContexttypedef struct _t_PDFontDownloadContext *PDFontDownloadContext;DescriptionMaintains information about the current print job and what fonts have been downloaded.Header FilePDFLExpt.hRelated MethodsPDFontDownloadContextCreatePDFontDownloadContextDestroyPDF Library Supplement to the Acrobat Core API Reference 113

PDF Library-specific DeclarationsPDFontStylePDFontStyleenum {PDRoman = 0,PDItalic,PDBold,PDBoldItalic};typedef ASUns8 PDFontStyle;DescriptionSpecifies a synthetic font style.Header FilePDFLExpt.hRelated TypesPDPrintFontRecPDF Library Supplement to the Acrobat Core API Reference 114

PDF Library-specific DeclarationsPDInclusionPDInclusiontypedef ASEnum8 PDInclusion;enum {kIncludeOncePerDoc,kIncludeOnEveryPage,kIncludeNever};DescriptionSpecifies how to include a resource in a file.Header FilePDFLExpt.hRelated TypesPDPrintParamsRelated MethodsNoneMemberskIncludeOncePerDockIncludeOnEveryPagekIncludeNeverkIncludeWhenNeededInclude the resource only once per file.Include the resource on every page in the file.Never include the resource.When needed.PDF Library Supplement to the Acrobat Core API Reference 115

PDF Library-specific DeclarationsPDOutputTypePDOutputTypetypedef ASEnum8 PDOutputType;enum {PDOutput_PS,PDOutput_EPSNoPrev,PDOutput_EPSMacStdPrev,PDOutput_EPSMacExtPrev};DescriptionSpecifies what kind of file to emit.Header FilePDFLExpt.hRelated TypesPDPrintParamsRelated MethodsNoneMembersPDOutput_PSPDOutput_EPSNoPrevPDOutput_EPSMacStdPrevPDOutput_EPSMacExtPrevEmit a PostScript file.Emit an EPS file with no preview.Emit an EPS file with standard preview.Emit an EPS file with extended preview.PDF Library Supplement to the Acrobat Core API Reference 116

PDF Library-specific DeclarationsPDPageDrawSmoothFlagsPDPageDrawSmoothFlagstypedef ASUns32 PDPageDrawSmoothFlags;enum {kPDPageDrawSmoothText = 0x00000001,kPDPageDrawSmoothLineArt = 0x00000002,kPDPageDrawSmoothImage = 0x00000004};DescriptionBit flags indicating how a page is rendered.Header FilePDFLExpt.hRelated TypesPDPageDrawFlagsRelated MethodsPDPageDrawContentsToMemoryMemberskPDPageDrawSmoothTextkPDPageDrawSmoothLineArtkPDPageDrawSmoothImageDraw smooth text.Draw smooth line art.Draw smooth image.PDF Library Supplement to the Acrobat Core API Reference 117

PDF Library-specific DeclarationsPDPageMarkFlagsPDPageMarkFlagstypedef ASUns32 PDPageMarkFlags;enum {kPDPageEmitColorBars = 0x0001,kPDPageEmitRegMarks = 0x0002,kPDPageEmitCropMarks = 0x0004,kPDPageEmitBleedMarks = 0x0008,kPDPageEmitPageInfo = 0x0010,kPDPageEmitTrimMarks = 0x0020,kPDPageEmitSlurMarks = 0x0040};DescriptionBit flags indicating which page marks are emitted for color separations.Header FilePDFLExpt.hRelated TypesPDPrintParamsRelated MethodsPDFLPrintDocPDPageEmitPSOrientAVDocPrintSeparationsPDPageMakeSeparationsPDF Library Supplement to the Acrobat Core API Reference 118

PDF Library-specific DeclarationsPDPrintClientPDPrintClientPDPrintClientRectypedef struct _t_PDPrintClient {ASSize_t size;PDDoc pdDoc;PDPrintParams params;/* CONTROL STRUCTURE: Print methods called in this order */DocBegin;DocSetup;EndSetup;NotifyNewPage;PageBegin;PageSetup;PageSetupPostResource;PageCleanup;EmitPageContents;PageEnd;DocEnd;/* END OF CONTROL STRUCTURE */PDPrintGetFontEncodingMethodProc GetFontEncodingMethod;GetFontVMUsage;EmitPSFontBegin;EmitPSFontEnd;EmitPSFontEncodingBegin;EmitPSFontEncodingEnd;EmitPSResourceBegin;EmitPSResourceEnd;ShouldCancelCancelPrintJobFlushString;EmitPrologString;PDPrintEmitPrologResourceProc EmitPrologResource;PDPrintCanEmitFontProc CanEmitFont;PDPrintEmitFontProc EmitFont;EmitFontProcSet;EmitGlyphsIncr;GetComponentFontList;FlushIncrGlyphList;OPIhandler;DataSourceString;PDF Library Supplement to the Acrobat Core API Reference 119

PDF Library-specific DeclarationsPDPrintClientASInt32 sequentialPageNum;void* clientData;void* fontDownloadContext;ASInt32 vmUsed;} PDPrintClientRec, *PDPrintClient;DescriptionData structure used by PDDocPrintPages. Contains methods to be implemented by theclient. Unless otherwise indicated, methods may be NULL, indicating that they do nothing.The methods are called in the order listed in this structure.Header FilePDFLExpT.hRelated MethodsPDDocPrintPagesPDFontPSEmitGlyphsIncrPDFontPSFlushIncrGlyphListPDFontPSGetComponentFontListMemberssizepdDocparamscallbacksSize of the structure.The document to print.A control structure describing how to print thedocument.See individual descriptions.sequentialPageNum Current page, starting at 1.clientDatafontDownloadContextvmUsedData for the client's use. This data is passed to theOPIhandler and DataSourceString methods.For client's use to hold a font download context for theEmitFontProcSet.Amount of virtual memory used. Incremented byroutines that download fonts and resources.PDF Library Supplement to the Acrobat Core API Reference 120

PDF Library-specific DeclarationsPDPrintFontArrayPDPrintFontArrayPDPrintFontArrayPtypedef struct{ASUns32 count;ASBool usesDisplayCTFont;PDPrintFontP arr;} PDPrintFontArray, *PDPrintFontArrayP;DescriptionAn array of font pointers for use in PDFontPSGetComponentFontList.Header FilePDFLExpt.hRelated MethodsPDFontPSGetComponentFontListMemberscountusesDisplayCTFontarrThe number of fonts in arr.Whether to use the Display CT Font.The font array.PDF Library Supplement to the Acrobat Core API Reference 121

PDF Library-specific DeclarationsPDPrintFontPPDPrintFontPPDPrintFontRecDescriptionFont array.typedef struct{const char *name;const char *encoding;const char *cidFontName;ASInt16 style;PDFontStyle syntheticStyle;ASBool used;ASBool emitted;ASInt32 baseLineAdj;} PDPrintFontRec, *PDPrintFontP;Header FilePDFLExpt.hRelated TypePDPrintFontArrayMembersnameencodingcidFontNamestylesyntheticStyleusedemittedbaseLineAdjThe font name.The font encoding.CID font name.Gothic or MinchoRoman, Italic, Bold, or BoldItalic.Set to true if glyphs from this component are used.Set to true if this component is emitted.Baseline adjustment.PDF Library Supplement to the Acrobat Core API Reference 122

PDF Library-specific DeclarationsPDPrintParamsPDPrintParamsPDPrintParamsRectypedef struct {ASSize_t size;PDPageRange* ranges;ASInt32 numRanges;ASBool shrinkToFit;ASBool expandToFit;ASBool rotateAndCenter;ASBool emitAnnotForms;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 emitRawData;ASBool TTasT42;float scale;ASBool emitExternalStreamRef;ASBool emitHalftones;ASBool centerCropBox;ASBool emitSeparableImagesOnly;ASBool emitExtGState;ASFixedRect boundingBox;ASBool useFontAliasNames;ASBool emitPageRotation;PDF Library Supplement to the Acrobat Core API Reference 123

PDF Library-specific DeclarationsPDPrintParams/* New for PDF 1.3 */ASBool emitBBoxClip;ASBool reverse;ASFixedRect* tCropBox;ASBool emitPageClip;ASBool emitTransfer;ASBool emitBG;ASBool emitUCR;PDFarEastFont farEastFontOpt;ASBool suppressCJKSubstitution;float flexoX;float flexoY;ASBool suppressCSA;ASBool hostBased;ASAtom hostBasedOutputCS;PDDuplexEnum duplex;PDTile tileInfo;ASBool rotate;ASBool hostBasedCM;char destProfile[256];ASAtom destCSAtom;ASBool saveVM;ASInt32 transQuality;ASBool doOPP;ASBool optimizeForSpeed;ASBool brokenCRDs;ASBool useMaxVM;ASInt32 lastWidth;ASInt32 lastHeight;/* New for PDF 1.4 */ASUns32 bitmapResolution;ASUns32 gradientResolution;ASUns32 transparencyQuality;PDOCContext ocContext;ASBool applyOCGPrintOverrides;ASBool useFullResolutionJP2KData;ASBool emitInRipSeps;PDPageMarkFlags whichMarks;ASBool westernMarksStyle;ASBool doProofing;ASBool useExecForm;PDFlatten flattenInfo;ASBool negative;PDF Library Supplement to the Acrobat Core API Reference 124

PDF Library-specific DeclarationsPDPrintParamsASEnum8 mirrorprint;ASUns32 numCollatedCopies; /* MacOS only */} PDPrintParamsRec, *PDPrintParams;DescriptionData structure indicating how a document should be printed.N OTE:All fields in the PDPrintParams structure apply only to PostScript file creation.PDPrintParams are ignored when printing to non-PostScript devices.Header FilePDFLExpT.hRelated MethodsPDFLPrintDocMemberssizerangesnumRangesshrinkToFitexpandToFitrotateAndCenteremitAnnotFormsemitPSSize of the data structure. Must be set tosizeof(PDPrintParams).Ranges of pages to print. Use NULL to print theentire document.Number of ranges of pages to print in ranges.The default value is 0.true if the page is scaled to fit the printer pagesize, false otherwise. This field overridesscale. The default value is false.true if small pages are to be scaled up to fit theprinter page size, false otherwise. Overridesscale. The default value is false.true if page is to be rotated to fit printer’sorientation, and centered in 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 fiton a narrow page (or vice versa) and the pagecontents are less than an inch smaller than thetarget page in one direction.Emit annotations that contain a Form XObject.The default value is true.If true, emit a PostScript file. The default value istrue.PDF Library Supplement to the Acrobat Core API Reference 125

PDF Library-specific DeclarationsPDPrintParamspsLevel PostScript level: 1, 2, or 3. The default value is 2.outputTypePrint PostScript or EPS with or without a preview.N OTE: EPS preview generation is not currentlyavailable on UNIX.N OTE: For fonts, the following 6 parameters are applied in the order in which they areappear in this table. For example, an embedded Type 1 font follows the rule forembedded fonts, not the rule for Type 1 fonts.incBaseFontsincEmbeddedFontsincType1FontsincType3FontsincTrueTypeFontsincCIDFontsincProcsetsincOtherResourcesfontPerDocVMemitShowpageEmbed the base fonts. The default value iskIncludeNever.Embed fonts that are embedded in the PDF file.This overrides the incType1Fonts,incTrueTypeFonts, and incCIDFontsfields. The default value iskIncludeOncePerDoc.Embed Type 1 fonts. The default value iskIncludeOncePerDoc.Embed Type 3 fonts. The default value iskIncludeOnEveryPage.N OTE: This parameter must always be set tokIncludeOnEveryPage. PDF files existwith Type 3 fonts that contain differentencodings on different pages.Embed TrueType fonts. The default value iskIncludeOncePerDoc.Embed CID fonts. The default value iskIncludeOncePerDoc.Include Procsets in the file. The default value iskIncludeOncePerDoc.Include all other types of resources in the file. Thedefault value is kIncludeOncePerDoc.Amount of VM available for font downloading atthe document level. Ignored if

PDF Library-specific DeclarationsPDPrintParamsemitTTFontsFirstsetPageSizeemitDSCsetupProcsetsemitColorSepsbinaryOKemitRawDataEmit TrueType fonts before any other fonts. Thedefault value is false.(PostScript level 2 only) Set the page size on eachpage. Use the media box for outputting toPostScript files, use the crop box for EPS files.Default is false.Write DSC (Document Structuring Conventions)comments. The default value is true.If procsets are included, also include init/termcode. The default value is true.N OTE: This must be set to true for the toolkit.Emit images for Level-1 separations. The defaultvalue is false.true if binary data is permitted in the PostScriptfile, false otherwise. The default value is true.true if add no unnecessary filters when emittingimage data, false otherwise. The default valueis true.TTasT42 If including TrueType fonts, convert to Type 42fonts instead of Type 1 fonts. The default value isfalse.scaleemitExternalStreamRefemitHalftonescenterCropBoxemitSeparableImagesOnlyemitExtGStateDocument-wide scale factor. 100.0 = full size. Thedefault value is 100.If an Image resource uses an external stream, emitcode that points to the external file. The defaultvalue is false.N OTE: This must be set to false.Preserve any halftone screening in the PDF file.The default value is false.true if CropBox output is centered on the pagewhen the CropBox < MediaBox, falseotherwise. The default value is true.If emitting EPS, include only CMYK and grayimages.Omit all extended graphic state parameters. Thisoverrides emitHalftones. If false, halftones arenot emitted. The default value is true.PDF Library Supplement to the Acrobat Core API Reference 127

PDF Library-specific DeclarationsPDPrintParamsboundingBoxuseFontAliasNamesemitPageRotationemitBBoxClipreversetCropBoxemitPageClipemitTransferemitBGemitUCRfarEastFontOptsuppressCJKSubstitutionIf all zeroes, is ignored. Otherwise, is used for%%BoundingBox DSC comment and incenterCropBox calculations and forsetpagedevice. The default value is [0 0 0 0].Used when printing with system fonts. Thedefault value is false.Emit a concat at the beginning of each page sothat the page is properly rotated. Used whenemitting EPS. The default value is false.If true, emit a clipping box the size of thebounding box when printing an EPS file. This fixesproblems with EPS files from certain applications.If set to true, reverse the order of page output.Temporary crop box to represent selected region.Emit page clip.Emit transfer.Emit black generation.Emit undercolor removal.GDI to PS or download CJK fonts.If true, do not do CJK substitution on the printer.This has an impact only whenfarEastFontOpt isPDPDFarEastFont_Download_None.flexoX X, Y scale factors for anamorphic scaling. “flexo”flexoYrefers to a market that prints on plastic media thatstretches (e.g., toothpaste tubes)suppressCSAhostBasedhostBasedOutputCSduplextileInfoDon't emit CSAs for 4 component (CMYK) colors.For separator, do host-based color management.The output color space when hostBased colormanagement is true.For compatibility with IronCity.If non-NULL, tiling is desired with theseparameters.PDF Library Supplement to the Acrobat Core API Reference 128

PDF Library-specific DeclarationsPDPrintParamsrotatehostBasedCMdestProfile[256]destCSAtomsaveVMtransQualitydoOPPoptimizeForSpeedbrokenCRDsuseMaxVMlastWidthlastHeightEnable the auto-rotating behavior from pastversions of Acrobat.Default: false, do CSA generation for profilesinstead of converting all colors on the host.If hostBase color management is true, use thisprofile.An ASAtom representing the device color space(DeviceGray, DeviceRGB, etc.)true means try to save VM when printing toPostScript.Parameters for the flattener, 1 - 5, similar to whatIllustrator does.Do the overprint preview operation.If true, do it fast; false means PostScript codemust be page independent. If set to true, fontdownloads are forced fromkIncludeOnEveryPage tokIncludeOncePerDoc (see PDFLExpT.h)If true, don't set rendering intent in PostScriptstream due to broken non-default CRDs.If true, store all possible resources in VM.Used when setPageSize is true to preventunneeded setpagedevice calls.Used when setPageSize is true to preventunneeded setpagedevice calls.bitmapResolution DPI for bitmaps. Default is 300.gradientResolutionDPI for gradients interior to the object (notedges). Can generally be lower than thebitmapResolution. Default is 150.transparencyQuality The transparency level. Range is 1-100.ocContextapplyOCGPrintOverridesThe optional-content context to use for visibilitystate information, or NULL to use the document'scurrent states in the default context.When true, apply print-specific visibility statesettings from the optional-content group.PDF Library Supplement to the Acrobat Core API Reference 129

PDF Library-specific DeclarationsPDPrintParamsuseFullResolutionJP2KDataemitInRipSepswhichMarkswesternMarksStyledoProofinguseExecFormflattenInfonegativemirrorprintnumCollatedCopiesWhether to use the maximum available JPEG2000resolution.When true, requests that separations, one sheetper ink, be generated in the RIP (printer).Page mark indication. A bit-wise OR of thePDPageMarkFlags values.Applies to print separations, which are availableonly in Adobe Acrobat Professional.When true, use western style for page marks.Applies to print separations, which are availableonly in Adobe Acrobat Professional.When true, print using proofing settings.When true, emit execform calls when emittingForm XObjectsA structure containing parameters that controltile flattening.When true, invert the plate.One of the following constants:kPDPrintFlipNone = 0x01,kPDPrintFlipX = 0x02,kPDPrintFlipY = 0x04,kPDPrintFlipXY = 0x08Mirroring is done in the PostScript output stream.MacOS only. Enables collation for viewer.PDF Library Supplement to the Acrobat Core API Reference 130

PDF Library-specific DeclarationsPDPrintStrPDPrintStrPDPrintStrPtypedef struct{char *str;ASUns32 len;ASRealPoint *displacements;ASUns32 numGlyphs;ASUns32 flags;} PDPrintStr, *PDPrintStrP;DescriptionStructure for controlling the printing of glyphs.Header FilePDFLExpT.hRelated MethodsPDFontPSEmitGlyphsIncrMembersstrlendisplacementsnumGlyphsflagsThe string.Byte length.Displacements.Number of glyphs.Reserved for internal use.PDF Library Supplement to the Acrobat Core API Reference 131

PDF Library-specific DeclarationsTKAllocatorProcsTKAllocatorProcsTKAllocatorProcsPtypedef struct _t_TKAllocatorProcs {ASMemAllocProc allocProc;ASMemReallocProc reallocProc;ASMemFreeProc freeProc;ASMemAvailProc memAvailProc;void* clientData;} TKAllocatorProcs, *TKAllocatorProcsP;DescriptionStructure for memory allocation callbacks used by the PDF Library.Header FilePDFInit.hRelated MethodsPDFLInitMembersallocProcreallocProcfreeProcmemAvailProcclientDataCalled when the PDF Library needs to allocate memory.Called when the PDF Library needs to reallocate a block of memory.Called when the PDF Library needs to free a block of memory.Called when the PDF Library needs to determine the amount ofmemory available.A pointer to data to pass into each of the memory managementcallbacks.PDF Library Supplement to the Acrobat Core API Reference 132

PDF Library-specific DeclarationsTKExtensionProcsTKExtensionProcsTKExtensionProcsPtypedef struct _t_TKExtensionProcs {ASExtensionProgressProc progressProc;ASExtensionReportErrorProc reportErrProc;void *clientData;} TKExtensionProcs, *TKExtensionProcsP;DescriptionStructure containing function pointers for ASExtension callbacks used by the PDFLibrary.Header FilePDFInit.hRelated MethodsPDFLInitMembersprogressProcreportErrProcclientDataCalled when the PDF Library needs to allocate memory.Called when the PDF Library needs to reallocate a block ofmemory.A pointer to data to pass into each of the memory managementcallbacks.PDF Library Supplement to the Acrobat Core API Reference 133

PDF Library-specific DeclarationsTKResourceProcsTKResourceProcsTKResourceProcsPtypedef struct _t_TKResourceProcs {TKResourceAcquireProc acquireProc;TKResourceReleaseProc releaseProc;void* clientData;} TKResourceProcs, *TKResourceProcsP;DescriptionStructure for resource acquisition callbacks used by the PDF Library.Header FilePDFInit.hRelated MethodsPDFLInitMembersacquireProcreleaseProcclientDataCalled when the PDF Library needs to acquire resources.Called when the PDF Library needs to release resources.A pointer to data to pass into every call to the PMSetTextProc orTKResourceReleaseProc as the clientData argument.PDF Library Supplement to the Acrobat Core API Reference 134