DL Logo

ASExtension Typedefs

ASExtension

Header: CoreExpT.h:195

Description

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.

Syntax

typedef struct _t_ASExtension *ASExtension;

Returned From

Used By

Used In

ExtensionID

Header: CoreExpT.h:197

Syntax

typedef ASExtension ExtensionID;

Used By

ASExtension Callback Signatures

ASExtensionEnumProc

Header: CoreExpT.h:267

Description

Enumeration function for ASEnumExtensions().

Syntax

ASBool ASExtensionEnumProc(ASExtension extension, void *clientData);

Parameters

extension
The ASExtension for a client.
clientData
User-supplied data that was passed in the call to ASEnumExtensions().

Returns

If false, enumeration halts and the ASExtension on which enumeration halted is returned. If true, enumeration continues.

Used By

ASExtension Functions

ASEnumExtensions

Header: CorProcs.h:276

Description

Enumerates all ASExtension objects (valid plug-ins).

Syntax

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

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.

ASExtensionGetFileName

Header: CorProcs.h:293

Description

Gets the file name of an ASExtension.

Syntax

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

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.

ASExtensionGetRegisteredName

Header: CorProcs.h:304

Description

Gets the registered name associated with a plug-in.

Related Methods

Syntax

ASAtom ASExtensionGetRegisteredName(ASExtension extension);

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.

ASExtensionMgrGetHFT

Header: CorProcs.h:215

Description

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.

Syntax

HFT ASExtensionMgrGetHFT(ASAtom name, ASVersion version);

Parameters

name
The name of the HFT to obtain.
version
The version number of the HFT to obtain.

Returns

The specified HFT, or NULL if the HFT does not exist.