LayerPDF_Library
ObjectGeneral

General PDF Library constructs.



Define Summary
 Define
 ATTR_AcceptCertWithoutCheck
 ATTR_DirCertificates
 ATTR_DirEmail
 ATTR_DirFirstName
 ATTR_DirFullName
 ATTR_DirLastName
 ATTR_DirPrefEncryptionCert
 AVPS_MAC_ROMAN_ENC
Encoding identifiers (for TE).
 AVPS_WIN_ANSI_ENC
 BeginWebProgress
 CatalogHFT_LATEST_VERSION
 CatalogHFT_NAME
 CatalogNUMSELECTORS
 CatalogRealHFT_NAME
 ConsStackGetCount
 ConsStackIndexGetArrayIndex
 ConsStackIndexGetDictKey
 ConsStackIndexGetObj
 ConsStackIndexGetTypeAt
 ConsStackIndexGetTypeCount
 ConsStackIndexIsArray
 ConsStackIndexIsDict
 ConsultantCreate
 ConsultantDestroy
 ConsultantGetNumDirectVisited
 ConsultantGetNumIndirectVisited
 ConsultantGetNumUniqueIndirectsVisited
 ConsultantGetPercentDone
 ConsultantNeverVisitObj
 ConsultantNextObj
 ConsultantNUMSELECTORS
 ConsultantRegisterAgent
 ConsultantResume
 ConsultantSetStart
 ConsultantSuspend
 ConsultantTraverseFrom
 EndWebProgress
 GetAppSpecifier
 include
 Init_CatalogHFT
 Init_gWLHFT
 Init_PDFConsultantHFT
 Init_SearchHFT
 Init_SpellerHFT
 iNumPDFObjTypes
 kAddIndexFailed
 kDirDirectoryTooLargeToList
Retrieve all entries in the specified groups. If that would take too long, return kDirDirectoryTooLargeToList. This may be used in the user interface to immediately display the contents of a small directory or group, so responsiveness is important.
 kIndexAvailableFlag
The index is available for searching.
 kIndexExists
 kIndexPtrInvalidFlag
(Read only - cannot be set)
 kIndexSelectedFlag
The index is used for searching.
 kParserCQL
 kParserSimple
 kPDFLVersion
 kSCparam_LATEST_VERSION
 kSCparam_VERSION_1
 kSCparam_VERSION_2
 kSCparam_VERSION_3
 kSearchBookmarks
SearchWordOptions
 kSearchDocInfo
SearchWordOptions
 kSearchDocumentText
SearchWordOptions
 kSearchDocumentXMP
SearchWordOptions
 kSearchEveryWhere
SearchWordOptions
 kSearchJPEGExif
SearchWordOptions
 kSearchMarkup
SearchWordOptions
 kSearchPDFAttachments
SearchWordOptions
 kSearchSignatures
SearchWordOptions
 kSearchUserProperties
By including the kSearchUserProperties option, you will ensure that the object level data is the same as that seen by the menu item Object Data Tool in Acrobat. This is not the metadata associated with individual COS level objects in the PDF document.
 kSecFalse
 kSecOk
 kSecTrue
 kSpellLastBuffer
 kSpellMaxName
 kSpellNotLastBuffer
 kWordOptionCase
The search is case-sensitive.
 kWordOptionIgnoreDiacritics
SearchWordOptionsFlags
 kWordOptionIgnoreFH
SearchWordOptionsFlags
 kWordOptionProximity
Consider the proximity of results when using the AND operator to look for more than one word in a document. Without this option, ANDed terms can be anywhere in a document. Searching for "red" and "blue", for example, finds a document where "red" is the first word on the first page and "blue" is the last word on the last page. With this option, however, ANDed terms must be within two or three pages of each other to be found. Also, the closer ANDed terms appear together, the higher the relevance ranking of the document that contains them.
 kWordOptionRefine
Do not search the entire list of indices, but only the documents that matched the previous search. This is used to refine the results of the previous search.
 kWordOptionStemming
Find not only the specified word, but other words that have the same stem (for example, run and ran have the same stem).
 kWordOptionWholeWord
SearchWordOptionsFlags
 PDFCONSULTANT_HFT_LATEST
 PDFCONSULTANT_HFT_NAME
 PDFCONSULTANT_HFT_VER_1
 PDFCONSULTANT_HFT_VER_2
 PDFCONSULTANT_HFT_VER_3
 PDFCONSULTANT_REAL_HFT_NAME
 _PDFLHFT_IS_BETA
 _PDFLHFT_LAST_BETA_COMPATIBLE_VERSION
 _PDFLHFT_LATEST_VERSION
 PDFLHFT_LATEST_VERSION
 PDFLHFTName
 PDFLHFT_VERSION_10
 PDFLHFT_VERSION_5
 PDFLHFT_VERSION_6
 PDFLHFT_VERSION_7
 PDFLHFT_VERSION_7_1
 PDFLHFT_VERSION_7_5
 PDFLHFT_VERSION_8
 PDFLHFT_VERSION_9
 PDFL_VERSION
 PDFObjTypeGetSuperclass
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PIPROC
 PROGRESS_HAS_CANCEL
Add either a Cancel button or a message directing the user how to abort the operation.
 PROGRESS_HAS_METER
Put a thermometer-style meter in the progress display.
 PROP_DirectoryInfo_DirHandlerID
 PROP_DirectoryInfo_DirType
 PROP_DirectoryInfo_ID
 PROP_DirectoryInfo_Name
 PROP_DirectoryInfo_Version
 RegisterWebDriver
 REQUIRES_CLASSIFY
Modes that an agent must pass to the PDF Consultant to define behavior when the RegisterAgent function is called.
 SearchHFT_LATEST_VERSION
 SearchHFT_NAME
 SearchNUMSELECTORS
 SpellerHFT_LATEST_VERSION
 SpellerHFT_NAME
 SpellerHFT_VERSION_1_1
 SpellerHFT_VERSION_1_2
 SpellerHFT_VERSION_1_3
 SpellerNum_SEL
 UpdateWebProgress
 WDVCURRENTREV
 WEB_LINK_HFT_LATEST_VERSION
 WebLinkNUMSELECTORS
 WebProgressDidCancel
 WLCreateOrDeleteWebLinks
 WLHFTNAME
 WWWOpenURL
 WWWOpenURLWithParams
Typedef Summary
 Typedef
 ASMemAllocProc
 ASMemAvailProc
 ASMemFreeProc
 ASMemReallocProc
 ConsStack
An opaque traversal stack object. The ConsStackXXX methods allow retrieval of individual members of the PDFObjType and CosObj stacks associated with a Consultant object.
 Consultant
The opaque type to allow programs to retain handles to create PDF Consultant and Accessibility Checker objects.
 ConsultantAgent
 ConsultantAgentAction
 DirAttributes
A directory attribute collection is used to set output options of a directory connection.
 DirConnection
 DirConnectionHandler
 DirConnectionRec
 DirectoryInfo
A directory information structure contains configuration settings used to establish a connection to a directory. Common top-level properties are defined below. Note that the prefix DirStdEntry_ is reserved for standard entries and should not be used for entries specific to a particular directory. Optionally, this could contain other configuration information specific to the directory.
 DirGroupList
Group names are represented as text in an ASCab. For example:
 DirResults
Search and enumeration results are represented as a two-dimensional ASCab where each "row" is itself an ASCab that contains attributes defined by SetOutputOptions calls.
 DirSearchCriteria
Directory search criteria are represented as a set of key/value pairs where the keys are attribute names and the values are search strings applied to those attributes. A logical "AND" is implied when multiple search criteria are present. Unrecognized search criteria are ignored.
 HyphenationRecord
 HyphenationRecordPtr
 InitProcs
 InitProcsP
 MonoInkList
 PDFlatten
 PDFLData (Macintosh)
 PDFLData (UNIX)
 PDFLData (Windows)
 PDFLDataRec (Macintosh)
 PDFLDataRec (UNIX)
 PDFLDataRec (Windows)
 PDFLMemStats
 PDFLPrintUserCallbacks
 PDFLPrintUserCallbacksRec
 PDFLPrintUserParams
Declare the the type PDFLPrintUserParams, which is a pointer to a structure and is passed into PDFLPrintDoc. This structure is defined in PDFLPrint.h , but it is complex and platform-specific. This declaration avoids the need to include the platform specific details into files that just need a decaration of this pointer.
 PDFLPrintUserParamsEx
 PDFLPrintUserParamsRec (Macintosh)
 PDFLPrintUserParamsRec (UNIX)
 PDFLPrintUserParamsRec (Windows)
 PDFLPrintUserParamsRecEx (Windows)
 PDFObjID
 PDFObjType
A type corresponding to the enum defined in ConsObTp.h . This type is used to refer to specific object types in PDF. It is specifically used by Agents to make object requests of the framework, and is used by the framework to report the types of objects found.
 PDInclusion
Specifies how to include a resource in a file.
 PDPrintClient
A data structure used by PDDocPrintPages(). It contains methods to be implemented by the client. Unless otherwise indicated, methods may be NULL, indicating that they do nothing. The methods are called in the order listed in this structure.
 PDPrintClientRec
 PDPrintController
 PDPrintFontArrayP
 PDPrintFontP
 PDPrintParams
 PDPrintStrP
 PlatformBitmapPtr (Windows)
 PlatformWindowPtr (Windows)
 PPDFeaturesP
 PPDFeaturesRec
 RegAgentFlag
 SearchIndexListPtr
 SearchIndexPtr
 SearchQueryDataRec
 SearchScope
 SearchSelector
 SearchWordOptions
The client must supply all the search word options in the scope parameter by doing an OR (|) operation on all options where the search needs to be executed. For example, if the client needs to search on attachments, and within attachments the search needs to be done on document text and XMP data, then it can be specified as follows:
 SecErrorInfo
 SecErrorInfoRec
 SecRetCode
Error handling
 SpellCheckParam
This parameter block is used for communication between the Spelling plug-in and a client plug-in. The client must allocate it, initialize all fields, and pass it to the Spelling plug-in when adding a domain with SpellAddDomain(). Spelling passes it back to the client when the SCEnableProc(), SCGetTextProc(), and SCCompletionProc() are called. It is passed to the client's SCGetTextProc() from the Spelling plug-in when it needs to request a text buffer from the client. After the user has completed the spell check on the scInBuffer, this same parameter block is passed to the client's SCCompletionProc() with the result of the spell check in scOutBuffer. When the SCGetTextProc() is called, scPageNum, scIndex and scAVDoc are filled in by the Spelling plugin.
 SpellCheckParamPtr
 TermProcs
 TermProcsP
 TextList
 TextServer
Text server.
 ThreadLocalKey (Macintosh)
PDFLData structure for PDFLInit.
 ThreadLocalKey (UNIX)
PDFLData structure for PDFLInit.
 ThreadLocalKey (Windows)
PDFLData structure for PDFLInit.
 TIFFASCIITagList
 TKAllocatorProcs
 TKAllocatorProcsP
 TKExtensionProcs
 TKExtensionProcsP
 TKResourceProcs
 TKResourceProcsP
 WDAppSpecifier (Macintosh)
A data structure that specifies the path name to the web browser.
 WDAppSpecifier (UNIX)
A data structure that specifies the path name to the web browser.
 WDAppSpecifier (Windows)
A data structure that specifies the path name to the web browser.
 WDAppSupportPredicate
Tests whether a driver can support a given web browser application.
 WDBecomeDriverFunction
Called whenever the state of the driver changes from inactive to current, or vice versa.
 WDBringFrontFunction
Called when the user clicks on the Weblink toolbar button to switch to the browser application.
 WDFollowLinkFunction
Follows and retrieves the link specified by a URL from the PDF document specified by theDoc. Weblink supplies the driver a fully resolved the URL. The driver is solely responsible for launching a web browser, if it requires one. If the driver depends on an external web browser, the driver or the web browser is responsible for bringing that browser to the foreground if the link data is not displayed by the Acrobat viewer.
 WDFollowLinkWithParamsFunction
Follows and retrieves the link specified by a URL from the PDF document specified by theDoc, going to a target frame. Weblink supplies the driver a fully resolved the URL. The driver is solely responsible for launching a web browser, if it requires one. If the driver depends on an external web browser, the driver or the web browser is responsible for bringing that browser to the foreground if the link data is not displayed by the Acrobat viewer.
 WDIsDriverBusyFunction
(Optional) Called to determine if the driver is performing a transaction. Weblink uses this to check that the driver is not busy (driver-defined) before allowing a user to change preferences.
 WDOptionsFunction
(Optional) Called when the user clicks the Options button in the Weblink Preferences dialog box. If this function is NULL, the Options button is disabled.
 WebProgressMonitor
A data structure that implements a progress monitor.
 WWWOpenURLParams
Enumeration Summary
 Enumeration
  _SearchSelector
  ALDImageColorType
OPI 1.3 color type information.
  anoncathft25
  anonConsHFT27
  anonWLHFT31
  CatalogStatus
Return values for the current state of Catalog. If Catalog is currently busy performing some operation, it returns the relevant state, which could be CatalogBuilding, CatalogPurging, or CatalogWaiting.
  eHyphenType
The types of hyphenations.
  ImageInk
OPI 2.0 image ink information.
  IndexStatus
Return values for the current state of the Index after a call to Purge, Build, or Load an index.
  OPIversion
OPI Types for PostScript printing.
  PDDuplexEnum
Duplex values.
  PDEncodingType
Font encoding methods.
  PDFarEastFont
CJK font related option for PostScript printing.
  PDFlattenTilingMode
Support for tiled flattening
  PDFLFarEastFont
  PDFLInitFlags
Flags for PDFLInit
  PDFLPrefDrawSmoothFlags
Bit flags that set the default smooth text and smooth images global flags for subsequent rendering methods. These flags are passed to the PDPrefSetAntialiasLevel, and are similar to PDPageDrawSmoothFlags.
  PDFLProcSetIDs
ProcSet identifiers used to specify which procsets must be downloaded.
  PDFLSingleByteFont
Font array.
  PDOutputType
Specifies what kind of file to emit.
  PDPrintMarkStyles
  PDPrintTrapType
  PDRefXObjMode
Modes used to control the display of reference XObjects.
  SearchMatchOption
Search Match Options
  SearchType
  SpellDialogResult
Possible results of the spell check when the SpellCheck() method is called.
  SpellDomainFlags
SpellingDomainFlags Valid values for the scFlags field of the SpellCheckParam block. For Acrobat 5 and higher, all clients should set this field to kSpellFlagAllDomain. All other bits in this flag are reserved for future use. The spelling client's private data and flags can be stored in the scClientData field.
  tagConsultantAgentAction
Bit flags that instruct the Consultant about how to handle a found object. A logical OR of these values should be returned by the ObjFound callback.
  tagPDFObjType
  tagRegAgentFlag
Constants that specify an operation mode for the Consultant. This value determines whether and how often the Consultant should revisit objects that have been previously encountered.
Variable Summary
 Variable
 gCatalogHFT
 gConsultantHFT
 gSearchHFT
 gSpellerHFT
 gWLHFT
Structure Summary
 Structure
 _t_DirConnection
A directory connection object structure.
 _t_HyphenationRecord
The hyphenation record.
 _t_InitProcs
 _t_monoInkList
Image ink monochrome list.
 _t_PDFLData (Macintosh)
PDFLData structure.
 _t_PDFLData (UNIX)
PDFLData structure.
 _t_PDFLData (Windows)
 _t_PDFLMemStats
 _t_PDFLPrintUserCallbacks
The structure holding pointers to certain optional Callbacks available with the PDFLPrintDoc() API.
 _t_PDFLPrintUserParams (Macintosh)
Used to control printing with PDFLPrintDoc.
 _t_PDFLPrintUserParams (UNIX)
Used to control printing with PDFLPrintDoc.
 _t_PDFLPrintUserParams (Windows)
Used to control printing with PDFLPrintDoc.
 _t_PDFLPrintUserParamsEx (Windows)
Used to control the emitting of PPD dependent features to a PostScript file when printing with PDFLPrintDoc. These features are emitted only if emitToFile is set to true. Please see PDFLPrintDoc for more details.
 _t_PDPrintClient
A data structure used by PDDocPrintPages. It contains methods to be implemented by the client. Unless otherwise indicated, methods may be NULL, indicating that they do nothing. The methods are called in the order listed in this structure.
 _t_PPDFeatures
Used to control the emitting of PPD dependent features to a PostScript file when printing with PDFLPrintDoc. These features are emitted only if emitToFile is set to true. Please see PDFLPrintDoc for more details.
 _t_SearchQueryDataRec
 _t_SecErrorInfo
If a function returns -1 or less, you can call a GetLastError appropriate to the context and retrieve information about the last error. That call may return NULL which basically means "Unknown Error". Note that in the presence of threads, the error information may become inaccurate.
 _t_TermProcs
 _t_textList
List structure used in TIFFASCIITagList.
 _t_TIFFASCIITagList
TIFF ASCII tags.
 _t_TKAllocatorProcs
A structure for memory allocation callbacks used by the PDF Library.
 _t_TKExtensionProcs
A structure containing function pointers for ASExtension callbacks used by the PDF Library.
 _t_TKResourceProcs
Structure for resource acquisition callbacks used by the PDF Library.
 ImageInks
Image inks.
 OPI13dict
OPI 1.3 dictionary.
 OPI20dict
OPI 2.0 dictionary.
 OPIdict
OPI dictionary.
 PDFlattenRec
Controls tile flattening. It is primarily of interest to resource limited (embedded) systems developers.
 PDPrintFontArray
An array of font pointers for use in PDFontPSGetComponentFontList.
 PDPrintFontRec
 PDPrintParamsRec
A data structure indicating how a document should be printed.
 PDPrintStr
A structure for controlling the printing of glyphs.
 SpellCheckParam
Spell Check parameters This parameter block is used for communication between the Spelling plug-in and a client plug-in. The client must allocate it, initialize all fields, and pass it to the Spelling plug-in when adding a domain with SpellAddDomain. Spelling passes it back to the client when the SCEnableProc(), SCGetTextProc(), and SCCompletionProc() are called.
 tagConsultantAgent
 tagPDFObjID
During traversal, the Consultant checks the Agent's list of object types of interest to see if the Agent is interested in the current object, and it calls the callback function pointers when objects of interest are found and when traversal is complete.
 WebDriverVector
A data structure containing callbacks that implement a Weblink driver.
 WWWOpenURLParamsRec
A parameter block specifying the target frame of a URL.
Callback Summary
 Callback
 ASClientAllocProc
Called when the PDF Library needs to allocate memory. The callback should allocate the requested amount of memory and return it as a void*.
 ASClientFreeProc
Called when the PDF Library needs to free memory. The callback should free the requested block of memory.
 ASClientMemAvailProc
Called when the PDF Library needs to determine the amount of available free memory.
 ASClientReallocProc
Called when the PDF Library needs to reallocate memory. The callback should reallocate the requested amount of memory and return it as a void*.
 ConsAgentObjFoundCallback
Returns a set of flags instructing the Consultant as to how to handle the current object. The Consultant calls this method when it recognizes the current object as a type which an Agent has declared to be interesting.
 ConsAgentPercentDoneCallback
The Consultant calls this method with progress updates. It can display a progress bar.
 ConsAgentPostProcessCallback
The Consultant calls this method when it is ready to finish a cycle. You should perform any document modifications assigned to your Agent at this point.
 DirConnection_close
Closes the specified directory connection.
 DirConnection_customSearch
 DirConnection_customUISearch
Pops up a custom user interface that allows the user to set search criteria and execute the search.
 DirConnection_getDirInfo
Retrieves information about the directory associated with the connection.
 DirConnection_getGroups
Retrieves the list of groups that this connection supports.
 DirConnection_list
TBD
 DirConnection_setCustomOutputOptions
TBD
 DirConnection_setStandardOutputOptions
Special case: The ATTR_Certificates attribute is intended to encompass all certificate attributes a directory might have. If ATTR_Certificates is requested, it may have to be translated into several attributes depending on the directory.
 DirConnection_standardSearch
TBD
 ExternalFilePermissionProc
 PDDoExtGStateProc
A callback method that is called when an ExtGState object is encountered. This method is called for each key/value pair in the ExtGState object. If this method returns true, then the key/value will be emitted into the print job. If this method returns false, then nothing will be emitted for this key/value. If emitHalftones is false, then this method will not be called for the HT key.
 PDFLClientRNGProc
A callback for PDFLibraryRegisterRNG(). It is called once to provide random data for encryption. Normally an operating system supplied source of highly random numbers is used (/dev/urandom on Mac OS and Unix, CryptGenRandom() on Windows). For some supported Unix environments, the /dev/urandom device does not exist. While it is preferable to install this device, the PDFLibraryRegisterRNG() function is provided for the client to register an alternate source for strong random data.
 PDFLGetCoreHFTType
 PDFLInitThreadLocalDataType
 PDFLInitType
 PDFLPrintCancelProc
This is called once per page of a document being printed.
 PDFLTermType
 PDPrintCanEmitFontProc
(Optional) A callback for PDPrintClient. It is called to determine whether a font can be emitted into the print job. This is used to determine whether a font is a document-included resource. Only used for PostScript printing.
 PDPrintEmitFontProc
(Required) A callback for PDPrintClient. It emits a font. For Type0 fonts that require font substition, this routine may emit multiple font definitions. The caller can get the list of fonts used by calling GetFontComponentList().
 PDPrintGetFontEncodingMethodProc
(Required for PostScript printing) A callback for PDPrintClient. It asks the client which encoding method should be used for the font.
 SCChangeProc
Called by the Spelling plug-in each time scOutBufferAStext is about to change. An SCChangeProc() is optional.
 SCCompletionProc
An SCCompletionProc() must be provided for each domain a plug-in registers with SpellAddDomain(). It is called by the Spelling plug-in when the user has completed the spell check.
 SCEnableProc
Called by the Spelling plug-in to determine whether the Spelling menu items and toolbar button should be enabled. An SCEnableProc() must be provided for each domain a plug-in registers with SpellAddDomain().
 SCGetTextProc
This procedure is called by Spelling to request a text buffer to be checked by the user in the Spelling dialog box.
 SCInitProc
 SCRTFChangeProc
Callback proc for SpellCheckRTF. This proc is called each time the user changes something in the original input buffer. This allows the caller of SpellCheckRTF() to track text changes to a rich text buffer and overlay the plain text change onto the rich text spans to perserve formatting.
 SCTermProc
 TKResourceAcquireProc
A callback in the TKResourceProcs structure in the Adobe PDF Library. It acquires the specified resource and uses it to fill in the rdStm parameter.
 TKResourceReleaseProc
A callback in the TKResourceProcs structure in the Adobe PDF Library. It releases the resources previously acquired and closes the ASStm passed in as rdStm.
Method Summary
 Method
 
ASInt32 ASAtomGetCount()
Gets the number of ASAtom objects that have been allocated. The maximum number of ASAtom objects is 0xFFFFFFFF. (This was a 16-bit value in Acrobat 4.x, and changed to a 32-bit value in Acrobat 5.0).
 
Gets the default temporary path that was set by ASFileSysSetDefaultTempPath().
 
Sets the default temporary path for the specified file system to the specified path name. The method copies the passed pathname object on success; the client is responsible for releasing the object when it is no longer needed, using ASFileSysReleasePath().
 
ASSize_t ASPurgeMemory(ASSize_t amount)
Attempts to free memory from the PDF Library caches.
 
void AVExtensionMgrRegisterNotification(NSelector nsel, ASExtension owner, void* proc, void* clientData)
Registers a user-supplied procedure to call when the event of the specified type occurs. This is exactly the same as the AVAppRegisterNotification() method. All of the PD level notifications are available with the Adobe PDF Library.
 
void AVExtensionMgrUnregisterNotification(NSelector nsel, ASExtension owner, void* proc, void* clientData)
Unregisters a user-supplied procedure to call when the specified event occurs. This is exactly the same as the AVAppUnregisterNotification() method.
 
ASBool GetRequestedHFT(const char* table, ASUns32 requiredVer, ASUns32* resultingVer, HFT* resultHFT)
 
Prints a range of pages from a document, controlled by a structure of data and callbacks.
 
ACEX1HFTACEX2 PDFLGetCoreHFT()
Gets the Core HFT.
 
ASUns32 PDFLGetFlags()
Gets the flags set when the PDF Library was initialized. Currently kPDFLInitIgnoreDefaultDirectories , kPDFLInitIgnoreSystemFonts and kDontLoadPlugIns flags are supported.
 
Gets the number of times the PDF Library has been initialized.
 
ASUns32 PDFLGetVersion()
Gets the value of the Adobe PDF Library version (kPDFLVersion). The most significant 16 bits are the major version number; the least significant 16 bits are the minor version number. The major version number indicates whether any incompatible API changes have been made. The minor version number indicates that the API has changed, but in a compatible fashion.
 
void PDFLibraryRegisterNotification(NSelector nsel, ASExtension owner, void* proc, void* clientData)
Registers a user-supplied procedure to call when the specified event occurs. This is exactly the same as the AVAppRegisterNotification method. All of the PD level notifications are available with the Adobe PDF Library.
 
void PDFLibraryRegisterNotificationEx(NSelector nsel, ASExtension owner, void* proc, void* clientData, ASInt32 priority)
Registers a user-supplied procedure to call when the specified event occurs.
 
Registers a user-supplied random number generator. By default, the PDF Library obtains high-quality random values from the operating system (CryptGenRandom() on Windows, and /dev/random on Mac OS and many UNIX operating systems). This method allows an alternate handler to be used. The random numbers returned should be of high quality, and it is the responsibility of the developer to ensure this. A NULL parameter will reset to default behavior.
 
void PDFLibraryUnregisterNotification(NSelector nsel, ASExtension owner, void* proc, void* clientData)
Unregisters a user-supplied procedure to call when the specified event occurs. This is exactly the same as the AVAppUnregisterNotification() method.
 
ACEX1ASInt32ACEX2 PDFLInit(PDFLData data)
Initializes the Adobe PDF Library. This method must be called before any other Library calls can be made, printing or otherwise.
 
ASInt32 PDFLInitCommon(PDFLData data, InitProcsP procs, os_size_t sizeHFTLocTab)
 
ASInt32 PDFLInitHFT(PDFLData data)
 
ASInt32 PDFLInitHFT(PDFLData data)
 
 
void PDFLPrintDoc(PDDoc doc, PDFLPrintUserParams userParams)
Prints a PDF document or pages from a PDF document allowing the caller to specify options such as page size, rotation, and shrink-to-fit.
 
Prints a PDF document or pages from a PDF document allowing the caller to specify options such as page size, rotation, and shrink-to-fit.
 
void PDFLPrintPDF(PDDoc pdDoc, ASPathName pathName, PDPrintParams psParams)
Deprecated: use PDFLPrintDoc() instead.
 
void PDFLTerm()
Terminates the Adobe PDF Library. Call this method after you are completely done using the library. Call this once to terminate and release memory used by the library. After the library has been shut down, the process should terminate.
 
void PDFLTermCommon(TermProcsP termProcs)
 
 
 
PDFontDownloadContext PDFontDownloadContextCreate(PDPrintClient client)
Creates a font download context object. This object keeps track of the fonts downloaded during a print job and whether substitution fonts have already been downloaded. It also tracks the font download parameters, such as binaryOK and 'emit TrueType as Type 42'. It is meant for use in the PDFontStreamPS() method.
 
Destroys a font download context object. Call this method after PDDocPrintPages() returns.
 
ASBool PDFontPSEmitGlyphsIncr(ASStm stm, PDFont fontP, PDPrintStrP srcStr, PDPrintStrP dstStr, ASUns32* srcBytesUsedP, ASUns32* dstBytesUsedP, ASUns32* glyphCount, ASUns16* fontIndexP, PDPrintClient printClient)
Emit glyphs incrementally. This is the default EmitGlyphsIncr callback procedure for the PDPrintClient structure.
 
Flush the incremental glyphs list from a stream. This is the default FlushIncrGlyphList callback procedure for the PDPrintClient structure.
 
Get the component font list. This is the default GetComponentFontList callback procedure for the PDPrintClient structure.
 
ASBool PDFontStreamPS(PDFont fontP, ASStm stm, PDFontDownloadContext context)
Emits a font into a specified stream. The font is in a format suitable for downloading to a PostScript VM. For example, a TrueType font is converted into a Type 1 or Type 42 font.
 
Tests whether the specified font is embedded in the PDF file and has already been extracted to display or print the file.
 
ASBool PDFontWasFauxed(PDFont font)
Tests whether the specified font is embedded in the PDF file or is installed in the user's system. If this is the case, the correct font can be used for display and printing.
 
void PDPageDrawContentsPlacedToWindow(PDPage page, void* window, void* displayContext, ASBool isDPS, ASFixedMatrix* matrix, ASFixedRect* updateRect, CancelProc cancelProc, void* cancelProcClientData)
Draws the page to the window or display context. The window and display context are implementation-dependent.
 
Draws the page to the window or display context. The window and display context are implementation-dependent.
 
ASInt32 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)
Superseded by PDPageDrawContentsToMemoryEx() in Acrobat 10.0.
 
ASUns32 PDPageDrawContentsToMemoryEx(PDPage page, ASCab flags, ASDoubleMatrix* matrix, ASDoubleRect* updateRect, ASAtom csAtom, ASInt32 bpc, ASDoubleRect* destRect, char* buffer, ASUns32 bufferSize, CancelProc cancelProc, void* cancelProcData)
Supersedes PDPageDrawContentsToMemory() in Acrobat 10.0.
 
