SPPluginsSuite Struct Reference

This suite allows you to access and manipulate the plug-in object for your own and those of other plug-ins managed by the Adobe plug-in manager (PICA). More...

#include <SPPlugs.h>

List of all members.

Public Attributes
SPAPI SPErr(*	AllocatePluginList )(SPStringPoolRef strings, SPPluginListRef *pluginList)
	Creates a new plug-in list.
SPAPI SPErr(*	FreePluginList )(SPPluginListRef pluginList)
	Frees a list of plug-ins allocated with `AllocatePluginList()`, and also frees any entries in the list.
SPAPI SPErr(*	AddPlugin )(SPPluginListRef pluginList, const SPPlatformFileReference fileSpec, PIPropertyList PiPL, const char adapterName, void adapterInfo, SPPluginRef *plugin)
	Creates a new plug-in object and adds it to a plug-in list.
SPAPI SPErr(*	NewPluginListIterator )(SPPluginListRef pluginList, SPPluginListIteratorRef *iter)
	Creates an iterator object with which to traverse a plug-in list.
SPAPI SPErr(*	NextPlugin )(SPPluginListIteratorRef iter, SPPluginRef *plugin)
	Retrieves the current plug-in and advances a plug-in-list iterator to the next plug-in in the list.
SPAPI SPErr(*	DeletePluginListIterator )(SPPluginListIteratorRef iter)
	Frees a plug-in-list iterator that is no longer needed.
SPAPI SPErr(*	GetPluginListNeededSuiteAvailable )(SPPluginListRef pluginList, SPBoolean *available)
	Reports whether a plug-in that is needed is available in a plug-in list.
SPAPI SPErr(*	GetPluginHostEntry )(SPPluginRef plugin, SPPluginEntryFunc *host)
	Retrieves the callback structure provided by the host application for a plug-in.
SPAPI SPErr(*	GetPluginFileReference )(SPPluginRef plugin, SPPlatformFileReference *fileSpec)
	Retrieves the code and resources file of a plug-in.
SPAPI SPErr(*	GetPluginPropertyList )(SPPluginRef plugin, SPPropertyListRef *propertList)
	Retrieves the property list of a plug-in.
SPAPI SPErr(*	GetPluginGlobals )(SPPluginRef plugin, void **globals)
	Retrieves the global variables of a plug-in.
SPAPI SPErr(*	SetPluginGlobals )(SPPluginRef plugin, void *globals)
	Sets the global variables for a plug-in.
SPAPI SPErr(*	GetPluginStarted )(SPPluginRef plugin, ai::int32 *started)
	Reports whether a plug-in has received and returned from the interface start-up message.
SPAPI SPErr(*	SetPluginStarted )(SPPluginRef plugin, ai::int32 started)
	Sets whether a plug-in has received and returned from the interface start-up message.
SPAPI SPErr(*	GetPluginSkipShutdown )(SPPluginRef plugin, ai::int32 *skipShutdown)
	Reports whether a plug-in is instructed to skip the start-up message.
SPAPI SPErr(*	SetPluginSkipShutdown )(SPPluginRef plugin, ai::int32 skipShutdown)
	Instructs a plug-in to respond or not to respond to the start-up message.
SPAPI SPErr(*	GetPluginBroken )(SPPluginRef plugin, ai::int32 *broken)
	Reports whether a plug-in has reported an error condition that makes it unavailable.
SPAPI SPErr(*	SetPluginBroken )(SPPluginRef plugin, ai::int32 broken)
	Sets or clears the broken flag that marks a plug-in as unavailable due to an error condition.
SPAPI SPErr(*	GetPluginAdapter )(SPPluginRef plugin, SPAdapterRef *adapter)
	Retrieves the adapter for a plug-in.
SPAPI SPErr(*	GetPluginAdapterInfo )(SPPluginRef plugin, void **adapterInfo)
	Retrieves the adapter-specific information for a plug-in.
SPAPI SPErr(*	SetPluginAdapterInfo )(SPPluginRef plugin, void *adapterInfo)
	Sets the adapter-specific information for a plug-in.
