Acrobat API ReferenceAll Layers | All Objects | Index | Samples | Frames
ASExtension
 
LayerAS_Layer
ObjectASExtension

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.


Typedef Summary
 Typedef
 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.
Enumeration Summary
 Enumeration
  ASExtensionPhase
Called periodically during plug-in loading with the ASExtension currently being loaded, and a selector indicating what phase of loading is happening.
Callback Summary
 Callback
 ASExtensionEnumProc
Enumeration function for ASEnumExtensions().
 ASExtensionProgressProc
Called periodically during plug-in loading with the ASExtension currently being loaded.
 ASExtensionReportErrorProc
Called during ASExtension initialization whenever an error occurs.
Method Summary
 Method
 
ASExtension ASEnumExtensions(ASExtensionEnumProc proc, void* clientData, ASBool onlyLivingExtensions)
Enumerates all ASExtension objects (valid plug-ins).
 
ASTArraySize ASExtensionGetFileName(ASExtension extension, char* buffer, ASTArraySize bufSize)
Gets the file name of an ASExtension.
 
ASAtom ASExtensionGetRegisteredName(ASExtension extension)
Gets the registered name associated with a plug-in.

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

Syntax

typedef struct _t_ASExtension* 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.

See Also

ASEnumExtensions

File: CoreExpT.h
Line: 190

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

Syntax

enum ASExtensionPhase {
 ASExtensionPhase_LOADING,
 
 ASExtensionPhase_EXPORTING,
 
 ASExtensionPhase_IMPORTING,
 
 ASExtensionPhase_INITIALIZING,
 
 ASExtensionPhase_UNLOADING
}

File: PDFInit.h
Line: 284

Elements
ASExtensionPhase_LOADING  

Loading

 
ASExtensionPhase_EXPORTING  

Exporting

 
ASExtensionPhase_IMPORTING  

Importing

 
ASExtensionPhase_INITIALIZING  

Initializing

 
ASExtensionPhase_UNLOADING  

Unloading


Callbacks Detail
ASExtensionEnumProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*ASExtensionEnumProc)(ASExtension extension, void *clientData)

Enumeration function for ASEnumExtensions().

See Also

ASEnumExtensions

File: CoreExpT.h
Line: 266
ASExtensionProgressProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*ASExtensionProgressProc)(ASExtension extension, ASExtensionPhase phase, void *clientData)

Called periodically during plug-in loading with the ASExtension currently being loaded.

See Also

ASExtensionReportErrorProc

Note

Extensions to the PDF Library are very similar to plugins to the Acrobat application. However, Adobe does not currently supply any extensions or support their creation.

File: PDFInit.h
Line: 332
ASExtensionReportErrorProc 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void (*ASExtensionReportErrorProc)(ASExtension extension, ASExtensionPhase phase, ASInt32 error, void *clientData)

Called during ASExtension initialization whenever an error occurs.

See Also

ASExtensionProgressProc

File: PDFInit.h
Line: 348

Method Detail
ASEnumExtensions()
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASExtension ASEnumExtensions(ASExtensionEnumProc proc, void* clientData, ASBool onlyLivingExtensions)

Enumerates all ASExtension objects (valid plug-ins).

Parameters

proc — 

A user-supplied callback to call for each plug-in. Enumeration halts if proc returns false.

 
clientData — 

A pointer to user-supplied data to pass to proc each time it is called.

 
onlyLivingExtensions — 

If true, ASExtension objects that have been unloaded or otherwise deactivated are not enumerated. If false, all ASExtension objects are enumerated.

Returns

If proc returned false, the last ASExtension that was enumerated is returned, NULL otherwise.

See Also

ASExtensionGetFileName
ASExtensionGetRegisteredName

Since

PI_ACROSUPPORT_VERSION >= 0x00040000

File: CorProcs.h
Line: 280
ASExtensionGetFileName() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASTArraySize ASExtensionGetFileName(ASExtension extension, char* buffer, ASTArraySize bufSize)

Gets the file name of an ASExtension.

Parameters

extension — 

IN/OUT The ASExtension whose file name is obtained.
 
buffer — 

IN/OUT (Filled by the method, may be NULL) A pointer to a buffer for the file name. Pass NULL to have this method return the length of the file name (excluding a terminating NULL character).

 
bufSize — 

IN/OUT The number of bytes in buffer. It is ignored if buffer is NULL.

Returns

The number of characters written into buffer, excluding the NULL character.

See Also

ASExtensionGetRegisteredName

Since

PI_ACROSUPPORT_VERSION >= 0x00040000

File: CorProcs.h
Line: 297
ASExtensionGetRegisteredName() 
Product availability: PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

ASAtom ASExtensionGetRegisteredName(ASExtension extension)

Gets the registered name associated with a plug-in.

Parameters

extension — 

IN/OUT The ASExtension whose name is obtained.

Returns

An ASAtom representing the plug-in name, or NULL if the name could not be identified.

See Also

ASExtensionGetFileName

Since

PI_ACROSUPPORT_VERSION >= 0x00040000

File: CorProcs.h
Line: 308



Copyright 2020 Adobe Systems Incorporated and its licensors. All rights reserved. Adobe and the Adobe logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. This product contains either BSAFE and/or TIPEM software by RSA Security, Inc. Portions utilize Microsoft Windows Media Technologies. Copyright © 2006 Microsoft Corporation. All Rights Reserved. Notices, terms and conditions pertaining to other third party software are located at http://www.adobe.com/go/thirdparty/ and incorporated herein by reference.
Wed Feb 7 2024, 2:16 pm IST