void PDPageEmitPSOrient(PDPage pdPage, ASInt16 paperHeight, ASInt16 paperWidth, ASStm stm, PDPrintParams params)
Obsolete in PDF Library 6.0. Do not use.
 
void PDPageGetSize(PDPage page, ASFixed* width, ASFixed* height)
Returns the width and height of the page, which could be rotated or defaulted.
 
Returns the antialias level, in pixels.
 
Returns the black-point compensation flag.
 
Determines whether thin lines will be fattened non-linearly or the stroke adjust will be applied to thin rectangles.
 
Returns the greek level.
 
PDRefXObjMode PDPrefGetRefXObj(ASFileSys* fileSys, ASPathName* pathName)
Gets reference XObject parameters.
 
Returns the value of the suppress flag for ICC-based spaces with the specified number of components.
 
Returns the value of the Output Intent flag. When this flag is true, the system overrides the working space with the Output Intent, if it is present.
 
void PDPrefSetAntialiasLevel(ASInt16 antialiasPixelLevel)
Sets the default smooth text and smooth images global flags for subsequent rendering methods.
 
Sets the black-point compensation flag, which controls whether to adjust for differences in black points when converting colors between color spaces. When enabled, the full dynamic range 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).
 
Sets whether thin lines will be fattened non-linearly or the stroke adjust will be applied to thin rectangles.
 
void PDPrefSetGreekLevel(ASInt16 greekPixelLevel)
Sets the greek level. The greek level is a text height below which text characters are not rendered. Instead, text-like glyphs that have no meaning but look good at very small size are used. This is known as greeking.
 
void PDPrefSetRefXObj(PDRefXObjMode refXObjMode, ASFileSys fileSys, ASPathName pathName)
Sets reference XObject parameters.
 
void PDPrefSetSuppressICCSpaces(ASUns32 nComponents, ASBool value)
Specifies use of a default color space rather than an ICC-based color space.
 
void PDPrefSetUseLocalFonts(ASBool useLocalFonts)
Enables or disables use of local fonts.
 
Sets the Output Intent flag.
 
void PDPrefSetWorkingCMYK(void* profile, ASUns32 profileLength)
Sets the current CMYK working space to a given ICC profile. A CMYK working space in PDF is defined as a profile to substitute for a corresponding /DeviceCMYK space.
 
void PDPrefSetWorkingGray(void* profile, ASUns32 profileLength)
Sets the current gray working space to a given ICC profile. A gray working space in PDF is defined as a profile to substitute for a corresponding /DeviceGray space. When rendering with overprint preview, the gray substitution is suppressed, to avoid converting grayscale to "rich black."
 
void PDPrefSetWorkingRGB(void* profile, ASUns32 profileLength)
Set the current RGB working space to a given ICC profile. An RGB working space in PDF is defined as a profile to substitute for a corresponding /DeviceRGB space.
 
void PSPrintAfterBeginPageSetup(PDDoc doc, ASInt32 page, ASStm stm, void* clientData)
This notification is broadcast after the beginning of the Page Setup (immediately after writing %% BeginPageSetup) during the printing of a page to a PostScript printer with the methods PDFLPrintDoc() (only available with PDF Library SDK) or PDDocPrintPages() (only available with PDF Library SDK). At this point it is possible to use setpagedevice and set the graphics state but marks cannot be made on the page.
 
void PSPrintAfterBeginProlog(PDDoc doc, ASStm stm, void* clientData)
This notification is broadcast after the beginning of the PostScript Prolog (immediately after writing %% BeginPrologue) during the printing of a document to a PostScript printer with the methods PDFLPrintDoc() (only available with PDF Library SDK) or PDDocPrintPages() (only available with PDF Library SDK). The Prolog is a set of application-specific procedure definitions that an application may emit in a PostScript stream.
 
void PSPrintAfterBeginSetup(PDDoc doc, ASStm stm, void* clientData)
This notification is broadcast after the beginning of the Document Setup (immediately after writing %% BeginSetup) during the printing of a page to a PostScript printer with the methods PDFLPrintDoc() (only available with PDF Library SDK) or PDDocPrintPages() (only available with PDF Library SDK). During Document Setup, fonts may be downloaded, setpagedevice may be called, procsets may be initialized, the graphics state may be initialized, and so forth.
 
void PSPrintAfterEmitExtGState(ASStm stm, void* clientData)
This notification is broadcast after extended graphics state parameters are emitted while printing to a PostScript printer with the methods PDFLPrintDoc() (only available with the PDF Library SDK) or PDDocPrintPages() (only available with the PDF Library SDK).
 
void PSPrintAfterPageTrailer(PDDoc doc, ASInt32 page, ASStm stm, void* clientData)
This notification is broadcast after the page trailer is emitted (immediately after writing %% PageTrailer) during the printing of a page to a PostScript printer with the methods PDFLPrintDoc() (only available with PDF Library SDK) or PDDocPrintPages() (only available with PDF Library SDK). At this point it is possible to resolve comments (at end) and emit cleanup code.
 
void PSPrintAfterTrailer(PDDoc doc, ASStm stm, void* clientData)
This notification is broadcast after the DSC trailer is emitted (immediately after writing %% Trailer) during the printing of a page to a PostScript printer with the methods PDFLPrintDoc() (only available with PDF Library SDK) or PDDocPrintPages() (only available with PDF Library SDK). At this point it is possible to resolve comments (at end) and emit cleanup code.
 
void PSPrintBeforeAcrobatProcsets(PDDoc doc, ASStm stm, void* clientData)
Clients that register for this notification will be called back during PostScript printing, just prior to emission of the Acrobat procsets.
 
void PSPrintBeforeEndComments(PDDoc doc, ASStm stm, void* clientData)
This notification is broadcast after the DSC page-level comments that apply to all pages have been emitted (immediately before writing %% EndComments) during the printing of a page to a PostScript printer with the methods PDFLPrintDoc() (only available with the PDF Library SDK) or PDDocPrintPages() (only available with the PDF Library SDK).
 
void PSPrintBeforeEndSetup(PDDoc doc, ASStm stm, void* clientData)
This notification is broadcast before the end of Document Setup (immediately before writing %% EndSetup) during the printing of a page to a PostScript printer with the methods PDFLPrintDoc() (only available with PDF Library SDK) or PDDocPrintPages() (only available with PDF Library SDK). At this point all of the job level resources and procsets have been added to the print stream.
 
SearchIndexPtr SearchAddIndex(SearchIndexListPtr list, char* fullPath, ASUns32 flags)
Superseded in Acrobat 6.0 by SearchAddIndexEx().
 
SearchIndexPtr SearchAddIndexEx(SearchIndexListPtr list, ASFileSys fileSys, ASPathName indexPath, ASUns32 flags)
Supersedes SearchAddIndex() in Acrobat 6.0.
 
Gets the number of indices currently on the shelf.
 
ASInt32 SearchExecuteQuery(char* cQuery, ASInt16 nParserID, ASUns16 nSortCount, char** cSortNames, ASBool* bSortWays, ASUns32 nWordOptions, ASBool bOverrideWordOptions, ASUns16 nMaxDocs)
Superseded in Acrobat 6.0 by SearchExecuteQueryEx(), which allows a broader range of search locations.
 
ASBool SearchExecuteQueryEx(const SearchQueryDataRec* queryData)
Supersedes SearchExecuteQuery() in Acrobat 6.0.
 
SearchIndexPtr SearchGetIndexByPath(SearchIndexListPtr list, char* fullPath)
Superseded by SearchGetIndexPathEx() in Acrobat 6.0.
 
SearchIndexPtr SearchGetIndexByPathEx(SearchIndexListPtr list, ASFileSys fileSys, ASPathName indexPath)
Supersedes SearchGetIndexPath() in Acrobat 6.0.
 
Gets the file system for a specified index as an ASFileSys object.
 
Gets the flags for a specified index.
 
SearchIndexListPtr SearchGetIndexList()
Gets a list of the indices currently on the shelf.
 
Superseded in Acrobat 6.0 by SearchGetIndexPathEx().
 
Supersedes SearchGetIndexPath() in Acrobat 6.0.
 
Superseded in Acrobat 6.0 by SearchGetIndexTitleEx().
 
Supersedes SearchGetIndexTitle() in Acrobat 6.0.
 
Gets the nth index on the shelf. The index can be passed to other Search plug-in methods to remove it from the shelf, obtain its title, and so forth.
 
Tests whether the search mechanism (Search5) for previous Acrobat versions (prior to 6.0) is available for the current system. When Search5 is available, you can search indexes from Acrobat 5.0 and earlier.
 
Removes the specified index from the shelf.
 
Sets the flags for a specified index.
 
 
 
ASBool WDAppSupportPredicateProc(void* driverRock, WDAppSpecifier timeoutTime)
Callback functions to test a driver. It tests whether a driver can support a given web browser application.
 
ASBool WDBecomeDriverFunctionProc(void* driverRock, ASBool bComing)
Callback functions for driver state changes.
 
void WDBringFrontFunctionProc(void* driverRock)
Callback functions for Weblink toolbar button click.
 
ASBool WDFollowLinkFunctionProc(void* driverRock, AVDoc theDoc, char* cURL, char* cFormData)
Callback functions for to Follow a Link.
 
ASBool WDFollowLinkWithParamsFunctionProc(void* driverRock, AVDoc theDoc, char* cURL, char* cFormData, WWWOpenURLParams params)
Callback functions for to Follow a Link with parameters.
 
ASBool WDIsDriverBusyFunctionProc(void* driverRock)
Callback functions to check driver transaction status (Optional) Called to determine if the driver is performing a transaction or not. Weblink uses this to check that the driver is not busy before allowing a user to change preferences.
 
void WDOptionsFunctionProc(void* driverRock)
Callback functions for a Weblink Options button click.
Defines Detail
_PDFLHFT_IS_BETA 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define _PDFLHFT_IS_BETA 0

File: PDFLCalls.h
Line: 94
_PDFLHFT_LAST_BETA_COMPATIBLE_VERSION 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define _PDFLHFT_LAST_BETA_COMPATIBLE_VERSION 0x000A0000

File: PDFLCalls.h
Line: 93
_PDFLHFT_LATEST_VERSION 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define _PDFLHFT_LATEST_VERSION 0x000A0000

File: PDFLCalls.h
Line: 92
ATTR_AcceptCertWithoutCheck 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ATTR_AcceptCertWithoutCheck "accept"

File: DirectoryHFT.h
Line: 154
ATTR_DirCertificates 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ATTR_DirCertificates "certificates"

File: DirectoryHFT.h
Line: 152
ATTR_DirEmail 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ATTR_DirEmail "email"

File: DirectoryHFT.h
Line: 151
ATTR_DirFirstName 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ATTR_DirFirstName "firstName"

File: DirectoryHFT.h
Line: 148
ATTR_DirFullName 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ATTR_DirFullName "fullName"

File: DirectoryHFT.h
Line: 150
ATTR_DirLastName 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ATTR_DirLastName "lastName"

File: DirectoryHFT.h
Line: 149
ATTR_DirPrefEncryptionCert 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ATTR_DirPrefEncryptionCert "defaultEncryptCert"

File: DirectoryHFT.h
Line: 155
AVPS_MAC_ROMAN_ENC 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVPS_MAC_ROMAN_ENC 101

Description

Encoding identifiers (for TE).


File: PDFLExpT.h
Line: 1637
AVPS_WIN_ANSI_ENC 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define AVPS_WIN_ANSI_ENC 102

File: PDFLExpT.h
Line: 1639
BeginWebProgress 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define BeginWebProgress ((*((BeginWebProgress_SELPROTO)(gWLHFT[BeginWebProgress_SEL]))))

File: WLHFT.h
Line: 405
CatalogHFT_LATEST_VERSION 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CatalogHFT_LATEST_VERSION (0L)

File: cathft.h
Line: 26
CatalogHFT_NAME 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CatalogHFT_NAME "Catalog"

File: cathft.h
Line: 24
CatalogNUMSELECTORS 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CatalogNUMSELECTORS (CatalogNUMSELECTORSplusOne - 1)

File: cathft.h
Line: 83
CatalogRealHFT_NAME 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define CatalogRealHFT_NAME ("$"CatalogHFT_NAME)

File: cathft.h
Line: 25
ConsStackGetCount 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ConsStackGetCount ( *( ( ConsStackGetCount_SELPROTO )( gConsultantHFT[ ConsStackGetCount_SEL ] ) ) )

File: ConsHFT.h
Line: 84
ConsStackIndexGetArrayIndex 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ConsStackIndexGetArrayIndex ( *( ( ConsStackIndexGetArrayIndex_SELPROTO )( gConsultantHFT[ ConsStackIndexGetArrayIndex_SEL ] ) ) )

File: ConsHFT.h
Line: 91
ConsStackIndexGetDictKey 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ConsStackIndexGetDictKey ( *( ( ConsStackIndexGetDictKey_SELPROTO )( gConsultantHFT[ ConsStackIndexGetDictKey_SEL ] ) ) )

File: ConsHFT.h
Line: 90
ConsStackIndexGetObj 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ConsStackIndexGetObj ( *( ( ConsStackIndexGetObj_SELPROTO )( gConsultantHFT[ ConsStackIndexGetObj_SEL ] ) ) )

File: ConsHFT.h
Line: 87
ConsStackIndexGetTypeAt 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ConsStackIndexGetTypeAt ( *( ( ConsStackIndexGetTypeAt_SELPROTO )( gConsultantHFT[ ConsStackIndexGetTypeAt_SEL ] ) ) )

File: ConsHFT.h
Line: 86
ConsStackIndexGetTypeCount 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ConsStackIndexGetTypeCount ( *( ( ConsStackIndexGetTypeCount_SELPROTO )( gConsultantHFT[ ConsStackIndexGetTypeCount_SEL ] ) ) )

File: ConsHFT.h
Line: 85
ConsStackIndexIsArray 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ConsStackIndexIsArray ( *( ( ConsStackIndexIsArray_SELPROTO )( gConsultantHFT[ ConsStackIndexIsArray_SEL ] ) ) )

File: ConsHFT.h
Line: 89
ConsStackIndexIsDict 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ConsStackIndexIsDict ( *( ( ConsStackIndexIsDict_SELPROTO )( gConsultantHFT[ ConsStackIndexIsDict_SEL ] ) ) )

File: ConsHFT.h
Line: 88
ConsultantCreate 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ConsultantCreate ( *( ( ConsultantCreate_SELPROTO )( gConsultantHFT[ ConsultantCreate_SEL ] ) ) )

File: ConsHFT.h
Line: 72
ConsultantDestroy 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ConsultantDestroy ( *( ( ConsultantDestroy_SELPROTO )( gConsultantHFT[ ConsultantDestroy_SEL ] ) ) )

File: ConsHFT.h
Line: 73
ConsultantGetNumDirectVisited 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ConsultantGetNumDirectVisited ( *( ( ConsultantGetNumDirectVisited_SELPROTO )( gConsultantHFT[ ConsultantGetNumDirectVisited_SEL ] ) ) )

File: ConsHFT.h
Line: 81
ConsultantGetNumIndirectVisited 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ConsultantGetNumIndirectVisited ( *( ( ConsultantGetNumIndirectVisited_SELPROTO )( gConsultantHFT[ ConsultantGetNumIndirectVisited_SEL ] ) ) )

File: ConsHFT.h
Line: 82
ConsultantGetNumUniqueIndirectsVisited 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ConsultantGetNumUniqueIndirectsVisited ( *( ( ConsultantGetNumUniqueIndirectsVisited_SELPROTO )( gConsultantHFT[ ConsultantGetNumUniqueIndirectsVisited_SEL ] ) ) )

File: ConsHFT.h
Line: 83
ConsultantGetPercentDone 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ConsultantGetPercentDone ( *( ( ConsultantGetPercentDone_SELPROTO )( gConsultantHFT[ ConsultantGetPercentDone_SEL ] ) ) )

File: ConsHFT.h
Line: 80
ConsultantNeverVisitObj 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ConsultantNeverVisitObj ( *( ( ConsultantNeverVisitObj_SELPROTO )( gConsultantHFT[ ConsultantNeverVisitObj_SEL ] ) ) )

File: ConsHFT.h
Line: 94
ConsultantNextObj 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ConsultantNextObj ( *( ( ConsultantNextObj_SELPROTO )( gConsultantHFT[ ConsultantNextObj_SEL ] ) ) )

File: ConsHFT.h
Line: 79
ConsultantNUMSELECTORS 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ConsultantNUMSELECTORS ( ConsultantNUMSELECTORSPlusOne - 1 )

File: ConsHFT.h
Line: 64
ConsultantRegisterAgent 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ConsultantRegisterAgent ( *( ( ConsultantRegisterAgent_SELPROTO )( gConsultantHFT[ ConsultantRegisterAgent_SEL ] ) ) )

File: ConsHFT.h
Line: 77
ConsultantResume 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ConsultantResume ( *( ( ConsultantResume_SELPROTO )( gConsultantHFT[ ConsultantResume_SEL ] ) ) )

File: ConsHFT.h
Line: 76
ConsultantSetStart 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ConsultantSetStart ( *( ( ConsultantSetStart_SELPROTO )( gConsultantHFT[ ConsultantSetStart_SEL ] ) ) )

File: ConsHFT.h
Line: 78
ConsultantSuspend 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ConsultantSuspend ( *( ( ConsultantSuspend_SELPROTO )( gConsultantHFT[ ConsultantSuspend_SEL ] ) ) )

File: ConsHFT.h
Line: 75
ConsultantTraverseFrom 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define ConsultantTraverseFrom ( *( ( ConsultantTraverseFrom_SELPROTO )( gConsultantHFT[ ConsultantTraverseFrom_SEL ] ) ) )

File: ConsHFT.h
Line: 74
EndWebProgress 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define EndWebProgress ((*((EndWebProgress_SELPROTO)(gWLHFT[EndWebProgress_SEL]))))

File: WLHFT.h
Line: 407
GetAppSpecifier 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define GetAppSpecifier ((*((GetAppSpecifier_SELPROTO)(gWLHFT[GetAppSpecifier_SEL]))))

File: WLHFT.h
Line: 408
include 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define include h"

File: PDFLCalls.h
Line: 125
Init_CatalogHFT 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define Init_CatalogHFT ASExtensionMgrGetHFT(ASAtomFromString(CatalogHFT_NAME), CatalogHFT_LATEST_VERSION)

File: cathft.h
Line: 29
Init_gWLHFT 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define Init_gWLHFT ASExtensionMgrGetHFT( ASAtomFromString(WLHFTNAME), WEB_LINK_HFT_LATEST_VERSION);

File: WLHFT.h
Line: 397
Init_PDFConsultantHFT 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define Init_PDFConsultantHFT ASExtensionMgrGetHFT( ASAtomFromString( PDFCONSULTANT_HFT_NAME ), PDFCONSULTANT_HFT_LATEST )

File: ConsHFT.h
Line: 49
Init_SearchHFT 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define Init_SearchHFT ASExtensionMgrGetHFT(ASAtomFromString(SearchHFT_NAME), SearchHFT_LATEST_VERSION)

File: SrchHFT.h
Line: 31
Init_SpellerHFT 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define Init_SpellerHFT ASExtensionMgrGetHFT(ASAtomFromString(SpellerHFT_NAME), SpellerHFT_LATEST_VERSION)

File: SpellerHFT.h
Line: 46
iNumPDFObjTypes 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define iNumPDFObjTypes 515

File: ConsObTp.h
Line: 538
kAddIndexFailed 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kAddIndexFailed ((SearchIndexPtr)0)

File: SrchType.h
Line: 235
kDirDirectoryTooLargeToList 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kDirDirectoryTooLargeToList 2

Description

Retrieve all entries in the specified groups. If that would take too long, return kDirDirectoryTooLargeToList. This may be used in the user interface to immediately display the contents of a small directory or group, so responsiveness is important.


File: DirectoryHFT.h
Line: 313
kIndexAvailableFlag 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kIndexAvailableFlag (1L << 0)

Description

The index is available for searching.

Indices that are not available appear grayed out in the Search plug-in's user interface.


File: SrchType.h
Line: 218
kIndexExists 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kIndexExists ((SearchIndexPtr)-1)

File: SrchType.h
Line: 236
kIndexPtrInvalidFlag 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kIndexPtrInvalidFlag (1L << 31)

Description

(Read only - cannot be set)

The index cannot be located; it does not exist. In practice, kIndexAvailableFlag should always be set.


File: SrchType.h
Line: 233
kIndexSelectedFlag 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kIndexSelectedFlag (1L << 1)

Description

The index is used for searching.

Indices that are selected appear with a filled in check box in the Search plug-in's user interface.


File: SrchType.h
Line: 226
kParserCQL 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kParserCQL 1

File: SrchType.h
Line: 242
kParserSimple 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kParserSimple 0

File: SrchType.h
Line: 241
kPDFLVersion 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kPDFLVersion 0x00090000

File: PDFInit.h
Line: 41
kSCparam_LATEST_VERSION 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSCparam_LATEST_VERSION kSCparam_VERSION_3

File: Speller_Sel.h
Line: 226
kSCparam_VERSION_1 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSCparam_VERSION_1 0x0001

File: Speller_Sel.h
Line: 223
kSCparam_VERSION_2 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSCparam_VERSION_2 0x0002

File: Speller_Sel.h
Line: 224
kSCparam_VERSION_3 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSCparam_VERSION_3 0x0003

File: Speller_Sel.h
Line: 225
kSearchBookmarks 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSearchBookmarks 0x00000002L

File: SrchType.h
Line: 90
kSearchDocInfo 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSearchDocInfo 0x00000020L

File: SrchType.h
Line: 106
kSearchDocumentText 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSearchDocumentText 0x00000001L

File: SrchType.h
Line: 86
kSearchDocumentXMP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSearchDocumentXMP 0x00000008L

File: SrchType.h
Line: 98
kSearchEveryWhere 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSearchEveryWhere ASMAXUns32

File: SrchType.h
Line: 128
kSearchJPEGExif 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSearchJPEGExif 0x00000040L

File: SrchType.h
Line: 110
kSearchMarkup 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSearchMarkup 0x00000004L

File: SrchType.h
Line: 94
kSearchPDFAttachments 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSearchPDFAttachments 0x00000100L

File: SrchType.h
Line: 124
kSearchSignatures 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSearchSignatures 0x00000010L

File: SrchType.h
Line: 102
kSearchUserProperties 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSearchUserProperties 0x00000080L

Description

By including the kSearchUserProperties option, you will ensure that the object level data is the same as that seen by the menu item Object Data Tool in Acrobat. This is not the metadata associated with individual COS level objects in the PDF document.


File: SrchType.h
Line: 120
kSecFalse 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSecFalse 0

File: DirectoryHFT.h
Line: 40
kSecOk 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSecOk 1

File: DirectoryHFT.h
Line: 42
kSecTrue 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSecTrue 1

File: DirectoryHFT.h
Line: 38
kSpellLastBuffer 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSpellLastBuffer true

File: Speller_Sel.h
Line: 47
kSpellMaxName 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSpellMaxName 48

File: Speller_Sel.h
Line: 49
kSpellNotLastBuffer 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kSpellNotLastBuffer false

File: Speller_Sel.h
Line: 48
kWordOptionCase 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kWordOptionCase 0x00000001L

Description

The search is case-sensitive.


File: SrchType.h
Line: 25
kWordOptionIgnoreDiacritics 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kWordOptionIgnoreDiacritics 0x00000100L

File: SrchType.h
Line: 64
kWordOptionIgnoreFH 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kWordOptionIgnoreFH 0x00000080L

File: SrchType.h
Line: 59
kWordOptionProximity 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kWordOptionProximity 0x00000010L

Description

Consider the proximity of results when using the AND operator to look for more than one word in a document. Without this option, ANDed terms can be anywhere in a document. Searching for "red" and "blue", for example, finds a document where "red" is the first word on the first page and "blue" is the last word on the last page. With this option, however, ANDed terms must be within two or three pages of each other to be found. Also, the closer ANDed terms appear together, the higher the relevance ranking of the document that contains them.


File: SrchType.h
Line: 44
kWordOptionRefine 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kWordOptionRefine 0x00000020L

Description

Do not search the entire list of indices, but only the documents that matched the previous search. This is used to refine the results of the previous search.


File: SrchType.h
Line: 51
kWordOptionStemming 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kWordOptionStemming 0x00000002L

Description

Find not only the specified word, but other words that have the same stem (for example, run and ran have the same stem).


File: SrchType.h
Line: 30
kWordOptionWholeWord 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define kWordOptionWholeWord 0x00000040L

File: SrchType.h
Line: 55
PDFCONSULTANT_HFT_LATEST 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFCONSULTANT_HFT_LATEST PDFCONSULTANT_HFT_VER_3

File: ConsHFT.h
Line: 47
PDFCONSULTANT_HFT_NAME 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFCONSULTANT_HFT_NAME "PDFConsultant"

File: ConsHFT.h
Line: 42
PDFCONSULTANT_HFT_VER_1 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFCONSULTANT_HFT_VER_1 0x00010000

File: ConsHFT.h
Line: 44
PDFCONSULTANT_HFT_VER_2 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFCONSULTANT_HFT_VER_2 0x00020000

File: ConsHFT.h
Line: 45
PDFCONSULTANT_HFT_VER_3 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFCONSULTANT_HFT_VER_3 0x00030000

File: ConsHFT.h
Line: 46
PDFCONSULTANT_REAL_HFT_NAME 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFCONSULTANT_REAL_HFT_NAME ("$"PDFCONSULTANT_HFT_NAME)

File: ConsHFT.h
Line: 43
PDFL_VERSION 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFL_VERSION ((6L<<16) + 0)

File: PDFLRequir.h
Line: 59
PDFLHFT_LATEST_VERSION 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFLHFT_LATEST_VERSION _PDFLHFT_LATEST_VERSION)

File: PDFLCalls.h
Line: 97
PDFLHFT_VERSION_10 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFLHFT_VERSION_10 PDFLHFT_LATEST_VERSION

File: PDFLCalls.h
Line: 99
PDFLHFT_VERSION_5 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFLHFT_VERSION_5 0x00050000

File: PDFLCalls.h
Line: 106
PDFLHFT_VERSION_6 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFLHFT_VERSION_6 0x00060000

File: PDFLCalls.h
Line: 105
PDFLHFT_VERSION_7 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFLHFT_VERSION_7 0x00070000

File: PDFLCalls.h
Line: 104
PDFLHFT_VERSION_7_1 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFLHFT_VERSION_7_1 0x00070001

File: PDFLCalls.h
Line: 103
PDFLHFT_VERSION_7_5 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFLHFT_VERSION_7_5 0x00070005

File: PDFLCalls.h
Line: 102
PDFLHFT_VERSION_8 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFLHFT_VERSION_8 0x00080000

File: PDFLCalls.h
Line: 101
PDFLHFT_VERSION_9 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFLHFT_VERSION_9 0x00090000

File: PDFLCalls.h
Line: 100
PDFLHFTName 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFLHFTName "PDFLibrary"

File: PDFLHFTVers.h
Line: 16
PDFObjTypeGetSuperclass 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PDFObjTypeGetSuperclass ( *( ( PDFObjTypeGetSuperclass_SELPROTO )( gConsultantHFT[ PDFObjTypeGetSuperclass_SEL ] ) ) )

File: ConsHFT.h
Line: 92
PIPROC 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC name##_SEL,