SPAPI SPErr(*	FindPluginProperty )(SPPluginRef plugin, PIType vendorID, PIType propertyKey, ai::int32 propertyID, PIProperty **p)
	Retrieves a specific property from the property list for a plug-in.
SPAPI SPErr(*	GetPluginName )(SPPluginRef plugin, const char **name)
	Retrieves the name of a plug-in.
SPAPI SPErr(*	SetPluginName )(SPPluginRef plugin, const char *name)
	Sets the name of a plug-in.
SPAPI SPErr(*	GetNamedPlugin )(const char name, SPPluginRef plugin)
	Retrieves a plug-in by name.
SPAPI SPErr(*	SetPluginPropertyList )(SPPluginRef plugin, SPFileRef file)
	Sets the property list for a plug-in.
SPAPI SPErr(*	GetPluginHostInfo )(SPPluginRef plugin, void **hostInfo)
	Retrieves host information for a plug-in.
SPAPI SPErr(*	SetPluginHostInfo )(SPPluginRef plugin, void *hostInfo)
	Sets host information for a plug-in.

Detailed Description

This suite allows you to access and manipulate the plug-in object for your own and those of other plug-ins managed by the Adobe plug-in manager (PICA).

You can access both plug-ins provided with the application (host plug-ins), and external plug-ins.You can query and set plug-in states, including the "broken" state, which indicates that a plug-in has become unavailable due to an error condition.

You can also use this suite to create and use your own lists of plug-ins, in addition to the global list kept by the application.

For higher-level access to plug-ins, see AIPluginSuite.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kSPPluginsSuite and kSPPluginsSuiteVersion.

Member Data Documentation

SPAPI SPErr(* SPPluginsSuite::AddPlugin)(SPPluginListRef pluginList, const SPPlatformFileReference *fileSpec, PIPropertyList *PiPL, const char *adapterName, void *adapterInfo, SPPluginRef *plugin)

Creates a new plug-in object and adds it to a plug-in list.

Parameters:

	pluginList	The plug-in list object, or `NULL` to use the global list.
	fileSpec	The file specification for the plug-in code and resources.
	PiPL	The structure containing the plug-in properties.
	adapterName	The unique identifying name of the adapter for the new plug-in.
	adapterInfo	A pointer to the adapter-defined structure that stores needed information about this plug-in.
	plugin	[out] A buffer in which to return the new plug-in object.

See also:: AllocatePluginList(), SPAdaptersSuite

SPAPI SPErr(* SPPluginsSuite::AllocatePluginList)(SPStringPoolRef strings, SPPluginListRef *pluginList)

Creates a new plug-in list.

You can also access PICA's global plug-in list, using SPRuntimeSuite::GetRuntimePluginList().

Parameters:

	stringPool	The string pool in which to keep plug-in names.
	pluginList	[out] A buffer in which to return the new list object.

SPAPI SPErr(* SPPluginsSuite::DeletePluginListIterator)(SPPluginListIteratorRef iter)

Frees a plug-in-list iterator that is no longer needed.

Parameters:

iter

The plug-in-list iterator object.

See also:: NewPluginListIterator(),

SPAPI SPErr(* SPPluginsSuite::FindPluginProperty)(SPPluginRef plugin, PIType vendorID, PIType propertyKey, ai::int32 propertyID, PIProperty **p)

Retrieves a specific property from the property list for a plug-in.

If the property is not found in the list, sends the plug-in the kSPPropertiesAcquireSelector message. The plug-in can ignore the message, or it can create and return the requested property. In either case, this function adds the (possibly NULL) property to the list and returns it.

Parameters:

	plugin	The plug-in object.
	vendorID	The property vendor ID code.
	propetyKey	The property type key code.
	propertyID	The specific property identifier.
	p	[out] A buffer in which to return a pointer to the property object.

See also:: SPPropertiesSuite

SPAPI SPErr(* SPPluginsSuite::FreePluginList)(SPPluginListRef pluginList)

Frees a list of plug-ins allocated with AllocatePluginList(), and also frees any entries in the list.

