Symbols   A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  

AC_AbsColorimetric
AC_CHANGEALL
AC_ColorSpace — Constant values for ICC color space signatures.
AC_Error — Error codes returned by AcroColor functions.
AC_Error_BadAlignment
AC_Error_BadConcat
AC_Error_BadDescription
AC_Error_BadMerge
AC_Error_BadProfile
AC_Error_ColorSync
AC_Error_DiskIO
AC_Error_EOF
AC_Error_FileLocked
AC_Error_FileNotFound
AC_Error_General
AC_Error_ICM
AC_Error_InvalidSettings
AC_Error_MaxEnum
AC_Error_Memory
AC_Error_MissingKey
AC_Error_MissingProfile
AC_Error_ModifiedProfile
AC_Error_NoASCII
AC_Error_NoLocalized
AC_Error_None
AC_Error_NotImplemented
AC_Error_NoUnicode
AC_Error_Param
AC_Error_ScratchFull
AC_Error_SettingsVersion
AC_Error_StackFull
AC_Error_StringOverflow
AC_Error_UnsupCMS
AC_Error_UnsupOption
AC_Error_UnsupPacking
AC_Error_UnsupProfile
AC_Error_UnsupProfileCode
AC_Error_UnsupQuery
AC_Error_UnsupSpace
AC_Error_UserAbort
AC_Error_Version
AC_FileSpec
AC_Key_BlendGammaEnabled
AC_Key_BlendGammaValue
AC_Key_CompressionEnabled
AC_Key_CompressionPercent
AC_Key_Description
AC_Key_Dither
AC_Key_EngineCMM
AC_Key_EngineCMS
AC_Key_Intent
AC_Key_KPC
AC_Key_MaxEnum
AC_Key_MismatchAskOpening
AC_Key_MismatchAskPasting
AC_Key_MissingAskOpening
AC_Key_Name
AC_Key_PolicyCMYK
AC_Key_PolicyGray
AC_Key_PolicyRGB
AC_Key_ProofProfile
AC_Key_ProofType
AC_Key_Simulate
AC_Key_WorkingCMYK
AC_Key_WorkingGray
AC_Key_WorkingRGB
AC_Key_WorkingSpot
AC_Key_WriterName
AC_LabColor
AC_NEVERREVISIT
AC_NOCHANGE
AC_Packing_ABC8
AC_Packing_ABCD15
AC_Packing_ABCD8
AC_Packing_CMYK15_Black0
AC_Packing_CMYK8_Black0
AC_Packing_CMYK8_White0
AC_Packing_CS64_ABC
AC_Packing_CS64_ABCD
AC_Packing_CS64_CMYK
AC_Packing_CS64_Gray
AC_Packing_CS64_Lab
AC_Packing_CS64_RGB
AC_Packing_CS64_XYZ
AC_Packing_General
AC_Packing_Gray15_Black0
AC_Packing_Gray8_Black0
AC_Packing_Gray8_White0
AC_Packing_Lab8
AC_Packing_MaxEnum
AC_Packing_Null
AC_Packing_pABC15
AC_Packing_pABC8
AC_Packing_pLab15
AC_Packing_pLab8
AC_Packing_pRGB15
AC_Packing_pRGB8
AC_Packing_pXYZ16
AC_Packing_RGB8
AC_PackingCode — Constants that specify the packing used in a color transformation.
AC_Perceptual
AC_PresetList
AC_Profile
AC_Profile_AdobeRGB1998
AC_Profile_AppleRGB
AC_Profile_ColorMatchRGB
AC_Profile_DotGain10
AC_Profile_DotGain15
AC_Profile_DotGain20
AC_Profile_DotGain25
AC_Profile_DotGain30
AC_Profile_Flat_XYZ
AC_Profile_Gamma18
AC_Profile_Gamma22
AC_Profile_Lab_D50
AC_Profile_MaxEnum
AC_Profile_MonitorRGB
AC_Profile_Null
AC_Profile_PCS_XYZ
AC_Profile_sRGB
AC_Profile_SystemCMYK
AC_Profile_SystemGray
AC_Profile_SystemInput
AC_Profile_SystemOutput
AC_Profile_SystemProofer
AC_Profile_SystemRGB
AC_Profile_WorkingCMYK
AC_Profile_WorkingGray
AC_Profile_WorkingRGB
AC_ProfileCode — Constants that describe the type of a device color profile.
AC_ProfileList
AC_RelColorimetric
AC_REMOVE
AC_RenderIntent — Constants that specify a standard ICC rendering intent for a device color profile. The rendering intent specifies the color translation method for colors that are outside the gamut of the color profile.
AC_REPLACE
AC_REVISIT
AC_Saturation
AC_Selector_CMYK_OtherInputCapable
AC_Selector_CMYK_OtherOutputCapable
AC_Selector_CMYK_StandardInput
AC_Selector_CMYK_StandardOutput
AC_Selector_DotGain_Other
AC_Selector_DotGain_Standard
AC_Selector_Gray_OtherInputCapable
AC_Selector_Gray_OtherOutputCapable
AC_Selector_Gray_Standard
AC_Selector_MaxEnum
AC_Selector_PhotoYCC_InputCapable
AC_Selector_RGB_OtherInputCapable
AC_Selector_RGB_OtherOutputCapable
AC_Selector_RGB_Standard
AC_SelectorCode — Constants that specify the types of device profiles to include in a profile list.
AC_Settings
AC_SettingsKey — Constant key values for an AC_Settings object.
AC_SettingsType — Constant values that determine the type of an AC_Settings object.
AC_SettingsType_Color
AC_SettingsType_MaxEnum
AC_SettingsType_Proof
AC_Space_10Component
AC_Space_11Component
AC_Space_12Component
AC_Space_13Component
AC_Space_14Component
AC_Space_15Component
AC_Space_2Component
AC_Space_3Component
AC_Space_4Component
AC_Space_5Component
AC_Space_6Component
AC_Space_7Component
AC_Space_8Component
AC_Space_9Component
AC_Space_CMY
AC_Space_CMYK
AC_Space_Gray
AC_Space_HLS
AC_Space_HSV
AC_Space_Lab
AC_Space_Luv
AC_Space_MaxEnum
AC_Space_Null
AC_Space_PhotoYCC
AC_Space_RGB
AC_Space_XYZ
AC_Space_YCbCr
AC_String
AC_ToneCurve
AC_Transform
AC_UseProfileIntent
AC_XYColor
AC_XYZColor
ACApplyTransform — Applies a color conversion or gamut test transformation. It processes the number of colors specified by count, using the memory formats for the source and destination data specified in srcPacking and dstPacking. The source data and destination data can point to the same block of memory if the source and destination packing formats use the same number of bits per color.
ACCalCMYK
ACCalGray
ACCalLab
ACCalRGB
ACEngineCount — Gets the number of Color Management System/Color Management Module (CMS/CMM) choices available for the AcroColor engine (ACE).
ACEngineInfo — Gets information for a CMS/CMM in the AcroColor engine (ACE) by index. The CMS and CMM identifiers specify an engine to the ACE. Engine names should only be used as the text for popup menus. It is better to store the identifiers in settings files (rather than names), because they are independent of localization.
ACGetBlackPointCompensation — Get the black-point compensation flag.
ACGetExceptionErrorCode
ACGetSettingsProfile — Gets the current color profile for a given key from the AcroColor engine (ACE) settings object. If the settings file contains a profile entry with the specified key, that profile is returned. If the settings file contains a special NULL entry with the key, a NULL profile is returned. If the settings file contains a string with this key rather than an embedded profile, this method returns an installed profile whose description matches the string, if found. In all other cases, AC_Error_MissingKey is returned. The method does not check for known keys or legal key values. It is up to the client to write only legal key values, and to verify key values when reading.
ACGetSettingsString — Gets the current string value for a given key from the AcroColor engine (ACE) settings object. If the settings file contains a string entry with the specified key, the method returns the entry. If the settings file contains a special NULL entry with the key, the method returns a NULL string. In all other cases, the method returns AC_Error_MissingKey.
ACGetSettingsUnsigned32 — Gets the current numeric value for a given key from the AcroColor engine (ACE) settings object. If the settings file contains an unsigned 32-bit numeric entry with the specified key, the method returns the entry. In all other cases, the method returns AC_Error_MissingKey.
ACGetWorkingSpaceProfile — Gets a working color profile in a specified color space.
ACLoadSettings — [DEPRECATED] Loads the AcroColor engine (ACE) settings from a file.
ACLoadSettingsU — Reads the settings entries from the specified file. All entries are stored in the settings object, even entries with unknown keys or data formats. As a general rule, the client should keep the settings object around so these unknown keys are preserved when the settings are saved out. The only time the client should start with a fresh settings object is when performing another settings load.
ACMakeBufferProfile — Creates a device color profile object from a data buffer containing the raw ICC profile data. The method copies the data, so the client can dispose of the source data. The client should call ACUnReferenceProfile() when done with the profile.
ACMakeCalGray — Creates a device color profile object from a calibrated grayscale color space with the specified rendering intent and description string. The client should call ACUnReferenceProfile() when done with the profile.
ACMakeCalLab — Creates a device color profile object from a calibrated Lab color space with the specified rendering intent and description string. The client should call ACUnReferenceProfile() when done with the profile.
ACMakeCalRGB — Creates a device color profile object from a calibrated RGB color space, with the specified rendering intent and descriptive string. The client should call ACUnReferenceProfile() when done with the profile.
ACMakeColorTransform — Creates a color transformation object.
ACMakePresetList — Creates a list of preset AcroColor engine (ACE) settings of the specified type. Clients should call ACUnReferencePresetList() when done with the preset list.
ACMakeProfileList — Creates a list of device color profiles of a given type.
ACMakeSettings — Creates an AcroColor engine (ACE) settings object of a given type, with no entries. When done with all operations, call ACUnReferenceSettings() to free the settings object.
ACMakeString — Creates an AcroColor string from a NULL-terminated ASCII string or a NULL-terminated Unicode string, or both. If both ASCII and Unicode data are specified, the AC_String object keeps track of both in parallel, returning the ASCII data when asked for ASCII, and the Unicode data when asked for Unicode.
ACMonitorProfile — Gets a device color profile for a specific monitor device. The returned profile may be either RGB or grayscale. If no profile is specified by the system, the method returns a default platform profile (sRGB on Windows). The client should call ACUnReferenceProfile() when done with the returned profile.
ACMonitorProfileN
ACPopExceptionFrame
ACPresetFileToName — [DEPRECATED] Translates a preset settings file specification to a name ready to be displayed in menus (with directory paths and file extensions removed). The client should call ACUnReferenceString() when done with the name. If the file contains an internal name tag, the returned string is created from the internal name. If the file does not contain an internal name tag, the returned string is built from the file name. In this case, the method assumes that the file name and the ASCII data of the returned string are in the local script code.
ACPresetListCount — Gets the number of predefined color settings, as listed in the color management settings in the Acrobat user interface.
ACPresetListItemFile — [DEPRECATED] Gets the file specification for a preset settings item in a preset list.
ACPresetListItemFileAndNameU — Returns the file specification and a display name of a specified preset in a list. The client should call ACE_UnReferenceString when done with the file and name.
ACProfileColorSpace — Gets the color space for a device profile.
ACProfileData — Gets the data for a device profile. Copies the raw ICC profile data into a supplied buffer.
ACProfileDescription — Gets the description of a device profile. The returned description string contains both ASCII and Unicode data, even if the profile itself only contains ASCII data.
ACProfileFromCode — Creates a device profile from a device profile type code. The client should call ACUnReferenceProfile() when done with the profile.
ACProfileFromDescription — Finds a profile matching the description string in the database. The client should call ACUnReferenceProfile() when done with the profile. If the description string contains Unicode text, the Unicode text is used to find the profile. If the description string contains only ASCII text, the method tries to find a match. However, the AcroColor engine requires only Unicode descriptions to be unique, so this might return the wrong profile is in some rare cases. Use ASCII-only description strings only when Unicode description string are unavailable.
ACProfileListCount — Gets the number of profiles in a device color profile list.
ACProfileListItemCode — Gets the profile code of a specified profile in a profile list.
ACProfileListItemDescription — Returns the description string of a specified profile in a list. The returned description string always contains both ASCII and Unicode data, even if the profile itself only contains an ASCII version. You can store only the Unicode data in settings files if you wish; the ACProfileFromDescription() method finds the correct profile when passed the Unicode-only string.
ACProfileSize — Gets the size in bytes of the raw ICC profile data in a device profile.
ACProfilesMatch — Compares the working device profile with the document device profile to determine if they are the same. This comparison ignores rendering intents, and is fuzzy, allowing very close, but not exactly the same, profiles to match. Equivalent profiles always match, but some non-equivalent profiles may also match.
ACPushExceptionFrame
AcquirePage — The PDPage object is released. It then acquires a new PDPage pointer using PDDocAcquirePage(). Modules using this class should never call PDDocAcquirePage() directly.
ACRestoreEnvironProc
Acrobat_Color — AcroColor is an HFT that allows you to access the AcroColor engine (ACE), which controls color profile management for Adobe Acrobat. Plug-ins can import the AcroColor HFT to use the color management methods.
AcroColorHFT_LATEST_VERSION
AcroColorHFT_VERSION_10
AcroColorHFT_VERSION_11
AcroColorHFT_VERSION_12
AcroColorHFT_VERSION_13
AcroColorHFT_VERSION_6
AcroColorHFT_VERSION_7
AcroColorHFT_VERSION_8
AcroColorHFT_VERSION_9
AcroColorHFTNAME
AcroColorNUMSELECTORS
ACROjmp_buf
ACROjmp_buf
ACROjmp_buf
ACROlongjmp
ACROlongjmp
ACROlongjmp
ACROsetjmp
ACROsetjmp
ACROsetjmp
AcroViewError
AcroViewErrors
ACSetBlackPointCompensation — 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).
ACSetEngine — Sets the AcroColor engine (ACE) for the system, changing the global default CMS/CMM choice.
ACStringASCII — Copies the ASCII version of a string into a supplied buffer. Either the buffer or the count can be NULL.
ACStringLocalized — Copies the localized Unicode version of a string into a supplied buffer. Either the buffer or the count can be NULL.
ACStringUnicode — Copies the Unicode version of a string into a supplied buffer. Either the buffer or the count can be NULL.
ACUnReferencePresetList — Decrements the reference count of a preset list object. If this causes the object's reference count to reach zero, the method deletes it.
ACUnReferenceProfile — Decrements the reference count of a device color profile object. If this causes the object's reference count to reach zero, the method deletes it.
ACUnReferenceProfileList — Decrements the reference count of a device color profile list object. If this causes the object's reference count to reach zero, the method deletes it.
ACUnReferenceSettings — Decrements the reference count of an AcroColor engine settings object. If this causes the object's reference count to reach zero, the method deletes it.
ACUnReferenceString — Decrements the reference count of a string object. If this causes the object's reference count to reach zero, the method deletes it.
ACUnReferenceTransform — Decrements the reference count of a color transformation object. If this causes the object's reference count to reach zero, the method deletes it.
ACWorkingSpace — Constants that specify the color space of working profiles. This enumeration is added for the purpose of ACGetWorkingSpaceProfile(). The profile returned by this function must be unreferenced by the caller.
AdobePDFVersion
AFHorizontalAlign
AFVerticalAlign
ALDImageColorType — OPI 1.3 color type information.
ALDImageColorType_Intrinsic
ALDImageColorType_Process
ALDImageColorType_Separation
ALDImageColorType_Spot
anoncathft25
anonConsHFT27
anonWLHFT31
AS_UNUSED_PARAM
AS_UNUSED_VAR
ASArraySize — An array size value for use in callback procedures.
ASAtom — ASAtom objects are hashed tokens that Acrobat uses in place of strings to optimize performance (it is much faster to compare ASAtom objects than strings). ASAtom methods convert between strings and ASAtom objects.
ASAtom
ASAtomExistsForString — Tests whether an ASAtom exists for the specified string.
ASAtomFromString — Gets the ASAtom for the specified string. You can also use this method to create an ASAtom, since it creates one for the string if one does not already exist.
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).
ASAtomGetString — Gets the string associated with the specified ASAtom.
ASAtomNull
ASBool — ASBool
ASBoolToBool
ASByte
ASByteCount — A byte count value for use in ASProcStmRdExHandler and ASFileSysItemProps.
ASCab — ASCab objects (cabinets) can be used to store arbitrary key-value pairs. The keys are always NULL-terminated strings containing only low-ASCII alphanumeric characters.
ASCab — ASCab objects (cabinets) can be used to store arbitrary key/value pairs. The keys are always NULL-terminated strings containing only low ASCII alphanumeric characters and spaces (ASCII character 32). Key names cannot begin or end with a space.
ASCabCopy — For each key/value pair in srcCab a copy of the key/value pair will be placed into dstCab, possibly overwriting any identically named key/value pair in dstCab. If the value being copied is a pointer with an associated destroyProc, the pointer and its type string, but not the data it points to, will be copied and an internal reference count will be incremented.
ASCabDestroy — Destroys the cabinet and all its key/value pairs. This method raises an exception if the cabinet is the value for some key in another cabinet.
ASCabDestroyEmpties — Finds any empty cabinets in theCab, removes their corresponding keys, and destroys them.
ASCabDetachBinary — Retrieves the binary object stored under theKey in theCab and removes the key from theCab.
ASCabDetachCab — Retrieves the ASCab stored under theKey in theCab and removes the key from theCab.
ASCabDetachPathName — Retrieves the ASPathName stored under theKey in theCab and removes the key from theCab.
ASCabDetachPointer
ASCabDetachPointerRaw — Retrieves the pointer stored under theKey in theCab and removes the key from theCab. If noRefs is set to true, the client assumes ownership of the data referenced by the pointer and is responsible for deallocating any resources associated with it.
ASCabDetachString — Retrieves the string stored under theKey in theCab and removes the key from theCab.
ASCabDetachText — Retrieves the ASText object stored under theKey in theCab and removes the key from theCab.
ASCabDup — Creates a new ASCab and populates it with copies of the key/value pairs in srcCab. It is equivalent to ASCabCopy( srcCab, ASCabNew () ).
ASCabEntryRec
ASCabEnum — Enumerates all the keys in the cabinet.
ASCabEnumProc — Used when enumerating the values inside a cabinet.
ASCabEqual — Compares two cabinets and verifies that they have a matching set of keys and that all key values are equal as reported by ASCabValueEqual().
ASCabFromEntryList — Builds a cabinet based on a constant array of ASCabDescriptor records (see ASCabEntryRec). The first entry in each descriptor specifies the name of the key; subsequent fields contain the value. The entry list must end with a descriptor containing NULL for the key name. See ASExtraExpT.h for more info.
ASCabGetAtom — Returns the ASAtom value stored under theKey in theCab.
ASCabGetBinary — Returns the binary object stored under theKey in theCab.
ASCabGetBinaryCopy — Returns a copy of the binary object stored under theKey in theCab.
ASCabGetBool — Returns the ASBool value stored under theKey in theCab.
ASCabGetCab — Returns the ASCab stored under theKey in theCab.
ASCabGetDouble — Returns the double value stored under theKey in theCab. If the value stored under theKey is of type kASValueInteger, this value will be cast to a double and returned to the client.
ASCabGetInt — Returns the ASInt32 value stored under theKey in theCab.
ASCabGetInt64 — Returns the ASInt64 value stored under theKey in theCab.
ASCabGetPathNameCopy — Returns a copy of ASPathName stored under theKey in theCab.
ASCabGetPointer
ASCabGetPointerDestroyProc — Obtains the resource deallocation callback associated with the pointer stored under theKey in theCab. When the reference count of the pointer falls to zero, the callback is called to free the resources associated with the object it references.
ASCabGetPointerRaw — Returns the pointer value stored under theKey in theCab.
ASCabGetPointerType — Returns a string representation of the data type referenced by the pointer stored under theKey in theCab.
ASCabGetString — Returns the string stored under theKey in theCab.
ASCabGetStringCopy — Returns a copy of the string stored under theKey in theCab.
ASCabGetText — Returns the ASText object stored under theKey in theCab.
ASCabGetType — Returns the type of value stored under theKey in theCab.
ASCabGetUns — Returns the ASUns32 value stored under theKey in theCab.
ASCabGetUns64 — Returns the ASUns64 value stored under theKey in theCab.
ASCabKnown — Returns true if theKey is present in theCab.
ASCabMakeEmpty — Removes all keys from theCab and destroys all values they point to.
ASCabMunge — Munges the keys and the corresponding values in theCab based on the keys in keyCab and the munge action. Note that keyCab is never altered, but theCab is.
ASCabMungeAction — A value that determines the actions to be taken when ASCabMunge() is called. keyCab is the ASCab that provides the keys determining how theCab is to be changed. During an ASCabMunge() operation, the key cab will not be altered.
ASCabNew — Creates a new, empty cabinet.
ASCabNumEntries — Returns the number of key/value pairs in theCab.
ASCabPointerDestroyProc — A deallocation callback that can be associated with a pointer in an ASCab. When the reference count of the pointer falls to zero, this callback is called to free the resources associated with the object the pointer references.
ASCabPutAtom — Stores an ASAtom value in theCab under theKey.
ASCabPutBinary — Stores a binary object in theCab under theKey. The ASCab assumes ownership of the binary object, so the client should not attempt to free the memory associated with it. The binary object must have been allocated using ASmalloc().
ASCabPutBool — Stores an ASBool value in theCab under theKey.
ASCabPutCab — Stores an ASCab in theCab under theKey. If the cabinet is already a value for some other ASCab, ASCabPutCab() will raise an exception, since any cabinet can be contained by at most one other cabinet.
ASCabPutDouble — Stores a double value in theCab under theKey.
ASCabPutInt — Stores an ASInt32 value in theCab under theKey.
ASCabPutInt64 — Stores an ASInt64 value in theCab under theKey.
ASCabPutNull — Stores a value with a type of kASValueNull in theCab under theKey. NULL cabinet entries are used as placeholders or to removed other cabinet entries during an ASCabMunge operation.
ASCabPutPathName — Stores an ASPathName in theCab under theKey.
ASCabPutPointer
ASCabPutPointerRaw — Stores a pointer in theCab under theKey. See the ASCab description for more information.
ASCabPutString — Stores a string in theCab under theKey. A string consists of some number of bytes followed by a single NULL (zero) byte. The string must have been allocated using ASmalloc().
ASCabPutText — Stores an ASText object in theCab under theKey.
ASCabPutUns — Stores the ASUns32 value under theKey in theCab.
ASCabPutUns64 — Stores an ASUns64 value in theCab under theKey.
ASCabReadFromStream — Reads a previously written cabinet from a stream.
ASCabRemove — Removes theKey entry from theCab, destroying the associated value.
ASCabRename — Renames a key within theCab while preserving the value associated with it. If there is already a key equal to newKeyName in theCab, its value will be destroyed and replaced with the value of oldKeyName.
ASCabValueEqual — Compares two cabinet values and returns true only if they are equal (meaning that they have the same type and value). Cabinets are compared using ASCabEqual(). ASText values are compared by using ASTextCmp() and testing for a return value of 0 (zero). Strings and binary values must have the same lengths and byte-for-byte contents. Booleans, atoms, doubles, and integers must have equal values. Pointer values must point to the same location in memory but may have different destroyProcs and type strings.
ASCabValueType — ASCabinet objects can be used to store arbitrary key/value pairs. The keys are always NULL-terminated strings containing only low ASCII alphanumeric characters. The various types of values are enumerated here.
ASCabWriteToStream — Writes theCab out to a stream. The caller retains ownership of the cabinet. The stream will not be closed or flushed.
ASCalendarTimeSpan
ASCalendarTimeSpanAddWithBase — Adds two calendar time spans, storing the result in another calendar time span object. Because the values in a calendar time span are not absolute (for example, a leap year has a different number of days), they are resolved with respect to the base date before the addition is done. The result is broken down into years, months, and so on, in the highest denomination possible. For example, a difference of 13 months is reported as 1 year and 1 month.
ASCalendarTimeSpanCompare — Compares two calendar time spans with respect to a base date. Because the values in a calendar time span are not absolute (for example, a leap year has a different number of days), they are resolved with respect to the base date before the comparison is made.
ASCalendarTimeSpanDiff — Calculates the difference between calendar time span objects and stores the result in the provided ASCalendarTimeSpan object. If timeSpan2 is less than timeSpan1, the result is negative. Because the values in a calendar time span are not absolute (for example, a leap year has a different number of days), they are resolved with respect to the base date before the addition is done. The result is broken down into years, months, and so on, in the highest denomination possible. For example, a difference of 13 months is reported as 1 year and 1 month.
ASCalendarTimeSpanRec
ASCallback — Callbacks allow Acrobat to call functions in a plug-in. The core API provides macros to create and destroy callbacks. These include ASCallbackCreateProto(), ASCallbackCreateReplacement(), and ASCallbackCreateNotification() (defined in PICommon.h), and ASCallbackDestroy(). These macros (which eventually call the macro ASCallbackCreate()) allow compilers to perform type checking, eliminating an extremely common source of bugs. It is sometimes necessary for a plug-in to call ASCallbackCreate() directly; for example, when it is passing function pointers without typedefs to Mac OS toolbox routines.
ASCallback
ASCallbackCreate
ASCallbackCreate — Deprecated as of Acrobat 8.0.
ASCallbackCreateProto
ASCallbackDestroy
ASCallbackDestroy — Deprecated as of Acrobat 8.0.
ASCallsHFT_LATEST_VERSION
ASCallsHFT_VERSION_10
ASCallsHFT_VERSION_2
ASCallsHFT_VERSION_2_2
ASCallsHFT_VERSION_4
ASCallsHFT_VERSION_5
ASCallsHFT_VERSION_6
ASCallsHFT_VERSION_7
ASCallsHFT_VERSION_8
ASCallsHFT_VERSION_9
ASCancelProc — This callback replaces CancelProc().
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*.
ASConstCab
ASConstCabEnum — Enumerates all the keys in the constant cabinet.
ASConstCabEnumProc — Used when enumerating the values inside a constant cabinet. The callback procedure must not add, delete, or modify items in theCab during the enumeration.
ASConstText — An opaque object holding constant encoded text.
ASCoord — A coordinate for a point in device space, for use in mouse click callbacks. Values are conditionally compiled as 16-bit or 32-bit integers, depending on the Acrobat version.
ASCount — A numeric count value.
ASCountryCode
ASCryptStm — An ASStm object cover used for a cryptographic filter's stream callbacks.
ASCRYPTSTM_EOF
ASCryptStmFCloseProc — A callback for ASCryptStm. This closes a security stream.
ASCryptStmFFlushProc — A callback for ASCryptStm. This flushes a dirty buffer if necessary.
ASCryptStmFilBufProc — A callback for ASCryptStm. This is called by getc when the buffer is empty. It is called only during decryption (when reading from the stream, not when writing).
ASCryptStmFlsBufProc — A callback for ASCryptStm. This is called by putc when the buffer is full. It is called only during encryption (when writing to the stream, not when reading).
ASCryptStmFPutEOFProc — A callback for ASCryptStm. This puts an end-of-file (EOF) marker to a security stream.
ASCryptStmFResetProc — A callback for ASCryptStm. This resets a security stream, discarding any buffered data. It is called only during encryption (when writing to the stream, not when reading).
ASCryptStmModeEOF
ASCryptStmModeError
ASCryptStmModeRead
ASCryptStmModeWrite
ASCryptStmProcs — Callback procs for ASCryptStm
ASCryptStmRec
ASCryptStmUnGetcProc — A callback for ASCryptStm. It goes back one character in the input stream, undoing a character get operation. It is called only during decryption (when reading from the stream, not when writing).
ASCStringToFixed — Converts a CString to a fixed point number. It processes the string from left to right only until the first invalid character is located (for example, a-z, A-Z).
ASDate — Date objects represent a particular date and time. All date objects are guaranteed to give accurate representation of UTC time (not adjusted for leap seconds, as the addition of leap seconds to the international calendar does not happen according to a well-defined rule).
ASDate — An opaque object holding information for a particular date and time. All ASDate objects are guaranteed to give accurate representation of UTC time, unadjusted for leap seconds. This is due to the fact that the introduction of leap seconds to the international calendar does not happen according to a well-defined rule.
ASDateAddCalendarTimeSpan — Adds a calendar time span to a date. It modifies the date by the length of time provided in the ASCalendarTimeSpan object.
ASDateAddTimeSpan — Adds a time span (an exact number of seconds) to a date. It modifies the date by the length of time provided in the ASTimeSpan object.
ASDateCalendarDiff — Calculates the difference between two ASDate objects and stores the result in the provided ASCalendarTimeSpan object. The result is broken down into years, months, and so on, in the highest denomination possible. For example, a difference of 13 months is reported as 1 year and 1 month.
ASDateClear — Reinitializes a date object to the newly-allocated state, as returned by ASDateNew().
ASDateCompare — Tests whether one date is earlier or later than another.
ASDateCopy — Copies date and time data from one date object to another.
ASDateDestroy — Releases and destroys a date object.
ASDateDup — Creates a new date object containing the same data as an existing date object.
ASDateExactDiff — Calculates the exact difference in seconds between two date objects and stores the result in the provided ASTimeSpan object. If date1 is earlier than date2, the result is negative.
ASDateGetLocalTime — Creates a time record that represents the local time represented by the date object. The resulting local time might not account for daylight savings time correctly if the date object has been modified by adding or substracting a time span or calendar time span. It raises an exception if there is not enough memory.
ASDateGetTimeString — Creates a time string from a date object according to a specified format. If time zone information is available in the date object, the string contains the local time along with the time zone adjustment, if that is supported by the requested format. It raises an exception if there is not enough memory.
ASDateGetUTCTime — Creates a time record that represents the UTC time represented by the date object. It raises an exception if there is not enough memory.
ASDateNew — Creates a date object. The newly allocated object reflects the epoch time: Jan 1 1970 00:00:00 UTC.
ASDateSetLocalTimeOffset — Sets a date object's local time offset according to the operating system's current time zone information. Different operating systems handle daylight savings differently. This method causes the date object to always use the same daylight savings time offset that the operating system is currently using, even if the date object is modified.
ASDateSetTimeFromRec — Initializes a date object from a time record. It raises an exception if the time structure represents an invalid time, such as January 32nd 1999 or Feb 29th 2001. It assumes that the parameters for the day and month in the time record are 1-based.
ASDateSetTimeFromString — Initializes a date object from a time string. It raises an exception if there is not enough memory, if the format is unrecognized, or if the time string is not formatted according to the supplied format.
ASDateSetToCurrentLocalTime — Sets a date object to the current local time, using the time zone information from the operating system.
ASDateSetToCurrentUTCTime — Sets a date object to the current UTC time with no time zone information.
ASDateSubtractCalendarTimeSpan — Subtracts a calendar time span from a date. It modifies the date by the length of time provided in the ASCalendarTimeSpan object.
ASDateSubtractTimeSpan — Subtracts a time span (an exact number of seconds) from a date. It modifies the date by the length of time provided in the ASTimeSpan object.
ASDateTimeFormat — A constant indicating a string format for representing a date and time.
ASDebug — For internal use only.
ASDiskSpace — Can only contain values up to 4 GB.
ASDiskSpace64
ASDouble — The ASDouble type is a 64-bit type representing a floating number
ASDoubleMatrix
ASDoubleMatrixConcat — Multiplies two matrices.
ASDoubleMatrixInvert — Inverts a matrix.
ASDoubleMatrixP
ASDoubleMatrixTransform — Transforms the point p through the matrix m, and puts the result in result. p and result can point to the same location.
ASDoubleMatrixTransformRect — Transforms a rectangle through a matrix.
ASDoubleP
ASDoublePoint
ASDoublePointP
ASDoubleRect
ASDoubleRectP
ASDuration
ASEnum16 — 2-byte enumeration with values from 0 to 32,767, used in data structures.
ASEnum16 — 2-byte enumeration with values from 0 to 32,767, used in data structures.
ASEnum8 — WIN_PLATFORM.
ASEnum8 — 1-byte enumeration with values from 0 to 127, used in data structures.
ASEnumExtensions — Enumerates all ASExtension objects (valid plug-ins).
ASErrorCode — An error code value for use in ASFile and ASFileSys methods and callbacks. Introduced in Acrobat 6.0.
ASErrSeverity
ASExtension — An ASExtension represents a specific plug-in. A unique ASExtension object is created for each plug-in when it is loaded. If the plug-in fails to initialize, the ASExtension remains, but is marked as dead. The ASEnumExtensions() method allows you to iterate over all plug-in objects.
ASExtension — An opaque pointer to an object that identifies a specific loaded plug-in. A unique ASExtension object is created for each plug-in when it is loaded. If the plug-in fails to initialize, the ASExtension remains but is marked as inactive.
ASExtensionEnumProc — Enumeration function for ASEnumExtensions().
ASExtensionGetFileName — Gets the file name of an ASExtension.
ASExtensionGetRegisteredName — Gets the registered name associated with a plug-in.
ASExtensionMgrGetHFT
ASExtensionMgrGetHFT — Gets the specified version of the Host Function Table (HFT) that has the specified name. If you want to get one of the Acrobat viewer's built-in HFTs, use the predefined global variables for the HFT Values instead of this method.
ASExtensionPhase — Called periodically during plug-in loading with the ASExtension currently being loaded, and a selector indicating what phase of loading is happening.
ASExtensionPhase_EXPORTING
ASExtensionPhase_IMPORTING
ASExtensionPhase_INITIALIZING
ASExtensionPhase_LOADING
ASExtensionPhase_UNLOADING
ASExtensionProgressProc — Called periodically during plug-in loading with the ASExtension currently being loaded.
ASExtensionReportErrorProc — Called during ASExtension initialization whenever an error occurs.
ASExtraHFT_LATEST_VERSION
ASExtraHFT_VERSION_5
ASExtraHFT_VERSION_6
ASExtraHFT_VERSION_7
ASExtraHFT_VERSION_9
ASExtraHFTName
ASFile — The ASFile interface encapsulates Acrobat's access to file services. It provides a common interface for Acrobat, applications, and plug-ins to access file system services on different platforms, and enables you to provide your own file storage implementations.
ASFile — An opaque representation of a particular open file. Each open file has a unique ASFile. The ASFile value has meaning only to the common ASFile implementation and bears no relationship to platform-specific file objects.
ASFILE_CREATE — Create the file if it does not exist.
ASFILE_ENCRYPT — File is to be encrypted when written to disk Encryption is with an instance specific key, so that the file is NOT readable if it is accidentally left when Acrobat exits (say, on a crash)
ASFILE_LOCAL — A hint indicating that a local copy of the file will be needed.
ASFILE_RANDOMACCESS — A hint indicating that the file will be primarily accessed randomly.
ASFILE_READ — Open the file for reading.
ASFILE_SERIAL — A hint indicating that the file will be primarily accessed sequentially.
ASFILE_TEMPORARY — A hint that file is for temporary usage. Disk backing store is deleted on close, writes are not flushed to disk on close. If possible the file will be kept in memory.
ASFILE_WRITE — Open the file for writing.
ASFileAcquirePathName — Gets the path name for a file and increments an internal reference count. It is the caller's responsibility to release the ASPathName when it is no longer needed by using ASFileSysReleasePath().
ASFileAttachmentCreatePathName — Creates an ASPathName corresponding to the specified file or folder in the collection.
ASFileAttachmentGetPDFileAttachment — Produces a PDFileAttachment corresponding to the ASFileSys and ASPathName. It raises an exception if the ASFileSys is is not the embedded files file system, or if the ASPathName or PDFileAttachment parameters are NULL.
ASFileAttachmentGetPDFolder — Produces a PDFolder corresponding to the ASFileSys and ASPathName. It raises an exception if the ASFileSys is is not the embedded files file system, or if the ASPathName or PDFolder parameters are NULL.
ASFileCanSetEOF — Checks if ASFileSetEOF() can be done for this file with a specified new file size.
ASFileClearOutstandingMReads — Clears all outstanding mreads for the given file.
ASFileClose — Closes the specified file. After a call to ASFileClose(), the file handle is no longer valid but may be reused as the result of a subsequent call to ASFileSysOpenFile().
ASFileCompletionProc — Called when an asynchronous read or write request has completed.
ASFileError
ASFileErrors
ASFileFlush — Flushes any buffered data to a file. This method may raise file system or platform-specific exceptions.
ASFileFromMDFile — Gets the ASFile associated with the specified ASMDFile and ASFileSys.
ASFileGetEOF — Gets the current size of a file. It calls ASFileSysGetEofProc(). This call returns an error if the file size is greater than 2 GB.
ASFileGetEOF64 — Gets the current size of a file.
ASFileGetFileSys — Gets the file system through which a file was opened.
ASFileGetFileSysByName — Gets the file system that was registered with the specified name.
ASFileGetMDFile — Given an ASFile, returns the fileSys and the ASMDFile identification in that fileSys. This call is needed for a file system in a plug-in to be able to call the inner routines in another file system.
ASFileGetOpenMode — Gets the file access mode(s) specified for the file when it was opened.
ASFileGetPos — Gets the current seek position in a file. This is the position at which the next read or write will begin. This call returns an error if the file position is greater than 2 GB.
ASFileGetPos64 — Gets the current seek position in a file. This is the position at which the next read or write will begin. This call will work with files over 2 GB in length.
ASFileGetURL — Returns the URL associated with file. It is the caller's responsibility to release the memory associated with the returned string using ASfree().
ASFileHardFlush — Causes a hard flush on a file, which means that the file is flushed to the physical destination. For example, if a WebDAV-based file is opened, ASFileFlush() only flushes changes to the local cached version of the file. This method would flush changes all the way to the WebDAV server.
ASFileHasOutstandingMReads — Determines whether there are any outstanding multi-byte range requests for a file. A document can have outstanding mreads if it was opened in a browser, Acrobat requested some byte ranges, and the byte ranges have not yet arrived.
ASFileIsSame — Performs a comparison between the file and path to determine if they represent the same file. This method will return false if the file was not opened through the fileSys file system.
ASFileMode — File access modes used to specify how a file can be used when it is open. Not all modes can be specified individually: ASFILE_CREATE can be used only in conjunction with ASFILE_READ or ASFILE_WRITE. In addition, it is acceptable to specify ASFILE_READ and ASFILE_WRITE together by OR-ing the two constants. ASFILE_SERIAL and ASFILE_LOCAL (present only in version 3.0 or later) are hints that help the Acrobat viewer optimize access to the file; they must be OR-ed with one or more of the other constants: Value Description ASFILE_READ Open the file for reading. ASFILE_WRITE Open the file for writing. ASFILE_CREATE Create the file if it does not exist. ASFILE_SERIAL A hint indicating that the file will be accessed sequentially. ASFILE_LOCAL A hint indicating that a local copy of the file will be needed.
ASFileMReadRequest — Initiates a byte range request for a given file, if the file is in the browser.
ASFileOffset — A file offset value for use in callback procedures.
ASFileOffset64
ASFileOpenWithVirtualEOF — ASFileOpenWithVirtualEOF attempts to create a second ASFile instance to a file that is already open. Both the current instance fN and the new instance must be read only. The new instance shall set a virtual end of file. This virtual EOF and no effect on the first instance or on the physical file. It only effect the ASFile calls where newFile is passed in has the file. Each instance maintains it's own file position marker. The original instance of the file should be close after all other instances have been closed. This routine does not raise, but returns an error code.
ASFilePos — A file position value for use in callback procedures. This value cannot exceed 2 GB.
ASFilePos64 — The absolute position within a file. This value can exceed 2 GB.
ASFilePushData — Sends data from a file system implementation to an ASFile. The data may be for a multi-read request call, or may be unsolicited.
ASFileRead — Reads data from a file, beginning at the current seek position.
ASFileRegisterFileSys — Allows an implementor to provide a file system for use by external clients. An external client can locate the file system using ASFileGetFileSysByName(). fileSys provides its name via the ASFileSysGetFileSysNameProc() callback. This method returns false if a file system with the same name is already registered.
ASFileReopen — Attempts to reopen a file using the specified read/write mode. On some platforms, this may result in the file being closed and then reopened, and some error conditions may render the file invalid.
ASFileSetEOF — Changes the size of a file. The new size may by larger or smaller than the original size. Since this method does not return any values, the status can be assessed by examining the error code in the HANDLER clause. This method may raise file system or platform-specific exceptions. This call only works when the desired file size is less than 2 GB.
ASFileSetEOF64 — Changes the size of a file. The new size may by larger or smaller than the original size. This method may raise file system or platform-specific exceptions. This call will work with files over 2 GB in length.
ASFileSetMode — Gets or sets the mode flags for a file. Pass 0 for modeValue and modeMask to simply get the current mode flags.
ASFileSetPos — Seeks to the specified position in a file. This is the position at which the next read or write will begin. This call only works when the desired file position is less than 2 GB.
ASFileSetPos64 — Seeks to the specified position in a file. This is the position at which the next read or write will begin. This call will work with files over 2 GB in length.
ASFileStatusFlags — Values returned by ASFileSysGetStatusProc().
ASFileStmRdOpen — Creates a read-only ASStm from a file. The stream supports seek operations.
ASFileStmWrOpen — Creates a writable ASStm from a file. The stream supports seek operations.
ASFileSys — An ASFileSys is a collection of functions that implement file system services, such as opening files, deleting files, reading data from a file, and writing data to a file. Each ASFileSys provides these services for one class of devices. Acrobat has a built-in ASFileSys that services the platform's native file system. Acrobat on Windows includes an additional ASFileSys that services the OLE2 IStorage/IStream interfaces. Plug-ins may create additional ASFileSys objects to service other file systems. For example, a plug-in could implement an ASFileSys to access PDF files stored in a document database or to access PDF files across a serial link.
ASFileSys — A data structure containing callbacks that implement a file system.
ASFileSysAcquireFileSysPath — Converts an ASPathName from one file system to another. It returns an ASPathName acquired through newFileSys that refers to an image (which may possibly be cached) of the file in oldfileSys. Use this call to get a local file that is an image of a remote file (in a URL file system, for example). This is needed by programs such as the QuickTime Movie Player, because they can only work from local file-system files. The returned ASPathName may be a reference to a cache, so the file should be treated as read-only.
ASFileSysAcquireFileSysPathProc — A callback for ASFileSysRec that is used for non-local file systems. It returns an ASPathName on the new ASFileSys that refers to an image (which may be cached) of the remote file. Because of the possibility of cache flushing, you must hold a copy of the remote file's ASPathName for the duration of use of the local file.
ASFileSysAcquireParent — Returns the parent folder of the file system object associated with pathName. The following rules apply in the default file systems:
ASFileSysAcquirePlatformPath — Returns a platform-specific file system representation of the specified path, according to the specified type, wrapped in an allocated ASPlatformPath object. It calls ASFileSysAcquirePlatformPathProc().
ASFileSysAcquirePlatformPathProc — A callback for ASFileSysRec that acquires a platform-specific file system representation of the specified path, according to the specified type, wrapped in an allocated ASPlatformPath object. Use the ASPlatformPath* calls to get the actual platform object.
ASFileSysAsyncAbortProc — A callback for ASFileSysRec that aborts all uncompleted asynchronous I/O requests for the specified file. This callback can be called at any time.
ASFileSysAsyncReadProc — A callback for ASFileSysRec that asynchronously reads the specified data, returning immediately after the request has been queued. The ASFileSys must call the ASIODoneProc() (if one was provided) when the specified data has been read.
ASFileSysAsyncWriteProc — A callback for ASFileSysRec that asynchronously writes the specified data, returning immediately after the request has been queued. The ASFileSys must call the ASIODoneProc() (if one was provided) when the specified data has been written.
ASFileSysCanPerformOpOnItem — Tests whether a given operation can be performed on a particular file. It calls the canPerformOpOnItem() procedure registered for the ASFileSysRec, which determines whether the operation is one of the file system-defined operation strings for which there is a handler.
ASFileSysCanPerformOpOnItemProc — A callback for ASFileSysRec that tests whether a specified operation can be performed on the file, which means that it tests whether a handler is defined for that operation in ASFileSysPerformOpOnItemProc.
ASFileSysCanSetEofProc — A callback for ASFileSysRec that determines whether ASFileSys can set the end of file marker (EOF) to a new offset for the specified file.
ASFileSysClearOutstandingMReadsProc — A callback for ASFileSysRec that is used to advise a file system that the previous range of bytes requested to read are not needed, so that it may drop the read requests. The file system can continue pushing the bytes if it cannot stop the reads.
ASFileSysCloseProc — A callback for ASFileSysRec. This callback is responsible for closing the specified file. It is called by ASFileClose().
ASFileSysConvertCabToItemProps — Converts a set of item properties from the ASCab format to the ASFileSysItemPropsRec format.
ASFileSysConvertItemPropsToCab — Converts a set of item properties from the ASFileSysItemPropsRec format to the ASCab format.
ASFileSysCopyPath
ASFileSysCopyPath — Generates and copies the specified ASPathName (but does not copy the file specified by the path name). The ASPathName must have been obtained through the specified file system. This method may be used regardless of whether the file specified by path name is open.
ASFileSysCopyPathNameProc — A callback for ASFileSysRec that copies a path name (not the underlying file). It is called by ASFileSysCopyPath().
ASFileSysCreateFolder — Creates an empty folder at the specified pathName.
ASFileSysCreateFolderProc — A callback for ASFileSysRec used to create an empty folder at the specified path.
ASFileSysCreatePathFromCFURLRef
ASFileSysCreatePathFromCString — Helper macro for the ASFileSysCreatePathName() method.
ASFileSysCreatePathFromDIPath — A helper macro for the ASFileSysCreatePathName() method.
ASFileSysCreatePathFromDIPathText
ASFileSysCreatePathFromFSRef
ASFileSysCreatePathFromFSRefWithCFStringRef
ASFileSysCreatePathFromFSSpec — Helper macro for the ASFileSysCreatePathName() method.
ASFileSysCreatePathFromPOSIXPath
ASFileSysCreatePathName — Creates an ASPathName based on the input type and pathSpec. Each fileSys implementation must publish the input types that it accepts.
ASFileSysCreatePathNameProc — A callback for ASFileSysRec that creates an ASPathName based on the input type and PDFileSpec. Each ASFileSys implementation must publish the input types that it accepts. For example, the Mac OS ASFileSys may accept the type FSSpecPtr, and the MS-DOS ASFileSys may only accept types of CString.
ASFileSysCreatePathWithFolderName — Helper macro for the ASFileSysCreatePathName() method.
ASFileSysCreatePathWithFolderNameWithASText
ASFileSysDestroyFolderIterator — Releases the resources associated with folderIter.
ASFileSysDestroyFolderIteratorProc — A callback for ASFileSysRec used to release the resources associated with folderIter.
ASFileSysDIPathFromPath — Converts a file name, specified as an ASPathName, to a device-independent path name. It is the caller's responsibility to free the memory associated with the returned string using ASfree().
ASFileSysDIPathFromPathEx — Converts a file name, specified as an ASPathName, to a device-independent path name, which is returned as an ASText object. It calls ASFileSysDIPathFromPathExProc().
ASFileSysDIPathFromPathExProc — A callback for ASFileSysRec that converts a path name to a device-independent path name, returned as an ASText object. It is called by ASFileSysDIPathFromPathEx().
ASFileSysDiPathFromPathProc — A callback for ASFileSysRec that converts a path name to a device- independent path name. It is called by ASFileSysDIPathFromPath().
ASFileSysDisplayASTextFromPath — Returns a user-friendly representation of a path as a text object. It calls ASFileSysDisplayASTextFromPathProc().
ASFileSysDisplayASTextFromPathProc — Places a representation that can be displayed to users of a path into displayText.
ASFileSysDisplayStringFromPath — Returns a user-friendly representation of a path. It is the caller's responsibility to release the memory associated with the returned string using ASfree().
ASFileSysDisplayStringFromPathProc — A callback for ASFileSysRec used to obtain a representation of a path that can be displayed by the user.
ASFileSysDisposePathNameProc — A callback for ASFileSysRec that is called by ASFileSysReleasePath().
ASFileSysFirstFolderItem — Creates an iterator which can be used to enumerate all objects inside the specified folder, and returns the properties of the first item found in the folder. The iteration can be continued by passing the returned ASFolderIterator to ASFileSysNextFolderItem.
ASFileSysFirstFolderItemProc — A callback for ASFileSysRec that begins the process of iterating through the contents of a folder.
ASFileSysFlushProc — A callback for ASFileSysRec that flushes data for the specified file. It is called by ASFileFlush().
ASFileSysFlushVolume — Flushes the volume on which the specified file resides. This ensures that any data written to the system for the volume containing pathName is flushed out to the physical volume (equivalent to Mac OS FlushVol or to the UNIX sync).
ASFileSysFlushVolumeProc — A callback for ASFileSysRec that flushes the volume on which the specified file resides. This ensures that any data written to the system for the volume containing pathName is flushed out to the physical volume (equivalent to the Mac OS FlushVol, or to the UNIX sync). Call this after you are finished writing a complete transaction to force a commit.
ASFileSysGetDefaultTempPath — Gets the default temporary path that was set by ASFileSysSetDefaultTempPath().
ASFileSysGetEof64Proc — A callback for ASFileSysRec that gets a file's current logical size. It is called by ASFileGetEOF() and is capable of handling file sizes over 2 GB.
ASFileSysGetEofProc — A callback for ASFileSysRec that gets a file's current logical size. It is called by ASFileGetEOF(), and is not capable of handling file sizes over 2 GB.
ASFileSysGetFileFlags — A callback for ASFileSysRec that gets the flags for the specified file.
ASFileSysGetFilePositionLimitProc — A callback for ASFileSysRec that returns the maximum file position that can be processed by this file system. This is not the maximum size file that can be created, but the maximum file position that can be handled by the arithmetic in the file system implementation. This will typically be (2 ^ 31) - 1 or (2 ^ 63) - 1. If this entry is not present, a value of (2 ^ 31) - 1 should be assumed.
ASFileSysGetFilePosLimit — Returns the maximum file position that can be processed by this file system. This is not the maximum size file that can be created or the amount of room left in the file system, but the maximum file position that can be handled by the arithmetic in the file system implementation. This will typically be (2 ^ 31) - 1 or (2 ^ 63) - 1.
ASFileSysGetFileSysNameProc — A callback for ASFileSysRec that gets this file system's name.
ASFileSysGetItemProps — Populates an ASFileSysItemProps record with a full description of the file system object associated with pathName. It calls ASFileSysGetItemPropsProc().
ASFileSysGetItemPropsAsCab — Gets a full description of the file system object associated with pathName, returning the item properties in the ASCab format. Calls ASFileSysGetItemPropsAsCabProc().
ASFileSysGetItemPropsAsCabProc — A callback for ASFileSysRec that gets a full description of the file system object associated with pathName, returning the item properties in the ASCab format.
ASFileSysGetItemPropsProc — A callback for ASFileSysRec used to retrieve a full description of the file system object associated with the path.
ASFileSysGetNameAsASTextProc — A callback for ASFileSysRec that gets the file name for the specified ASPathName as an ASText object.
ASFileSysGetNameForDisplayProc — A callback for ASFileSysRec that gets the Windows Explorer/Mac Finder representation for the specified ASPathName as an ASText object. This may be a localized and extension-stripped version of the filename.
ASFileSysGetNameFromPath — Extracts the file name (including extension) from the path.
ASFileSysGetNameFromPathAsASText — Extracts the file name (including the extension) from the path as an ASText object. This method supersedes ASFileSysGetNameFromPath() in Acrobat 6.0 and later.
ASFileSysGetNameFromPathForDisplay — This method writes into nameForDisplay the representation of that item as it would be shown in Windows Explorer or Mac OS Finder. For example, it will provide the localized string for "My Documents" even though, on disk, "My Documents" is always in English. It will also strip the extension if that is what Windows Explorer or the Mac Finder would do for that file.
ASFileSysGetNameProc — A callback for ASFileSysRec that returns a character string containing the file name for the specified ASPathName. The character string contains only the file name; it is not a complete path name.
ASFileSysGetParentProc — A callback for ASFileSysRec used to obtain the parent of the input path.
ASFileSysGetPlatformThing — Deprecated API: always returns NULL.
ASFileSysGetPlatformThingProc — Returns a platform file system representation of the ASPathName passed according to the atom selector. It allocates memory for the returned structure, which the caller must release with ASfree().
ASFileSysGetPos64Proc — A callback that gets the current position for the specified file. It is called by ASFileGetPos(), and is capable of handling file postions over 2 GB.
ASFileSysGetPosProc — A callback for ASFileSysRec that gets the current position for the specified file. It is called by ASFileGetPos(), and is not capable of handling file positions over 2 GB.
ASFileSysGetStatusProc — A callback for ASFileSysRec that gets the status of the specified file. This callback is used for asynchronous I/O. For example, it can indicate that an underlying file connection has been closed.
ASFileSysGetStorageFreeSpace — Gets the amount of free space on the volume containing pathName.
ASFileSysGetStorageFreeSpace64 — Gets the amount of free space on the volume containing pathName. This is the same as ASFileSysGetStorageFreeSpace() without the 4 GB limit.
ASFileSysGetStorageFreeSpace64Proc — A callback for ASFileSysRec that gets the amount of free space on the volume containing the specified ASPathName. It is similar to ASFileSysGetStorageFreeSpace(), except that the return value is not limited to 4 GB (with a 64-bit return value).
ASFileSysGetStorageFreeSpaceProc — A callback for ASFileSysRec that gets the amount of free space on the volume containing the specified ASPathName.
ASFileSysGetTempPathName — Returns a unique path name suitable for use in creating temporary files. It is the caller's responsibility to release the returned object using ASFileSysReleasePath().
ASFileSysGetTempPathNameProc — A callback for ASFileSysRec that returns a unique path name suitable for use in creating temporary files.
ASFileSysGetTypeAndCreator — Gets the type and creator of the file specified by the path.
ASFileSysGetTypeAndCreatorProc — A callback for ASFileSysRec that gets the file type and creator for the file. This callback is currently only implemented on Mac OS. It does not raise an error.
ASFileSysHardFlushProc — Does a hard flush on the file. A hard flush makes sure the data is flushed even if the file is remote. This proc should succeed and do nothing if it is not supported.
ASFileSysIsInUseProc — A callback for ASFileSysRec that tests whether a file is in use by another process.
ASFileSysIsLocal — Returns true if fileSys is NULL, the default file system or the default Unicode file system.
ASFileSysIsSameFileProc — A callback for ASFileSysRec that tests whether two files are the same.
ASFileSysItemProps
ASFileSysItemPropsRec
ASFileSysItemType — An enumerated data type used to categorize an object associated with an ASPathName.
ASFileSysMReadRequestProc — A callback for ASFileSysRec that queues asynchronous requests for one or more byte ranges that the caller (usually the Acrobat viewer or library) will need in the near future. This callback is important for slow file systems, such as the web, to improve overall performance. It allows the file system to begin retrieving bytes before they are actually needed, while the Acrobat software continues processing as much as it can with the data that has already been downloaded.
ASFileSysNextFolderItem — Continues the iteration process associated with the ASFolderIterator object.
ASFileSysNextFolderItemProc — A callback for ASFileSysRec used to continue the iteration process associated with the ASFolderIterator object. Both itemPath and props are optional and can be NULL if the caller is not interested in that information.
ASFileSysOpen64Proc — A callback for ASFileSysRec that opens the specified file. It is called by ASFileSysOpen64(). This callback must be used if the file is over 2 GB in length.
ASFileSysOpenFile — Attempts to open a file in the specified file system, in the specified read/write/create mode. If the file is already open, the existing file handle is returned. The caller retains ownership of pathName.
ASFileSysOpenFile64 — Attempts to open a file in the specified file system, in the specified read/write/create mode. If the file is already open, the existing file handle is returned. The caller retains ownership of pathName.
ASFileSysOpenProc — A callback for ASFileSysRec that opens the specified file. It is called by ASFileSysOpenFile() and ASFileReopen(). This callback returns an error if the file is over 2 GB in length.
ASFileSysPathFromDIPath — Converts a device-independent path name to an ASPathName. This method can only be used for files that already exist (that is, it cannot be used to create a placeholder path name for files that a plug-in intends to create in the future).
ASFileSysPathFromDIPathEx — Converts a device-independent path name in an ASText object to an ASPathName. This method can only be used for files that already exist (that is, it cannot be used to create a placeholder path name for files that a plug-in intends to create in the future).
ASFileSysPathFromDIPathExProc — A callback for ASFileSysRec that converts a device-independent path name from an ASText object to an ASPathName. It is called by ASFileSysPathFromDIPathEx().
ASFileSysPathFromDIPathProc — A callback for ASFileSysRec that converts a device-independent path name to an ASPathName. It is called by ASFileSysPathFromDIPath().
ASFileSysPerformOpOnItem — Performs a specified operation on a particular file, passing specified parameters. It calls the performOpOnItem() procedure registered for the ASFileSysRec.
ASFileSysPerformOpOnItemProc — A callback for ASFileSysRec that performs the specified operation on a particular file.
ASFileSysRangeArrivedProc — A callback for ASFileSysRec used when a byte range has arrived during a file load operation.
ASFileSysReadProc — A callback for ASFileSysRec that reads data from the specified file. It is called by ASFileRead() and returns an error if the file size is over 2 GB.
ASFileSysRec
ASFileSysReleasePath
ASFileSysReleasePath — Decrements the internal reference count for the path name and disposes of the path name (but not the file itself) if the reference count is zero. This does not result in any file-level operations, and is unaffected by whether there is an open file for this path name.
ASFileSysReleasePlatformPath — Releases the specified platform path object. Each call to ASFileSysAcquirePlatformPath() should have a corresponding call to this method.
ASFileSysReleasePlatformPathProc — A callback for ASFileSysRec that releases the specified platform path object when the client is done with it.
ASFileSysRemoveFile
ASFileSysRemoveFile — Attempts to delete the file referred to by pathName.
ASFileSysRemoveFolder — Deletes the folder at the specified pathName only if it is empty.
ASFileSysRemoveFolderProc — A callback for ASFileSysRec used to delete the folder at the specified path.
ASFileSysRemoveProc — A callback for ASFileSysRec that deletes a file. It is called by ASFileSysRemoveFile().
ASFileSysRenameProc — A callback for ASFileSysRec that renames a file. It is not called directly by any method in the client API, but is used internally by the Acrobat viewer.
ASFileSysReopenProc — A callback for ASFileSysRec that reopens a file in the specified mode. ASFileReopen() calls this method if it is present. If this method is not present, or if it returns NULL and error is 0, ASFileReopen() does a close followed by an open. If error is non-zero, ASFileReopen() ignores the return value and fails with that error.
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().
ASFileSysSetEof64Proc — A callback for ASFileSysRec that increases or decreases the logical size of a file. It is called by ASFileSetEOF() and is capable of handling file sizes over 2 GB.
ASFileSysSetEofProc — A callback for ASFileSysRec that increases or decreases the logical size of a file. It is called by ASFileSetEOF(). It returns an error if the current file position is over 2 GB.
ASFileSysSetModeProc — ASFileSysSetMode() sets and gets parameters for the specified file.
ASFileSysSetPos64Proc — A callback for ASFileSysRec that sets the current position in a file, which is the point from which data will next be read. It is called by ASFileSetPos() and is capable of handling file postions over 2 GB.
ASFileSysSetPosProc — A callback for ASFileSysRec that sets the current position in a file (the point from which data will next be read). It is called by ASFileSetPos().
ASFileSysSetTypeAndCreator — Sets the type and creator of a file. See Type/Creator Codes.
ASFileSysSetTypeAndCreatorProc — A callback for ASFileSysRec that sets the file type and creator for the file. This callback is currently only implemented on Mac OS. It does not raise an error.
ASFileSysURLFromPath — Returns the URL corresponding to pathName. It is the caller's responsibility to free the memory associated with the returned string using ASfree().
ASFileSysURLFromPathProc — A callback for ASFileSysRec used to obtain the URL associated with the given ASPathName.
ASFileSysWriteProc — A callback for ASFileSysRec that writes data to the specified file.
ASFileSysYieldProc — A callback for ASFileSysRec that yields the asynchronous I/O requests for the specified file. This allows other processes to process events that may be required for a file read to complete. An ASFileSys should implement a yield mechanism to complement asynchronous read and write requests.
ASFileUnregisterFileSys — Allows a fileSys to be unregistered. In general, a fileSys is only unregistered by the extension that registered it.
ASFileWrite — Writes data to a file, beginning at the current seek position.
ASFixed — The ASFixed type is a 32-bit quantity representing a rational number with the high (low on little-endian machines) 16 bits representing the number's mantissa and the low (high on little-endian machines) 16 bits representing the fractional part. The definition is platform-dependent.
ASFixedDiv — Divides two fixed numbers.
ASFixedMatrix
ASFixedMatrixConcat — Multiplies two matrices.
ASFixedMatrixInvert — Inverts a matrix.
ASFixedMatrixP
ASFixedMatrixTransform — Transforms the point p through the matrix m, and puts the result in result. p and result can point to the same location.
ASFixedMatrixTransformRect — Transforms a rectangle through a matrix.
ASFixedMul — Multiplies two fixed numbers.
ASFixedNegInf
ASFixedP
ASFixedPoint
ASFixedPointP
ASFixedPosInf
ASFixedQuad
ASFixedQuadP
ASFixedRect
ASFixedRectP
ASFixedRoundToInt16 — Converts a fixed point number to an ASInt16, rounding the result.
ASFixedRoundToInt32 — Converts a fixed point number to an ASInt32, rounding the result.
ASFixedToCString — Converts a fixed number to a CString.
ASFixedToFloat — Converts an ASFixed to a float.
ASFixedTruncToInt16 — Converts a fixed point number to an ASInt16, truncating the result.
ASFixedTruncToInt32 — Converts a fixed point number to an ASInt32, truncating the result.
ASFlagBits — A flag-bits value.
ASFolderIterator — An opaque object used to iterate through the contents of a folder. ASFileSysFirstFolderItem() returns the first item in the folder along with an ASFolderIterator object for iterating through the rest of the items in the folder. Call ASFileSysNextFolderItem() with this object to return the next object in the folder until the method returns false. To discard the ASFolderIterator object, call ASFileSysDestroyFolderIterator().
ASFourCharCode
ASFourCharCode
ASFract — Definition of ASFract.
ASfree — Frees the specified memory block.
ASGetConfiguration — Gets information about the Acrobat viewer application under which the plug-in is running. Use this method if your plug-in's functionality depends on the Acrobat viewer that is running.
ASGetDefaultFileSys — Gets the default standard file system implementation for a platform.
ASGetDefaultFileSysForPath — Gets the best file system implementation that supports the passed in path. If the path requires the Unicode file system then the default Unicode file system is returned, otherwise the default file system is returned.
ASGetDefaultUnicodeFileSys — Gets the file system implementation that supports Unicode file path names. If a platform does not have a file system that supports Unicode, then NULL will be returned.
ASGetErrorString — Gets a string describing the specified error/exception.
ASGetErrorStringASText — Gets an ASText object containing a string describing the specified exception.
ASGetExceptionErrorCode
ASGetRamFileSys — Gets the in-memory file system implementation for a platform.
ASGetSecs
ASGetSecs — Returns the number of seconds elapsed since midnight, January 1, 1970, coordinated universal time, up to the current time.
ASGetTempFileSys — Gets the temporary file system implementation for a platform.
ASHostEncoding — An integer specifying the host encoding for text. On Mac OS, it is a script code. On Windows, it is a CHARSET id. In UNIX, Acrobat currently only supports English, so the only valid ASHostEncoding is 0 (Roman). See ASScript.
ASHostMBLen — Determines whether the given byte is a lead byte of a multi-byte character, and how many tail bytes follow.
ASInt16 — 2-byte signed short numeric value.
ASInt16P
ASInt16ToFixed — Converts an ASInt16 to a fixed point number.
ASInt32 — 4-byte signed long numeric value.
ASInt32P
ASInt32ToFixed — Converts an ASInt32 to a fixed point number.
ASInt64 — 8-byte signed long numeric value.
ASInt8 — 1-byte signed char value.
ASInt8P
ASIntOrPtr
ASIODoneProc — A callback in ASIORequest used by the asynchronous read/write ASFileSys implementation and provided by the ASFile implementation to the ASFileSys. The ASFileSys must call this method when an asynchronous request is completed:
ASIORequest — A data structure representing an I/O request.
ASIORequestRec
ASIsValidUTF8 — Tests whether the bytes in the string conform to the Unicode UTF-8 encoding form. The method does not test whether the string is NULL-terminated.
ASKEY
ASKEY
ASKEY_ARROW_D — KeyCodeAllPlatforms
ASKEY_ARROW_L — KeyCodeAllPlatforms
ASKEY_ARROW_R — KeyCodeAllPlatforms
ASKEY_ARROW_U — KeyCodeAllPlatforms
ASKEY_BACKSPACE — KeyCodeMacintosh
ASKEY_BACKSPACE — KeyCodeUNIX
ASKEY_BACKSPACE — KeyCodeWindows
ASKEY_CLEAR — KeyCodeMacintosh
ASKEY_CLEAR — KeyCodeUNIX
ASKEY_CR — KeyCodeMacintosh
ASKEY_CR — KeyCodeUNIX
ASKEY_DEL — Deprecated. Please use ASKEY_RIGHT_DELETE or ASKEY_BACKSPACE.
ASKEY_DEL — Deprecated. Please use ASKEY_RIGHT_DELETE or ASKEY_BACKSPACE.
ASKEY_DEL — Deprecated. Use ASKEY_RIGHT_DELETE or ASKEY_BACKSPACE.
ASKEY_END — KeyCodeMacintosh
ASKEY_END — KeyCodeUNIX
ASKEY_END — KeyCodeWindows
ASKEY_ENTER — KeyCodeMacintosh
ASKEY_ENTER — KeyCodeUNIX
ASKEY_ENTER — KeyCodeWindows
ASKEY_ESCAPE — KeyCodeAllPlatforms
ASKEY_HELP — KeyCodeAllPlatforms
ASKEY_HOME — KeyCodeMacintosh
ASKEY_HOME — KeyCodeUNIX
ASKEY_HOME — KeyCodeWindows
ASKEY_INSERT — KeyCodeMacintosh
ASKEY_INSERT
ASKEY_INSERT — KeyCodeWindows
ASKEY_MENU
ASKEY_MENU — KeyCodeWindows
ASKEY_PAGE_D — KeyCodeAllPlatforms
ASKEY_PAGE_U — KeyCodeAllPlatforms
ASKEY_RIGHT_DELETE — KeyCodeMacintosh
ASKEY_RIGHT_DELETE — KeyCodeUNIX
ASKEY_RIGHT_DELETE — KeyCodeWindows
ASKEY_SPACE — KeyCodeAllPlatforms
ASKEY_TAB — KeyCodeAllPlatforms
ASKEYIsReturnOrEnter
ASKEYIsReturnOrEnter
ASLanguageCode
ASlFileMode
ASmalloc — Allocates and returns a pointer to a memory block containing the specified number of bytes.
ASMaskBits
ASMAXInt16
ASMAXInt32
ASMAXInt64
ASMAXInt8
ASMAXUns16
ASMAXUns32
ASMAXUns64
ASMAXUns8
ASMDFile — ASMDFile replaces MDFile. MDFile is an obsolete name for this data type for backward compatibility.
ASMemAllocProc
ASMemAvailProc
ASMemFreeProc
ASMemReallocProc
ASMemStmRdOpen — Creates a read-only ASStm from a memory-resident buffer. The stream supports seek operations.
ASMINInt16
ASMINInt32
ASMINInt64
ASMINInt8
ASMINUns16
ASMINUns32
ASMINUns64
ASMINUns8
ASPathFromPlatformPath — This method was deprecated in Acrobat 5.0. Use ASFileSysCreatePathName() instead.
ASPathName — ASFileAcquirePathName
ASPlatformPath — An opaque object used to retrieve a platform-specific path object. This object was added in Acrobat 6.0 to improve device-independent path referencing.
ASPlatformPath — An ASPlatformPath and associated platform path types. This is an opaque object used to retrieve a platform path object. ASFileSysAcquirePlatformPath() allocates and initializes this object. ASPlatformPath* calls are used to access its contents. To discard this object, call ASFileSysReleasePlatformPath().
ASPlatformPathGetCFURLRefRecPtr — Gets a platform path object in the form of a CFURLRef for the Mac OS, if the ASPlatformPath object was acquired with this type in the platformPathType parameter of ASFileSysAcquirePlatformPath().
ASPlatformPathGetCstringPtr — Gets a platform path object in the form of a C string for Windows or UNIX, if the ASPlatformPath object was acquired with this type in the platformPathType parameter of ASFileSysAcquirePlatformPath().
ASPlatformPathGetFSRefPtr — Gets a platform path object in the form of an FSRef for the Mac OS, if the ASPlatformPath object was acquired with this type in the platformPathType parameter of ASFileSysAcquirePlatformPath().
ASPlatformPathGetFSRefWithCFStringRefRecPtr — Gets a platform path object in the form of an FSRef and CFStringRef for Mac OS, if the ASPlatformPath object was acquired with this type in the platformPathType parameter of ASFileSysAcquirePlatformPath().
ASPlatformPathGetFSSpecPtr — This method was deprecated in Acrobat 9.0. Use ASPlatformPathGetFSRefPtr(), ASPlatformPathGetFSRefWithCFStringRefRecPtr(), ASPlatformPathGetCFURLRefRecPtr(), or ASPlatformPathGetPOSIXPathPtr() instead.
ASPlatformPathGetPOSIXPathPtr — Gets a platform path object in the form of a POSIX path C string, if the ASPlatformPath object was acquired with this type in the platformPathType parameter of ASFileSysAcquirePlatformPath().
ASProcStmDestroyProc — A callback for use by ASProcStmWrOpen() and ASProcStmRdOpenEx().
ASProcStmGetLength — A callback for use by ASProcStmRdOpenEx().
ASProcStmRdExHandler
ASProcStmRdExHandlerRec
ASProcStmRdOpen — Creates a read-only ASStm from an arbitrary data-producing procedure. The stream does not support seek operations.
ASProcStmRdOpenEx — Extends ASProcStmRdOpen() and creates a read-only ASStm from an arbitrary data-producing procedure. The stream optionally supports seek operations, although external clients do not have the ability to initiate a seek operation.
ASProcStmSeekProc — A callback for use by ASProcStmRdOpenEx().
ASProcStmWrOpen — Creates an ASStm from an arbitrary data-producing procedure. The stream does not support seek operations.
ASProgressMonitor
ASProgressMonitorRec
ASPurgeMemory — Attempts to free memory from the PDF Library caches.
ASRaise — Raises an exception. Plug-ins can raise any exception defined in the AcroErr.h header file using the ErrBuildCode macro, or can define their own exceptions using ASRegisterErrorString(). See Errors for a list of predefined exceptions.
ASRamFileSysSetLimitKB — Sets the temporary file system implementation for a platform.
ASReal — Definition of ASReal.
ASrealloc — If possible, extends the given block and simply returns ptr. Otherwise, it allocates a new block of newNBytes bytes, copies the contents from the old pointer into the new block, frees the old pointer, and returns the pointer to the new block. If a new block cannot be allocated, the call fails and ptr is not freed. Reallocating a block to a smaller size will never fail.
ASRealMatrix
ASRealPoint
ASRealRect
ASRegisterErrorString — Registers a new error and string. The error can be used to raise a plug-in-specific exception using ASRaise(). When the exception is raised, its error string can be retrieved using ASGetErrorString() and reported to the user using AVAlertNote().
ASRegisterErrorStringASText — Registers a new error and string.
ASReportProc — A report proc can be used to report errors, warnings, and other messages to the user. Normally a report proc will use a dialog to notify the user of an error, but in some contexts (such as during batch processing) it may either log the error or warning to a file or ignore it.
ASReportType — Used in an ASReportProc to indicate what kind of information is being reported.
ASScript — An enumeration of writing scripts. Not all of these scripts are supported on all platforms.
ASScriptFromHostEncoding — Converts from a host encoding type to an ASScript value. On Windows, the host encoding is a CHARSET id. On Mac OS, the host encoding is a script code.
ASScriptToHostEncoding — Converts from an ASScript code to a host encoding type. On Windows, the host encoding is a CHARSET id. On Mac OS, the host encoding is a script code.
ASSetTempFileSys — Sets the temporary file system implementation for a platform.
AssignAndTakeOwnership — The old PDPage pointer contained within is released. It then takes ownership of the PDPage pointer passed in as parameter. The method does not increase the reference count of the passed in PDPage object. This method is used in scenarios where the Smart pointer needs to be constructed before the page object becomes available. It is also used with APIs like PDPageAcquireFromCosPage() that have already increased the reference count for the PDPage object but are not encapsulated by the class methods.
AssignPage — Wrapper for PDPageAcquirePage(). This API assumes that there is no PDPage object.
AssignPage — Wrapper for PDDocAcquirePage(). This API assumes that there is no PDPage object.
ASSize_t
ASSmallBufferSize — May not be larger than int16.
ASSmallCount — A signed int value. Negative values are never used.
ASStatusMonitorProcs
ASStatusMonitorProcsRec
ASStm — An ASStm is a data stream that may be a buffer in memory, a file, or an arbitrary user-written procedure. You typically would use an ASStm to extract data from a PDF file. When writing or extracting data streams, the ASStm must be connected to a Cos stream. ASStm methods allow you to open and close streams, and to read and write data.
ASStm
ASStmClose — Closes the specified stream.
ASStmFlush — Flushes any buffered data to the specified stream.
ASStmProc — A callback for use by ASProcStmRdOpenEx() and ASProcStmWrOpen(). This should place data in the buffer specified by the parameter data.
ASStmRead — Reads data from stm into memory.
ASStmRec — A stream object definition (see ASStream.h). It is a data stream that may be a buffer in memory, a file, or an arbitrary user-written procedure. It is typically used to extract data from a PDF file. When writing or extracting data streams, the ASStm must be connected to a Cos stream.
ASStmWrite — Writes data from a memory buffer into an ASStm.
ASTArraySize — A numeric array size value for use in AS and Cos-level I/O methods and data structures.
ASTCount — A numeric count value for use in stream methods.
ASText — An ASText object holds encoded text.
ASText — An opaque object holding encoded text.
ASTextCaseSensitiveCmp — Compares two ASConstText objects, ignoring language and country information. The comparison is case-sensitive.
ASTextCat — Concatenates the from text to the end of the to text, altering to but not from. It does not change the language or country of to unless it has no language or country, in which case it acquires the language and country of from.
ASTextCatMany — Concatenates a series of ASText objects to the end of the to object. Be sure to provide NULL as the last argument to the call.
ASTextCmp — Compares two ASText objects. This routine can be used to sort text objects using the default collating rules of the underlying operating system before presenting them to the user. The comparison is case-sensitive. The results are suitable for displaying a sorted list of strings to the user in his chosen language and according to the rules of the platform on which the application is running. The results can vary based on the platform and user locale. If you want to compare strings in a way that is consistent across locales and platforms (but not suitable for displaying sorted strings to a user) see ASTextCaseSensitiveCmp().
ASTextCopy — Copies the text in from to to, along with the country and language.
ASTextDestroy — Frees all memory associated with the text object.
ASTextDup — Creates a new ASText object that contains the same text/country/language as the one passed in.
ASTextEqual
ASTextEval — Replaces percent-quoted expressions in the text object with the result of their evaluation, using key/value pairs in the ASCab. For example, for a text value containing the string "%keyone%%keytwo%", the value is replaced with the concatenation of the values of the keys keyone and keytwo in the ASCab passed in.
ASTextEvalProc
ASTextFilter — Runs the specified filter on a text object, modifying the text as specified.
ASTextFilterType — Constants that specify filter types used to modify text objects.
ASTextFromEncoded — Creates a new text object from a NULL-terminated multi-byte string in the specified host encoding.
ASTextFromInt32 — Creates a new string from an ASInt32 by converting the number to its decimal representation without punctuation or leading zeros.
ASTextFromPDText — Creates a new string from some PDF text taken out of a PDF file. This is either a UTF-16 string with the 0xFEFF prepended to the front or a PDFDocEncoding string. In either case the string is expected to have the appropriate NULL termination. If the PDText is in UTF-16, it may have embedded language and country information; this will cause the ASText object to have its language and country codes set to the values found in the string.
ASTextFromScriptText — Creates a new string from a NULL-terminated multi-byte string of the specified script. This is a wrapper around ASTextFromEncoded(); the script is converted to a host encoding using ASScriptToHostEncoding().
ASTextFromSizedEncoded — Creates a new text object from a multi-byte string of the specified length in the specified host encoding.
ASTextFromSizedPDText — Creates a new string from some PDF text taken out of a PDF file. This is either a UTF-16 string with the 0xFEFF prepended to the front or a PDFDocEncoding string. If the PDText is in UTF-16, it may have embedded language and country information; this will cause the ASText object to have its language and country codes set to the values found in the string. The length parameter specifies the size, in bytes, of the string. The string must not contain embedded NULL characters.
ASTextFromSizedScriptText — Creates a new text object from the specified multi-byte string of the specified script. This is a wrapper around ASTextFromEncoded(); the script is converted to a host encoding using ASScriptToHostEncoding().
ASTextFromSizedUnicode — Creates a new text object from the specified Unicode string. This string is not expected to have 0xFE 0xFF prepended, or country/language identifiers.
ASTextFromUnicode — Creates a new string from a NULL-terminated Unicode string. This string is not expected to have 0xFE 0xFF prepended, or country/language identifiers.
ASTextFromUns32 — Creates a new string from an ASUns32 by converting it to a decimal representation without punctuation or leading zeros.
ASTextGetBestEncoding — Returns the best host encoding for representing the text. The best host encoding is the one that is least likely to lose characters during the conversion from Unicode to host. If the string can be represented accurately in multiple encodings (for example, it is low-ASCII text that can be correctly represented in any host encoding), ASTextGetBestEncoding() returns the preferred encoding based on the preferredEncoding parameter.
ASTextGetBestScript — Returns the best host script for representing the text. The functionality is similar to ASTextGetBestEncoding(), with resulting host encoding converted to a script code using ASScriptFromHostEncoding().
ASTextGetCountry — Retrieves the country associated with an ASText object.
ASTextGetEncoded — Returns a NULL-terminated string in the given encoding. The memory to which this string points is owned by the ASText object and may not be valid after additional operations are performed on the object.
ASTextGetEncodedCopy — Returns a copy of a string in a specified encoding.
ASTextGetLanguage — Retrieves the language code associated with an ASText object.
ASTextGetPDTextCopy — Returns the text in a form suitable for storage in a PDF file. If the text can be represented using PDFDocEncoding, it is; otherwise it is represented in big-endian UTF-16 format with 0xFE 0xFF prepended to the front and any country/language codes embedded in an escape sequence right after 0xFE 0xFF.
ASTextGetScriptText — Converts the Unicode string in the ASText object to the appropriate script, and returns a pointer to the converted text. The memory to which it points is owned by the ASText object and must not be altered or destroyed by the client. The memory may also become invalid after subsequent operations are applied to the ASText object.
ASTextGetScriptTextCopy — Converts the Unicode string in the ASText object to the appropriate script and returns a pointer to the converted text. The memory to which it points is owned by the client, which is responsible for freeing it using ASfree().
ASTextGetUnicode — Returns a pointer to a string in kUTF16HostEndian format (see ASUnicodeFormat). The memory to which this string points is owned by the ASText object, and may not be valid after additional operations are performed on the object.
ASTextGetUnicodeCopy — Returns a pointer to a NULL-terminated string in the specified Unicode format. The memory to which this string points is owned by the client, which can modify it at will and is responsible for destroying it using ASfree.
ASTextIsEmpty — Used to determine whether the ASText object contains no text. For example, it determines if retrieving Unicode text would yield a 0-length string.
ASTextMakeEmpty — Removes the contents of an ASText (turns it into an empty string).
ASTextMakeEmptyClear — Removes the contents of an ASText object (converts it into an empty string). It clears the released storage (for security strings).
ASTextNew — Creates a new text object containing no text.
ASTextNormalizeEndOfLine — Replaces all end-of-line characters within the ASText object with the correct end-of-line character for the current platform. For example, on Windows, \r and \n are replaced with \r\n.
ASTextReplace — Replaces all occurrences of toReplace in src with the text specified in replacement. This uses an ASText string to indicate the toReplace string; ASTextReplaceASCII() uses a low ASCII Roman string to indicate the text to replace.
ASTextReplaceASCII — Replaces all occurrences of toReplace in src with the text specified in replacement. ASTextReplace() uses an ASText string to indicate the toReplace string; this uses a low-ASCII Roman string to indicate the text to replace.
ASTextReplaceBadChars — Replaces all occurrences of characters contained in the list pszBadCharList in the text with the specified replacement character.
ASTextSetCountry — Sets the language codes associated with a piece of text. ASText objects can have country and language codes associated with them. These can be explicitly set or parsed from the Unicode form of PDText strings.
ASTextSetEncoded — Replaces the contents of an existing ASText object with a NULL-terminated multi-byte string in the specified host encoding.
ASTextSetLanguage — Sets the language codes associated with a piece of text.
ASTextSetPDText — Alters an existing string from some PDF text taken out of a PDF file. This is either a big-endian UTF-16 string with the 0xFEFF prepended to the front or a PDFDocEncoding string. In either case the string is expected to have the appropriate NULL termination. If the PDText is in UTF-16, it may have embedded language and country information; this will cause the ASText object to have its language and country codes set to the values found in the string.
ASTextSetScriptText — Alters an existing string from a NULL-terminated multi-byte string of the specified script. This is a wrapper around ASTextFromEncoded(); the script is converted to a host encoding using ASScriptToHostEncoding().
ASTextSetSizedEncoded — Alters an existing string from a multi-byte string in the specified host encoding and of the specified length. This text does not need to be NULL-terminated, and no NULL (zero) bytes should appear in the characters passed in.
ASTextSetSizedPDText — Replaces the contents of an existing ASText object with PDF text taken out of a PDF file. This is either a big-endian UTF-16 string with the 0xFEFF prepended to the front or a PDFDocEncoding string. In either case the length parameter indicates the number of bytes in the string. The string should not be NULL-terminated and must not contain any NULL characters. If the PDText is in UTF-16, it may have embedded language and country information; this will cause the ASText object to have its language and country codes set to the values found in the string.
ASTextSetSizedScriptText — Replaces the contents of an existing ASText object with the specified multi-byte string of the specified script. This is a wrapper around ASTextFromSizedEncoded(); the script is converted to a host encoding using ASScriptToHostEncoding().
ASTextSetSizedUnicode — Replaces the contents of an existing ASText object with the specified Unicode string. This string is not expected to have 0xFE 0xFF prepended or embedded country/language identifiers.
ASTextSetUnicode — Alters an existing string from a NULL-terminated Unicode string. This string is not expected to have 0xFE 0xFF prepended or embedded country/language identifiers.
ASTFilePos — A numeric count value for use in I/O methods and data structures.
ASTimeRec
ASTimeRecP
ASTimeSpan — An ASTimeSpan object represents an exact time span, measured in seconds. The internal representation uses 64-bit signed integers (to avoid the 2038 problem caused by 32-bit representation). Negative timespans are allowed.
ASTimeSpan — An ASTimeSpan represents an exact time span, measured in seconds. The internal representation uses 64-bit signed integers to avoid the year 2037 problem. Negative timespans are allowed.
ASTimeSpanAdd — Adds two time spans, storing the result (an exact number of seconds) in another time span object.
ASTimeSpanCompare — Compares two time spans to determine if they are equal or if one represents fewer seconds than the other.
ASTimeSpanCopy — Copies data from one time span object to another.
ASTimeSpanDestroy — Releases and destroys a time span object.
ASTimeSpanDiff — Calculates the exact difference in seconds between time span objects and stores the result in the provided ASTimeSpan object. If timeSpan2 is less than timeSpan1, the result is negative.
ASTimeSpanDup — Creates a new time span object containing the same data as an existing time span object. It raises an exception if there is not enough memory.
ASTimeSpanGetASInt32 — Gets the number of seconds from a time span object.
ASTimeSpanNegate — Negates the time span value of a time span object.
ASTimeSpanNew — Creates a time span object. It raises an exception if there is not enough memory for the operation.
ASTimeSpanSet — The internal representation of a time span uses 64-bit signed integers (to avoid the year 2038 problem caused by 32-bit representation). This method initializes a time span object to represent a time span of x seconds, where x is the 64-bit signed integer obtained from concatenating highBits and lowBits.
ASTimeSpanSetFromASInt32 — Initializes a time span object to represent a time span of a specific number of seconds.
ASTimeSpanSetFromString — Converts a string to a number of seconds, and initializes a time span object to represent a time span of that number of seconds. This is useful for time spans that are too long to represent with an ASInt32 value.
ASTVersion — A cryptographic version number.
ASUCS_GetPasswordFromUnicode — Converts user input of a password to a form that can be used by Acrobat to open a file.
ASUniChar
ASUnicodeChar — An ASUnicodeChar is large enough to hold any Unicode character (at least 21 bits wide).
ASUnicodeFormat — Describes the various Unicode formats you can place into and read out of an ASText object.
ASUns16 — 2-byte unsigned short numeric value.
ASUns16P
ASUns16ToFixed
ASUns32 — 4-byte unsigned long numeric value.
ASUns32P
ASUns64 — 8-byte unsigned long numeric value.
ASUns8 — 1-byte unsigned char value.
ASUns8P
ASUnsOrPtr
ASUSE_OBSOLETE_TYPES
ASUTF16Val — Holds a single 16-bit value from a UTF-16 encoded Unicode string. It is typically used to point to the beginning of an UTF-16 string. For example: ASUTF16Val *utf16String = ...
ASUTF32Val
ASUTF8Val — An ASUTF8Val holds a single 8-bit value from a UTF-8 encoded Unicode string.
ASUUID — An object containing data and methods supporting a universal unique identifier (UUID) for the current user or the current session.
ASUUID — A structure representing a universal unique identifier (UUID) for the current user or the current session.
ASUUIDFromCString — Parses a C string, such as one generated by ASUUIDToCString(), into a unique identifier (UUID).
ASUUIDGenFromHash — Generates a unique identifier (UUID) from a hash value.
ASUUIDGenFromName — Generates a universal unique identifier (UUID) for a block of data (a name) in a context (a namespace).
ASUUIDGenUnique — Generates a unique identifier (UUID).
ASUUIDMaxStringLen — A constant for the maximum string length of a unique identifier (UUID).
ASUUIDToCString — Generates a NULL-terminated C string from the unique identifier (UUID) for a user or session.
ASVersion — An HFT version number.
ATTR_AcceptCertWithoutCheck
ATTR_DirCertificates
ATTR_DirEmail
ATTR_DirFirstName
ATTR_DirFullName
ATTR_DirLastName
ATTR_DirPrefEncryptionCert
avErrActionExternal
avErrActionFullScreen
avErrActionRestricted
avErrBadActionCopy
avErrBadAnnotationCopy
avErrBadThreadLinkError
avErrCantOpenDialog
avErrCantOpenMoreThanTenDocs
avErrCantOpenPrinting
avErrDownloadHelpError
avErrNoError
avErrNoText
avErrPrintJobTooBig
avErrTooManyChars
avErrUpdateInternalError
avErrUpdateInternetError
avErrUpdateNoWebServices
AVExtensionMgrRegisterNotification — 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.
AVExtensionMgrUnregisterNotification — Unregisters a user-supplied procedure to call when the specified event occurs. This is exactly the same as the AVAppUnregisterNotification() method.
avInvalidPageRange
AVPS_MAC_ROMAN_ENC — Encoding identifiers (for TE).
AVPS_WIN_ANSI_ENC
avSA128EncryptionPresent
avSAInsufficientPermission