File: cathft.h
Line: 34
PIPROC 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC typedef returnType ( name##_PROTO)params;

File: cathft.h
Line: 89
PIPROC 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC typedef name##_PROTO *name##_SELPROTO;

File: cathft.h
Line: 93
PIPROC 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC name##_SEL,

File: ConsHFT.h
Line: 56
PIPROC 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC typedef returnType ( *name##_SELPROTO)params;

File: ConsHFT.h
Line: 68
PIPROC 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC name##_SEL,

File: Speller_Sel.h
Line: 29
PIPROC 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC typedef returnType ( *name##_SELPROTO)params;

File: Speller_Sel.h
Line: 362
PIPROC 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC name##_SEL,

File: SrchHFT.h
Line: 34
PIPROC 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC typedef returnType ( *name##_SELPROTO)params;

File: SrchHFT.h
Line: 49
PIPROC 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC name##_SEL,

File: WLHFT.h
Line: 376
PIPROC 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PIPROC typedef returnType ( *name##_SELPROTO)params;

File: WLHFT.h
Line: 400
PROGRESS_HAS_CANCEL 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PROGRESS_HAS_CANCEL (1L << 1)

Description

Add either a Cancel button or a message directing the user how to abort the operation.


File: WLHFT.h
Line: 67
PROGRESS_HAS_METER 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PROGRESS_HAS_METER (1L << 0)

Description

Put a thermometer-style meter in the progress display.


File: WLHFT.h
Line: 63
PROP_DirectoryInfo_DirHandlerID 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PROP_DirectoryInfo_DirHandlerID "dirStdEntryPrefDirHandlerID"

File: DirectoryHFT.h
Line: 124
PROP_DirectoryInfo_DirType 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PROP_DirectoryInfo_DirType "dirStdEntryDirType"

File: DirectoryHFT.h
Line: 131
PROP_DirectoryInfo_ID 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PROP_DirectoryInfo_ID "dirStdEntryID"

File: DirectoryHFT.h
Line: 116
PROP_DirectoryInfo_Name 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PROP_DirectoryInfo_Name "dirStdEntryName"

File: DirectoryHFT.h
Line: 111
PROP_DirectoryInfo_Version 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define PROP_DirectoryInfo_Version "dirStdEntryVersion"

File: DirectoryHFT.h
Line: 136
RegisterWebDriver 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define RegisterWebDriver ((*((RegisterWebDriver_SELPROTO)(gWLHFT[RegisterWebDriver_SEL]))))

File: WLHFT.h
Line: 404
REQUIRES_CLASSIFY 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define REQUIRES_CLASSIFY 128

Description

Modes that an agent must pass to the PDF Consultant to define behavior when the RegisterAgent function is called.

It is important to note that the Consultant framework can only be in one mode at a time. If multiple agents register with different modes, the last mode to be assigned is the one that is eventually used. As always, group similar agents together to avoid conflicts such as this.


File: ConsExpT.h
Line: 310
SearchHFT_LATEST_VERSION 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define SearchHFT_LATEST_VERSION (0L)

File: SrchHFT.h
Line: 29
SearchHFT_NAME 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define SearchHFT_NAME "Search"

File: SrchHFT.h
Line: 28
SearchNUMSELECTORS 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define SearchNUMSELECTORS (SearchNUMSELECTORSplusOne - 1)

File: SrchHFT.h
Line: 44
SpellerHFT_LATEST_VERSION 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define SpellerHFT_LATEST_VERSION SpellerHFT_VERSION_1_3

File: Speller_Sel.h
Line: 45
SpellerHFT_NAME 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define SpellerHFT_NAME "Spell"

File: Speller_Sel.h
Line: 41
SpellerHFT_VERSION_1_1 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define SpellerHFT_VERSION_1_1 0x00010001

File: Speller_Sel.h
Line: 42
SpellerHFT_VERSION_1_2 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define SpellerHFT_VERSION_1_2 0x00010002

File: Speller_Sel.h
Line: 43
SpellerHFT_VERSION_1_3 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define SpellerHFT_VERSION_1_3 0x00010003

File: Speller_Sel.h
Line: 44
SpellerNum_SEL 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define SpellerNum_SEL SpellerLast_SEL - 1

File: Speller_Sel.h
Line: 40
UpdateWebProgress 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define UpdateWebProgress ((*((UpdateWebProgress_SELPROTO)(gWLHFT[UpdateWebProgress_SEL]))))

File: WLHFT.h
Line: 406
WDVCURRENTREV 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define WDVCURRENTREV (0L)

File: WLHFT.h
Line: 58
WEB_LINK_HFT_LATEST_VERSION 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define WEB_LINK_HFT_LATEST_VERSION (2L)

File: WLHFT.h
Line: 372
WebLinkNUMSELECTORS 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define WebLinkNUMSELECTORS (WLNUMSELECTORSplusOne - 1)

File: WLHFT.h
Line: 385
WebProgressDidCancel 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define WebProgressDidCancel ((*((WebProgressDidCancel_SELPROTO)(gWLHFT[WebProgressDidCancel_SEL]))))

File: WLHFT.h
Line: 409
WLCreateOrDeleteWebLinks 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define WLCreateOrDeleteWebLinks ((*((WLCreateOrDeleteWebLinks_SELPROTO)(gWLHFT[WLCreateOrDeleteWebLinks_SEL]))))

File: WLHFT.h
Line: 411
WLHFTNAME 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define WLHFTNAME "WebLink"

File: WLHFT.h
Line: 395
WWWOpenURL 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define WWWOpenURL ((*((WWWOpenURL_SELPROTO)(gWLHFT[WWWOpenURL_SEL]))))

File: WLHFT.h
Line: 410
WWWOpenURLWithParams 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

#define WWWOpenURLWithParams ((*((WWWOpenURLWithParams_SELPROTO)(gWLHFT[WWWOpenURLWithParams_SEL]))))

File: WLHFT.h
Line: 412

Typedefs Detail
ASMemAllocProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASClientAllocProc ASMemAllocProc;

File: PDFInit.h
Line: 110
ASMemAvailProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASClientMemAvailProc ASMemAvailProc;

File: PDFInit.h
Line: 155
ASMemFreeProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASClientFreeProc ASMemFreeProc;

File: PDFInit.h
Line: 141
ASMemReallocProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASClientReallocProc ASMemReallocProc;

File: PDFInit.h
Line: 127
ConsStack 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct tagConsStack* ConsStack;

An opaque traversal stack object. The ConsStackXXX methods allow retrieval of individual members of the PDFObjType and CosObj stacks associated with a Consultant object.

See Also


File: ConsExpT.h
Line: 51
Consultant 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct tagConsultant* Consultant;

The opaque type to allow programs to retain handles to create PDF Consultant and Accessibility Checker objects.

See Also

numerous

File: ConsExpT.h
Line: 59
ConsultantAgent 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef tagConsultantAgent ConsultantAgent;

File: ConsExpT.h
Line: 193
ConsultantAgentAction 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASUns32 ConsultantAgentAction;

File: ConsExpT.h
Line: 106
DirAttributes 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASCab DirAttributes;

A directory attribute collection is used to set output options of a directory connection.

The collection is represented in an ASCab as:

{ ("0", "nameOfAttribute1"), ("1", "nameOfAttribute2"), ... }


File: DirectoryHFT.h
Line: 187
DirConnection 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DirConnection DirConnection;

File: DirectoryHFT.h
Line: 63
DirConnectionHandler 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DirConnection DirConnectionHandler;

File: DirectoryHFT.h
Line: 375
DirConnectionRec 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_DirConnection DirConnectionRec;

File: DirectoryHFT.h
Line: 375
DirectoryInfo 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASCab DirectoryInfo;

A directory information structure contains configuration settings used to establish a connection to a directory. Common top-level properties are defined below. Note that the prefix DirStdEntry_ is reserved for standard entries and should not be used for entries specific to a particular directory. Optionally, this could contain other configuration information specific to the directory.


File: DirectoryHFT.h
Line: 105
DirGroupList 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASCab DirGroupList;

Group names are represented as text in an ASCab. For example:

{ ("0", "friends"), ("1", "family"), ... }


File: DirectoryHFT.h
Line: 164
DirResults 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASCab DirResults;

Search and enumeration results are represented as a two-dimensional ASCab where each "row" is itself an ASCab that contains attributes defined by SetOutputOptions calls.

Note

Special Case: If standard output options are used and ATTR_Certificates is included, the ATTR_Certificates value in the row ASCab objects will be another ASCab, which stores all certificates associated with that directory entry.

File: DirectoryHFT.h
Line: 254
DirSearchCriteria 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASCab DirSearchCriteria;

Directory search criteria are represented as a set of key/value pairs where the keys are attribute names and the values are search strings applied to those attributes. A logical "AND" is implied when multiple search criteria are present. Unrecognized search criteria are ignored.

Note

Special Case: For a standard search, the value of the ATTR_Certificates search criterion shall be a list of certificates. In order for a directory entry to match the criterion, it must have all those certificates.

File: DirectoryHFT.h
Line: 235
HyphenationRecord 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_HyphenationRecord HyphenationRecord;

File: Speller_Sel.h
Line: 349
HyphenationRecordPtr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef HyphenationRecord HyphenationRecordPtr;

File: Speller_Sel.h
Line: 351
InitProcs 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_InitProcs InitProcs;

File: PDFLInitCommon.h
Line: 44
InitProcsP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_InitProcs InitProcsP;

File: PDFLInitCommon.h
Line: 44
MonoInkList 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_monoInkList MonoInkList;

File: PDFLExpT.h
Line: 1537
PDFlatten 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef PDFlattenRec PDFlatten;

File: PDFLExpT.h
Line: 366
PDFLData 
Product availability: PDFL
Platform availability: Macintosh

Syntax

typedef _t_PDFLData PDFLData;

File: PDFInit.h
Line: 722
PDFLData 
Product availability: PDFL
Platform availability: UNIX

Syntax

typedef _t_PDFLData PDFLData;

File: PDFInit.h
Line: 893
PDFLData 
Product availability: PDFL
Platform availability: Windows

Syntax

typedef _t_PDFLData PDFLData;

File: PDFInit.h
Line: 553
PDFLDataRec 
Product availability: PDFL
Platform availability: Macintosh

Syntax

typedef _t_PDFLData PDFLDataRec;

File: PDFInit.h
Line: 722
PDFLDataRec 
Product availability: PDFL
Platform availability: UNIX

Syntax

typedef _t_PDFLData PDFLDataRec;

File: PDFInit.h
Line: 893
PDFLDataRec 
Product availability: PDFL
Platform availability: Windows

Syntax

typedef _t_PDFLData PDFLDataRec;

File: PDFInit.h
Line: 553
PDFLMemStats 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDFLMemStats PDFLMemStats;

File: PDFLExpT.h
Line: 82
PDFLPrintUserCallbacks 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDFLPrintUserCallbacks PDFLPrintUserCallbacks;

File: PDFLExpT.h
Line: 2378
PDFLPrintUserCallbacksRec 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDFLPrintUserCallbacks PDFLPrintUserCallbacksRec;

File: PDFLExpT.h
Line: 2376
PDFLPrintUserParams 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDFLPrintUserParams PDFLPrintUserParams;

Declare the the type PDFLPrintUserParams, which is a pointer to a structure and is passed into PDFLPrintDoc. This structure is defined in PDFLPrint.h , but it is complex and platform-specific. This declaration avoids the need to include the platform specific details into files that just need a decaration of this pointer.


File: PDFLExpT.h
Line: 2384
PDFLPrintUserParamsEx 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_PDFLPrintUserParamsEx* PDFLPrintUserParamsEx;

File: PDFLExpT.h
Line: 2386
PDFLPrintUserParamsRec 
Product availability: PDFL
Platform availability: Macintosh

Syntax

typedef _t_PDFLPrintUserParams PDFLPrintUserParamsRec;

File: PDFLPrint.h
Line: 673
PDFLPrintUserParamsRec 
Product availability: PDFL
Platform availability: UNIX

Syntax

typedef _t_PDFLPrintUserParams PDFLPrintUserParamsRec;

File: PDFLPrint.h
Line: 187
PDFLPrintUserParamsRec 
Product availability: PDFL
Platform availability: Windows

Syntax

typedef _t_PDFLPrintUserParams PDFLPrintUserParamsRec;

File: PDFLPrint.h
Line: 511
PDFLPrintUserParamsRecEx 
Product availability: PDFL
Platform availability: Windows

Syntax

typedef _t_PDFLPrintUserParamsEx PDFLPrintUserParamsRecEx;

File: PDFLPrint.h
Line: 1022
PDFObjID 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef tagPDFObjID PDFObjID;

File: ConsExpT.h
Line: 172
PDFObjType 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASUns32 PDFObjType;

A type corresponding to the enum defined in ConsObTp.h . This type is used to refer to specific object types in PDF. It is specifically used by Agents to make object requests of the framework, and is used by the framework to report the types of objects found.

See Also


File: ConsExpT.h
Line: 35
PDInclusion 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASEnum8 PDInclusion;

Specifies how to include a resource in a file.


File: PDFLExpT.h
Line: 123
PDPrintClient 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDPrintClient PDPrintClient;

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


File: PDFLExpT.h
Line: 1387
PDPrintClientRec 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PDPrintClient PDPrintClientRec;

File: PDFLExpT.h
Line: 2368
PDPrintController 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_PDPrintController* PDPrintController;

File: PDFLExpT.h
Line: 1388
PDPrintFontArrayP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef PDPrintFontArray PDPrintFontArrayP;

File: PDFLExpT.h
Line: 287
PDPrintFontP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef PDPrintFontRec PDPrintFontP;

File: PDFLExpT.h
Line: 267
PDPrintParams 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef PDPrintParamsRec PDPrintParams;

File: PDFLExpT.h
Line: 987
PDPrintStrP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef PDPrintStr PDPrintStrP;

File: PDFLExpT.h
Line: 202
PlatformBitmapPtr 
Product availability: PDFL
Platform availability: Windows

Syntax

typedef void* PlatformBitmapPtr;

File: PDFLExpT.h
Line: 52
PlatformWindowPtr 
Product availability: PDFL
Platform availability: Windows

Syntax

typedef void* PlatformWindowPtr;

File: PDFLExpT.h
Line: 51
PPDFeaturesP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PPDFeatures PPDFeaturesP;

File: PDFLPrint.h
Line: 50
PPDFeaturesRec 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_PPDFeatures PPDFeaturesRec;

File: PDFLPrint.h
Line: 50
RegAgentFlag 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASUns32 RegAgentFlag;

File: ConsExpT.h
Line: 354
SearchIndexListPtr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef void* SearchIndexListPtr;

File: SrchType.h
Line: 206
SearchIndexPtr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef void* SearchIndexPtr;

File: SrchType.h
Line: 208
SearchQueryDataRec 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_SearchQueryDataRec SearchQueryDataRec;

File: SrchType.h
Line: 201
SearchScope 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASUns32 SearchScope;

File: SrchType.h
Line: 133
SearchSelector 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _SearchSelector SearchSelector;

File: SrchHFT.h
Line: 40
SearchWordOptions 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASUns32 SearchWordOptions;

The client must supply all the search word options in the scope parameter by doing an OR (|) operation on all options where the search needs to be executed. For example, if the client needs to search on attachments, and within attachments the search needs to be done on document text and XMP data, then it can be specified as follows:

scope = kSearchDocumentText | kSearchDocumentXMP | kSearchPDFAttachments;

In most cases, however, the client might want to search on all the places possible, so it would suffice to write:

scope = kSearchEveryWhere;


File: SrchType.h
Line: 82
SecErrorInfo 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_SecErrorInfo SecErrorInfo;

File: DirectoryHFT.h
Line: 60
SecErrorInfoRec 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_SecErrorInfo SecErrorInfoRec;

File: DirectoryHFT.h
Line: 60
SecRetCode 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef ASInt32 SecRetCode;

File: DirectoryHFT.h
Line: 36
SpellCheckParam 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef SpellCheckParam SpellCheckParam;

This parameter block is used for communication between the Spelling plug-in and a client plug-in. The client must allocate it, initialize all fields, and pass it to the Spelling plug-in when adding a domain with SpellAddDomain(). Spelling passes it back to the client when the SCEnableProc(), SCGetTextProc(), and SCCompletionProc() are called. It is passed to the client's SCGetTextProc() from the Spelling plug-in when it needs to request a text buffer from the client. After the user has completed the spell check on the scInBuffer, this same parameter block is passed to the client's SCCompletionProc() with the result of the spell check in scOutBuffer. When the SCGetTextProc() is called, scPageNum, scIndex and scAVDoc are filled in by the Spelling plugin.

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

When the spell check is completed, SCCompletionProc() is called with scOutBuffer if the user made changes to scInBuffer. Note that the spelling client is responsible for all memory allocated including the scOutBuffer returned from the Spelling plug-in. The client is responsible for all parameters except where indicated.


File: Speller_Sel.h
Line: 118
SpellCheckParamPtr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef SpellCheckParam SpellCheckParamPtr;

File: Speller_Sel.h
Line: 120
TermProcs 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_TermProcs TermProcs;

File: PDFLInitCommon.h
Line: 49
TermProcsP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_TermProcs TermProcsP;

File: PDFLInitCommon.h
Line: 49
TextList 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_textList TextList;

File: PDFLExpT.h
Line: 1441
TextServer 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_TextServer* TextServer;

Text server.


File: PDFLExpT.h
Line: 1348
ThreadLocalKey 
Product availability: PDFL
Platform availability: Macintosh

Syntax

typedef TaskStorageIndex ThreadLocalKey;

PDFLData structure for PDFLInit.


File: PDFInit.h
Line: 555
ThreadLocalKey 
Product availability: PDFL
Platform availability: UNIX

Syntax

typedef pthread_key_t ThreadLocalKey;

PDFLData structure for PDFLInit.


File: PDFInit.h
Line: 724
ThreadLocalKey 
Product availability: PDFL
Platform availability: Windows

Syntax

typedef DWORD ThreadLocalKey;

PDFLData structure for PDFLInit.


File: PDFInit.h
Line: 380
TIFFASCIITagList 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_TIFFASCIITagList TIFFASCIITagList;

File: PDFLExpT.h
Line: 1451
TKAllocatorProcs 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_TKAllocatorProcs TKAllocatorProcs;

File: PDFInit.h
Line: 191
TKAllocatorProcsP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_TKAllocatorProcs TKAllocatorProcsP;

File: PDFInit.h
Line: 191
TKExtensionProcs 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_TKExtensionProcs TKExtensionProcs;

File: PDFInit.h
Line: 375
TKExtensionProcsP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_TKExtensionProcs TKExtensionProcsP;

File: PDFInit.h
Line: 375
TKResourceProcs 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_TKResourceProcs TKResourceProcs;

File: PDFInit.h
Line: 275
TKResourceProcsP 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef _t_TKResourceProcs TKResourceProcsP;

File: PDFInit.h
Line: 275
WDAppSpecifier 
Product availability: PDFL
Platform availability: Macintosh

Syntax

typedef FSSpec* WDAppSpecifier;

A data structure that specifies the path name to the web browser.

See Also


File: WLHFT.h
Line: 46
WDAppSpecifier 
Product availability: PDFL
Platform availability: UNIX

Syntax

typedef char* WDAppSpecifier;

A data structure that specifies the path name to the web browser.

See Also


File: WLHFT.h
Line: 55
WDAppSpecifier 
Product availability: PDFL
Platform availability: Windows

Syntax

typedef char* WDAppSpecifier;

A data structure that specifies the path name to the web browser.

See Also


File: WLHFT.h
Line: 51
WDAppSupportPredicate 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef WDAppSupportPredicateProc* WDAppSupportPredicate;

Tests whether a driver can support a given web browser application.


File: WLHFT.h
Line: 222
WDBecomeDriverFunction 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef WDBecomeDriverFunctionProc* WDBecomeDriverFunction;

Called whenever the state of the driver changes from inactive to current, or vice versa.


File: WLHFT.h
Line: 313
WDBringFrontFunction 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef WDBringFrontFunctionProc* WDBringFrontFunction;

Called when the user clicks on the Weblink toolbar button to switch to the browser application.


File: WLHFT.h
Line: 321
WDFollowLinkFunction 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef WDFollowLinkFunctionProc* WDFollowLinkFunction;

Follows and retrieves the link specified by a URL from the PDF document specified by theDoc. Weblink supplies the driver a fully resolved the URL. The driver is solely responsible for launching a web browser, if it requires one. If the driver depends on an external web browser, the driver or the web browser is responsible for bringing that browser to the foreground if the link data is not displayed by the Acrobat viewer.

For relative links, Weblink prepends a base URL if specified; otherwise, it prepends the appropriate portion from the current document's URL to resolve a relative link.

Weblink automatically handles mapped links, that is, links that generate different results based on the location of the mouse within the links. (Such links are specified by checking the Mapped Coordinates Link box in the Edit URL dialog box. These links have the isMap attribute). Weblink appends "?" to the URL, followed by the x- and y-coordinates of the mouse at the time the link was selected, relative to the upper-left corner of the link's rectangle.


File: WLHFT.h
Line: 258
WDFollowLinkWithParamsFunction 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef WDFollowLinkWithParamsFunctionProc* WDFollowLinkWithParamsFunction;

Follows and retrieves the link specified by a URL from the PDF document specified by theDoc, going to a target frame. Weblink supplies the driver a fully resolved the URL. The driver is solely responsible for launching a web browser, if it requires one. If the driver depends on an external web browser, the driver or the web browser is responsible for bringing that browser to the foreground if the link data is not displayed by the Acrobat viewer.

For relative links, Weblink prepends a base URL if specified; otherwise, it prepends the appropriate portion from the current document's URL to resolve a relative link.

Weblink automatically handles mapped links, that is, links that generate different results based on the location of the mouse within the links. (Such links are specified by checking the Mapped Coordinates Link box in the Edit URL dialog box. These links have the isMap attribute). Weblink appends "?" to the URL, followed by the x- and y-coordinates of the mouse at the time the link was selected, relative to the upper-left corner of the link's rectangle.


File: WLHFT.h
Line: 296
WDIsDriverBusyFunction 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef WDIsDriverBusyFunctionProc* WDIsDriverBusyFunction;

(Optional) Called to determine if the driver is performing a transaction. Weblink uses this to check that the driver is not busy (driver-defined) before allowing a user to change preferences.

The driver should return busy whenever it is not convenient for it to become the current driver as requested by WDBecomeDriverFunction() .


File: WLHFT.h
Line: 343
WDOptionsFunction 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef WDOptionsFunctionProc* WDOptionsFunction;

(Optional) Called when the user clicks the Options button in the Weblink Preferences dialog box. If this function is NULL, the Options button is disabled.


File: WLHFT.h
Line: 329
WebProgressMonitor 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef void* WebProgressMonitor;

A data structure that implements a progress monitor.


File: WLHFT.h
Line: 98
WWWOpenURLParams 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

typedef WWWOpenURLParamsRec WWWOpenURLParams;

File: WLHFT.h
Line: 94

Enumeration Detail
_SearchSelector
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum _SearchSelector {
 SearchBAD_SELECTOR,
 
 SearchNUMSELECTORSplusOne = (char *cQuery, ASInt16 nParserID, ASUns16 nSortCount, char **cSortNames, ASBool *bSortWays, ASUns32 nWordOptions, ASBool bOverrideWordOptions, ASUns16 nMaxDocs)(void)(SearchIndexListPtr list)(SearchIndexListPtr list, ASUns32 n)(SearchIndexListPtr list, char *fullPath)(SearchIndexListPtr list, char *fullPath, ASUns32 flags)(SearchIndexListPtr list, SearchIndexPtr index)(SearchIndexPtr index)(SearchIndexPtr index, ASUns32 flags)(SearchIndexPtr index)(SearchIndexPtr index)(SearchIndexListPtr list, ASFileSys fileSys, ASPathName indexPath)(SearchIndexListPtr list, ASFileSys fileSys, ASPathName indexPath, ASUns32 flags)(SearchIndexPtr index)(SearchIndexPtr index)(SearchIndexPtr index)(void)(const SearchQueryDataRec *queryData)
}

File: SrchHFT.h
Line: 36

ALDImageColorType 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax


File: PDFLExpT.h
Line: 1423

Elements
ALDImageColorType_Spot  

Spot color type.

 
ALDImageColorType_Process  

Process color type.

 
ALDImageColorType_Separation  

Separation color type.

 
ALDImageColorType_Intrinsic  

Intrinsic color type.

anoncathft25 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum anoncathft25 {
 CatalogBAD_SELECTOR,
 
 CatalogNUMSELECTORSplusOne = (void)(char *szIndex)(char *szIndex)(char *szIndex)(void)
}

File: cathft.h
Line: 35

anonConsHFT27 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum anonConsHFT27 {
 ConsultantBAD_SELECTOR = 0,
 
 ConsultantNUMSELECTORSPlusOne = ( ConsAgentPercentDoneCallback pPercentDoneCallBack )( Consultant hConsultantToDestroy )( Consultant hConsultant, CosObj hObj, PDFObjType kObjType )( Consultant hConsultant, const ConsultantAgent* pAgent, RegAgentFlag kFlag )( Consultant hConsultant, CosObj hObjStart, PDFObjType kInitType )( Consultant hConsultant )( Consultant hConsultant )( Consultant hConsultant )( Consultant hConsultant )( Consultant hConsultant )( Consultant hConsultant )( ConsStack hConsultant )( ConsStack hConsultant, ASUns32 iIndex )( ConsStack hConsultant, ASUns32 iIndex )( ConsStack hConsultant, ASUns32 iIndex, ASUns32 iTypeIndex )( ConsStack hConsultant, ASUns32 iIndex )( ConsStack hConsultant, ASUns32 iIndex )( ConsStack hConsultant, ASUns32 iIndex )( ConsStack hConsultant, ASUns32 iIndex )( PDFObjType kType )( Consultant hConsultant )( Consultant hConsultant, CosObj hObj )
}

File: ConsHFT.h
Line: 57

anonWLHFT31 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum anonWLHFT31 {
 WLBAD_SELECTOR,
 
 WLNUMSELECTORSplusOne = (const char *driverName, void *driverRock, WebDriverVector *wdVec)(char *message, ASUns32 flags, ASInt32 timeoutTime)(WebProgressMonitor progMon, char *message, ASInt32 from, ASInt32 to, ASInt32 outOf, ASInt32 timeoutTime)(WebProgressMonitor progMon)(ASBool promptUser)(WebProgressMonitor progMon)(AVDoc avd, const char *cURL, const char *cFormData)(ASBool bCreate, PDDoc pdd, ASInt32 nStart, ASInt32 nEnd, ProgressMonitor pm, void *vPMData, CancelProc cp, void *vCPData)(AVDoc avd, const char *cURL, const char *cFormData, WWWOpenURLParams params)
}

File: WLHFT.h
Line: 378

CatalogStatus 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum CatalogStatus {
 CatalogIdle = 0,
 
 CatalogBuilding,
 
 CatalogPurging,
 
 CatalogWaiting
}

File: cathft.h
Line: 49

eHyphenType 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum eHyphenType {
 kHyphen_all = -1,
 
 kHyphenType_preferred = 0,
 
 kHyphenType_normal,
 
 kHyphenType_nonpreferred
}

File: Speller_Sel.h
Line: 322

ImageInk 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax


File: PDFLExpT.h
Line: 1518

Elements
ImageInk_Registration  

Image colorant registration value.

 
ImageInk_FullColor  

Image colorant full color value.

 
ImageInk_Monochrome  

Image colorant monochrome value

IndexStatus 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum IndexStatus {
 IndexInvalid = 0,
 
 IndexCouldNotBeSaved,
 
 IndexBuildDone,
 
 IndexPurgeDone,
 
 IndexLoadDone,
 
 CatalogBusy,
 
 IndexJobAdded
}

File: cathft.h
Line: 65

Elements
IndexInvalid  

Input path is not correct, or Catalog was not able to load the index.

 
IndexCouldNotBeSaved  

Catalog was unable to save the index at the given path.

 
IndexBuildDone  

The build operation was valid and was completed.

 
IndexPurgeDone  

The purge operation was valid and was completed.

 
IndexLoadDone  

The index was loaded successfully.

 
CatalogBusy  

Catalog is currently busy and could not process the request.

 
OPIversion 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum OPIversion {
 OPIv13,
 
 OPIv20
}

File: PDFLExpT.h
Line: 1413

Elements
OPIv13  

OPI version 1.3.

 
OPIv20  

OPI version 2.0.

PDDuplexEnum 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDDuplexEnum {
 kPDDuplexOff,
 
 kPDDuplexOnTumbleShort,
 
 kPDDuplexOnTumbleLong
}

See Also


File: PDFLExpT.h
Line: 372

PDEncodingType 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDEncodingType {
 kPDDoReencode,
 
 kPDDoNothing,
 
 kPDDoXlate
}

File: PDFLExpT.h
Line: 1392

Elements
kPDDoReencode  

The encoding method to be used for Type 1 fonts and substituted fonts.

 
kPDDoNothing  

The encoding method to be used for TrueType Windows font or built-in encoding font.

 
kPDDoXlate  

The encoding method to be used for a TrueType custom font or font with Mac OS encoding.

PDFarEastFont 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax


File: PDFLExpT.h
Line: 147

Elements
PDOutput_PS  

Emit a PostScript file.

 
PDOutput_EPSNoPrev  

Emit an EPS file with no preview.

 
PDOutput_EPSMacStdPrev  

Emit an EPS file with standard preview.

 
PDOutput_EPSMacExtPrev  

Emit an EPS file with extended preview.

PDFlattenTilingMode 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDFlattenTilingMode {
 kPDNoTiling = 0,
 
 kPDConstantTiling,
 
 kPDAdaptiveTiling
}

File: PDFLExpT.h
Line: 291

Elements
kPDNoTiling  

No tiling.

 
kPDConstantTiling  

Constant tiling.

 
kPDAdaptiveTiling  

Adaptive tiling.

PDFLFarEastFont 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax


File: PDFLExpT.h
Line: 169

Elements
PDPDFarEastFont_Download_All  

Download all CJK fonts to the printer.

 
PDPDFarEastFont_Download_None  

Download only embedded fonts to the printer.

 
PDPDFarEastFont_Print_As_Image  

GDI/QuickDraw on PS option. PS Level 1 should use this to print CJK.

PDFLInitFlags 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDFLInitFlags {
 kPDFLInitIgnoreDefaultDirectories = 0x001,
 
 kReadOnlyInit = 0x0002,
 
 kCheckSubFonts = 0x0004,
 
 kDontLoadPlugIns = 0x0008,
 
 kTestUniform = 0x0010,
 
 kInitPDFEdit = 0x0020,
 
 kNewFontWidths = 0x0040,
 
 kPDFLInitIgnoreSystemFonts = 0x0080
}

File: PDFInit.h
Line: 44

Elements
kPDFLInitIgnoreDefaultDirectories  

Do not search through default font directories.

 
kReadOnlyInit  

(obsolete) If it is not necessary to write PDF, there is no need to initialize the font table (which would be much faster!).

 
kCheckSubFonts  

Check for substitution fonts at toolkit initialization. If they are not found, return an error.

 
kDontLoadPlugIns  

Do not load plug-ins if this is set.

 
kTestUniform  

TEST ONLY ** Create the same PDF file for every run. This forces dates to January 1, 1999 at 1:01:01 and file IDs to "[&lt;11111111111111111111111111111111&gt;&lt;11111111111111111111111111111111&gt;]". The resulting PDF files are invalid and should only be used for testing purposes.

 
kInitPDFEdit  

Initialize PDFEdit if this is true.

 
kNewFontWidths  

PDFLib 10 GM and earlier versions have incorrect widths specified for several of their characters of the 'standard/core 14 fonts', the widths do not always correspond with what the corresponding AFM files specify. Use new and correct font widths for 'standard/core 14 fonts' if this is true.

 
kPDFLInitIgnoreSystemFonts  

Do not search through default System font directories. If set, CoolType will not automatically search for any system fonts. If this flag is not set, CoolType will enumerate system fonts on Mac and Windows using the standard APIs. On Unix, CoolType will look in the following locations: /usr/lib/X11/fonts /usr/local/X11R6/lib/X11/fonts /usr/share/X11/fonts

PDFLPrefDrawSmoothFlags 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDFLPrefDrawSmoothFlags {
 kPDPrefAASmoothText = 0x00000001,
 
 kPDPrefAASmoothLineArt = 0x00000002,
 
 kPDPrefAASmoothImage = 0x00000010
}

See Also


File: PDFLExpT.h
Line: 1335

Elements
kPDPrefAASmoothText  

Draw smooth text.

 
kPDPrefAASmoothLineArt  

Draw smooth line art.

 
kPDPrefAASmoothImage  

Draw smooth image.

PDFLProcSetIDs 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDFLProcSetIDs {
 pdfProcSet,
 
 typeProcSet,
 
 imgProcSet,
 
 imbProcSet,
 
 imcProcSet,
 
 imiProcSet,
 
 ocfProcSet,
 
 nProcSets
}

File: PDFLExpT.h
Line: 1616

Elements
pdfProcSet  

PDF only operators.

 
typeProcSet  

AI3 or PDF typography.

 
imgProcSet  

General image support.

 
imbProcSet  

Monochrome images.

 
imcProcSet  

Color images.

 
imiProcSet  

Indexed (color table) images.

 
ocfProcSet  

Make Original Composite Font (OCF) support.

 
nProcSets  

How many are defined.

PDFLSingleByteFont 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDFLSingleByteFont {
 kPDSingleByteFont = 0x0001
}

See Also


File: PDFLExpT.h
Line: 230

Elements
kPDSingleByteFont  

A fLag to indicate that the font uses a single byte encoding.

PDOutputType 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDOutputType {
 kIncludeOncePerDoc,
 
 kIncludeOnEveryPage,
 
 kIncludeNever,
 
 kIncludeWhenNeeded,
 
 kIncludeByRange
}

File: PDFLExpT.h
Line: 124

Elements
kIncludeOncePerDoc  

Include the resource only once per file.

 
kIncludeOnEveryPage  

Include the resource on every page in the file.

 
kIncludeNever  

Never include the resource.

 
kIncludeWhenNeeded  

When needed.

 
PDPrintMarkStyles 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax


File: PDFLExpT.h
Line: 1350

Elements
kPDInDesignStyle  

InDesign style.

 
kPDInDesignJ1Style  

InDesign J1 style.

 
kPDInDesignJ2Style  

InDesign J2 style.

 
kPDIllustratorStyle  

Illustrator style.

 
kPDIllustratorJStyle  

Illustrator J style.

 
kPDQuarkXPressStyle  

QuarkXPress style.

PDPrintTrapType 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDPrintTrapType {
 kPDPrintTrapNone = 0x01,
 
 kPDPrintTrapInRIP = 0x04
}

File: PDFLExpT.h
Line: 468

PDRefXObjMode 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum PDRefXObjMode {
 kRefXObjNever = 0,
 
 kRefXObjAlways = 1,
 
 kRefXObjPDFX5 = 2,
 
 kRefXObjAlwaysAssured = 3,
 
 kRefXObjPDFX5Assured = 4
}

File: PDFLExpT.h
Line: 1246

Elements
kRefXObjNever  

Never display reference XObjects. If a file contains reference XObjects, their content will not be displayed, and only the proxy will be displayed if this mode is selected.

 
kRefXObjAlways  

Always display reference XObjects. All files containing reference XObjects will display content from the XObjects.

 
kRefXObjPDFX5  

All files that are PDFX5 compliant and that contain reference XObjects will display their content.

 
kRefXObjAlwaysAssured  

Always display reference XObjects, but do not display the proxy. The PDF parsing fails if the target is not found.

 
kRefXObjPDFX5Assured  

Always display reference XObjects, but do not display the proxy. The PDF parsing fails if the target PDF/X-5 document is not found.

SearchMatchOption 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum SearchMatchOption {
 kMatchPhrase,
 
 kMatchAllWords,
 
 kMatchAnyWords,
 
 kBooleanQuery
}

File: SrchType.h
Line: 150

SearchType 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum SearchType {
 kSearchActiveDoc,
 
 kSearchFolder,
 
 kSearchIndex,
 
 kSearchActiveIndexes
}

File: SrchType.h
Line: 137

SpellDialogResult 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum SpellDialogResult {
 kSpellDone = 0,
 
 kSpellCompleted,
 
 kSpellFailed = -1,
 
 kSpellResultLast
}

See Also

SpellCheck

File: Speller_Sel.h
Line: 55

Elements
kSpellDone  

The user clicked the Done button to dismiss the dialog box and did not complete the spell check, but may have made changes to the text buffer.

 
kSpellCompleted  

The user completed spell checking the input buffer, or all words were correct. A new text buffer is returned if corrections where made.

 
kSpellFailed  

The spell check dialog box failed due to an internal error.

 
SpellDomainFlags 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum SpellDomainFlags {
 kSpellFlagNone = 0x0000,
 
 kSpellFlagAllDomain = 0x0001,
 
 kSpellCheckStart = 0x0002,
 
 kSpellFlagLast = 0xFFFF
}

File: Speller_Sel.h
Line: 82

Elements
kSpellFlagNone  

Default domain behavior.

 
kSpellFlagAllDomain  

For Acrobat 5 and later, all registered spelling domains should set this flag. Only the All domains are called by spelling when the user clicks the Start button on the Spell Check dialog box.

 
kSpellCheckStart  

Announce to the client that the spell dialog box has just been popped.

 
tagConsultantAgentAction 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum tagConsultantAgentAction {
 AC_NOCHANGE = 0,
 
 AC_REPLACE = 1,
 
 AC_REMOVE = 2,
 
 AC_REVISIT = 4,
 
 AC_NEVERREVISIT = 8,
 
 AC_CHANGEALL = 16
}

See Also


File: ConsExpT.h
Line: 68

Elements
AC_NOCHANGE  

The Consultant makes no changes to the current object. Use this if the Agent is only gathering information or if the Agent is in charge of making all the modifications itself.

 
AC_REPLACE  

Instructs the Consultant to replace this occurence of the current object in the document with the one retured via the pObjToReturn parameter to the ObjFound callback. You can optionally combine this with AC_REVISIT or AC_CHANGEALL.

 
AC_REMOVE  

Instructs the Consultant to remove this occurence of the current object in the document. You can optionally combine this with OD_REVISIT or OD_CHANGEALL.

 
AC_REVISIT  

Instructs the Consultant to visit this object again if it is encountered again. You can combine this with any flag except OD_NEVERREVISIT or OD_CHANGEALL.

 
AC_NEVERREVISIT  

Instructs the Consultant that under no circumstances should the object be revisited, regardless of whether it is reclassified when encountered again. It is only applicable in the mode in which the Consultant pays attention to object classification when determining whether an obect has already been visited.

 
AC_CHANGEALL  

You must use this in conjunction with either OD_REPLACE or OD_REMOVE. It instructs the Consultant to silently perform the desired operation on all instances of the current object, without calling the ObjFound callback again for this object.

tagPDFObjType 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum tagPDFObjType {
 PT_AADICTIONARY = 0,
 
 PT_ACROFORMSPAGESTREE,
 
 PT_ACROFORMSTEMPLATESTREE,
 
 PT_ACTION,
 
 PT_ACTIONSARRAY,
 
 PT_AFPAGESCHILDREN,
 
 PT_AFPAGESINTNODE,
 
 PT_AFPAGESLEAFNODE,
 
 PT_AFPAGESNAMEDCHILDREN,
 
 PT_AFTEMPLATESCHILDREN,
 
 PT_AFTEMPLATESINTNODE,
 
 PT_AFTEMPLATESLEAFNODE,
 
 PT_AFTEMPLATESNAMEDCHILDREN,
 
 PT_ANNOTATION,
 
 PT_ANNOTSARRAY,
 
 PT_APPEARANCEDICT,
 
 PT_BEAD,
 
 PT_BLENDMODELIST,
 
 PT_BOXCOLORINFO,
 
 PT_CALGRAYATTRIBUTES,
 
 PT_CALGRAYCOLORSPACE,
 
 PT_CALRGBATTRIBUTES,
 
 PT_CALRGBCOLORSPACE,
 
 PT_CATALOG,
 
 PT_CHARPROCS,
 
 PT_CHOICEFIELD,
 
 PT_COLORANTSDICT,
 
 PT_COLORSPACEATTRIBUTES,
 
 PT_COLORSPACELIST,
 
 PT_CONTENTSARRAY,
 
 PT_DESTINATION,
 
 PT_DEVICENCOLORSPACE,
 
 PT_DOWNAPPEARANCEDICT,
 
 PT_EMBEDOBJCHILDREN,
 
 PT_EMBEDOBJINTNODE,
 
 PT_EMBEDOBJLEAFNODE,
 
 PT_EMBEDOBJNAMEDCHILDREN,
 
 PT_EMBEDOBJTREE,
 
 PT_EXPONENTIALFUNCTION,
 
 PT_EXTGSTATE,
 
 PT_EXTGSTATELIST,
 
 PT_FIELD,
 
 PT_FIELDCHILDREN,
 
 PT_FONT,
 
 PT_FONTDESCRIPTOR,
 
 PT_FONTDIFFERENCES,
 
 PT_FONTENCODING,
 
 PT_FONTRESOURCELIST,
 
 PT_FORM,
 
 PT_FORMCALCORDER,
 
 PT_FORMSDICT,
 
 PT_FUNCTION,
 
 PT_FUNCTIONARRAY,
 
 PT_GOTOACTION,
 
 PT_ICCBASEDATTRIBUTES,
 
 PT_ICCBASEDCOLORSPACE,
 
 PT_IMAGE,
 
 PT_INDEXEDCOLORSPACE,
 
 PT_JAVASCRIPTACTION,
 
 PT_LABATTRIBUTES,
 
 PT_LABCOLORSPACE,
 
 PT_LINKANNOTATION,
 
 PT_MARKEDCONTENTREF,
 
 PT_MMTYPE1FONT,
 
 PT_NAMEDAPPEARCHILDREN,
 
 PT_NAMEDAPPEARINTNODE,
 
 PT_NAMEDAPPEARLEAFNODE,
 
 PT_NAMEDAPPEARNAMEDCHILDREN,
 
 PT_NAMEDAPPEARTREE,
 
 PT_NAMEDDESTDICT,
 
 PT_NAMEDDESTLIST,
 
 PT_NAMEDDESTSCHILDREN,
 
 PT_NAMEDDESTSINTNODE,
 
 PT_NAMEDDESTSLEAFNODE,
 
 PT_NAMEDDESTSNAMEDCHILDREN,
 
 PT_NAMEDDESTSTREE,
 
 PT_NAMEDJAVASCRIPTTREE,
 
 PT_NAMEDJSCHILDREN,
 
 PT_NAMEDJSINTNODE,
 
 PT_NAMEDJSLEAFNODE,
 
 PT_NAMEDJSNAMEDCHILDREN,
 
 PT_NAMESCHILDREN,
 
 PT_NAMESDICT,
 
 PT_NAMESINTNODE,
 
 PT_NAMESLEAFNODE,
 
 PT_NAMESNAMEDCHILDREN,
 
 PT_NAMESTREE,
 
 PT_NORMALAPPEARANCEDICT,
 
 PT_OBJECTREF,
 
 PT_OUTLINEENTRY,
 
 PT_OUTLINETREE,
 
 PT_PAGE,
 
 PT_PAGESARRAY,
 
 PT_PAGESEPARATIONS,
 
 PT_PAGESNODE,
 
 PT_PATTERNCOLORSPACE,
 
 PT_POSTSCRIPT,
 
 PT_PRINTERMARKANNOTATION,
 
 PT_PRINTERMARKAPPEARANCE,
 
 PT_RECTANGLE,
 
 PT_RESOURCEDICT,
 
 PT_ROLLOVERAPPEARANCEDICT,
 
 PT_ROOTFIELDSLIST,
 
 PT_SAMPLEDFUNCTION,
 
 PT_SEPARATIONCOLORSPACE,
 
 PT_SEPARATIONINFO,
 
 PT_SOFTMASKDICT,
 
 PT_STITCHINGFUNCTION,
 
 PT_STITCHINGINPUTFUNCTIONS,
 
 PT_STPARENTCHILDREN,
 
 PT_STPARENTINTNODE,
 
 PT_STPARENTLEAFNODE,
 
 PT_STPARENTNUMBEREDCHILDREN,
 
 PT_STRUCTELEMATTRARRAY,
 
 PT_STRUCTELEMENT,
 
 PT_STRUCTELEMLIST,
 
 PT_STRUCTIDCHILDREN,
 
 PT_STRUCTIDINTNODE,
 
 PT_STRUCTIDLEAFNODE,
 
 PT_STRUCTIDNAMEDCHILDREN,
 
 PT_STRUCTIDTREE,
 
 PT_STRUCTPARENTTREE,
 
 PT_STRUCTTREEROOT,
 
 PT_THREAD,
 
 PT_THREADSLIST,
 
 PT_TRANSPARENCYGROUP,
 
 PT_TRUETYPEFONT,
 
 PT_TYPE1FONT,
 
 PT_TYPE3FONT,
 
 PT_WEBCAPCOMMAND,
 
 PT_WEBCAPCOMMANDLIST,
 
 PT_WEBCAPCOMMANDSETTINGS,
 
 PT_WEBCAPCONTENTSET,
 
 PT_WEBCAPIDSCHILDREN,
 
 PT_WEBCAPIDSINTNODE,
 
 PT_WEBCAPIDSLEAFNODE,
 
 PT_WEBCAPIDSNAMEDCHILDREN,
 
 PT_WEBCAPIDSTREE,
 
 PT_WEBCAPIMAGESET,
 
 PT_WEBCAPIMAGESETARRAY,
 
 PT_WEBCAPINFO,
 
 PT_WEBCAPPAGESET,
 
 PT_WEBCAPPAGESETARRAY,
 
 PT_WEBCAPSOURCEINFO,
 
 PT_WEBCAPURLALIASDICT,
 
 PT_WEBCAPURLCHAIN,
 
 PT_WEBCAPURLSCHILDREN,
 
 PT_WEBCAPURLSINTNODE,
 
 PT_WEBCAPURLSLEAFNODE,
 
 PT_WEBCAPURLSNAMEDCHILDREN,
 
 PT_WEBCAPURLSTREE,
 
 PT_WIDGETANNOTATION,
 
 PT_XOBJECTLIST,
 
 PT_ABRANGE,
 
 PT_ACTUALTEXT,
 
 PT_ALTERNATETEXT,
 
 PT_ANNOTATIONBORDER,
 
 PT_ANNOTATIONBORDERSTYLE,
 
 PT_ANNOTATIONCOLOR,
 
 PT_ANNOTATIONLOC,
 
 PT_APPEARANCE,
 
 PT_ARTBOXSTYLE,
 
 PT_BEADSARRAY,
 
 PT_BG2FUNCTION,
 
 PT_BGFUNCTION,
 
 PT_BLACKPOINT,
 
 PT_BLEEDBOXSTYLE,
 
 PT_BLENDMODE,
 
 PT_BOUNDINGBOX,
 
 PT_BOXSTYLE,
 
 PT_BUTTONFIELD,
 
 PT_CHARPROC_STREAM,
 
 PT_CHOICEFIELDOPTIONS,
 
 PT_CHOICEFIELDVALUE,
 
 PT_CIDTYPE0FONT,
 
 PT_CIDTYPE2FONT,
 
 PT_CIRCLEANNOTATION,
 
 PT_OBSOLETE3,
 
 PT_COLORANTNAMES,
 
 PT_COLORSPACE,
 
 PT_COLORSPACETYPE,
 
 PT_CONTENTSSTREAM,
 
 PT_CROPBOX,
 
 PT_CROPBOXSTYLE,
 
 PT_DASHPATTERN,
 
 PT_DATE,
 
 PT_DEFAULTFUNCTION,
 
 PT_DEFAULTHALFTONE,
 
 PT_DEFRESOURCEDICT,
 
 PT_DEVICECMYKCOLORSPACE,
 
 PT_DEVICEGRAYCOLORSPACE,
 
 PT_DEVICERGBCOLORSPACE,
 
 PT_OBSOLETE4,
 
 PT_DOWNAPPEARANCE,
 
 PT_EMBEDDEDFONTSTREAM,
 
 PT_EMBEDDEDOBJDICT,
 
 PT_OBSOLETE5,
 
 PT_OBSOLETE6,
 
 PT_EXPONENTIAL0RESULT,
 
 PT_EXPONENTIAL1RESULT,
 
 PT_FILEATTACHANNOTATION,
 
 PT_FONTBBOX,
 
 PT_FONTMATRIX,
 
 PT_FONTTABLEENTRY,
 
 PT_FONTWIDTHS,
 
 PT_OBSOLETE7,
 
 PT_FORMIMPORTACTION,
 
 PT_OBSOLETE0,
 
 PT_FORMRESETACTION,
 
 PT_FORMSUBMITACTION,
 
 PT_FREETEXTANNOTATION,
 
 PT_FUNCTIONDOMAIN,
 
 PT_FUNCTIONNAME,
 
 PT_FUNCTIONRANGE,
 
 PT_GOTORACTION,
 
 PT_GROUPATTRIBUTES,
 
 PT_GSTATEFONT,
 
 PT_HALFTONE,
 
 PT_HALFTONEPHASE,
 
 PT_HIDEACTION,
 
 PT_HIGHLIGHTANNOTATION,
 
 PT_ICCRANGE,
 
 PT_IDENTITYFUNCTION,
 
 PT_INDEXEDLOOKUP,
 
 PT_INKANNOTATION,
 
 PT_JAVASCRIPT,
 
 PT_OBSOLETE8,
 
 PT_LANGUAGESPEC,
 
 PT_LASTMODIFIED,
 
 PT_LAUNCHACTION,
 
 PT_LEVEL1POSTSCRIPT,
 
 PT_LINEANNOTATION,
 
 PT_MARKEDPDFINFODICT,
 
 PT_MEDIABOX,
 
 PT_METADATASTREAM,
 
 PT_MOVIEACTION,
 
 PT_MOVIEANNOTATION,
 
 PT_NAMEDACTION,
 
 PT_NAMEDOBJECT,
 
 PT_NAMEDOBJECTNAME,
 
 PT_NOPACTION,
 
 PT_NORMALAPPEARANCE,
 
 PT_OBSOLETE9,
 
 PT_OBSOLETE1,
 
 PT_OBSOLETE2,
 
 PT_PAGELABELTREE,
 
 PT_PIECEINFO,
 
 PT_POPUPANNOTATION,
 
 PT_POSTSCRIPTFUNCTION,
 
 PT_PREVIOUSACTION,
 
 PT_PROCSET,
 
 PT_RECTPOINT,
 
 PT_REFERENCEDPDF,
 
 PT_RGBGAMMA,
 
 PT_RGBGAMMAMATRIX,
 
 PT_ROLLOVERAPPEARANCE,
 
 PT_SAMPLEDFUNCTIONDECODE,
 
 PT_SAMPLEDFUNCTIONENCODE,
 
 PT_SAMPLEDFUNCTIONSIZE,
 
 PT_SETSTATEACTION,
 
 PT_SIGNATUREDICT,
 
 PT_SIGNATUREFIELD,
 
 PT_SOFTMASKIMAGE,
 
 PT_SOFTMASKNAME,
 
 PT_SOUNDACTION,
 
 PT_SOUNDANNOTATION,
 
 PT_SQUAREANNOTATION,
 
 PT_STAMPANNOTATION,
 
 PT_STITCHINGFUNCTIONBOUNDS,
 
 PT_STITCHINGFUNCTIONENCODE,
 
 PT_STRIKEOUTANNOTATION,
 
 PT_STRUCTCLASSMAP,
 
 PT_STRUCTELEMATTR,
 
 PT_STRUCTROLEMAP,
 
 PT_TEXTANNOTATION,
 
 PT_TEXTFIELD,
 
 PT_THREADACTION,
 
 PT_THREADINFO,
 
 PT_THUMBNAIL,
 
 PT_TINTTRANSFORM,
 
 PT_TR2FUNCTION,
 
 PT_TRANSITION,
 
 PT_TRAPNETANNOTATION,
 
 PT_TRFUNCTION,
 
 PT_TRIMBOXSTYLE,
 
 PT_TRUETYPEFONTSTREAM,
 
 PT_TYPE0FONT,
 
 PT_TYPE1FONTSTREAM,
 
 PT_TYPE1UNICODEMAP,
 
 PT_UCR2FUNCTION,
 
 PT_UCRFUNCTION,
 
 PT_UNDERLINEANNOTATION,
 
 PT_OBSOLETE10,
 
 PT_URIACTION,
 
 PT_URIDICT,
 
 PT_URL,
 
 PT_OBSOLETE11,
 
 PT_VIEWERPREFERENCES,
 
 PT_WEBCAPCONTENTNAME,
 
 PT_WEBCAPENGINESETTINGS,
 
 PT_WEBCAPGLOBALSETTINGS,
 
 PT_WEBCAPID,
 
 PT_WEBCAPIMAGEREFCOUNTS,
 
 PT_WHITEPOINT,
 
 PT_XUID,
 
 PT_BUILTINTYPES,
 
 PT_COSNULL,
 
 PT_COSINTEGER,
 
 PT_COSFIXED,
 
 PT_COSBOOLEAN,
 
 PT_COSNAME,
 
 PT_COSSTRING,
 
 PT_COSDICT,
 
 PT_COSARRAY,
 
 PT_COSSTREAM,
 
 PT_NULL,
 
 PT_UNKNOWN,
 
 PT_ALL,
 
 PT_PATTERNLIST,
 
 PT_PATTERN,
 
 PT_SHADINGPATTERN,
 
 PT_TILINGPATTERN,
 
 PT_TILINGPATTERNBBOX,
 
 PT_PATTERNMATRIX,
 
 PT_SHADING,
 
 PT_TYPE1SHADING,
 
 PT_TYPE2SHADING,
 
 PT_TYPE3SHADING,
 
 PT_TYPE4SHADING,
 
 PT_TYPE5SHADING,
 
 PT_TYPE6SHADING,
 
 PT_TYPE7SHADING,
 
 PT_SHADINGBBOX,
 
 PT_SHADINGBACKGROUND,
 
 PT_SHADINGDOMAIN,
 
 PT_SHADINGMATRIX,
 
 PT_SHADINGCOORDS,
 
 PT_SHADINGDECODEARRAY,
 
 PT_TRUETYPEUNICODEMAP,
 
 PT_TYPE3UNICODEMAP,
 
 PT_CIDSYSTEMINFO,
 
 PT_CIDGLYPHWIDTHS,
 
 PT_CIDDEFAULTVERTICALMETRICS,
 
 PT_CIDVERTICALWIDTHS,
 
 PT_TYPE0UNICODEMAP,
 
 PT_INKANNOTINKLIST,
 
 PT_INKANNOTINKLISTITEM,
 
 PT_APPEARCHARACTERISTICS,
 
 PT_APPEARCHARBOARDERCOLOR,
 
 PT_APPEARCHARBACKGRNDCOLOR,
 
 PT_PAGELABELSCHILDREN,
 
 PT_PAGELABELSNAMEDCHILDREN,
 
 PT_PAGELABELSINTNODE,
 
 PT_PAGELABELSLEAFNODE,
 
 PT_PAGELABELDICT,
 
 PT_OPIVERSIONDICT,
 
 PT_OPI_1_3_DICT,
 
 PT_OPI_2_0_DICT,
 
 PT_MARKEDCONTENTLIST,
 
 PT_WEBCAPSOURCEINFOLIST,
 
 PT_SOFTMASKBACKGRNDCOLOR,
 
 PT_SHADINGLIST,
 
 PT_MARKEDCONTENTDICT,
 
 PT_ALTERNATEIMAGESARRAY,
 
 PT_ALTERNATEIMAGEDICT,
 
 PT_ALTERNATEIMAGE,
 
 PT_FONTTOUNICODEMAP,
 
 PT_FILESPEC,
 
 PT_FILESPECID,
 
 PT_FILESPECEMBEDDEDFILEDICT,
 
 PT_EMBEDDEFILESTRMPARAMSDICT,
 
 PT_EMBEDDEDFILESTRMRESFORK,
 
 PT_EMBEDDEFILESTRMMACPARAMS,
 
 PT_EMBEDDEFILESTREAM,
 
 PT_JOBTICKET,
 
 PT_JTACCOUNTINGOBJ,
 
 PT_JTADDRESSOBJLIST,
 
 PT_JTANALYSISOBJECT,
 
 PT_JTANALYSISOBJLIST,
 
 PT_JTAUDITOBJECT,
 
 PT_JTAUDITOBJECTLIST,
 
 PT_JTCOLORANTALIASOBJ,
 
 PT_JTCOLORANTALIASOBJLIST,
 
 PT_JTCOLORANTCONTROLOBJ,
 
 PT_JTCOLORSPACESUBOBJ,
 
 PT_JTCOLORSPACESUBOBJLIST,
 
 PT_JTCONTENTLIST,
 
 PT_JTCONTENTOBJECT,
 
 PT_JTDELIVERYOBJ,
 
 PT_JTDELIVERYOBJLIST,
 
 PT_JTDOCOBJECT,
 
 PT_JTDOCOBJLIST,
 
 PT_JTFILEOBJECT,
 
 PT_JTFILEOBJECTFILESDICT,
 
 PT_JTFILESLIST,
 
 PT_JTFINISHINGOBJ,
 
 PT_JTFINISHINGOBJLIST,
 
 PT_JTINSERTPAGESOBJ,
 
 PT_JTINSERTSHEETOBJ,
 
 PT_JTINVENTORYOBJ,
 
 PT_JTLAYOUTOBJ,
 
 PT_JTMEDIAOBJ,
 
 PT_JTMEDIASOURCEOBJ,
 
 PT_JTPAGERANGELIST,
 
 PT_JTPAGERANGEOBJ,
 
 PT_JTPLACEDOBJECT,
 
 PT_JTPLACEDOBJLIST,
 
 PT_JTPLANEORDEROBJ,
 
 PT_JTPLANEORDEROBJLIST,
 
 PT_JTPREFLIGHTCONSTRAINTLIST,
 
 PT_JTPREFLIGHTDETAILOBJ,
 
 PT_JTPREFLIGHTDETAILOBJLIST,
 
 PT_JTPREFLIGHTINSTANCE,
 
 PT_JTPREFLIGHTINSTANCELIST,
 
 PT_JTPREFLIGHTOBJECT,
 
 PT_JTPREFLIGHTRESULTSOBJ,
 
 PT_JTPRINTLAYOUTOBJ,
 
 PT_JTPROFILEOBJECT,
 
 PT_JTPROFILEOBJLIST,
 
 PT_JTRENDERINGOBJ,
 
 PT_JTRESOURCEALIASLIST,
 
 PT_JTRESOURCEALIASOBJ,
 
 PT_JTSHEETOBJ,
 
 PT_JTSHEETOBJLIST,
 
 PT_JTSIGNATUREOBJ,
 
 PT_JTSIGNATUREOBJLIST,
 
 PT_JTSLIPSHEETOBJ,
 
 PT_JTSOURCECLIPPATH,
 
 PT_JTSURFACEOBJECT,
 
 PT_JTTILINGOBJ,
 
 PT_JTTILINGOBJLIST,
 
 PT_JTTRAPPINGOBJ,
 
 PT_JTTRAPPINGPARAMOBJ,
 
 PT_JTTRAPREGIONOBJ,
 
 PT_JTTRAPREGIONSLIST,
 
 PT_JTRESOURCELIST,
 
 PT_JTADDRESSOBJECT,
 
 PT_JTDETAILSOBJECT,
 
 PT_JTCOLORANTALIASES,
 
 PT_JTCOLORANTORDER,
 
 PT_JTCOLORANTPARAMS,
 
 PT_JTCOLORANTDETAILSOBJ,
 
 PT_JTDEVICECOLORANTOBJ,
 
 PT_JTTARGETCOLORANTNAMES,
 
 PT_BLEEDBOX,
 
 PT_JTFONTPOLICYOBJ,
 
 PT_JTMEDIAUSAGEOBJ,
 
 PT_JTSCHEDULINGOBJ,
 
 PT_JTFILEDECODEPARAMSLIST,
 
 PT_JTFILEOBJECTFILTERS,
 
 PT_JTFINISHINGDETAILSOBJ,
 
 PT_JTSURFACECONTENTSBOX,
 
 PT_JTMEDIAOBJDIMENSIONS,
 
 PT_JTPAGERANGEWHICH,
 
 PT_JTCLIPBOX,
 
 PT_JTCOORDTRANSFORMMATRIX,
 
 PT_JTCOLORANTPLANESARRAY,
 
 PT_JTPREFLIGHTCONSTRAINTOBJ,
 
 PT_JTPREFLIGHTDETAILOBJPAGES,
 
 PT_JTPREFLIGHTINSTANCEPAGES,
 
 PT_JTPREFLIGHTINSTANCEDETAIL,
 
 PT_RENDERINGRESOLUTION,
 
 PT_JTDEVICERENDERINGINFO,
 
 PT_JTPOSTRENDERINGINFO,
 
 PT_JTPRERENDERINGINFO,
 
 PT_JTSHEETALIGNMENT,
 
 PT_JTSLIPSHEETALIGNMENT,
 
 PT_JTSOURCECLIPPATHPOINT,
 
 PT_JTMARKEDREFSARRAY,
 
 PT_JTTRAPPINGORDER,
 
 PT_JTCOLORANTZONEDETAILSOBJ,
 
 PT_JTTRAPZONE,
 
 PT_JTTRAPZONELIST,
 
 PT_JTTRAPPINGPARAMOBJLIST,
 
 PT_JTTRAPPINGDETAILSOBJ,
 
 PT_JTCOORDTRANSFORMDICT,
 
 PT_AFTEMPLATE,
 
 PT_SOUNDSTREAM,
 
 PT_SCREENANNOT,
 
 PT_RENDITIONACTION,
 
 PT_RENDITION,
 
 PT_MEDIARENDITION,
 
 PT_SELECTORRENDITION,
 
 PT_RENDITIONSLIST,
 
 PT_ALTERNATEPRESCHILDREN,
 
 PT_ALTERNATEPRESINTNODE,
 
 PT_ALTERNATEPRESLEAFNODE,
 
 PT_ALTERNATEPRESNAMEDCHILDREN,
 
 PT_SLIDESHOW,
 
 PT_ALTERNATEPRESTREE,
 
 PT_OCGSARRAY,
 
 PT_OCPROPERTIES,
 
 PT_OCCONFIGSARRAY,
 
 PT_OCGUSAGE,
 
 PT_OCG,
 
 PT_OCCONFIGDICT,
 
 PT_OCASARRAY,
 
 PT_OCUSAGEAPPLICATION,
 
 PT_OCMD,
 
 PT_SETOCGSTATEACTION,
 
 PT_MEDIACRITERIA,
 
 PT_MEDIACLIP,
 
 PT_MEDIACLIPDATA,
 
 PT_MEDIAPERMSDICT,
 
 PT_MEDIAPLAYERS,
 
 PT_MEDIAPLAYPARAMS,
 
 PT_MEDIASCREENPARAMS,
 
 PT_MEDIACLIPSECTION,
 
 PT_MEDIAPLAYINFOARRAY,
 
 PT_MEDIAPLAYINFO,
 
 PT_FONTENCODINGSDICT,
 
 PT_STRUCTELEMATTRBBOX,
 
 PT_3DANNOTATION,
 
 PT_3DSTREAM,
 
 PT_3DREF,
 
 PT_BOGUS_NO_SUCH_TYPE = 0x7FFFFFFF
}

File: ConsObTp.h
Line: 16

tagRegAgentFlag 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

enum tagRegAgentFlag {
 REG_ONLYREVISITUNKNOWN = 0,
 
 REG_REVISITNONE,
 
 REG_REVISITRECLASS_ALL = REQUIRES_CLASSIFY,
 
 REG_REVISITRECLASS_ALWAYSUNKNOWN,
 
 REG_REVISIT_ONDEMAND = 0x00000100
}

File: ConsExpT.h
Line: 320

Elements
REG_ONLYREVISITUNKNOWN  

Revisit unknown objects only. Once the object is of a known type, that object is no longer visited. Visit all objects of known types only once (unless an agent returns OD_REVISIT for the object).

 
REG_REVISITNONE  

Do not revisit objects of any type, whether or not they are later encountered with a new classification at some point. Only revisit an object if an agent returns OD_REVISIT for the object.

 
REG_REVISITRECLASS_ALL  

Revisit an object whenever it is encountered again with a new classification (regardless of whether the new classification is as an unknown type).

 
REG_REVISITRECLASS_ALWAYSUNKNOWN  

Revisit an object whenever it is encountered again with a new classification, but always revisit objects classified as unknown (even if the object has previously been encountered and classified as unknown).

 
Variables Detail
gCatalogHFT 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

HFT gCatalogHFT;

File: cathft.h
Line: 85
gConsultantHFT 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

HFT gConsultantHFT;

File: ConsHFT.h
Line: 40
gSearchHFT 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

HFT gSearchHFT;

File: SrchHFT.h
Line: 53
gSpellerHFT 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

HFT gSpellerHFT;

File: SpellerHFT.h
Line: 38
gWLHFT 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

HFT gWLHFT;

File: WLHFT.h
Line: 387

Structure Detail
_t_DirConnection
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_DirConnection {
 ASSize_t size; 
 
 void* clientData; 
 
 DirConnection_close close; 
 
 DirConnection_getLastError getLastError; 
 
 DirConnection_getDirInfo getDirInfo; 
 
 DirConnection_getGroups getGroups; 
 
 DirConnection_setStandardOutputOptions setStandardOutputOptions; 
 
 DirConnection_setCustomOutputOptions setCustomOutputOptions; 
 
 DirConnection_standardSearch standardSearch; 
 
 DirConnection_customSearch customSearch; 
 
 DirConnection_customUISearch customUISearch; 
 
 DirConnection_list list; 
}

A directory connection object structure.


File: DirectoryHFT.h
Line: 343

Elements
size  

The size of this data structure.

 
clientData  

The data to be passed in.

 
_t_HyphenationRecord 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_HyphenationRecord {
 eHyphenType eType; 
 
 ASInt32 nPosition; 
 
 ASText astLeft; 
 
 ASText astRight; 
}

The hyphenation record.

One of these is returned by HyphenateWord() in the optional hyphenation array for each known hyphenation.


File: Speller_Sel.h
Line: 338

Elements
eType  

The type of hyphenation: preferred, normal, or non-preferred.

 
nPosition  

The hyphen index. The hyphen should follow this character.

 
astLeft  

The word part before the hyphen.

 
astRight  

The word part after the hyphen.

_t_InitProcs 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_InitProcs {
 PDFLInitType initProc; 
 
 PDFLGetCoreHFTType getCoreHFTProc; 
 
 PDFLInitThreadLocalDataType initThreadLocalData; 
}


File: PDFLInitCommon.h
Line: 40

_t_monoInkList 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_monoInkList {
 char* name; 
 
 float level; 
 
 _t_monoInkList next; 
}

Image ink monochrome list.


File: PDFLExpT.h
Line: 1530

Elements
name  

Name of the colorant.

 
level  

Concentration of the colorant.

 
next  

Pointer to next list element.

_t_PDFLData 
Product availability: PDFL
Platform availability: Macintosh

Syntax

struct _t_PDFLData {
 ASSize_t size; 
 
 ASUns32 flags; 
 
 char** dirList; 
 
 ASInt32 listLen; 
 
 TKAllocatorProcsP allocator; 
 
 short resFile; 
 
 TKResourceProcsP resProcs; 
 
 TKExtensionProcsP extProcs; 
 
 char** cacheFileList; 
 
 char* systemCacheFile; 
 
 char* commonCacheFile; 
 
 char* cMapDirectory; 
 
 char* unicodeDirectory; 
 
 ASInt32 pluginDirListLen; 
 
 char** pluginDirList; 
 
 ASInt32 colorProfileDirListLen; 
 
 char** colorProfileDirList; 
}

PDFLData structure.


File: PDFInit.h
Line: 558

Elements
size  

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

 
flags  

Currently kPDFLInitIgnoreDefaultDirectories , kPDFLInitIgnoreSystemFonts and kDontLoadPlugIns flags are supported. When kPDFLInitIgnoreDefaultDirectories flag is set, the initialization process does not search through the default font directories(currently Adobe font directories installed by some Adobe applications), but only in those specified in dirList. When kPDFLInitIgnoreSystemFonts flag is set, the initialization process does not search through default System fonts also. When kDontLoadPlugIns flag is set, plug-ins are ignored during initialization process.

 
dirList  

A list of directories with fonts.

 
listLen  

The number of directories listed in dirList.

 
allocator  

The structure containing function pointers for memory allocation callbacks. The library manages its own memory. Most applications linking with the library should pass NULL for this member. Applications wishing more control over memory allocation can fill out this structure and will be responsible for providing and freeing memory, as well as reporting available memory as requested by the library.

 
resFile  

(Mac only)

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

 
resProcs  

The structure containing function pointers for resource management callbacks. The library manages its own resources. Most applications linking with the library should pass NULL for this member. Applications wishing more control over resource allocation can fill out this structure and will be responsible for providing and freeing resources requested by the library.

 
extProcs  

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

 
cacheFileList  

A list of font cache file names. It is parallel to dirList, but contains separately configurable target files for CoolType cache files for use in cases where the specified font directory may not be writable by the client. If same font cache file name is provided for different font directories, font cache file created for the earlier font directory will get overwritten. Either cacheFileList or any/all of its subsidiary pointers may be NULL, in which case CoolType will default to the font directory passed in dirList.

 
systemCacheFile  

Separately configurable target file where CoolType should store the system font cache file. It may be NULL, in which case CoolType will choose a default path.

 
commonCacheFile  

Separately configurable target file where CoolType should store the common font cache file. It may be NULL, in which case CoolType will choose a default path.

 
cMapDirectory  

The complete NULL-terminated path of the directory where CoolType can find CMap files. This directory will be the preferred location for CMaps that are associated with the system fontset. If CMaps with the same name are found in this directory and common fonts directory, the copy in this directory will be preferred. May be NULL, in which case CoolType will only associate CMaps present in common fonts directory with the system font set.

 
unicodeDirectory  

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

 
pluginDirListLen  

Specifies the number of directories listed in pluginDirList. With regards to loading plug-ins, PDF Library behavior is now as follows:

  • If pluginDirListLen > 0, then PDF Library will only look for plug-ins in the paths passed in pluginDirList. It will not search the earlier locations, (for example, "pdfplug_ins" folder on Windows, "PDFPlug-Ins" on Mac OS, and the list of directories passed in dirList on Unix.

  • If pluginDirListLen <= 0 or is not a part of the PDFLDataRec structure passed by the PDF Library client, then PDF Library will search the earlier locations for plug-ins.

 
pluginDirList  

An array of plug-in directories.

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

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

  • On Windows, pluginDirList is an array of ASUTF16Val paths. Each path should be NULL-terminated.

  • On Mac OS, the paths passed in pluginDirList should be NULL-terminated UTF-8 POSIX strings. Hence, the type of pluginDirList on Mac is char **.

  • On Unix, the paths passed in pluginDirList should be simple NULL-terminated char strings.

 
colorProfileDirListLen  

Specifies the number of directories listed in colorProfileDirList.

 
colorProfileDirList  

An array of color profile directories.

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

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

  • On Windows, colorProfileDirList is an array of ASUTF16Val paths. Each path should be NULL-terminated.

  • On Mac OS, the paths passed in colorProfileDirList should be NULL-terminated UTF-8 POSIX strings. Hence, the type of colorProfileDirList on Mac is char **.

  • On Unix, the paths passed in colorProfileDirList should be simple NULL-terminated char strings.

_t_PDFLData 
Product availability: PDFL
Platform availability: UNIX

Syntax

struct _t_PDFLData {
 ASSize_t size; 
 
 ASUns32 flags; 
 
 char** dirList; 
 
 ASInt32 listLen; 
 
 TKAllocatorProcsP allocator; 
 
 TKResourceProcsP resProcs; 
 
 TKExtensionProcsP extProcs; 
 
 char** cacheFileList; 
 
 char* systemCacheFile; 
 
 char* commonCacheFile; 
 
 char* unicodeDirectory; 
 
 char* cMapDirectory; 
 
 ASInt32 pluginDirListLen; 
 
 char** pluginDirList; 
 
 ASInt32 colorProfileDirListLen; 
 
 char** colorProfileDirList; 
}

PDFLData structure.


File: PDFInit.h
Line: 727

Elements
size  

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

 
flags  

Currently kPDFLInitIgnoreDefaultDirectories , kPDFLInitIgnoreSystemFonts and kDontLoadPlugIns flags are supported. When kPDFLInitIgnoreDefaultDirectories flag is set, the initialization process does not search through the default font directories(currently Adobe font directories installed by some Adobe applications), but only in those specified in dirList. When kPDFLInitIgnoreSystemFonts flag is set, the initialization process does not search through default System fonts also. When kDontLoadPlugIns flag is set, plug-ins are ignored during initialization process.

 
dirList  

A list of directories with fonts.

 
listLen  

The number of directories listed in dirList.

 
allocator  

The structure containing function pointers for memory allocation callbacks. The library manages its own memory. Most applications linking with the library should pass NULL for this member. Applications wishing more control over memory allocation can fill out this structure and will be responsible for providing and freeing memory, as well as reporting available memory as requested by the library.

 
resProcs  

The structure containing function pointers for resource management callbacks. The library manages its own resources. Most applications linking with the library should pass NULL for this member. Applications wishing more control over resource allocation can fill out this structure and will be responsible for providing and freeing resources requested by the library.

 
extProcs  

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

 
cacheFileList  

A list of font cache file names. It is parallel to dirList, but contains separately configurable target files for CoolType cache files for use in cases where the specified font directory may not be writable by the client. If same font cache file name is provided for different font directories, font cache file created for the earlier font directory will get overwritten. Either cacheFileList or any/all of its subsidiary pointers may be NULL, in which case CoolType will default to the font directory passed in dirList.

 
systemCacheFile  

Separately configurable target file where CoolType should store the system font cache file. It may be NULL, in which case CoolType will choose a default path.

 
commonCacheFile  

Separately configurable target file where CoolType should store the common font cache file. It may be NULL, in which case CoolType will choose a default path.

 
unicodeDirectory  

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

 
cMapDirectory  

The complete NULL-terminated path of the directory where CoolType can find CMap files. This directory will be the preferred location for CMaps that are associated with the system fontset. If CMaps with the same name are found in this directory and common fonts directory, the copy in this directory will be preferred. May be NULL, in which case CoolType will only associate CMaps present in common fonts directory with the system font set.

 
pluginDirList  

An array of plug-in directories.

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

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

  • On Windows, pluginDirList is an array of ASUTF16Val paths. Each path should be NULL-terminated.

  • On Mac OS, the paths passed in pluginDirList should be NULL-terminated UTF-8 POSIX strings. Hence, the type of pluginDirList on Mac is char **.

  • On Unix, the paths passed in pluginDirList should be simple NULL-terminated char strings.

 
colorProfileDirListLen  

Specifies the number of directories listed in colorProfileDirList.

 
colorProfileDirList  

An array of color profile directories.

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

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

  • On Windows, colorProfileDirList is an array of ASUTF16Val paths. Each path should be NULL-terminated.

  • On Mac OS, the paths passed in colorProfileDirList should be NULL-terminated UTF-8 POSIX strings. Hence, the type of colorProfileDirList on Mac is char **.

  • On Unix, the paths passed in colorProfileDirList should be simple NULL-terminated char strings.

_t_PDFLData 
Product availability: PDFL
Platform availability: Windows

Syntax


File: PDFInit.h
Line: 381

Elements
size  

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

 
flags  

Currently kPDFLInitIgnoreDefaultDirectories , kPDFLInitIgnoreSystemFonts and kDontLoadPlugIns flags are supported. When kPDFLInitIgnoreDefaultDirectories flag is set, the initialization process does not search through the default font directories(currently Adobe font directories installed by some Adobe applications), but only in those specified in dirList. When kPDFLInitIgnoreSystemFonts flag is set, the initialization process does not search through default System fonts also. When kDontLoadPlugIns flag is set, plug-ins are ignored during initialization process.

 
inst  

(Windows only)

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

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

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

Free the HINSTANCE with FreeLibrary after you call PDFLTerm.

 
dirList  

List of directories with fonts.

 
listLen  

The number of directories listed in dirList.

 
allocator  

The structure containing function pointers for memory allocation callbacks. The library manages its own memory. Most applications linking with the library should pass NULL for this member. Applications wishing more control over memory allocation can fill out this structure and will be responsible for providing and freeing memory, as well as reporting available memory as requested by the library.

 
resProcs  

The structure containing function pointers for resource management callbacks. The library manages its own resources. Most applications linking with the library should pass NULL for this member. Applications wishing more control over resource allocation can fill out this structure and will be responsible for providing and freeing resources requested by the library.

 
extProcs  

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

 
cacheFileList  

A list of font cache file names. It is parallel to dirList, but contains separately configurable target files for CoolType cache files for use in cases where the specified font directory may not be writable by the client. If same font cache file name is provided for different font directories, font cache file created for the earlier font directory will get overwritten. Either cacheFileList or any/all of its subsidiary pointers may be NULL, in which case CoolType will default to the font directory passed in dirList.

 
systemCacheFile  

A separately configurable target file where CoolType should store the system font cache file. It may be NULL, in which case CoolType will choose a default path.

 
commonCacheFile  

Separately configurable target file where CoolType should store the common font cache file. It may be NULL, in which case CoolType will choose a default path.

 
cMapDirectory  

The complete NULL-terminated path of the directory where CoolType can find CMap files. This directory will be the preferred location for CMaps that are associated with the system fontset. If CMaps with the same name are found in this directory and common fonts directory, the copy in this directory will be preferred. It may be NULL, in which case CoolType will only associate CMaps present in the common fonts directory with the system font set.

 
unicodeDirectory  

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

 
pluginDirListLen  

Specifies the number of directories listed in pluginDirList. With regards to loading plug-ins, PDF Library behavior is now as follows:

  • If pluginDirListLen > 0, then PDF Library will only look for plug-ins in the paths passed in pluginDirList. It will not search the earlier locations, (for example, "pdfplug_ins" folder on Windows, "PDFPlug-Ins" on Mac OS, and the list of directories passed in dirList on Unix.

  • If pluginDirListLen <= 0 or is not a part of the PDFLDataRec structure passed by the PDF Library client, then PDF Library will search the earlier locations for plug-ins.

 
pluginDirList  

An array of plug-in directories.

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

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

  • On Windows, pluginDirList is an array of ASUTF16Val paths. Each path should be NULL-terminated.

  • On Mac OS, the paths passed in pluginDirList should be NULL-terminated UTF-8 POSIX strings. Hence, the type of pluginDirList on Mac is char **.

  • On Unix, the paths passed in pluginDirList should be simple NULL-terminated char strings.

 
colorProfileDirListLen  

Specifies the number of directories listed in colorProfileDirList.

 
colorProfileDirList  

An array of color profile directories.

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

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

  • On Windows, colorProfileDirList is an array of ASUTF16Val paths. Each path should be NULL-terminated.

  • On Mac OS, the paths passed in colorProfileDirList should be NULL-terminated UTF-8 POSIX strings. Hence, the type of colorProfileDirList on Mac is char **.

  • On Unix, the paths passed in colorProfileDirList should be simple NULL-terminated char strings.

_t_PDFLMemStats 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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


File: PDFLExpT.h
Line: 78

_t_PDFLPrintUserCallbacks 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDFLPrintUserCallbacks {
 ASSize_t size; 
 
 PDPrintCanEmitFontProc CanEmitFont; 
}

The structure holding pointers to certain optional Callbacks available with the PDFLPrintDoc() API.


File: PDFLExpT.h
Line: 2373

_t_PDFLPrintUserParams 
Product availability: PDFL
Platform availability: Macintosh

Syntax

struct _t_PDFLPrintUserParams {
 ASInt32 size; 
 
 ASBool emitToFile; 
 
 PDPrintParams printParams; 
 
 ASStm printStm; 
 
 ASUns16 paperWidth; 
 
 ASUns16 paperHeight; 
 
 ASInt32 dontEmitListLen; 
 
 char** dontEmitList; 
 
 ASBool emitToPrinter; 
 
 void* printRecord; 
 
 PMPrintSession printSession; 
 
 PMPrintSettings printSettings; 
 
 PMPageFormat pageFormat; 
 
 PDFLPrintCancelProc cancelProc; 
 
 void* clientData; 
 
 int startPage; 
 
 int endPage; 
 
 int shrinkToFit; 
 
 int printAnnots; 
 
 int psLevel; 
 
 int nCopies; 
 
 int binaryOK; 
 
 int emitHalftones; 
 
 int reverse; 
 
 int doOPP; 
 
 PDFLPrintUserCallbacks userCallbacks; 
 
 PPDFeaturesP PPDFeatures; 
 
 ASText ppdFileName; 
}

Used to control printing with PDFLPrintDoc.

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

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

See Also

Note

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

File: PDFLPrint.h
Line: 531

Elements
size  

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

 
emitToFile  

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

 
printParams  

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

 
printStm  

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

 
paperWidth  

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

 
paperHeight  

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

 
dontEmitListLen  

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

 
dontEmitList  

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

 
emitToPrinter  

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

 
printRecord  

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

 
printSession  

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

 
printSettings  

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

 
pageFormat  

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

 
cancelProc  

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

 
clientData  

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

 
startPage  

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

 
endPage  

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

 
shrinkToFit  

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

 
printAnnots  

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

 
psLevel  

PostScript level. It applies to a PostScript printer.

 
nCopies  

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

 
binaryOK  

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

 
emitHalftones  

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

 
reverse  

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

 
doOPP  

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

The default is 0.

 
userCallbacks  

Optional pointer to structure containing pointers to user callback functions

 
PPDFeatures  

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

 
ppdFileName  

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

_t_PDFLPrintUserParams 
Product availability: PDFL
Platform availability: UNIX

Syntax

struct _t_PDFLPrintUserParams {
 ASInt32 size; 
 
 PDPrintParams printParams; 
 
 ASBool emitToFile; 
 
 ASStm printStm; 
 
 ASUns16 paperWidth; 
 
 ASUns16 paperHeight; 
 
 ASInt32 dontEmitListLen; 
 
 char** dontEmitList; 
 
 ASBool emitToPrinter; 
 
 char* command; 
 
 PDFLPrintCancelProc cancelProc; 
 
 void* clientData; 
 
 int startResult; 
 
 PDFLPrintUserCallbacks userCallbacks; 
 
 int nCopies; 
 
 PPDFeaturesP PPDFeatures; 
 
 ASText ppdFileName; 
}

Used to control printing with PDFLPrintDoc.

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

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

See Also

Note

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

File: PDFLPrint.h
Line: 90

Elements
size  

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

 
printParams  

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

 
emitToFile  

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

 
printStm  

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

 
paperWidth  

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

 
paperHeight  

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

 
dontEmitListLen  

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

 
dontEmitList  

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

 
emitToPrinter  

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

 
command  

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

 
cancelProc  

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

 
clientData  

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

 
startResult  

Spooler ID from StartDoc

 
userCallbacks  

Optional pointer to structure containing pointers to user callback functions

 
nCopies  

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

 
PPDFeatures  

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

 
ppdFileName  

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

_t_PDFLPrintUserParams 
Product availability: PDFL
Platform availability: Windows

Syntax

struct _t_PDFLPrintUserParams {
 ASInt32 size; 
 
 ASBool emitToFile; 
 
 PDPrintParams printParams; 
 
 ASStm printStm; 
 
 ASUns16 paperWidth; 
 
 ASUns16 paperHeight; 
 
 ASInt32 dontEmitListLen; 
 
 char** dontEmitList; 
 
 ASBool emitToPrinter; 
 
 char* inFileName; 
 
 char* outFileName; 
 
 char* deviceName; 
 
 char* driverName; 
 
 char* portName; 
 
 DEVMODEA* pDevMode; 
 
 int startPage; 
 
 int endPage; 
 
 int shrinkToFit; 
 
 int printAnnots; 
 
 int psLevel; 
 
 int nCopies; 
 
 int binaryOK; 
 
 int emitHalftones; 
 
 int reverse; 
 
 int farEastFontOpt; 
 
 int transQuality; 
 
 int doOPP; 
 
 PDFLPrintCancelProc cancelProc; 
 
 void* clientData; 
 
 int startResult; 
 
 ASUns16 inFileNameW; 
 
 ASUns16 outFileNameW; 
 
 ASUns16 deviceNameW; 
 
 ASUns16 driverNameW; 
 
 ASUns16 portNameW; 
 
 DEVMODEW* pDevModeW; 
 
 HDC pDC; 
 
 PDFLPrintUserCallbacks userCallbacks; 
 
 PPDFeaturesP PPDFeatures; 
 
 ASText ppdFileName; 
}

Used to control printing with PDFLPrintDoc.

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

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

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

See Also

Note

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

File: PDFLPrint.h
Line: 209

Elements
size  

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

 
emitToFile  

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

 
printParams  

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

 
printStm  

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

 
paperWidth  

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

 
paperHeight  

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

 
dontEmitListLen  

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

 
dontEmitList  

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

 
emitToPrinter  

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

 
inFileName  

Deprecated. Use the Unicode version inFileNameW.

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

 
outFileName  

Deprecated. Use the Unicode version outFileNameW.

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

 
deviceName  

Deprecated. Use the Unicode version deviceNameW.

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

 
driverName  

Deprecated. Use the Unicode version driverNameW.

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

 
portName  

Deprecated. Use the Unicode version portNameW.

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

 
pDevMode  

Deprecated. Use the Unicode version pDevModeW.

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

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

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

 
startPage  

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

 
endPage  

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

 
shrinkToFit  

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

 
printAnnots  

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

 
psLevel  

PostScript level. It applies to a PostScript printer.

 
nCopies  

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

 
binaryOK  

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

 
emitHalftones  

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

 
reverse  

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

 
farEastFontOpt  

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

 
transQuality  

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

 
doOPP  

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

The default is 0.

 
cancelProc  

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

 
clientData  

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

 
startResult  

Spooler ID from StartDoc().

 
inFileNameW  

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

 
outFileNameW  

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

 
deviceNameW  

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

 
driverNameW  

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

 
portNameW  

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

 
pDevModeW  

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

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

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

 
pDC  

(Optional) Allows you to pass a DeviceContext structure.

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

 
userCallbacks  

Optional pointer to structure containing pointers to user callback functions

 
PPDFeatures  

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

 
ppdFileName  

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

_t_PDFLPrintUserParamsEx 
Product availability: PDFL
Platform availability: Windows

Syntax

struct _t_PDFLPrintUserParamsEx {
 ASInt32 size; 
 
 ASBool emitToFile; 
 
 PDPrintParams printParams; 
 
 ASStm printStm; 
 
 ASUns16 paperWidth; 
 
 ASUns16 paperHeight; 
 
 ASInt32 dontEmitListLen; 
 
 char** dontEmitList; 
 
 ASBool emitToPrinter; 
 
 char* inFileName; 
 
 char* outFileName; 
 
 char* deviceName; 
 
 char* driverName; 
 
 char* portName; 
 
 DEVMODEA* pDevMode; 
 
 int startPage; 
 
 int endPage; 
 
 int shrinkToFit; 
 
 int printAnnots; 
 
 int psLevel; 
 
 int nCopies; 
 
 int binaryOK; 
 
 int emitHalftones; 
 
 int reverse; 
 
 int farEastFontOpt; 
 
 int transQuality; 
 
 int doOPP; 
 
 PDFLPrintCancelProc cancelProc; 
 
 void* clientData; 
 
 int startResult; 
 
 ASUns16 inFileNameW; 
 
 ASUns16 outFileNameW; 
 
 ASUns16 deviceNameW; 
 
 ASUns16 driverNameW; 
 
 ASUns16 portNameW; 
 
 DEVMODEW* pDevModeW; 
 
 HDC pDC; 
 
 PDFLPrintUserCallbacks userCallbacks; 
 
 PPDFeaturesP PPDFeatures; 
 
 ASText ppdFileName; 
 
 ASBool oneJobwithNCopies; 
}

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

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

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

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

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

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

Used to control printing with PDFLPrintDoc.

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

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

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

See Also

Note

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

File: PDFLPrint.h
Line: 717

Elements
size  

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

 
emitToFile  

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

 
printParams  

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

 
printStm  

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

 
paperWidth  

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

 
paperHeight  

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

 
dontEmitListLen  

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

 
dontEmitList  

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

 
emitToPrinter  

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

 
inFileName  

Deprecated. Use the Unicode version inFileNameW.

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

 
outFileName  

Deprecated. Use the Unicode version outFileNameW.

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

 
deviceName  

Deprecated. Use the Unicode version deviceNameW.

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

 
driverName  

Deprecated. Use the Unicode version driverNameW.

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

 
portName  

Deprecated. Use the Unicode version portNameW.

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

 
pDevMode  

Deprecated. Use the Unicode version pDevModeW.

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

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

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

 
startPage  

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

 
endPage  

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

 
shrinkToFit  

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

 
printAnnots  

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

 
psLevel  

PostScript level. It applies to a PostScript printer.

 
nCopies  

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

 
binaryOK  

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

 
emitHalftones  

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

 
reverse  

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

 
farEastFontOpt  

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

 
transQuality  

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

 
doOPP  

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

The default is 0.

 
cancelProc  

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

 
clientData  

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

 
startResult  

Spooler ID from StartDoc().

 
inFileNameW  

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

 
outFileNameW  

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

 
deviceNameW  

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

 
driverNameW  

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

 
portNameW  

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

 
pDevModeW  

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

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

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

 
pDC  

(Optional) Allows you to pass a DeviceContext structure.

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

 
userCallbacks  

Optional pointer to structure containing pointers to user callback functions

 
PPDFeatures  

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

 
ppdFileName  

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

 
_t_PDPrintClient 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PDPrintClient {
 ASSize_t size; 
 
 PDDoc pdDoc; 
 
 PDPrintParams params; 
 
 void DocBegin)(const PDPageRange ranges[], ASInt32 numRanges, ASStm stm, const PDResTree docTree, PDPrintClient printClient); 
 
 ASBool DocSetup)(const PDPageRange ranges[], ASInt32 numRanges, ASStm prologStm, PDPrintClient printClient); 
 
 void EndSetup)(ASStm stm, PDPrintClient client); 
 
 void NotifyNewPage)(ASInt32 pageNum, PDPrintClient printClient); 
 
 void PageBegin)(ASStm stm, ASInt32 pageNum, const PDResTree pageTree, PDPrintClient printClient); 
 
 ASBool PageSetup)(ASStm stm, ASInt32 pageNum, PDPrintClient printClient); 
 
 void PageSetupPostResource)(ASStm stm, ASInt32 pageNum, PDPrintClient printClient); 
 
 void PageCleanup)(ASStm stm, ASInt32 pageNum, PDPrintClient printClient); 
 
 void EmitPageContents)(ASStm stm, ASInt32 pageNum, PDPage pdPage, PDPrintClient printClient); 
 
 void PageEnd)(ASStm stm, ASInt32 pageNum, ASBool veryLastPage, PDPrintClient printClient); 
 
 void DocEnd)(ASStm stm, PDPrintClient printClient, PDPrintController controller); 
 
 PDPrintGetFontEncodingMethodProc GetFontEncodingMethod; 
 
 ASInt32 GetFontVMUsage)(PDFont fontP, PDPrintClient printClient); 
 
 void EmitPSFontBegin)(ASStm stm, PDFont fontP, PDPrintClient printClient); 
 
 void EmitPSFontEnd)(ASStm stm, PDFont fontP, PDPrintClient printClient); 
 
 ASBool EmitPSFontEncodingBegin)(ASStm stm, PDFont fontP, PDPrintClient printClient); 
 
 void EmitPSFontEncodingEnd)(ASStm stm, PDFont fontP, PDPrintClient printClient); 
 
 void EmitPSResourceBegin)(ASStm stm, ASAtom resType, const char *resName, CosObj resObj, PDPrintClient printClient); 
 
 void EmitPSResourceEnd)(ASStm stm, ASAtom resType, const char *resName, CosObj resObj, PDPrintClient printClient); 
 
 ASBool ShouldCancel)(PDPrintClient printClient); 
 
 ASBool CancelPrintJob)(PDPrintClient printClient); 
 
 ASInt32 FlushString)(char *data, ASInt32 nData, PDPrintClient printClient); 
 
 ASInt32 EmitPrologString)(const char *s, ASInt32 nData, PDPrintClient printClient); 
 
 PDPrintCanEmitFontProc CanEmitFont; 
 
 PDPrintEmitFontProc EmitFont; 
 
 ASBool UndefineFont)(ASStm stm, PDFont fontP, ASBool vmUndefine, PDPrintClient client); 
 
 ASBool EmitFontProcSet)(ASStm stm, PDFont fontP, PDPrintClient client); 
 
 ASBool EmitGlyphsIncr)(ASStm stm, PDFont fontP, PDPrintStrP srcStr, PDPrintStrP dstStr, ASUns32 *srcBytesUsed, ASUns32 *dstBytesUsed, ASUns32 *glyphCount, ASUns16 *fontIndex, PDPrintClient printClient); 
 
 void GetComponentFontList)(PDFont fontP, PDPrintFontArrayP fontList, PDPrintClient printClient); 
 
 void FlushIncrGlyphList)(ASStm stm, PDPrintClient printClient); 
 
 ASBool OPIhandler)(OPIdict *opi, ASStm stm, void *clientData); 
 
 ASUns32 DataSourceString)(PDFileSpec f, char *buf, ASUns32 bufSize, void *clientData); 
 
 ASInt32 sequentialPageNum; 
 
 void* clientData; 
 
 void* fontDownloadContext; 
 
 ASInt32 vmUsed; 
 
 ASBool ProgressMonitor)(ASInt32 pageNum, ASInt32 totalPages, float current, const char *name, ASInt32 stage, void *progMonClientData); 
 
 void* progMonClientData; 
 
 void GetTimeDate)(ASText timeDate); 
 
 PDHostSepsSpec seps; 
 
 void GetClientPaperSize)(PDPrintClient printClient, ASFixed *height, ASFixed *width); 
 
 ASStm outStm; 
}

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