Do not free the global list (kSPRuntimePluginList).

Parameters:

pluginList

The plug-in list object.

SPAPI SPErr(* SPPluginsSuite::GetNamedPlugin)(const char *name, SPPluginRef *plugin)

Retrieves a plug-in by name.

Parameters:

	name	The name string.
	plugin	[out] A buffer in which to return the plug-in object.

SPAPI SPErr(* SPPluginsSuite::GetPluginAdapter)(SPPluginRef plugin, SPAdapterRef *adapter)

Retrieves the adapter for a plug-in.

Parameters:

	plugin	The plug-in object.
	adapter	[out] A buffer in which to return the adapter object.

See also:: SPAdaptersSuite

SPAPI SPErr(* SPPluginsSuite::GetPluginAdapterInfo)(SPPluginRef plugin, void **adapterInfo)

Retrieves the adapter-specific information for a plug-in.

Typically used only by the adapter that defined the information. Other plug-ins should use AIPluginSuite::GetPluginOptions().

Parameters:

	plugin	The plug-in object.
	adapterInfo	[out] A buffer in which to return a pointer to the adapter-defined information structure.

See also:: SPAdaptersSuite

SPAPI SPErr(* SPPluginsSuite::GetPluginBroken)(SPPluginRef plugin, ai::int32 *broken)

Reports whether a plug-in has reported an error condition that makes it unavailable.

Parameters:

	plugin	The plug-in object.
	broken	[out] A buffer in which to return true (non-zero) if the plug-in is marked as broken, false (0) otherwise.

SPAPI SPErr(* SPPluginsSuite::GetPluginFileReference)(SPPluginRef plugin, SPPlatformFileReference *fileSpec)

Retrieves the code and resources file of a plug-in.

Parameters:

	plugin	The plug-in object.
	fileSpec	[out] A buffer in which to return the file specification.

See also:: SPFilesSuite

SPAPI SPErr(* SPPluginsSuite::GetPluginGlobals)(SPPluginRef plugin, void **globals)

Retrieves the global variables of a plug-in.

This is the same value passed in messages to the plug-in, which PICA stores when the plug-in is unloaded.

Parameters:

	plugin	The plug-in object.
	globals	[out] A buffer in which to return a pointer to the global variable array.

SPAPI SPErr(* SPPluginsSuite::GetPluginHostEntry)(SPPluginRef plugin, SPPluginEntryFunc *host)

Retrieves the callback structure provided by the host application for a plug-in.

Parameters:

	plugin	The plug-in object.
	host	A buffer in which to return the callback procedure.

SPAPI SPErr(* SPPluginsSuite::GetPluginHostInfo)(SPPluginRef plugin, void **hostInfo)

Retrieves host information for a plug-in.

Parameters:

	plugin	The plug-in object.
	hostInfo	[out] A buffer in which to return a pointer to the host information structure.

SPAPI SPErr(* SPPluginsSuite::GetPluginListNeededSuiteAvailable)(SPPluginListRef pluginList, SPBoolean *available)

Reports whether a plug-in that is needed is available in a plug-in list.

Parameters:

	pluginList	The plug-in list object, or `NULL` to use the global list.
	available	[out] A buffer in which to return true if the plug-in is found in the list.

See also:: SPInterfaceSuite::StartupExport()

SPAPI SPErr(* SPPluginsSuite::GetPluginName)(SPPluginRef plugin, const char **name)

Retrieves the name of a plug-in.

Parameters:

	plugin	The plug-in object.
	name	[out] A buffer in which to return the name string.

SPAPI SPErr(* SPPluginsSuite::GetPluginPropertyList)(SPPluginRef plugin, SPPropertyListRef *propertList)

Retrieves the property list of a plug-in.

Parameters:

	plugin	The plug-in object.
	propertList	[out] A buffer in which to return the property list object.

See also:: SPPropertiesSuite

SPAPI SPErr(* SPPluginsSuite::GetPluginSkipShutdown)(SPPluginRef plugin, ai::int32 *skipShutdown)

Reports whether a plug-in is instructed to skip the start-up message.

