PDFL Library Layer

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(). Pass a pathname of NULL to reset the default temporary path to the file system default.

Flags for CosDocSave saveFlags parameter. This is specific to the PDF Library.

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.

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.

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.

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

Gets the Core HFT.

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.

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

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. Obsolete in PDF Library 6.0. Use HFTGetVersion() instead.

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

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.

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.

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.

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.

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

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

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

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

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

CJK font related option for PostScript printing.

Specifies how to include a resource in a file.

PDFLData structure for PDFLInit.

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.

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.

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

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

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

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

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.

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.

Text server.

Encoding identifiers (for TE).

Prints a range of pages from a document, controlled by a structure of data and callbacks. This low-level method should be avoided; use the higher-level PDFLPrintDoc() instead.

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. Users of the PDFLPrintDoc() method do not have to create the PDPrintClient() callbacks. That detail is handled by the library.

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. Users of the PDFLPrintDoc() method do not have to create the PDPrintClient() callbacks. That detail is handled by the library. Platform: (WIN_ENV)

Deprecated: use PDFLPrintDoc() instead.

Specifies what kind of file to emit.

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.

A print progress callback.

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

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

(Required for PostScript printing) A callback for PDPrintClient. It asks the client which encoding method should be used for the font. Method Description kPDDoReencode Use for Type 1 fonts and substituted fonts. kPDDoNothing Use for TrueType Windows font or built-in encoding font. kPDDoXlate Use for a TrueType custom font or font with Mac OS encoding.

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

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.

OPI 1.3 color type information.

OPI 2.0 image ink information.

OPI Types for PostScript printing.

An enumeration of the various stages that might be involved in printing a PDF. For use with PDFLPrintProgressProc.

Font array.

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.

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

Tests whether the specified font is embedded in the PDF file and has already been extracted to display or print the file.

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.

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.

A resource tree for a PDPage or other PDModel object. Maintains information about the current print job and what fonts have been downloaded.

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.

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. Platform: ((!MAC_PLATFORM || !AS_ARCH_64BIT)) && ((!MAC_PLATFORM))

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));

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.

Obsolete in PDF Library 6.0. Do not use.

Returns the width and height of the page, which could be rotated or defaulted.

Takes ASext as input. If set we use this profile as blending profile. kPDPageDisplayOverPrintPreviewStr must be set for this to get honored.

Directly imposed page.

Display overprint preview.

Const strings used as ASCab keys when passing PDPageDrawFlags. These are valid only for calls to PDPageDrawContentsToMemoryEx and PDPageDrawContentsToWindowEx2.

Do not substitute working spaces.

Draw smooth image using bicubic resampling. This option can have performance overhead.

Draw smooth image.

Draw smooth line art.

Draw smooth text.

Emit a page group.

Ignore Isolated and Knockout transparency at page boundary.

PostScript printing.

The page is being printed.

Pass metadata to AGM port.

Pass optional content to AGM port.

Pass open prepress interface (OPI) to AGM port.

Suppress raster alpha.

Render colors in Swapped color vs the normal case, which is helpful for specialized scenarios where the output is expected to be in such an order. For DeviceRGB, this means BGR rather than RGB. For DeviceCMYK, this means KYMC rather than CMYK.

Draw annotation appearances.

User printer's mark annotations.

If set, only consider Stamp annotations. This overrides kPDPageUseAnnotFaces.

Use trap network annotations.

If this is set, only use a working space instead of a device space if the process color model of the target device is different than that of the source.

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.

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.

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.

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.

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.

Sets reference XObject parameters.

Specifies use of a default color space rather than an ICC-based color space.

Enables or disables use of local fonts.

Sets the Output Intent flag.

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.

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

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.

A selection of text on a single page that may contain more than one disjoint group of words. A text selection is specified by one or more ranges of text, with each range containing the word numbers of the selected words. Each range specifies a start and end word, where "start" is the first of a series of selected words and "end" is the first word not in the series.