See Also


File: PDFLExpT.h
Line: 1763

Elements
size  

The size of the structure.

 
pdDoc  

The document to print.

 
params  

A control structure describing how to print the document.

 
DocBegin  

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

 
DocSetup  

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

 
EndSetup  

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

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

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

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

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

}

 
NotifyNewPage  

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

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

 
PageBegin  

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

 
PageSetup  

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

 
PageSetupPostResource  

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

 
PageCleanup  

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

 
EmitPageContents  

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

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

There is a default callback for PostScript printing.

 
PageEnd  

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

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

 
DocEnd  

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

 
GetFontEncodingMethod  

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

 
GetFontVMUsage  

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

 
EmitPSFontBegin  

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

 
EmitPSFontEnd  

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

 
EmitPSFontEncodingBegin  

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

 
EmitPSFontEncodingEnd  

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

 
EmitPSResourceBegin  

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

 
EmitPSResourceEnd  

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

 
ShouldCancel  

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

 
CancelPrintJob  

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

 
FlushString  

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

 
EmitPrologString  

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

It defaults to a method that calls FlushString().

 
CanEmitFont  

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

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

 
EmitFont  

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

 
UndefineFont  

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

 
EmitFontProcSet  

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

 
EmitGlyphsIncr  

A callback for PDPrintClient. It emits glyphs incrementally.

 
GetComponentFontList  

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

 
FlushIncrGlyphList  

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

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

 
OPIhandler  

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

 
DataSourceString  

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

