#define ASBoolToBool ( boolval )( boolval != FALSE ) #define ASCryptStmModeError 0x0008 #define ASFourCharCode ( x )( x ) #define ASFourCharCode ( x )( 0U ) #define ASMAXInt16 (( ASInt16 ) 0x7FFF ) #define ASMAXInt32 (( ASInt32 ) 0x7FFFFFFF ) #define ASMAXInt64 (( ASInt64 ) 0x7FFFFFFFFFFFFFFFL L ) #define ASMAXInt8 (( ASInt8 ) 0x7F ) #define ASMAXUns16 (( ASUns16 ) 0xFFFF ) #define ASMAXUns32 (( ASUns32 ) 0xFFFFFFFF ) #define ASMAXUns64 (( ASUns64 ) 0xFFFFFFFFFFFFFFFFL L ) #define ASMAXUns8 (( ASUns8 ) 0xFF ) #define ASMINInt16 (( ASInt16 ) 0x8000 ) #define ASMINInt32 (( ASInt32 ) 0x80000000 ) #define ASMINInt64 (( ASInt64 ) 0x8000000000000000L L ) #define ASMINInt8 (( ASInt8 ) 0x80 ) #define ASMINUns16 (( ASUns16 ) 0x0000 ) #define ASMINUns32 (( ASUns32 ) 0x00000000 ) #define ASMINUns64 (( ASUns64 ) 0x0000000000000000L L ) #define ASMINUns8 (( ASUns8 ) 0x00 ) #define ASUSE_OBSOLETE_TYPES 1 #define AS_ARCH_64BIT 1 #define AS_ARCH_64BIT 0 #define AS_UNUSED_PARAM ( type, name ) type name __attribute__(( unused ) ) #define AS_UNUSED_PARAM ( type, name ) type name #define AS_UNUSED_VAR ( type, name ) type __attribute__(( unused ) ) name #define AS_UNUSED_VAR ( type, name ) #define CHECKTYPE ( type, data )(( void *)(( data ) ==(( type ) data ) ? data : data ) ) #define CHECKTYPE ( type, data )(( void *) data ) #define CHECK_CHARSTR ( data )(( void *) data ) #define CHECK_CHARSTR ( data ) CHECKTYPE( char *, data ) #define CancelProc ASCancelProc #define FALSE 0 #define HAS_32BIT_ATOMS 1 #define HAS_32BIT_ATOMS 0 #define HAS_BOOL_SUPPORT 1 #define HAS_BOOL_SUPPORT 0 #define HUGEPTRTYPE #define HugePtr char HUGEPTRTYPE *#define Int16 ASInt16 #define Int16P ASInt16P #define Int32 ASInt32 #define Int32P ASInt32P #define Int8 ASInt8 #define Int8P ASInt8P #define MAXInt16 ASMAXInt16 #define MAXInt32 ASMAXInt32 #define MAXInt8 ASMAXInt8 #define MAXUns16 ASMAXUns16 #define MAXUns32 ASMAXUns32 #define MAXUns8 ASMAXUns8 #define MINInt16 ASMINInt16 #define MINInt32 ASMINInt32 #define MINInt8 ASMINInt8 #define MINUns16 ASMINUns16 #define MINUns32 ASMINUns32 #define MINUns8 ASMINUns8 #define NULL 0 #define NULL (( void *) 0 ) #define POINTER_64_BITS 1 #define ProgressMonitor ASProgressMonitor #define ProgressMonitorRec ASProgressMonitorRec #define ProgressProc ASProgressProc #define TRUE 1 #define UNDEFINED_CONFIGURATION_SELECTOR (( void *) - 1 ) #define Uns16 ASUns16 #define Uns16P ASUns16P #define Uns32 ASUns32 #define Uns32P ASUns32P #define Uns8 ASUns8 #define Uns8P ASUns8P #define _open64_ open64 #define boolean ASBool #define false 0 #define kASMAXEnum16 ASMAXInt16 #define kASMAXEnum16 ASMAXInt16 #define kASMAXEnum8 ASMAXInt16 #define kASMAXEnum8 ASMAXInt8 #define kMoreTextKey "MoreText" #define open64 _open64_ #define os_size_t ASSize_t #define true 1 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.
Value options for ASCabMungeAction.
kASMungeRemove | Any keys in
keyCab are removed from theCab. |
kASMungeRemoveUnknown | Any keys in
theCab which are not also in keyCab are removed. |
kASMungeRemoveDefaults | Any keys in
keyCab which are also in theCab and have the same value in theCab are removed. |
kASMungeRemoveBadValues | Any keys in
theCab which are also in keyCab but have different values are removed. |
kASMungeCopy | All key/value pairs in
keyCab are copied into theCab. |
kASMungeReplace | Any keys in
theCab which are also in keyCab are replaced with the values in keyCab. |
kASMungeCopyMissing | Any keys in
keyCab which are not in theCab are copied over to theCab. |
kASMungeRemoveNulls |
Value options for ASReportType.
kASReportNote | A note.
|
kASReportWarning | A warning.
|
kASReportError | An error.
|
Value options for ASDateTimeFormat.
kASTimeNone=0 | None.
|
kASTimePDF | PDF date format. See the description of Dates in "Common Data Structures" in ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 7.9.4, page 87.
|
kASTimeUniversal | Slight variations of the time format expressed in ISO 8601. ISO 8601 is the international standard for formatting times and dates, first published in 1988.
|
kASTimeUniversalH | Slight variations of the time format expressed in ISO 8601.
|
kASTimeUTC_ASN1 | UTC ASN1 format.
|
kASTimeGENERALIZED_ASN1 | ASN1 format.
|
NULL-terminated strings containing only low ASCII alphanumeric characters. The various types of values are enumerated here. kASValueBool | An ASBool.
|
kASValueInteger | An ASInt32.
|
kASValueAtom | An ASAtom.
|
kASValueDouble | A double precision floating-point number.
|
kASValueString | A
NULL-terminated, unencoded string. |
kASValueText | An ASText object.
|
kASValueBinary | A binary blob of any size.
|
kASValuePointer | A pointer to something outside the cabinet.
|
kASValueCabinet | Another cabinet.
|
kASValueNull | The key exists but has no useful value. For example, the key may be a placeholder.
|
kASValueUns | An ASUns32.
|
kASValueInt64 | An ASInt64.
|
kASValueUns64 | An ASUns64.
|
kASValueUnknown=-1 | An invalid type.
|
kPDFLFlattenProg_EnterInFlattener=0 | |
kPDFLFlattenProg_FindObjectsInvolvedInTransparency | |
kPDFLFlattenProg_TextHeuristics | |
kPDFLFlattenProg_IdentifyingComplexityRegion | |
kPDFLFlattenProg_ComputingComplexityRegionClippath | |
kPDFLFlattenProg_EnterInPlanarMap | |
kPDFLFlattenProg_FlattenAtomicRegions | |
kPDFLFlattenProg_RasterizingComplexityRegion |
kPDFLRenderProg_Unknown=0 | |
kPDFLRenderProg_Stage1 | |
kPDFLRenderProg_Stage2 | |
kPDFLRenderProg_Stage3 | |
kPDFLRenderProg_Stage4 | |
kPDFLRenderProg_Stage5 | |
kPDFLRenderProg_Stage6 | |
kPDFLRenderProg_Stage7 | |
kPDFLRenderProg_Stage8 | |
kPDFLRenderProg_Stage9 |
Value options for ASUnicodeFormat.
kUTF16BigEndian | Always returns the bytes in big-endian order.
|
kUTF16HostEndian | Returns the bytes in the host's native endian order, whatever is natural for an ASUns16.
|
kUTF8 | Endian neutral.
|
kUTF32BigEndian | Always returns the bytes in big-endian order.
|
kUTF32HostEndian | Returns the bytes in the host's native endian order, whatever is natural for an ASUns32.
|
typedef ASUns32 ASArraySize; typedef ASUns16 ASBool; typedef ASUns8 ASByte; typedef ASUns32 ASByteCount; typedef void *ASCallback; typedef ASInt16 ASCoord; typedef ASInt32 ASCoord; typedef ASUns32 ASCount; typedef ASInt32 ASDuration; 0 to 32,767, used in data structures. typedef ASInt16 ASEnum16; 0 to 32,767, used in data structures. typedef ASInt16 ASEnum16; 0 to 127, used in data structures. typedef ASInt16 ASEnum8; typedef ASUns8 ASEnum8; typedef ASUns32 ASFlagBits; typedef ASInt32 ASFract; signed short numeric value. typedef short int ASInt16, *ASInt16P; signed long numeric value. typedef int ASInt32, *ASInt32P; signed long numeric value. typedef signed long long int ASInt64; signed char value. typedef signed char ASInt8, *ASInt8P; typedef intptr_t ASIntOrPtr; typedef ASUns32 ASMaskBits; For value options see ASReportOptions.
typedef ASEnum16 ASReportType; typedef size_t ASSize_t; int value. Negative values are never used. typedef ASInt16 ASSmallCount; typedef ASUns16 ASSmallCount; typedef ASInt32 ASTArraySize; typedef ASUns32 ASTArraySize; typedef ASInt32 ASTCount; typedef ASUns32 ASTCount; typedef ASInt32 ASTVersion; typedef ASUns32 ASTVersion; typedef unsigned short int ASUns16, *ASUns16P; unsigned long numeric value. typedef unsigned int ASUns32, *ASUns32P; unsigned long numeric value. typedef unsigned long long int ASUns64; unsigned char value. typedef unsigned char ASUns8, *ASUns8P; typedef uintptr_t ASUnsOrPtr; typedef ASInt32 OPAQUE_32_BITS;
This callback replaces CancelProc().
A callback to check for cancelling operations. An ASCancelProc() is typically passed to some method that takes a long time to complete. At frequent intervals, the method calls the ASCancelProc(). If it returns true, the method cancels its operation; if it returns false, it continues.
ASBool ASCancelProc(void *clientData); clientData | IN/OUT User-supplied data that was passed to the method that uses the ASCancelProc().
|
ASBool ASProgressProc(float current, const char *name, ASInt32 /* it's a PDFLFlattenProgressMarker (see PDFLPrint.h) */ stage, void *clientData);
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.
It is this callback's responsibility to destroy all objects passed to it, and it may do so at any time.
void ASReportProc(ASReportType reportType, ASInt32 errorCode, ASText message, ASText replacementText, ASCab moreInfo, void *reportProcData); reportType | The type of information that is reported.
|
errorCode | An error code defined by the system or by ASRegisterErrorString(). If message is not
NULL, the error code can be 0. |
message | Specifies the text the user should read. If the message field is
NULL, the system will retrieve the message associated with the errorCode. If both message and errorCode are specified, the message argument is used. |
replacementText | If this replacement text is not
NULL, the system will attempt to replace the string '%s' in the message with the replacement text. This applies whether the text is specified via the message argument or retrieved from the system using the errorCode argument. |
moreInfo | Not currently used. The report proc will destroy this cabinet immediately.
|
reportProcData | A pointer to the data associated with the report proc (which should be passed in when the report proc is acquired).
|
void PMBeginOperationProc(void *clientData); clientData | IN/OUT User-supplied data that was passed in the call to whatever API method required the progress monitor.
|
void PMEndOperationProc(void *clientData); clientData | IN/OUT User-supplied data that was passed in the call to whatever API method required the progress monitor.
|
ASDuration PMGetCurrValueProc(void *clientData); clientData | IN/OUT User-supplied data that was passed in the call to whatever API method required the progress monitor.
|
ASDuration PMGetDurationProc(void *clientData); clientData | IN/OUT User-supplied data that was passed in the call to whatever API method required the progress monitor.
|
0 (empty) to the value passed to setDuration. For example, if the progress monitor's duration is 10, the current value must be between 0 and 10, inclusive. void PMSetCurrValueProc(ASDuration currValue, void *clientData); currValue | IN/OUT The progress monitor's current value.
|
clientData | IN/OUT User-supplied data that was passed in the call to whatever API method required the progress monitor.
|
void PMSetDurationProc(ASDuration duration, void *clientData); duration | IN/OUT The maximum value the progress monitor will be allowed to have.
|
clientData | IN/OUT User-supplied data that was passed in the call to whatever API method required the progress monitor.
|
A callback within ASProgressMonitorRec that sets the text string that is displayed by the progress monitor.
The built-in document progress monitor (see AVAppGetDocProgressMonitor()) makes a copy of the text. As such, it is the client's responsibility to destroy it.
void PMSetTextProc(ASText text, void *clientData); text | IN/OUT The string to display.
|
clientData | IN/OUT A pointer to the data associated with the progress monitor (which should be passed in with the progress monitor).
|
| |
|
| |
The size of the structure.
| |
A pointer to the progress monitor.
| |
void *progMonClientData; | A pointer to client data, which can be of any type.
|
This call has been replaced by ASCancelProc(). A callback to check for cancelling operations. An ASCancelProc is typically passed to some method that takes a long time to complete. At frequent intervals, the method calls the ASCancelProc. If it returns | |
void *cancelProcClientData; | A pointer to client data for the cancel procedure.
|
The report procedure.
| |
void *reportProcClientData; | A pointer to client data for the report procedure.
|
A pointer to a callback function for monitoring progress.
| |
void *progressProcClientData; | |
|
Replaced by ASProgressMonitor.
A data structure containing callbacks that implement a progress monitor. The callbacks implement the progress monitor functions. A progress monitor is used to display progress during potentially time-consuming operations. Progress monitors are included as parameters in many API calls. Acrobat's built-in progress monitor can be obtained by calling AVAppGetDocProgressMonitor().
| |
The size of the data structure. It must be set to
sizeof(ProgressMonitorRec). | |
Initialize the progress monitor and display it with a current value of zero.
| |
Draw the progress monitor with its current value set to the progress monitor's duration (a full progress monitor).
| |
Set the progress monitor's duration.
| |
Set the current value of the progress monitor and update the display.
| |
Get the progress monitor's duration.
| |
Get the progress monitor's duration.
| |
Set the text string that is displayed by the progress monitor.
| |
|
Note: The coordinate numeric types changed in Acrobat 6.
void *ASDebug(ASInt32 op, void *parm, ASTArraySize parmLen, void *clientData);