Parameters:

	plugin	The plug-in object.
	skipShutdown	[out] A buffer in which to return true (non-zero) if the plug-in skips the start-up message, false (0) otherwise.

SPAPI SPErr(* SPPluginsSuite::GetPluginStarted)(SPPluginRef plugin, ai::int32 *started)

Reports whether a plug-in has received and returned from the interface start-up message.

Parameters:

	plugin	The plug-in object.
	started	[out] A buffer in which to return true (non-zero) if the plug-in has been started, false (0) otherwise.

SPAPI SPErr(* SPPluginsSuite::NewPluginListIterator)(SPPluginListRef pluginList, SPPluginListIteratorRef *iter)

Creates an iterator object with which to traverse a plug-in list.

The iterator is initially set to the first plug-in in the list.

Parameters:

	pluginList	The plug-in list object, or `NULL` to use the global list.
	iter	[out] A buffer in which to return the new iterator object.

See also:: NextPlugin(), DeletePluginListIterator()

SPAPI SPErr(* SPPluginsSuite::NextPlugin)(SPPluginListIteratorRef iter, SPPluginRef *plugin)

Retrieves the current plug-in and advances a plug-in-list iterator to the next plug-in in the list.

Parameters:

	iter	The plug-in-list iterator object.
	plugin	[out] A buffer in which to return the current plug-in object, `NULL` if the end of the list has been reached.

See also:: NewPluginListIterator(),

SPAPI SPErr(* SPPluginsSuite::SetPluginAdapterInfo)(SPPluginRef plugin, void *adapterInfo)

Sets the adapter-specific information for a plug-in.

Typically used only by the adapter that defined the information. Other plug-ins should use AIPluginSuite::SetPluginOptions().

Parameters:

	plugin	The plug-in object.
	adapterInfo	The adapter-defined information structure.

See also:: SPAdaptersSuite

SPAPI SPErr(* SPPluginsSuite::SetPluginBroken)(SPPluginRef plugin, ai::int32 broken)

Sets or clears the broken flag that marks a plug-in as unavailable due to an error condition.

Parameters:

	plugin	The plug-in object.
	broken	True (non-zero) to mark the plug-in as broken, false (0) to clear the broken flag.

SPAPI SPErr(* SPPluginsSuite::SetPluginGlobals)(SPPluginRef plugin, void *globals)

Sets the global variables for a plug-in.

This is the same value passed in messages to the plug-in, which PICA stores when the plug-in is unloaded.

Parameters:

	plugin	The plug-in object.
	globals	The new global variable array.

SPAPI SPErr(* SPPluginsSuite::SetPluginHostInfo)(SPPluginRef plugin, void *hostInfo)

Sets host information for a plug-in.

Parameters:

	plugin	The plug-in object.
	hostInfo	The new host information structure.

SPAPI SPErr(* SPPluginsSuite::SetPluginName)(SPPluginRef plugin, const char *name)

Sets the name of a plug-in.

Parameters:

	plugin	The plug-in object.
	name	The new name string.

SPAPI SPErr(* SPPluginsSuite::SetPluginPropertyList)(SPPluginRef plugin, SPFileRef file)

Sets the property list for a plug-in.

Parameters:

	plugin	The plug-in object.
	file	The file containing the property list.

SPAPI SPErr(* SPPluginsSuite::SetPluginSkipShutdown)(SPPluginRef plugin, ai::int32 skipShutdown)

Instructs a plug-in to respond or not to respond to the start-up message.

Parameters:

	plugin	The plug-in object.
	skipShutdown	True (non-zero) to skip the start-up message, false (0) to respond normally to the start-up message.

SPAPI SPErr(* SPPluginsSuite::SetPluginStarted)(SPPluginRef plugin, ai::int32 started)

Sets whether a plug-in has received and returned from the interface start-up message.

Parameters:

	plugin	The plug-in object.
	started	True (non-zero) if the plug-in has been started, false (0) otherwise.

The documentation for this struct was generated from the following file:

SPPlugs.h

SPPluginsSuite Struct Reference

Public Attributes

Detailed Description

Member Data Documentation