The DataSource is used thus:

/ DataSource (xxxxx) (r) file

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

 
sequentialPageNum  

The current page, starting at 1.

 
clientData  

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

 
fontDownloadContext  

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

 
vmUsed  

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

 
ProgressMonitor  

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

 
GetTimeDate  

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

 
seps  

Pro product only.

 
GetClientPaperSize  

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

 
outStm  

Output stream for creating postscript file.

_t_PPDFeatures 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_PPDFeatures {
 ASUns32 size; 
 
 ASText InputSlot; 
 
 ASText OutputBin; 
 
 ASText Duplex; 
 
 ASText StapleLocation; 
 
 ASText StapleX; 
 
 ASText StapleY; 
 
 ASText StapleOrientation; 
 
 ASText StapleWhen; 
}

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

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

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

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

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

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


File: PDFLPrint.h
Line: 1026

Elements
size  

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

 
InputSlot  

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

 
OutputBin  

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

 
Duplex  

Optional. Specifies the Duplex mode. For eg. DuplexTumble

 
StapleLocation  

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

 
StapleX  

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

 
StapleY  

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

 
StapleOrientation  

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

 
StapleWhen  

Optional. Specifies when to staple. For eg. EndOfPage

_t_SearchQueryDataRec 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_SearchQueryDataRec {
 ASSize_t size; 
 
 ASText query; 
 
 SearchType type; 
 
 SearchMatchOption match; 
 
 SearchWordOptions options; 
 
 SearchScope scope; 
 
 ASPathName path; 
 
 ASFileSys fs; 
 
 ASUns16 maxDocs; 
 
 ASUns32 startPage; 
 
 ASUns32 proximityRange; 
}


File: SrchType.h
Line: 162

Elements
size  

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

 
query  

The text to be searched.

 
type  

The location to search in.

 
match  

How the query text should be matched in the document.

 
options  

The search options.

 
scope  

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

 
path  

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

 
fs  

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

 
maxDocs  

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

 
startPage  

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

 
proximityRange  

The range of words for proximity searches.

_t_SecErrorInfo 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_SecErrorInfo {
 ASSize_t size; 
 
 ASText text; 
 
 void* reserved; 
}

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


File: DirectoryHFT.h
Line: 52

Elements
size  

The size of this structure.

 
text  

The description of the error.

 
reserved  

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

_t_TermProcs 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_TermProcs {
 PDFLTermType termProc; 
}


File: PDFLInitCommon.h
Line: 47

_t_textList 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_textList {
 char* name; 
 
 _t_textList next; 
}

List structure used in TIFFASCIITagList.


File: PDFLExpT.h
Line: 1436

Elements
name  

Tag name.

 
next  

Pointer to next list element.

_t_TIFFASCIITagList 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_TIFFASCIITagList {
 ASInt32 tagNumber; 
 
 TextList tagText; 
 
 _t_TIFFASCIITagList next; 
}

TIFF ASCII tags.


File: PDFLExpT.h
Line: 1444

Elements
tagNumber  

The tag number

 
tagText  

Tag text list.

 
next  

For OPI 1.3, the TextList contains only one element.

_t_TKAllocatorProcs 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_TKAllocatorProcs {
 ASClientAllocProc allocProc; 
 
 ASClientReallocProc reallocProc; 
 
 ASClientFreeProc freeProc; 
 
 ASClientMemAvailProc memAvailProc; 
 
 void* clientData; 
}

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

See Also


File: PDFInit.h
Line: 164

Elements
allocProc  

Called when the PDF Library needs to allocate memory.

 
reallocProc  

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

 
freeProc  

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

 
memAvailProc  

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

 
clientData  

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

_t_TKExtensionProcs 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_TKExtensionProcs {
 ASExtensionProgressProc progressProc; 
 
 ASExtensionReportErrorProc reportErrProc; 
 
 void* clientData; 
}

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

See Also


File: PDFInit.h
Line: 359

Elements
progressProc  

Called when the PDF Library needs to allocate memory.

 
reportErrProc  

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

 
clientData  

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

_t_TKResourceProcs 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct _t_TKResourceProcs {
 TKResourceAcquireProc acquireProc; 
 
 TKResourceReleaseProc releaseProc; 
 
 void* clientData; 
}

Structure for resource acquisition callbacks used by the PDF Library.

See Also


File: PDFInit.h
Line: 258

Elements
acquireProc  

Called when the PDF Library needs to acquire resources.

 
releaseProc  

Called when the PDF Library needs to release resources.

 
clientData  

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

ImageInks 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct ImageInks {
 ImageInk type; 
 
 MonoInkList mono; 
}

Image inks.


File: PDFLExpT.h
Line: 1540

Elements
type  

Image ink type.

 
mono  

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

OPI13dict 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct OPI13dict {
 TIFFASCIITagList aldImageAsciiTags; 
 
 float c; 
 
 float m; 
 
 float y; 
 
 float k; 
 
 char* name; 
 
 struct OPI13dict::@5 aldImageColor; 
 
 ALDImageColorType aldImageColorType; 
 
 float aldImageCropFixed[4]; 
 
 ASUns32 aldImageCropRect[4]; 
 
 ASUns32 aldImageDimensions[2]; 
 
 PDFileSpec aldImageFileName; 
 
 ASUns16 aldImageGrayMap; 
 
 ASUns16 aldImageGrayMapLength; 
 
 char* aldImageID; 
 
 ASBool aldImageOverprint; 
 
 float aldImagePosition[8]; 
 
 float aldImageResolution[2]; 
 
 float aldImageTint; 
 
 ASBool aldImageTransparency; 
 
 ASUns32 aldImageType[2]; 
 
 char* aldObjectComments; 
 
 unsigned aldimageasciitags; 
 
 unsigned aldimagecolor; 
 
 unsigned aldimagecolortype; 
 
 unsigned aldimagecropfixed; 
 
 unsigned aldimagecroprect; 
 
 unsigned aldimagedimensions; 
 
 unsigned aldimagefilename; 
 
 unsigned aldimagegraymap; 
 
 unsigned aldimageid; 
 
 unsigned aldimageoverprint; 
 
 unsigned aldimageposition; 
 
 unsigned aldimageresolution; 
 
 unsigned aldimagetint; 
 
 unsigned aldimagetransparency; 
 
 unsigned aldimagetype; 
 
 unsigned aldobjectcomments; 
 
 struct OPI13dict::@6 defined; 
}

OPI 1.3 dictionary.


File: PDFLExpT.h
Line: 1454

Elements
aldImageAsciiTags  

TIFF ASCII tags.

 
aldImageColorType  

Image color type.

 
aldImageCropFixed  

The portion of the image to be used.

 
aldImageCropRect  

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

 
aldImageDimensions  

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

 
aldImageFileName  

REQUIRED. Image file name.

 
aldImageGrayMap  

Changes to the brightness or contrast of the image.

 
aldImageGrayMapLength  

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

 
aldImageID  

Image identifier.

 
aldImageOverprint  

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

 
aldImagePosition  

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

 
aldImageResolution  

Image resolution ([horiz vert]).

 
aldImageTint  

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

 
aldImageTransparency  

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

 
aldImageType  

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

 
aldObjectComments  

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

 
OPI20dict 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct OPI20dict {
 float imageCropRect[4]; 
 
 float imageDimensions[2]; 
 
 PDFileSpec imageFileName; 
 
 ImageInks imageInks; 
 
 ASBool imageOverprint; 
 
 ASUns32 includedImageDimensions[2]; 
 
 float includedImageQuality; 
 
 char* mainImage; 
 
 TIFFASCIITagList tiffAsciiTags; 
 
 unsigned imagecroprect; 
 
 unsigned imagedimensions; 
 
 unsigned imagefilename; 
 
 unsigned imageinks; 
 
 unsigned imageoverprint; 
 
 unsigned includedimagedimensions; 
 
 unsigned includedimagequality; 
 
 unsigned mainimage; 
 
 unsigned tiffasciitags; 
 
 struct OPI20dict::@7 defined; 
}

OPI 2.0 dictionary.


File: PDFLExpT.h
Line: 1548

Elements
imageCropRect  

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

 
imageDimensions  

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

 
imageFileName  

The external file containing the image. The following values are required if imageCropRect and imageDimensions are defined:

0 <= left < right <= width

0 <= top < bottom <= height

REQUIRED.

 
imageInks  

The colorants to be applied to the image.

 
imageOverprint  

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

 
includedImageDimensions  

Included image dimensions.

 
includedImageQuality  

The quality of the included image.

 
mainImage  

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

 
OPIdict 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct OPIdict {
 OPIversion version; 
 
 OPI13dict dict13; 
 
 OPI20dict dict20; 
 
 union OPIdict::@8 dict; 
}

OPI dictionary.


File: PDFLExpT.h
Line: 1599

Elements
version  

OPI version (1.3 or 2.0).

 
PDFlattenRec 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct PDFlattenRec {
 ASSize_t size; 
 
 PDFlattenTilingMode tilingMode; 
 
 ASBool useTextOutlines; 
 
 ASBool allowShadingOutput; 
 
 ASBool allowLevel3ShadingOutput; 
 
 ASBool strokeToFill; 
 
 ASBool clipComplexRegions; 
 
 float internalDPI; 
 
 float externalDPI; 
 
 float pathDPI; 
 
 ASUns32 tileSizePts; 
 
 ASUns32 maxFltnrImageSize; 
 
 ASUns32 adaptiveThreshold; 
 
 ASBool preserveOverprint; 
}

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

See Also


File: PDFLExpT.h
Line: 323

Elements
size  

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

 
tilingMode  

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

 
useTextOutlines  

Output text outlines instead of native text.

 
allowShadingOutput  

Allow shading ouput.

 
allowLevel3ShadingOutput  

Allow level 3 shading output.

 
strokeToFill  

For converting stroke to outline.

 
clipComplexRegions  

Clip complex checkbox.

 
internalDPI  

Resolution for flattening the interior of an atomic region.

 
externalDPI  

Resolution for flattening edges of atomic regions.

 
pathDPI  

Flattener path resolution; the default is 800.

 
tileSizePts  

Target tile size in points.

 
maxFltnrImageSize  

Maximum image size when flattening. The default is 0.

 
adaptiveThreshold  

Adaptive flattening threshold.

 
preserveOverprint  

Attempt to preserve overprint.

PDPrintFontArray 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct PDPrintFontArray {
 ASUns32 count; 
 
 ASBool usesDisplayCTFont; 
 
 PDPrintFontP arr; 
}

An array of font pointers for use in PDFontPSGetComponentFontList.

See Also


File: PDFLExpT.h
Line: 276

Elements
count  

The number of fonts in arr.

 
usesDisplayCTFont  

Whether to use the Display CT Font.

 
arr  

The font array.

PDPrintFontRec 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct PDPrintFontRec {
 const char* name; 
 
 const char* encoding; 
 
 const char* cidFontName; 
 
 ASInt16 style; 
 
 PDFontStyle syntheticStyle; 
 
 ASBool used; 
 
 ASBool emitted; 
 
 ASInt32 baseLineAdj; 
 
 ASUns32 flags; 
}


File: PDFLExpT.h
Line: 236

Elements
name  

The font name.

 
encoding  

The font encoding.

 
cidFontName  

CID font name.

 
style  

Gothic or Mincho.

 
syntheticStyle  

Roman, Italic, Bold, or BoldItalic.

 
used  

Set to true if glyphs from this component are used.

 
emitted  

Set to true if this component is emmitted.

 
baseLineAdj  

Baseline adjustment.

 
flags  

Flags bits.

PDPrintParamsRec 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct PDPrintParamsRec {
 ASSize_t size; 
 
 PDPageRange ranges; 
 
 ASInt32 numRanges; 
 
 ASBool shrinkToFit; 
 
 ASBool expandToFit; 
 
 ASBool rotateAndCenter; 
 
 PDPrintWhat printWhat; 
 
 PDPrintWhatAnnot printWhatAnnot; 
 
 ASBool emitPS; 
 
 ASInt32 psLevel; 
 
 PDOutputType outputType; 
 
 PDInclusion incBaseFonts; 
 
 PDInclusion incEmbeddedFonts; 
 
 PDInclusion incType1Fonts; 
 
 PDInclusion incType3Fonts; 
 
 PDInclusion incTrueTypeFonts; 
 
 PDInclusion incCIDFonts; 
 
 PDInclusion incProcsets; 
 
 PDInclusion incOtherResources; 
 
 ASInt32 fontPerDocVM; 
 
 ASBool emitShowpage; 
 
 ASBool emitTTFontsFirst; 
 
 ASBool setPageSize; 
 
 ASBool emitDSC; 
 
 ASBool setupProcsets; 
 
 ASBool emitColorSeps; 
 
 ASBool binaryOK; 
 
 ASBool useSubFileDecode; 
 
 ASBool emitRawData; 
 
 ASBool TTasT42; 
 
 float scale; 
 
 ASBool emitExternalStreamRef; 
 
 ASBool emitHalftones; 
 
 ASBool emitPSXObjects; 
 
 ASBool centerCropBox; 
 
 ASBool emitSeparableImagesOnly; 
 
 ASBool emitDeviceExtGState; 
 
 ASFixedRect boundingBox; 
 
 ASBool useFontAliasNames; 
 
 ASBool emitPageRotation; 
 
 ASBool reverse; 
 
 ASFixedRect tCropBox; 
 
 ASBool emitPageClip; 
 
 ASBool emitTransfer; 
 
 ASBool emitBG; 
 
 ASBool emitUCR; 
 
 PDFarEastFont farEastFontOpt; 
 
 ASBool suppressCJKSubstitution; 
 
 ASBool suppressCSA; 
 
 ASBool hostBased; 
 
 ASAtom hostBasedOutputCS; 
 
 PDDuplexEnum duplex; 
 
 PDPageTilingMode doTiling; 
 
 PDTileEx tileInfo; 
 
 ASBool rotate; 
 
 ASBool hostBasedCM; 
 
 char destProfile[256]; 
 
 ASAtom destCSAtom; 
 
 ASBool saveVM; 
 
 ASBool doOPP; 
 
 ASInt32 suppressOPPWhenNoSpots; 
 
 ASBool optimizeForSpeed; 
 
 ASBool brokenCRDs; 
 
 ASBool useMaxVM; 
 
 ASInt32 lastWidth; 
 
 ASInt32 lastHeight; 
 
 ASUns32 bitmapResolution; 
 
 ASUns32 gradientResolution; 
 
 ASUns32 transparencyQuality; 
 
 PDOCContext ocContext; 
 
 ASBool applyOCGPrintOverrides; 
 
 ASBool useFullResolutionJP2KData; 
 
 ASBool emitInRipSeps; 
 
 PDPageMarkFlags whichMarks; 
 
 ASBool westernMarksStyle; 
 
 ASBool doProofing; 
 
 char proofProfile[256]; 
 
 ASBool inkBlack; 
 
 ASBool paperWhite; 
 
 ASBool useExecForm; 
 
 PDFlatten flattenInfo; 
 
 ASBool negative; 
 
 ASEnum8 mirrorprint; 
 
 ASUns32 numCollatedCopies; 
 
 ASBool emitFlatness; 
 
 ASInt32 trapType; 
 
 ASBool TTasCIDT2; 
 
 ASInt32 markStyle; 
 
 float lineWidth; 
 
 ASBool macQDPrinter; 
 
 ASPathName customMarksFileName; 
 
 ASBool grayToK; 
}

A data structure indicating how a document should be printed.

See Also

Note

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

File: PDFLExpT.h
Line: 480

Elements
size  

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

 
ranges  

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

 
numRanges  

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

 
shrinkToFit  

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

 
expandToFit  

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

 
rotateAndCenter  

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

 
printWhat  

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

 
printWhatAnnot  

Annotation flags which modify PDPrintWhat to enable Pro product behavior.

 
emitPS  

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

 
psLevel  

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

 
outputType  

Print PostScript or EPS with or without a preview.

 
incBaseFonts  

Embed the base fonts. The default value is kIncludeNever.

 
incEmbeddedFonts  

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

 
incType1Fonts  

Embed Type 1 fonts. The default value is kIncludeOncePerDoc.

 
incType3Fonts  

Embed Type 3 fonts. The default value is kIncludeOnEveryPage.

 
incTrueTypeFonts  

Embed TrueType fonts. The default value is kIncludeOncePerDoc.

 
incCIDFonts  

Embed CID fonts. The default value is kIncludeOncePerDoc.

 
incProcsets  

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

 
incOtherResources  

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

 
fontPerDocVM  

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

 
emitShowpage  

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

 
emitTTFontsFirst  

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

 
setPageSize  

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

 
emitDSC  

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

 
setupProcsets  

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

 
emitColorSeps  

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

 
binaryOK  

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

 
useSubFileDecode  

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

 
emitRawData  

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

 
TTasT42  

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

 
scale  

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

 
emitExternalStreamRef  

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

 
emitHalftones  

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

 
emitPSXObjects  

Emit PostScript XObjects into the PostScript stream [false].

 
centerCropBox  

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

 
emitSeparableImagesOnly  

If emitting EPS, include only CMYK and gray images.

 
emitDeviceExtGState  

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

 
boundingBox  

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

 
useFontAliasNames  

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

 
emitPageRotation  

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

 
reverse  

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

 
tCropBox  

Temporary crop box to represent the selected region.

 
emitPageClip  

Emit page clip.

 
emitTransfer  

Emit transfer.

 
emitBG  

Emit black generation.

 
emitUCR  

Emit undercolor removal.

 
farEastFontOpt  

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

 
suppressCJKSubstitution  

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

 
suppressCSA  

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

 
hostBased  

For separator, do host-based color management.

 
hostBasedOutputCS  

The output color space when hostBased color management is true.

 
duplex  

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

 
doTiling  

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

 
tileInfo  

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

 
rotate  

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

 
hostBasedCM  

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

 
destProfile  

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

 
destCSAtom  

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

 
saveVM  

true means try to save VM when printing to PostScript.

 
doOPP  

Do the overprint preview operation.

 
suppressOPPWhenNoSpots  

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

 
optimizeForSpeed  

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

 
brokenCRDs  

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

 
useMaxVM  

If true, store all possible resources in VM.

 
lastWidth  

Used when setPageSize is true to prevent unneeded setpagedevice calls.

 
lastHeight  

Used when setPageSize is true to prevent unneeded setpagedevice calls.

 
bitmapResolution  

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

 
gradientResolution  

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

 
transparencyQuality  

The transparency level. The range is 0-100.

 
ocContext  

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

 
applyOCGPrintOverrides  

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

 
useFullResolutionJP2KData  

Determines whether to use the maximum available JPEG2000 resolution.

 
emitInRipSeps  

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

 
whichMarks  

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

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

 
westernMarksStyle  

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

 
doProofing  

When true, print using proofing settings.

 
proofProfile  

Description string for the proofing profile.

 
inkBlack  

Proofing settings: simulate ink black.

 
paperWhite  

Proofing settings: simulate paper white.

 
useExecForm  

When true, emit execform calls when emitting Form XObjects.

 
flattenInfo  

A structure containing parameters that control tile flattening.

 
negative  

When true, invert the plate.

 
mirrorprint  

One of the following constants:

kPDPrintFlipNone = 0x01

kPDPrintFlipX = 0x02

kPDPrintFlipY = 0x04

kPDPrintFlipXY = 0x08

Mirroring is done in the PostScript output stream.

 
numCollatedCopies  

Enables collation for the viewer.

 
emitFlatness  

Honors the flatness settings over gstate flatness.

 
trapType  

The trap type:

  • kPDPrintTrapNone = 0x01.

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

  • kPDPrintTrapInRIP = 0x04.

 
TTasCIDT2  

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

 
markStyle  

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

 
lineWidth  

The line weight to use for printer marks.

 
macQDPrinter  

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

 
customMarksFileName  

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

 
grayToK  

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

PDPrintStr 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct PDPrintStr {
 char* str; 
 
 ASUns32 len; 
 
 ASRealPoint displacements; 
 
 ASUns32 numGlyphs; 
 
 ASUns32 flags; 
}

A structure for controlling the printing of glyphs.

See Also


File: PDFLExpT.h
Line: 186

Elements
str  

The string.

 
len  

Byte length.

 
displacements  

Displacements.

 
numGlyphs  

The number of glyphs.

 
flags  

Flags. Reserved for internal use.

SpellCheckParam 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct SpellCheckParam {
 ASInt16 scVersion; 
 
 ASInt16 scFlags; 
 
 char scName[kSpellMaxName]; 
 
 SCEnableProc scEnableProc; 
 
 SCGetTextProc scGetTextProc; 
 
 SCCompletionProc scCompletionProc; 
 
 AVDoc scAVDoc; 
 
 ASInt32 scPageNum; 
 
 ASInt32 scIndex; 
 
 char* scInBuffer; 
 
 char* scOutBuffer; 
 
 void* scClientData; 
 
 ASText scInBufferASText; 
 
 ASConstText scOutBufferAStext; 
 
 SCChangeProc scChangeProc; 
 
 ASConstText scChangeText; 
 
 ASInt32 scChangeStart; 
 
 ASInt32 scChangeEnd; 
 
 ASConstText scMenuTitle; 
}

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

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

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

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

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


File: Speller_Sel.h
Line: 252

Elements
scVersion  

Version number of this structure (kSCparam_LATEST_VERSION).

 
scFlags  

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

 
scName  

This name will be returned by SpellDomainNames().

 
scAVDoc  

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

 
scPageNum  

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

 
scIndex  

(Passed by Spelling plug-in) The 0-based index of this domain item. The Spelling plug-in will set scIndex to zero to start or restart, and request the first text buffer from this domain on scPageNum.

The Spelling plug-in will increment scIndex after each call to scGetTextProc. The client can increment scIndex if desired to track non-sequential domain items.

 
scInBuffer  

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

 
scOutBuffer  

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

 
scClientData  

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

 
scInBufferASText  

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

 
scOutBufferAStext  

Returned buffer from Spelling PI to scCompletionProc().

 
scChangeProc  

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

 
scChangeText  

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

 
scChangeStart  

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

 
scChangeEnd  

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

 
scMenuTitle  

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

tagConsultantAgent 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct tagConsultantAgent {
 ASSize_t Size; 
 
 PDFObjType pFindObjects; 
 
 ASUns32 NumFindObjects; 
 
 ConsAgentPostProcessCallback PostProcess; 
 
 ConsAgentObjFoundCallback ObjFound; 
 
 ASBool WantSubclasses; 
 
 CosObj pFindObjectIDs; 
 
 ASUns32 NumFindObjectIDs; 
 
 ConsAgentObjFoundCallback ObjIDFound; 
}


File: ConsExpT.h
Line: 175

Elements
Size  

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

 
pFindObjects  

An array of object types of interest.

 
NumFindObjects  

The number of object types in the pFindObjects array.

 
PostProcess  

A callback procedure for post-processing.

 
ObjFound  

A callback procedure for when an object is found.

 
WantSubclasses  

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

 
tagPDFObjID 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct tagPDFObjID {
 CosID objID; 
 
 CosGeneration objGen; 
}

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

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

See Also


File: ConsExpT.h
Line: 169

WebDriverVector 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct WebDriverVector {
 ASUns32 WDVRev; 
 
 ASUns32 nReserved; 
 
 WDAppSupportPredicate doYouSupport; 
 
 WDFollowLinkFunction followLink; 
 
 WDBecomeDriverFunction becomeDriver; 
 
 WDBringFrontFunction bringFront; 
 
 WDOptionsFunction options; 
 
 WDIsDriverBusyFunction isDriverBusy; 
 
 WDFollowLinkWithParamsFunction followLinkWithParams; 
}

A data structure containing callbacks that implement a Weblink driver.

See Also


File: WLHFT.h
Line: 348

Elements
WDVRev  

Driver version number.

 
nReserved  

Currently unused.

 
WWWOpenURLParamsRec 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

struct WWWOpenURLParamsRec {
 ASSize_t size; 
 
 const char* cFrame; 
}

A parameter block specifying the target frame of a URL.

See Also


File: WLHFT.h
Line: 74

Elements
size  

Should be initialized to sizeof(WWWOpenURLParamsRec).

 
cFrame  

The name of the frame to open.

Callbacks Detail
ASClientAllocProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

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

See Also


File: PDFInit.h
Line: 109
ASClientFreeProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

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

See Also


File: PDFInit.h
Line: 140
ASClientMemAvailProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASSize_t (*ASClientMemAvailProc)(void *clientData)

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

See Also


File: PDFInit.h
Line: 154
ASClientReallocProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

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

See Also


File: PDFInit.h
Line: 126
ConsAgentObjFoundCallback 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

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


File: ConsExpT.h
Line: 141
ConsAgentPercentDoneCallback 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*ConsAgentPercentDoneCallback)(ASReal fPercentDone)

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


File: ConsExpT.h
Line: 149
ConsAgentPostProcessCallback 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*ConsAgentPostProcessCallback)(struct tagConsultantAgent *)

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


File: ConsExpT.h
Line: 114
DirConnection_close 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*DirConnection_close)(DirConnection inConnection)

Closes the specified directory connection.


File: DirectoryHFT.h
Line: 324
DirConnection_customSearch 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

File: DirectoryHFT.h
Line: 288
DirConnection_customUISearch 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

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


File: DirectoryHFT.h
Line: 301
DirConnection_getDirInfo 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

Retrieves information about the directory associated with the connection.


File: DirectoryHFT.h
Line: 332
DirConnection_getGroups 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

Retrieves the list of groups that this connection supports.


File: DirectoryHFT.h
Line: 170
DirConnection_list 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

TBD


File: DirectoryHFT.h
Line: 319
DirConnection_setCustomOutputOptions 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

TBD


File: DirectoryHFT.h
Line: 215
DirConnection_setStandardOutputOptions 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

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


File: DirectoryHFT.h
Line: 203
DirConnection_standardSearch 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

TBD


File: DirectoryHFT.h
Line: 272
ExternalFilePermissionProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

File: PDFLExpT.h
Line: 90
PDDoExtGStateProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

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

See Also


File: PDFLExpT.h
Line: 1682
PDFLClientRNGProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

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

See Also


File: PDFLExpT.h
Line: 109
PDFLGetCoreHFTType 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

HFT (*PDFLGetCoreHFTType)()

File: PDFLInitCommon.h
Line: 35
PDFLInitThreadLocalDataType 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

File: PDFLInitCommon.h
Line: 36
PDFLInitType 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 (*PDFLInitType)(PDFLData data)

File: PDFLInitCommon.h
Line: 34
PDFLPrintCancelProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

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

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

See Also


File: PDFLPrint.h
Line: 69
PDFLTermType 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*PDFLTermType)()

File: PDFLInitCommon.h
Line: 37
PDPrintCanEmitFontProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

(Optional) A callback for PDPrintClient. It is called to determine whether a font can be emitted into the print job. This is used to determine whether a font is a document-included resource. Only used for PostScript printing.

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

See Also


File: PDFLExpT.h
Line: 1740
PDPrintEmitFontProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

(Required) A callback for PDPrintClient. It emits a font. For Type0 fonts that require font substition, this routine may emit multiple font definitions. The caller can get the list of fonts used by calling GetFontComponentList().

See Also


File: PDFLExpT.h
Line: 1722
PDPrintGetFontEncodingMethodProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

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

See Also


File: PDFLExpT.h
Line: 1705
SCChangeProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*SCChangeProc)(SpellCheckParamPtr scp)

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

See Also

SCEnableProc
SCGetTextProc
SpellAddDomain
SpellRemoveDomain
SCCompletionProc

Exceptions

None

File: Speller_Sel.h
Line: 206
SCCompletionProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*SCCompletionProc)(SpellCheckParamPtr scp)

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

See Also

SCEnableProc
SCGetTextProc
SpellAddDomain
SpellRemoveDomain

Note

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

File: Speller_Sel.h
Line: 188
SCEnableProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*SCEnableProc)(SpellCheckParamPtr scp)

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

See Also

SCCompletionProc
SCGetTextProc
SpellAddDomain
SpellRemoveDomain

File: Speller_Sel.h
Line: 145
SCGetTextProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*SCGetTextProc)(SpellCheckParamPtr scp)

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

See Also

SCCompletionProc
SCEnableProc
SpellAddDomain
SpellRemoveDomain

File: Speller_Sel.h
Line: 167
SCInitProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*SCInitProc)(void *clientData)

File: Speller_Sel.h
Line: 125
SCRTFChangeProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

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

See Also

SpellCheckRTF

File: Speller_Sel.h
Line: 221
SCTermProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*SCTermProc)(void *clientData)

File: Speller_Sel.h
Line: 127
TKResourceAcquireProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

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

See Also


File: PDFInit.h
Line: 233
TKResourceReleaseProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

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

See Also


File: PDFInit.h
Line: 249

Method Detail
ASAtomGetCount()
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 ASAtomGetCount()

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

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

Returns

The number of ASAtom objects currently allocated.

See Also


File: PDFLProcs.h
Line: 130
ASFileSysGetDefaultTempPath() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASPathName ASFileSysGetDefaultTempPath(ASFileSys fileSys)

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

Parameters

fileSys — 

The file system in which the ASPathname is set.

Returns

The ASPathName if the operation was successful, NULL otherwise.

See Also


File: PDFLProcs.h
Line: 163
ASFileSysSetDefaultTempPath() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool ASFileSysSetDefaultTempPath(ASFileSys fileSys, ASPathName pathName)

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

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

Parameters

fileSys — 

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

 
pathName — 

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

Returns

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

See Also


File: PDFLProcs.h
Line: 151
ASPurgeMemory() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASSize_t ASPurgeMemory(ASSize_t amount)

Attempts to free memory from the PDF Library caches.

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

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

Parameters

amount — 

The desired amount of memory to free.

Returns

The approximate amount of memory freed.

See Also


File: PDFLProcs.h
Line: 113
AVExtensionMgrRegisterNotification() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

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

Parameters

nsel — 

Notification type. It must be one of the notification selectors. The notification selector is the name of the notification with the characters NSEL appended. For example, the selector for PDDocDidPrintPage() is PDDocDidPrintPageNSEL. Only the PD-level notifications are available with the Adobe PDF Library.

 
owner — 

Identifies the owner. For the Adobe PDF Library, if there is only one owner of the PDFEdit subsystem, owner should be zero. If there are multiple owners, each should specify a nonzero, non-negative owner. (A negative owner is reserved for the implementation).

 
proc — 

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

 
clientData — 

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

See Also

AVExtensionMgrUnregisterNotification
AVAppRegisterNotification

File: PDFLProcs.h
Line: 611
AVExtensionMgrUnregisterNotification() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

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

Parameters

nsel — 

Notification type. It must be one of the notification selectors. The notification selector is the name of the notification with the characters NSEL appended. For example, the selector for PDDocDidOpen() is PDDocDidOpenNSEL.

 
owner — 

Identifies the owner with which the notification was registered.

 
proc — 

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

 
clientData — 

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

See Also

AVExtensionMgrRegisterNotification
AVAppUnregisterNotification

File: PDFLProcs.h
Line: 631
GetRequestedHFT() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

Parameters

table
 
requiredVer
 
resultingVer
 
resultHFT

Returns

File: PDFLInitCommon.h
Line: 74
PDDocPrintPages() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDDocPrintPages(PDPrintClient client)

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

Parameters

client — 

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

See Also

Exceptions

genErrBadParm

Notifications

Note

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

File: PDFLProcs.h
Line: 191
PDFLGetCoreHFT() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

HFT PDFLGetCoreHFT()

Gets the Core HFT.

Returns

The Core HFT object.

See Also


File: PDFInit.h
Line: 931
PDFLGetFlags() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASUns32 PDFLGetFlags()

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

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

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

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

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

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

Returns

The initialization flags value.

See Also


File: PDFLProcs.h
Line: 728
PDFLGetInitCount() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASUns32 PDFLGetInitCount()

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

Returns

The number of times the PDF Library has been initialized.

See Also


File: PDFLProcs.h
Line: 706
PDFLGetVersion() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASUns32 PDFLGetVersion()

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

Returns

Adobe PDF Library version (kPDFLVersion).

See Also

Note

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

File: PDFLProcs.h
Line: 686
PDFLibraryRegisterNotification() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

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

Parameters

nsel — 

Notification type. It must be one of the notification selectors. The notification selector is the name of the notification with the characters NSEL appended. For example, the selector for PDDocDidPrintPage() is PDDocDidPrintPageNSEL. Only the PD-level notifications are available with the Adobe PDF Library.

 
owner — 

Identifies the owner. For the Adobe PDF Library, if there is only one owner of the PDFEdit subsystem, owner should be zero. If there are multiple owners, each should specify a nonzero, non-negative owner. (A negative owner is reserved for the implementation).

 
proc — 

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

 
clientData — 

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

See Also


File: PDFLProcs.h
Line: 63
PDFLibraryRegisterNotificationEx() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

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

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

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

Parameters

nsel — 

The notification type. It must be one of the notification selectors . The notification selector is the name of the notification with the characters NSEL appended. For example, the selector for AVDocDidOpen() is AVDocDidOpenNSEL.

 
owner — 

The gExtensionID of the client registering the notification.

 
proc — 

A user-supplied callback to call when the notification occurs. Its declaration depends on the notification type. Remember to use ASCallbackCreateNotification() to convert proc to a callback before passing it to AVAppRegisterNotification().

 
clientData — 

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

 
priority — 

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


File: PDFLProcs.h
Line: 829
PDFLibraryRegisterRNG() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDFLibraryRegisterRNG(PDFLClientRNGProc clientRNG)

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

Parameters

clientRNG — 

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

See Also


File: PDFLProcs.h
Line: 845
PDFLibraryUnregisterNotification() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

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

Parameters

nsel — 

Notification type. It must be one of the notification selectors. The notification selector is the name of the notification with the characters NSEL appended. For example, the selector for PDDocDidOpen() is PDDocDidOpenNSEL.

 
owner — 

Identifies the owner. For the PDF Library, if there is only one owner of the PDFEdit subsystem, owner should be zero. If there are multiple owners, each should specify a nonzero, non-negative owner. (A negative owner is reserved for the implementation).

 
proc — 

A user-supplied callback to be called when the notification occurs. Its declaration depends on the notification type. You must use the same callback that you called AVExtensionMgrRegisterNotification() with.

 
clientData — 

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

See Also

PDFLibraryRegisterNotification
AVAppUnregisterNotification

File: PDFLProcs.h
Line: 89
PDFLInit() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 PDFLInit(PDFLData data)

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

Parameters

data — 

Initialization data for Adobe PDF Library.

Returns

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

See Also


File: PDFInit.h
Line: 909
PDFLInitCommon() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

Parameters

data
 
procs
 
sizeHFTLocTab

Returns

File: PDFLInitCommon.h
Line: 57
PDFLInitHFT() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 PDFLInitHFT(PDFLData data)

Parameters

data

Returns

File: PDFInit.h
Line: 916
PDFLInitHFT() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 PDFLInitHFT(PDFLData data)

Parameters

data

Returns

File: PDFLInitHFT.c
Line: 38
PDFLInitThreadLocalData() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void* PDFLInitThreadLocalData(ThreadLocalKey* key, ASUns32 size)

Parameters

key
 
size

Returns

File: PDFInit.h
Line: 924
PDFLPrintDoc() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDFLPrintDoc(PDDoc doc, PDFLPrintUserParams userParams)

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

Parameters

doc — 

The PDDoc for the document to print.

 
userParams — 

Parameters to control printing.

Exceptions

cosErrWriteError
pdErrOpNotPermitted
genErrBadParm

Notifications

Note

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

File: PDFLProcs.h
Line: 752
PDFLPrintDocEx() 
Product availability: PDFL
Platform availability: Windows

Syntax

void PDFLPrintDocEx(PDDoc doc, PDFLPrintUserParamsEx userParams)

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

Parameters

doc — 

The PDDoc for the document to print.

 
userParams — 

Parameters to control printing.

Exceptions

cosErrWriteError
pdErrOpNotPermitted
genErrBadParm

Notifications

Note

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

File: PDFLProcs.h
Line: 784
PDFLPrintPDF() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

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

Deprecated: use PDFLPrintDoc() instead.

Parameters

pdDoc
 
pathName
 
psParams


File: PDFLProcs.h
Line: 759
PDFLTerm() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDFLTerm()

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

See Also


File: PDFLProcs.h
Line: 696
PDFLTermCommon() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDFLTermCommon(TermProcsP termProcs)

Parameters

termProcs


File: PDFLInitCommon.h
Line: 64
PDFLTermHFT() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDFLTermHFT()


File: PDFInit.h
Line: 918
PDFLTermHFT() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDFLTermHFT()


File: PDFLInitHFT.c
Line: 57
PDFontDownloadContextCreate() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

PDFontDownloadContext PDFontDownloadContextCreate(PDPrintClient client)

Creates a font download context object. This object keeps track of the fonts downloaded during a print job and whether substitution fonts have already been downloaded. It also tracks the font download parameters, such as binaryOK and 'emit TrueType as Type 42'. It is meant for use in the PDFontStreamPS() method.

Parameters

client — 

The client record to pass to PDDocPrintPages().

Returns

The newly-created context.

See Also


File: PDFLProcs.h
Line: 270
PDFontDownloadContextDestroy() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDFontDownloadContextDestroy(PDFontDownloadContext context)

Destroys a font download context object. Call this method after PDDocPrintPages() returns.

Parameters

context — 

IN/OUT The context to destroy.

See Also


File: PDFLProcs.h
Line: 279
PDFontPSEmitGlyphsIncr() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool PDFontPSEmitGlyphsIncr(ASStm stm, PDFont fontP, PDPrintStrP srcStr, PDPrintStrP dstStr, ASUns32* srcBytesUsedP, ASUns32* dstBytesUsedP, ASUns32* glyphCount, ASUns16* fontIndexP, PDPrintClient printClient)

Emit glyphs incrementally. This is the default EmitGlyphsIncr callback procedure for the PDPrintClient structure.

Parameters

stm — 

The stream.

 
fontP — 

The font.

 
srcStr — 

The source string.

 
dstStr — 

The destination string.

 
srcBytesUsedP — 

The source bytes used.

 
dstBytesUsedP — 

The destination bytes used.

 
glyphCount — 

The number of glyphs.

 
fontIndexP — 

The font index.

 
printClient — 

The control structure.

Returns

true if successful, false otherwise.

See Also


File: PDFLProcs.h
Line: 427
PDFontPSFlushIncrGlyphList() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDFontPSFlushIncrGlyphList(ASStm stm, PDPrintClient printClient)

Flush the incremental glyphs list from a stream. This is the default FlushIncrGlyphList callback procedure for the PDPrintClient structure.

Parameters

stm — 

The stream.

 
printClient — 

The control structure.

See Also


File: PDFLProcs.h
Line: 452
PDFontPSGetComponentFontList() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDFontPSGetComponentFontList(PDFont fontP, PDPrintFontArrayP pdFontArr, PDPrintClient printClient)

Get the component font list. This is the default GetComponentFontList callback procedure for the PDPrintClient structure.

Parameters

fontP — 

The font.

 
pdFontArr — 

The font array.

 
printClient — 

The control structure.

See Also


File: PDFLProcs.h
Line: 439
PDFontStreamPS() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool PDFontStreamPS(PDFont fontP, ASStm stm, PDFontDownloadContext context)

Emits a font into a specified stream. The font is in a format suitable for downloading to a PostScript VM. For example, a TrueType font is converted into a Type 1 or Type 42 font.

It is meant for use in the EmitFont callback for PDDocPrintPages().

Parameters

fontP — 

The font to emit.

 
stm — 

The ASStm into which the font is emitted.

 
context — 

A context created by PDFontDownloadContextCreate.

Returns

true if successful, false otherwise.

See Also


File: PDFLProcs.h
Line: 255
PDFontWasExtracted() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool PDFontWasExtracted(PDFont fontP)

Tests whether the specified font is embedded in the PDF file and has already been extracted to display or print the file.

Parameters

fontP — 

The font to test.

Returns

true if the font is embedded in the PDF file and has been extracted, false otherwise.

See Also


File: PDFLProcs.h
Line: 303
PDFontWasFauxed() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool PDFontWasFauxed(PDFont font)

Tests whether the specified font is embedded in the PDF file or is installed in the user'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 font to create a substitute font, called a faux font.

Parameters

font — 

The font to test.

Returns

true if the font has been substituted, false otherwise.

See Also


File: PDFLProcs.h
Line: 321
PDPageDrawContentsPlacedToWindow() 
Product availability: PDFL
Platform availability: Windows, UNIX

Syntax

void PDPageDrawContentsPlacedToWindow(PDPage page, void* window, void* displayContext, ASBool isDPS, ASFixedMatrix* matrix, ASFixedRect* updateRect, CancelProc cancelProc, void* cancelProcClientData)

Draws the page to the window or display context. The window and display context are implementation-dependent.

This method is the same as PDPageDrawContentsToWindow(), except that it raises an exception if the pdPermCopy (see PDPerms) permission is not set in the document.

Parameters

page — 

The page to draw into window.

 
window — 

The platform window to which to render. On Windows, the window is an HWND.

 
displayContext — 

The platform display context to which to render. On Windows, displayContext is an HDC.

 
isDPS — 

Currently unused. Always set it to false.

 
matrix — 

A pointer to the matrix to concatenate onto the default page matrix. It is useful for converting from page to window coordinates and for scaling.

 
updateRect — 

A pointer to the rectangle to draw, defined in user space coordinates. Any objects outside of updateRect will not be drawn. All objects are drawn if updateRect is NULL.

 
cancelProc — 

A method called to check whether drawing should be cancelled. If the method returns true, drawing is stopped, nothing is erased, and the window contains whatever was drawn up to the current state.

 
cancelProcClientData — 

A pointer to user-supplied data to pass to cancelProc each time it is called. It should be NULL if cancelProc is NULL.

See Also

Exceptions

pdErrOpNotPermitted is raised if the pdPermCopy permission in PDPermReqObj for the document is not set.

File: PDFLProcs.h
Line: 237
PDPageDrawContentsPlacedWithParams() 
Product availability: PDFL
Platform availability: Windows, UNIX

Syntax

void PDPageDrawContentsPlacedWithParams(PDPage page, PDDrawParams params)

Draws the page to the window or display context. The window and display context are implementation-dependent.

This method is the same as PDPageDrawContentsToWindow(), except that it raises an exception if the pdPermCopy (see PDPerms) permission is not set in the document. This method is also like PDPageDrawContentsPlacedToWindow(), only passing in a PDDrawParams structure which lets the clients specify their own PDOCContext.

Parameters

page — 

The page to render.

 
params — 

Allows clients to specify their own PDOCContext.

See Also

Exceptions

pdErrOpNotPermitted is raised if the pdPermCopy permission in PDPermReqObj is not set.

File: PDFLProcs.h
Line: 539
PDPageDrawContentsToMemory() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 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)

Superseded by PDPageDrawContentsToMemoryEx() in Acrobat 10.0.

Renders 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 DeviceGray, 3 for DeviceRGB, 4 for DeviceCMYK

bpc = bits per component

Parameters

page — 

The page to render.

 
flags — 

A bit field of PDPageDrawFlags(). It must be an OR of the following flags:

Flag

Description

kPDPageDoLazyErase

If set, it erases the bitmap if the first object drawn does not cover the page's entire crop box.

kPDPageUseAnnotFaces

If set, it draws annotations that have a default face, such as the visible fields in an Acrobat form. Text and link annotations are not drawn.

kPDPageIsPrinting

If set, then form annotations are rendered as if they are being printed. This means that form fields marked as 'Hidden but printable' are rendered, but fields marked as 'Visible but doesn't print' will not be rendered. If it is not set, then form annotations are rendered as if they are being viewed. This means that form fields marked as 'Hidden but printable' are not rendered, but fields marked as 'Visible but doesn't print' will be.

 
matrix — 

A pointer to the matrix to be concatenated onto the default page matrix. It must not be NULL.

 
updateRect — 

A pointer to the rectangle to draw, defined in user space coordinates. Any objects outside of updateRect will not be drawn. All objects are drawn if updateRect is NULL.

 
smoothFlags — 

A bit field of PDPageDrawSmoothFlags(). It must be an OR of the following flags:

  • kPDPageDrawSmoothText

  • kPDPageDrawSmoothLineArt

  • kPDPageDrawSmoothImage

  • kPDPageDrawSmoothBicubicImage

 
csAtom — 

The color space in which the bitmap data is represented. It must be one of DeviceGray, DeviceRGB, or DeviceCMYK.

 
bpc — 

The number of bits per color component in the bitmap data. 8 is the only valid value for DeviceCMYK and DeviceRGB color spaces. 1 and 8 are valid for DeviceGray.

 
destRect — 

A pointer to the rectangle of the bitmap. It is defined in device space coordinates. It must not be NULL.

 
buffer — 

A pointer to the bitmap data. If it is NULL, this function returns the size of the buffer needed for the bitmap.

 
bufferSize — 

The size of the buffer.

 
cancelProc — 

A method to call to check whether drawing should be cancelled. If the method returns true, drawing is stopped, nothing is erased, and the buffer contains whatever was drawn up to the current state.

 
cancelProcData — 

User-supplied data to pass to cancelProc each time it is called.

Returns

The size of the bitmap in bytes.

See Also


File: PDFLProcs.h
Line: 518
PDPageDrawContentsToMemoryEx() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASUns32 PDPageDrawContentsToMemoryEx(PDPage page, ASCab flags, ASDoubleMatrix* matrix, ASDoubleRect* updateRect, ASAtom csAtom, ASInt32 bpc, ASDoubleRect* destRect, char* buffer, ASUns32 bufferSize, CancelProc cancelProc, void* cancelProcData)

Supersedes PDPageDrawContentsToMemory() in Acrobat 10.0.

Renders a page to memory. It uses double precision input parameters. The width of the image is calculated as follows:

width = abs(ROUND(destRect.right) - ROUND(destRect.left));

width = ((((width * bpc * nComps)+31) / 32) * 4) * 8 / (bpc * nComps);

nComps = 1 for DeviceGray, 3 for DeviceRGB, 4 for DeviceCMYK

bpc = bits per component where, ROUND() rounds off double precision values to nearest Int32 value.

Parameters

page — 

The page to render.

 
flags — 

ASCab used for passing PDPageDrawFlagsStr and PDPageDrawSmoothFlagsStr.

 
matrix — 

A pointer to double matrix to be concatenated onto the default page matrix. It must not be NULL.

 
updateRect — 

A pointer to the double rectangle to draw, defined in user space coordinates.

 
csAtom — 

The color space in which the bitmap data is represented.

 
bpc — 

The number of bits per color component in the bitmap data.

 
destRect — 

A pointer to double rectangle of the bitmap. It is defined in device space coordinates. It must not be NULL.

 
buffer — 

A pointer to the bitmap data. If it is NULL, this function returns the size of the buffer needed for the bitmap.

 
bufferSize — 

The size of the buffer.

 
cancelProc — 

A method to call to check whether drawing should be cancelled.

 
cancelProcData — 

User-supplied data to pass to cancelProc each time it is called.

Returns

The size of the bitmap in bytes.

See Also


File: PDFLProcs.h
Line: 953
PDPageEmitPSOrient() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPageEmitPSOrient(PDPage pdPage, ASInt16 paperHeight, ASInt16 paperWidth, ASStm stm, PDPrintParams params)

Parameters

pdPage
 
paperHeight
 
paperWidth
 
stm
 
params

See Also

Note

Obsolete in PDF Library 6.0. Do not use.

File: PDFLProcs.h
Line: 199
PDPageGetSize() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPageGetSize(PDPage page, ASFixed* width, ASFixed* height)

Returns the width and height of the page, which could be rotated or defaulted.

Parameters

page — 

The page whose size is being obtained.

 
width — 

(Filled by the method) The width of the page.

 
height — 

(Filled by the method) The height of the page.


File: PDFLProcs.h
Line: 289
PDPrefGetAntialiasLevel() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt16 PDPrefGetAntialiasLevel()

Returns the antialias level, in pixels.

Returns

The antialias level set by PDPrefSetAntialiasLevel().

See Also


File: PDFLProcs.h
Line: 369
PDPrefGetBlackPointCompensation() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool PDPrefGetBlackPointCompensation()

Returns the black-point compensation flag.

Returns

true if black-point compensation is done.

See Also


File: PDFLProcs.h
Line: 394
PDPrefGetEnableThinLineHeuristics() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool PDPrefGetEnableThinLineHeuristics()

Determines whether thin lines will be fattened non-linearly or the stroke adjust will be applied to thin rectangles.

Returns

true if thin line heuristics are applied, false otherwise.


File: PDFLProcs.h
Line: 910
PDPrefGetGreekLevel() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt16 PDPrefGetGreekLevel()

Returns the greek level.

Returns

The greek level set by PDPrefSetGreekLevel().

See Also


File: PDFLProcs.h
Line: 361
PDPrefGetRefXObj() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

PDRefXObjMode PDPrefGetRefXObj(ASFileSys* fileSys, ASPathName* pathName)

Gets reference XObject parameters.

Parameters

fileSys — 

Used with pathname to specify the location where the target files should be located. These are used to look for the target document.

 
pathName — 

Used with pathname to specify the location where the target files should be located. These are used to look for the target document. The order followed is that given in the PDF Reference.

Returns

File: PDFLProcs.h
Line: 897
PDPrefGetSuppressICCSpaces() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool PDPrefGetSuppressICCSpaces(ASUns32 nComponents)

Returns the value of the suppress flag for ICC-based spaces with the specified number of components.

Parameters

nComponents — 

The number of ICC-based space components that are suppressed or not, according to the flag value.

Returns

The suppress flag value.

See Also


File: PDFLProcs.h
Line: 584
PDPrefGetUseOutputIntents() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool PDPrefGetUseOutputIntents()

Returns the value of the Output Intent flag. When this flag is true, the system overrides the working space with the Output Intent, if it is present.

Returns

The Output Intent flag value.

See Also


File: PDFLProcs.h
Line: 562
PDPrefSetAntialiasLevel() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPrefSetAntialiasLevel(ASInt16 antialiasPixelLevel)

Sets the default smooth text and smooth images global flags for subsequent rendering methods.

If the function PDPageDrawContentsToMemory() is used for drawing, the smoothFlags value passed to that function supersedes the preference value for the duration of the call.

Parameters

antialiasPixelLevel — 

The antialias level, in pixels. It is an OR of the following flags:

  • kPDPrefAASmoothText

  • kPDPrefAASmoothLineArt

  • kPDPrefAASmoothImage

See Also


File: PDFLProcs.h
Line: 353
PDPrefSetBlackPointCompensation() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPrefSetBlackPointCompensation(ASBool kbpc)

Sets the black-point compensation flag, which controls whether to adjust for differences in black points when converting colors between color spaces. When enabled, the full dynamic range 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).

Parameters

kbpc — 

true to enable black-point compensation, false otherwise.

See Also


File: PDFLProcs.h
Line: 386
PDPrefSetEnableThinLineHeuristics() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPrefSetEnableThinLineHeuristics(ASBool doThinLineTricks)

Sets whether thin lines will be fattened non-linearly or the stroke adjust will be applied to thin rectangles.

Parameters

doThinLineTricks — 

true if thin line heuristics are applied, false otherwise.


File: PDFLProcs.h
Line: 904
PDPrefSetGreekLevel() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPrefSetGreekLevel(ASInt16 greekPixelLevel)

Sets the greek level. The greek level is a text height below which text characters are not rendered. Instead, text-like glyphs that have no meaning but look good at very small size are used. This is known as greeking.

Parameters

greekPixelLevel — 

The greek level, in pixels.

See Also


File: PDFLProcs.h
Line: 333
PDPrefSetRefXObj() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPrefSetRefXObj(PDRefXObjMode refXObjMode, ASFileSys fileSys, ASPathName pathName)

Sets reference XObject parameters.

Parameters

refXObjMode — 

The mode to view or print reference XObjects. Its value can be one of the following:

Reference XObject mode

Description

kRefXObjNever

Does nothing. The function returns false.

kRefXObjAlways

Find a substitution with minimal checking.

kRefXObjPDFX5

Restrict substitutions to PDF/X-5 conforming ones.

kRefXObjAlwaysAssured

Fail the parser if the target is not found. Do not display the proxy.

kRefXObjPDFX5Assured

Fail the parser if the target PDF/X-5 document not found. Do not display the proxy.

 
fileSys — 

Used with pathname to specify the location where the target files should be located. These are used to look for the target document.

 
pathName — 

Used with pathname to specify the location where the target files should be located. These are used to look for the target document. The order followed is that given in the PDF Reference.


File: PDFLProcs.h
Line: 888
PDPrefSetSuppressICCSpaces() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPrefSetSuppressICCSpaces(ASUns32 nComponents, ASBool value)

Specifies use of a default color space rather than an ICC-based color space.

Parameters

nComponents — 

The number of ICC color space components.

 
value — 

When true, use a DefaultCMYK, DefaultRGB, or DefaultGray color space instead of an ICC-based color space with the same number of components.

See Also


File: PDFLProcs.h
Line: 574
PDPrefSetUseLocalFonts() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPrefSetUseLocalFonts(ASBool useLocalFonts)

Enables or disables use of local fonts.

Parameters

useLocalFonts — 

When true, use local fonts. When false, use global fonts.


File: PDFLProcs.h
Line: 402
PDPrefSetUseOutputIntents() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPrefSetUseOutputIntents(ASBool flag)

Sets the Output Intent flag.

Parameters

flag — 

When true, use Output Intent to override a working space if it is present.

See Also


File: PDFLProcs.h
Line: 552
PDPrefSetWorkingCMYK() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPrefSetWorkingCMYK(void* profile, ASUns32 profileLength)

Sets the current CMYK working space to a given ICC profile. A CMYK working space in PDF is defined as a profile to substitute for a corresponding /DeviceCMYK space.

Parameters

profile — 

A pointer to a buffer containing the ICC color profile.

 
profileLength — 

The length in bytes of the profile.

See Also


File: PDFLProcs.h
Line: 655
PDPrefSetWorkingGray() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPrefSetWorkingGray(void* profile, ASUns32 profileLength)

Sets the current gray working space to a given ICC profile. A gray working space in PDF is defined as a profile to substitute for a corresponding /DeviceGray space. When rendering with overprint preview, the gray substitution is suppressed, to avoid converting grayscale to "rich black."

Parameters

profile — 

A pointer to a buffer containing the ICC color profile.

 
profileLength — 

The length in bytes of the profile.

See Also


File: PDFLProcs.h
Line: 669
PDPrefSetWorkingRGB() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDPrefSetWorkingRGB(void* profile, ASUns32 profileLength)

Set the current RGB working space to a given ICC profile. An RGB working space in PDF is defined as a profile to substitute for a corresponding /DeviceRGB space.

Parameters

profile — 

A pointer to a buffer containing the ICC color profile.

 
profileLength — 

The length in bytes of the profile.

See Also


File: PDFLProcs.h
Line: 643
PSPrintAfterBeginPageSetup() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PSPrintAfterBeginPageSetup(PDDoc doc, ASInt32 page, ASStm stm, void* clientData)

This notification is broadcast after the beginning of the Page Setup (immediately after writing %% BeginPageSetup) during the printing of a page to a PostScript printer with the methods PDFLPrintDoc() (only available with PDF Library SDK) or PDDocPrintPages() (only available with PDF Library SDK). At this point it is possible to use setpagedevice and set the graphics state but marks cannot be made on the page.

Parameters

doc — 

IN/OUT The document from which a page is printed.

 
page — 

IN/OUT The page number of the page being printed.

 
stm — 

IN/OUT The PostScript print stream. PostScript commands can be added to the print stream using ASStmWrite() . Some printer drivers (Windows PS4) may not allow additions to the PostScript stream at this point.

 
clientData — 

IN/OUT A pointer to a block of user-supplied data that was passed in by the calling application when this notification was registered for using AVAppRegisterNotification().

See Also

PDDocPrintPages (Only available with PDF Library SDK)
PDFLPrintDoc (Only available with PDF Library SDK)

Notifications


File: PIPokes.h
Line: 1530
PSPrintAfterBeginProlog() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PSPrintAfterBeginProlog(PDDoc doc, ASStm stm, void* clientData)

This notification is broadcast after the beginning of the PostScript Prolog (immediately after writing %% BeginPrologue) during the printing of a document to a PostScript printer with the methods PDFLPrintDoc() (only available with PDF Library SDK) or PDDocPrintPages() (only available with PDF Library SDK). The Prolog is a set of application-specific procedure definitions that an application may emit in a PostScript stream.

At this point nothing should be added to the PostScript print stream that modifies the graphics state or puts marks on the page. Callers should only emit procset resources.

Parameters

doc — 

IN/OUT The document that is being printed.

 
stm — 

IN/OUT The PostScript print stream. PostScript commands can be added to the print stream using ASStmWrite() .

 
clientData — 

IN/OUT A pointer to a block of user-supplied data that was passed in by the calling application when this notification was registered for using AVAppRegisterNotification().

See Also

PDDocPrintPages (Only available with PDF Library SDK)
PDFLPrintDoc (Only available with PDF Library SDK)

Notifications


File: PIPokes.h
Line: 1457
PSPrintAfterBeginSetup() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PSPrintAfterBeginSetup(PDDoc doc, ASStm stm, void* clientData)

This notification is broadcast after the beginning of the Document Setup (immediately after writing %% BeginSetup) during the printing of a page to a PostScript printer with the methods PDFLPrintDoc() (only available with PDF Library SDK) or PDDocPrintPages() (only available with PDF Library SDK). During Document Setup, fonts may be downloaded, setpagedevice may be called, procsets may be initialized, the graphics state may be initialized, and so forth.

Parameters

doc — 

IN/OUT The document that is being printed.

 
stm — 

IN/OUT The PostScript print stream. PostScript commands can be added to the print stream using ASStmWrite() .

 
clientData — 

IN/OUT A pointer to a block of user-supplied data that was passed in by the calling application when this notification was registered for using AVAppRegisterNotification().

See Also

PDDocPrintPages (Only available with PDF Library SDK)
PDFLPrintDoc (Only available with PDF Library SDK)

Notifications


File: PIPokes.h
Line: 1480
PSPrintAfterEmitExtGState() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PSPrintAfterEmitExtGState(ASStm stm, void* clientData)

This notification is broadcast after extended graphics state parameters are emitted while printing to a PostScript printer with the methods PDFLPrintDoc() (only available with the PDF Library SDK) or PDDocPrintPages() (only available with the PDF Library SDK).

These parameters are typically device-dependent. For information on extended graphics state, see Section 4.3.4 on extended graphics states in the PDF Reference.

Parameters

stm — 

IN/OUT The PostScript print stream. PostScript commands can be added to the print stream using ASStmWrite() .

 
clientData — 

IN/OUT A pointer to a block of user-supplied data that was passed in by the calling application when this notification was registered for using AVAppRegisterNotification().

See Also

PDDocPrintPages (Only available with the PDF Library SDK)
PDFLPrintDoc (Only available with the PDF Library SDK)

File: PIPokes.h
Line: 1620
PSPrintAfterPageTrailer() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PSPrintAfterPageTrailer(PDDoc doc, ASInt32 page, ASStm stm, void* clientData)

This notification is broadcast after the page trailer is emitted (immediately after writing %% PageTrailer) during the printing of a page to a PostScript printer with the methods PDFLPrintDoc() (only available with PDF Library SDK) or PDDocPrintPages() (only available with PDF Library SDK). At this point it is possible to resolve comments (at end) and emit cleanup code.

Parameters

doc — 

IN/OUT The document from which a page is printed.

 
page — 

IN/OUT The page number of the page being printed.

 
stm — 

IN/OUT The PostScript print stream. PostScript commands can be added to the print stream using ASStmWrite() .

 
clientData — 

IN/OUT A pointer to a block of user-supplied data that was passed in by the calling application when this notification was registered for using AVAppRegisterNotification().

See Also

PDDocPrintPages (Only available with PDF Library SDK)
PDFLPrintDoc (Only available with PDF Library SDK)

Notifications


File: PIPokes.h
Line: 1553
PSPrintAfterTrailer() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PSPrintAfterTrailer(PDDoc doc, ASStm stm, void* clientData)

This notification is broadcast after the DSC trailer is emitted (immediately after writing %% Trailer) during the printing of a page to a PostScript printer with the methods PDFLPrintDoc() (only available with PDF Library SDK) or PDDocPrintPages() (only available with PDF Library SDK). At this point it is possible to resolve comments (at end) and emit cleanup code.

Parameters

doc — 

IN/OUT The document that is being printed.

 
stm — 

IN/OUT The PostScript print stream. PostScript commands can be added to the print stream using ASStmWrite() .

 
clientData — 

IN/OUT A pointer to a block of user-supplied data that was passed in by the calling application when this notification was registered for using AVAppRegisterNotification().

See Also

PDDocPrintPages (Only available with PDF Library SDK)
PDFLPrintDoc (Only available with PDF Library SDK)

Notifications


File: PIPokes.h
Line: 1575
PSPrintBeforeAcrobatProcsets() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PSPrintBeforeAcrobatProcsets(PDDoc doc, ASStm stm, void* clientData)

Clients that register for this notification will be called back during PostScript printing, just prior to emission of the Acrobat procsets.

Parameters

doc — 

IN/OUT The document that is being printed.

 
stm — 

IN/OUT The PostScript print stream. PostScript commands can be added to the print stream using ASStmWrite() .

 
clientData — 

IN/OUT A pointer to a block of user-supplied data that was passed in by the calling application when this notification was registered for using AVAppRegisterNotification().

See Also

PDDocPrintPages() (Only available with PDF Library SDK)
PDFLPrintDoc() (only available with PDF Library SDK)

Notifications


File: PIPokes.h
Line: 2052
PSPrintBeforeEndComments() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PSPrintBeforeEndComments(PDDoc doc, ASStm stm, void* clientData)

This notification is broadcast after the DSC page-level comments that apply to all pages have been emitted (immediately before writing %% EndComments) during the printing of a page to a PostScript printer with the methods PDFLPrintDoc() (only available with the PDF Library SDK) or PDDocPrintPages() (only available with the PDF Library SDK).

Parameters

doc — 

IN/OUT The document that is being printed.

 
stm — 

IN/OUT The PostScript print stream. PostScript commands can be added to the print stream using ASStmWrite() .

 
clientData — 

IN/OUT A pointer to a block of user-supplied data that was passed in by the calling application when this notification was registered for using AVAppRegisterNotification().

See Also

PDDocPrintPages (Only available with PDF Library SDK)
PDFLPrintDoc (Only available with PDF Library SDK)

Notifications


File: PIPokes.h
Line: 1597
PSPrintBeforeEndSetup() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PSPrintBeforeEndSetup(PDDoc doc, ASStm stm, void* clientData)

This notification is broadcast before the end of Document Setup (immediately before writing %% EndSetup) during the printing of a page to a PostScript printer with the methods PDFLPrintDoc() (only available with PDF Library SDK) or PDDocPrintPages() (only available with PDF Library SDK). At this point all of the job level resources and procsets have been added to the print stream.

Parameters

doc — 

IN/OUT The document that is being printed.

 
stm — 

IN/OUT The PostScript print stream. PostScript commands can be added to the print stream using ASStmWrite() . Some printer drivers (Windows PS4) may not allow additions to the PostScript stream at this point.

 
clientData — 

IN/OUT A pointer to a block of user-supplied data that was passed in by the calling application when this notification was registered for using AVAppRegisterNotification().

See Also

PDDocPrintPages (Only available with PDF Library SDK)
PDFLPrintDoc (Only available with PDF Library SDK)

Notifications


File: PIPokes.h
Line: 1504
SearchAddIndex() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

SearchIndexPtr SearchAddIndex(SearchIndexListPtr list, char* fullPath, ASUns32 flags)

Superseded in Acrobat 6.0 by SearchAddIndexEx().

Adds a specified index to the shelf.

Parameters

list — 

The list of indices on the shelf, obtained using SearchGetIndexList().

 
fullPath — 

A platform-dependent path to the index.

 
flags — 

A platform-dependent path to the index:

  • On Mac OS, it is of the form MyDisk:TopFolder:BottomFolder:Strange.pdx.

  • On Windows, it is of the form C:\LVL1\MYFILES\INDEX. On UNIX and Windows, the .PDX extension is automatically added to the specified path name.

Returns

The index that was added. This value may be used in subsequent calls to remove the index, obtain its title, and so forth.


File: SrchPrcs.h
Line: 166
SearchAddIndexEx() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

SearchIndexPtr SearchAddIndexEx(SearchIndexListPtr list, ASFileSys fileSys, ASPathName indexPath, ASUns32 flags)

Supersedes SearchAddIndex() in Acrobat 6.0.

Adds a specified index to the shelf, using the Acrobat 6.0 file system and path mechanism.

Parameters

list — 

The list of indices on the shelf, obtained using SearchGetIndexList().

 
fileSys — 

The file system on which the index is found.

 
indexPath — 

The path to the index.

 
flags — 

Flags that indicate the state of the index. It must be an OR of the following values (see SrchType.h):

Value

Description

kIndexAvailableFlag

The index is available for searching. Indices that are not available appear grayed out in the Search plug-in's user interface.

kIndexSelectedFlag

The index is used for searching. Indices that are selected appear with a filled in check box in the Search plug-in's user interface.

kIndexPtrInvalidFlag

(Read only: cannot be set). The index cannot be located; it does not exist.

In practice, kIndexAvailableFlag should always be set.

Returns

The index that was added. This value may be used in subsequent calls to remove the index, obtain its title, and so forth.

It returns kAddIndexFailed if the specified index could not be added to the shelf. It returns kIndexExists if the index is already on the shelf.


File: SrchPrcs.h
Line: 285
SearchCountIndexList() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASUns32 SearchCountIndexList(SearchIndexListPtr list)

Gets the number of indices currently on the shelf.

Parameters

list — 

The list of indices on the shelf, obtained using SearchGetIndexList().

Returns

The number of indices on the shelf.


File: SrchPrcs.h
Line: 103
SearchExecuteQuery() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASInt32 SearchExecuteQuery(char* cQuery, ASInt16 nParserID, ASUns16 nSortCount, char** cSortNames, ASBool* bSortWays, ASUns32 nWordOptions, ASBool bOverrideWordOptions, ASUns16 nMaxDocs)

Superseded in Acrobat 6.0 by SearchExecuteQueryEx(), which allows a broader range of search locations.

Executes a specified query, using the set of indices currently on the shelf. The search results are displayed in the Acrobat Search plug-in's Results window.

Parameters

cQuery — 

The query. Its format is the same as what a user would type into the Search query dialog, and depends on the search language specified by parserID.

 
nParserID — 

The search language used in the query. It must be one of the following values (see SrchType.h):

Value

Description

kParserSimple

Allows only simple phrase searches; it does not allow boolean searching.

kParserCQL

Allows boolean searches using AND, OR, and NOT, as described in the Acrobat Search plug-in's online help file.

 
nSortCount — 

The number of entries in the sortSpec list.

 
cSortNames — 

An array of strings, each specifying a key whose value is used to sort the search results. The first entry is the primary sort key, the second is the secondary sort key, and so forth. Each string may be any field that appears in the index, plus Score (which sorts results by relevance ranking). Some common fields are Title, ModificationDate, CreationDate, and Keywords.

 
bSortWays — 

An array of boolean values indicating sort order, corresponding to the array of sortSpecs with true meaning ascending and false meaning descending.

 
nWordOptions — 

Search options. It must be an OR of the following values (see SrchType.h):

Value

Description

kWordOptionCase

The search is case-sensitive.

kWordOptionStemming

Find not only the specified word, but other words that have the same stem (for example, run and ran have the same stem).

kWordOptionProximity

Consider the proximity of results when using the AND operator to look for more than one word in a document. Without this option, ANDed terms can be anywhere in a document. Searching for "red" and "blue", for example, finds a document where "red" is the first word on the first page and "blue" is the last word on the last page. With this option, however, ANDed terms must be within two or three pages of each other to be found. Also, the closer ANDed terms appear together, the higher the relevance ranking of the document that contains them.

kWordOptionRefine

Do not search the entire list of indices, but only the documents that matched the previous search. This is used to refine the results of the previous search. The manner in which wordOptions is used depends on the value of overrideWordOptions.

 
bOverrideWordOptions — 

Flag that indicates whether wordOptions is ORed with the search options set in the user interface, or is used instead of them. If it is 0, wordOptions is ORed with the user interface search options, and the resulting value is used. If it is non-zero, wordOptions is used instead of the user interface search options.

 
nMaxDocs — 

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

Returns

true if successful, false otherwise.


File: SrchPrcs.h
Line: 88
SearchExecuteQueryEx() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool SearchExecuteQueryEx(const SearchQueryDataRec* queryData)

Supersedes SearchExecuteQuery() in Acrobat 6.0.

Executes a specified query, using the given set of search parameters. The search results are displayed in the Acrobat Search plug-in's Results window.

Parameters

queryData — 

A pointer to the structure containing the search parameters.

Returns

true if successful, false otherwise.

See Also

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

File: SrchPrcs.h
Line: 341
SearchGetIndexByPath() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

SearchIndexPtr SearchGetIndexByPath(SearchIndexListPtr list, char* fullPath)

Superseded by SearchGetIndexPathEx() in Acrobat 6.0.

Gets the index that has the specified path. The index must already be on the shelf. The index can be passed to other Search plug-in methods to remove it from the shelf, obtain its title, and so forth.

Parameters

list — 

The list of indices on the shelf, obtained using SearchGetIndexList().

 
fullPath — 

A platform-dependent path to the index:

  • On Mac OS, it is of the form MyDisk:TopFolder:BottomFolder:Strange.pdx.

  • On Windows, it is of the form C:\LVL1\MYFILES\INDEX. The .PDX extension is automatically added to the specified path name.

Returns

The specified index. This value may be used in subsequent calls to remove the index, obtain its title, and so forth.


File: SrchPrcs.h
Line: 136
SearchGetIndexByPathEx() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

SearchIndexPtr SearchGetIndexByPathEx(SearchIndexListPtr list, ASFileSys fileSys, ASPathName indexPath)

Supersedes SearchGetIndexPath() in Acrobat 6.0.

Gets the index that has the specified path. The index must already be on the shelf. The index can be passed to other Search plug-in methods to remove it from the shelf, obtain its title, and so forth.

Parameters

list — 

The list of indices on the shelf, obtained using SearchGetIndexList().

 
fileSys — 

The file system on which the index is found.

 
indexPath — 

The path to the index.

Returns

The specified index. This value may be used in subsequent calls to remove the index, obtain its title, and so forth.


File: SrchPrcs.h
Line: 254
SearchGetIndexFileSys() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASFileSys SearchGetIndexFileSys(SearchIndexPtr index)

Gets the file system for a specified index as an ASFileSys object.

Parameters

index — 

The index whose path is obtained. The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex().

Returns

The ASFileSys object.


File: SrchPrcs.h
Line: 316
SearchGetIndexFlags() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASUns32 SearchGetIndexFlags(SearchIndexPtr index)

Gets the flags for a specified index.

Parameters

index — 

The index whose flags are to be obtained (set). The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex().

Returns

The flags returned are the actual values set, and may not always be the same as the requested value. It gets a list of the indices currently on the shelf.

The list of indices currently on the shelf is returned. This value can subsequently be used by other Search plug-in methods to obtain information about a specific index, the number of indices on the shelf, and so forth.


File: SrchPrcs.h
Line: 188
SearchGetIndexList() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

SearchIndexListPtr SearchGetIndexList()

Gets a list of the indices currently on the shelf.

Returns

The list of indices currently on the shelf. This value can subsequently be used by other Search plug-in methods to obtain information about a specific index, the number of indices on the shelf, and so forth.


File: SrchPrcs.h
Line: 96
SearchGetIndexPath() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

char* SearchGetIndexPath(SearchIndexPtr index)

Superseded in Acrobat 6.0 by SearchGetIndexPathEx().

Gets the platform-dependent path for a specified index.

Parameters

index — 

The index whose path is obtained. The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex().

Returns

A platform-dependent path to the index:

  • On Windows, it is of the form C:\LVL1\MYFILES\INDEX. The .PDX extension is automatically added to the specified path name.

  • On Mac OS, it is of the form MyDisk:TopFolder:BottomFolder:Strange.pdx.


File: SrchPrcs.h
Line: 236
SearchGetIndexPathEx() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASPathName SearchGetIndexPathEx(SearchIndexPtr index)

Supersedes SearchGetIndexPath() in Acrobat 6.0.

Gets the path for a specified index as an ASPathName object.

Parameters

index — 

The index whose path is obtained. The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex().

Returns

The ASPathName object.


File: SrchPrcs.h
Line: 307
SearchGetIndexTitle() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

char* SearchGetIndexTitle(SearchIndexPtr index)

Superseded in Acrobat 6.0 by SearchGetIndexTitleEx().

Gets the title of a specified index.

Parameters

index — 

The index whose title is obtained. The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex().

Returns

The title of the specified index.


File: SrchPrcs.h
Line: 220
SearchGetIndexTitleEx() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASText SearchGetIndexTitleEx(SearchIndexPtr index)

Supersedes SearchGetIndexTitle() in Acrobat 6.0.

Gets the title of a specified index as an ASText object.

Parameters

index — 

The index whose title is obtained. The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex().

Returns

The title of the specified index as an ASText object.


File: SrchPrcs.h
Line: 296
SearchGetNthIndex() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

SearchIndexPtr SearchGetNthIndex(SearchIndexListPtr list, ASUns32 n)

Gets the nth index on the shelf. The index can be passed to other Search plug-in methods to remove it from the shelf, obtain its title, and so forth.

Parameters

list — 

The list of indices on the shelf, obtained using SearchGetIndexList().

 
n — 

The index to get. The first index on the shelf is index zero.

Returns

The nth index on the shelf. This value may be used in subsequent calls to remove the index, obtain its title, and so forth.


File: SrchPrcs.h
Line: 116
SearchIsLegacySearchAvailable() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool SearchIsLegacySearchAvailable()

Tests whether the search mechanism (Search5) for previous Acrobat versions (prior to 6.0) is available for the current system. When Search5 is available, you can search indexes from Acrobat 5.0 and earlier.

Returns

true if legacy searches are available, false otherwise.


File: SrchPrcs.h
Line: 325
SearchRemoveIndex() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void SearchRemoveIndex(SearchIndexListPtr list, SearchIndexPtr index)

Removes the specified index from the shelf.

Parameters

list — 

IN The list of indices on the shelf, obtained using SearchGetIndexList().

 
index — 

IN The index to be removed. The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex().


File: SrchPrcs.h
Line: 173
SearchSetIndexFlags() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASUns32 SearchSetIndexFlags(SearchIndexPtr index, ASUns32 flags)

Sets the flags for a specified index.

Parameters

index — 

The index whose flags are to be set. The index may be obtained using SearchGetIndexByPath(), SearchGetNthIndex(), or SearchAddIndex().

 
flags — 

Flags that indicate the status of the index. flags must be an OR of the values (see SrchType.h):

Value

Description

kIndexAvailableFlag

The index is available for searching. Indices that are not available appear grayed out in the Search plug-in's user interface.

kIndexSelectedFlag

The index is used for searching. Indices that are selected appear with a filled in check box in the Search plug-in's user interface.

kIndexPtrInvalidFlag

(Read only: cannot be set). The index cannot be located; it does not exist.

In practice, kIndexAvailableFlag should always be set.

Returns

The flags returned are the actual values set, and may not always be the same as the requested value.


File: SrchPrcs.h
Line: 209
SetUpCatalogHFTServer() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool SetUpCatalogHFTServer()

Returns

File: cathft.h
Line: 86
SetUpSearchHFTServer() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool SetUpSearchHFTServer()

Returns

File: SrchHFT.h
Line: 54
WDAppSupportPredicateProc() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool WDAppSupportPredicateProc(void* driverRock, WDAppSpecifier timeoutTime)

Callback functions to test a driver. It tests whether a driver can support a given web browser application.

Parameters

driverRock — 

IN A pointer to a driver-defined data structure provided in RegisterWebDriver(). WDAppSpecifier A platform-specific data structure used to identify the web browser application. On Mac OS, it is a pointer to an FSRef(64 bit) or and FSSpec (32 bit).

 
timeoutTime — 

IN data structure. On Windows, it is a pointer to a string (char*) representing the full path of the executable application.

Returns

true if the driver is compatible with the given web browser application, false otherwise.


File: WLHFT.h
Line: 112
WDBecomeDriverFunctionProc() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool WDBecomeDriverFunctionProc(void* driverRock, ASBool bComing)

Callback functions for driver state changes.

It is called whenever the state of the driver changes from inactive to current, or vice versa.

Parameters

driverRock — 

IN A pointer to a driver-defined data structure provided in RegisterWebDriver().

 
bComing — 

IN Tells the driver whether it should become current or relinquish control. If it is true, the driver is being requested to become the current Weblink driver, and it should take any action that is appropriate, such as installing IAC message handlers, opening TCP drivers, and so on. If it is false, the driver is being asked to relinquish its status as current driver and should take whatever action is necessary to accomplish this.

Returns

false if the driver fails to change its state to that requested in bComing, true otherwise.


File: WLHFT.h
Line: 180
WDBringFrontFunctionProc() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void WDBringFrontFunctionProc(void* driverRock)

Callback functions for Weblink toolbar button click.

It is called when the user clicks on the Weblink toolbar button to switch to the browser application.

Parameters

driverRock — 

IN A pointer to a driver-defined data structure provided in RegisterWebDriver().


File: WLHFT.h
Line: 188
WDFollowLinkFunctionProc() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool WDFollowLinkFunctionProc(void* driverRock, AVDoc theDoc, char* cURL, char* cFormData)

Callback functions for to Follow a Link.

Follows and retrieves the link specified by cURL from the PDF document specified by theDoc. Weblink supplies the driver a fully resolved URL. The driver is solely responsible for launching a web browser, if it requires one. If the driver depends on an external web browser, the driver or the web browser is responsible for bringing that browser to the foreground if the link data is not displayed by the Acrobat viewer. For relative links, Weblink prepends a base URL if specified; otherwise, it prepends the appropriate portion from the current document's URL to resolve a relative link. Weblink automatically handles mapped links, which are links that generate different results based on the location of the mouse within the links. (Such links are specified by checking the Mapped Coordinates Link box in the Edit URL dialog box. These links have the isMap attribute). Weblink appends "?" to the URL, followed by the x- and y-coordinates of the mouse at the time the link was selected, relative to the upper-left corner of the link's rectangle.

Parameters

driverRock — 

IN A pointer to a driver-defined data structure provided in RegisterWebDriver().

 
theDoc — 

IN The PDF document that contains the link.

 
cURL — 

IN A NULL-terminated C string containing the URL the link points to.

 
cFormData — 

IN Data from a form to be sent with the URL as post data. The default MIME type of form data is "application/x-www-formunencoded".

Returns

true if the driver has successfully begun the process of following the link, false otherwise.


File: WLHFT.h
Line: 137
WDFollowLinkWithParamsFunctionProc() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool WDFollowLinkWithParamsFunctionProc(void* driverRock, AVDoc theDoc, char* cURL, char* cFormData, WWWOpenURLParams params)

Callback functions for to Follow a Link with parameters.

Follows and retrieves the link specified by cURL from the PDF document specified by theDoc. Weblink supplies the driver a fully resolved URL. The driver is solely responsible for launching a web browser, if it requires one. If the driver depends on an external web browser, the driver or the web browser is responsible for bringing that browser to the foreground if the link data is not displayed by the Acrobat viewer. For relative links, Weblink prepends a base URL if specified; otherwise, it prepends the appropriate portion from the current document's URL to resolve a relative link. Weblink automatically handles mapped links, which are links that generate different results based on the location of the mouse within the links. (Such links are specified by checking the Mapped Coordinates Link box in the Edit URL dialog box. These links have the isMap attribute). Weblink appends "?" to the URL, followed by the x- and y-coordinates of the mouse at the time the link was selected, relative to the upper-left corner of the link's rectangle.

Parameters

driverRock — 

IN A pointer to a driver-defined data structure provided in RegisterWebDriver().

 
theDoc — 

IN The PDF document that contains the link.

 
cURL — 

A NULL-terminated C string containing the URL the link points to.

 
cFormData — 

Data from a form to be sent with the URL as post data. The default MIME type of form data is "application/x-www-formunencoded".

 
params — 

IN A parameter block specifying a target frame.

Returns

true if the driver has successfully begun the process of following the link, false otherwise.


File: WLHFT.h
Line: 164
WDIsDriverBusyFunctionProc() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool WDIsDriverBusyFunctionProc(void* driverRock)

Callback functions to check driver transaction status (Optional) Called to determine if the driver is performing a transaction or not. Weblink uses this to check that the driver is not busy before allowing a user to change preferences.

Parameters

driverRock — 

IN A pointer to a driver-defined data structure provided in RegisterWebDriver().

Returns

true if the driver is busy (driver-defined), false otherwise. The driver should return busy whenever it is not convenient for it to become the current driver as requested by <DXRef>WDBecomeDriverFunction.


File: WLHFT.h
Line: 207
WDOptionsFunctionProc() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void WDOptionsFunctionProc(void* driverRock)

Callback functions for a Weblink Options button click.

It is called when the user clicks on the Options button in the Weblink Preferences dialog box. If this function is NULL, the Options button is disabled. Optional: set it to NULL if there no options dialog.

Parameters

driverRock — 

IN A pointer to a driver-defined data structure provided in RegisterWebDriver().


File: WLHFT.h
Line: 197