SPPlugs.h File Reference

#include "SPTypes.h"
#include "SPFiles.h"
#include "SPAdapts.h"
#include "SPProps.h"
#include "SPStrngs.h"
#include "SPHeaderBegin.h"
#include "SPErrorCodes.h"
#include "SPHeaderEnd.h"

Go to the source code of this file.

Classes
struct	_SPErrorData
	PICA file-access error. More...
struct	SPPluginsSuite
	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...
Defines
#define	kSPPluginsSuite   "SP Plug-ins Suite"
	PICA plug-ins suite name.
#define	kSPPluginsSuiteVersion4   4
	PICA plug-ins suite version.
#define	kSPPluginsSuiteVersion5   5
	PICA plug-ins suite version.
#define	kSPPluginsSuiteVersion6   6
	PICA plug-ins suite version.
#define	kSPPluginsSuiteVersion   kSPPluginsSuiteVersion6
	PICA plug-ins suite version.
#define	kSPRuntimePluginList   ((SPPluginListRef)NULL)
	PICA global list of available plug-ins.
Typedefs
typedef struct SPPlugin *	SPPluginRef
	Opaque reference to a plug-in object.
typedef struct SPPluginList *	SPPluginListRef
	A list of plug-in objects.
typedef struct SPPluginListIterator *	SPPluginListIteratorRef
	An iterator object for examining a plug-in list.
typedef struct _SPErrorData	SPErrorData
	PICA file-access error.
typedef struct _SPErrorData *	SPErrorDataPtr
typedef SPAPI SPErr(*	SPPluginEntryFunc )(const char *caller, const char *selector, void *message)
Functions
SPAPI SPErr	SPAllocatePluginList (SPStringPoolRef strings, SPPluginListRef *pluginList)
	Internal.
SPAPI SPErr	SPFreePluginList (SPPluginListRef pluginList)
	Internal.
SPAPI SPErr	SPGetPluginListNeededSuiteAvailable (SPPluginListRef pluginList, SPBoolean *available)
	Internal.
SPAPI SPErr	SPAddPlugin (SPPluginListRef pluginList, const SPPlatformFileReference *fileSpec, PIPropertyList *PiPL, const char *adapterName, void *adapterInfo, SPPluginRef *plugin)
	Internal.
SPAPI SPErr	SPNewPluginListIterator (SPPluginListRef pluginList, SPPluginListIteratorRef *iter)
	Internal.
SPAPI SPErr	SPNextPlugin (SPPluginListIteratorRef iter, SPPluginRef *plugin)
	Internal.
SPAPI SPErr	SPDeletePluginListIterator (SPPluginListIteratorRef iter)
	Internal.
SPAPI SPErr	SPGetHostPluginEntry (SPPluginRef plugin, SPPluginEntryFunc *host)
	Internal.
SPAPI SPErr	SPGetPluginFileReference (SPPluginRef plugin, SPPlatformFileReference *fileSpec)
	Internal.
SPAPI SPErr	SPGetPluginPropertyList (SPPluginRef plugin, SPPropertyListRef *propertyList)
	Internal.
SPAPI SPErr	SPGetPluginGlobals (SPPluginRef plugin, void **globals)
	Internal.
SPAPI SPErr	SPSetPluginGlobals (SPPluginRef plugin, void *globals)
	Internal.
SPAPI SPErr	SPGetPluginStarted (SPPluginRef plugin, ai::int32 *started)
	Internal.
SPAPI SPErr	SPSetPluginStarted (SPPluginRef plugin, ai::int32 started)
	Internal.
SPAPI SPErr	SPGetPluginSkipShutdown (SPPluginRef plugin, ai::int32 *skipShutdown)
	Internal.
SPAPI SPErr	SPSetPluginSkipShutdown (SPPluginRef plugin, ai::int32 skipShutdown)
	Internal.
SPAPI SPErr	SPGetPluginBroken (SPPluginRef plugin, ai::int32 *broken)
	Internal.
SPAPI SPErr	SPSetPluginBroken (SPPluginRef plugin, ai::int32 broken)
	Internal.
SPAPI SPErr	SPGetPluginAdapter (SPPluginRef plugin, SPAdapterRef *adapter)
	Internal.
SPAPI SPErr	SPGetPluginAdapterInfo (SPPluginRef plugin, void **adapterInfo)
	Internal.
SPAPI SPErr	SPSetPluginAdapterInfo (SPPluginRef plugin, void *adapterInfo)
	Internal.
SPAPI SPErr	SPFindPluginProperty (SPPluginRef plugin, PIType vendorID, PIType propertyKey, ai::int32 propertyID, PIProperty **p)
	Internal.
SPAPI SPErr	SPGetPluginName (SPPluginRef plugin, const char **name)
	Internal.
SPAPI SPErr	SPSetPluginName (SPPluginRef plugin, const char *name)
	Internal.
SPAPI SPErr	SPGetNamedPlugin (const char *name, SPPluginRef *plugin)
	Internal.
SPAPI SPErr	SPSetPluginPropertyList (SPPluginRef plugin, SPFileRef file)
	Internal.
SPErr	SPAddHostPlugin (SPPluginListRef pluginList, SPPluginEntryFunc entry, void *access, const char *adapterName, void *adapterInfo, SPPluginRef *plugin, const char *name)
	Internal.
SPAPI SPErr	SPGetPluginHostInfo (SPPluginRef plugin, void **hostInfo)
	Internal.
SPAPI SPErr	SPSetPluginHostInfo (SPPluginRef plugin, void *hostInfo)
	Internal.
SPAPI SPErr	SPAddPlugin_v4_v5 (SPPluginListRef pluginList, const SPPlatformFileSpecification *fileSpec, PIPropertyList *PiPL, const char *adapterName, void *adapterInfo, SPPluginRef *plugin)
	Internal.
SPAPI SPErr	SPGetPluginFileReference_v4_v5 (SPPluginRef plugin, SPPlatformFileSpecification *fileSpec)
	Internal.

---

Define Documentation

#define kSPPluginsSuite   "SP Plug-ins Suite"

PICA plug-ins suite name.

#define kSPPluginsSuiteVersion   kSPPluginsSuiteVersion6

PICA plug-ins suite version.

#define kSPPluginsSuiteVersion4   4

PICA plug-ins suite version.

#define kSPPluginsSuiteVersion5   5

PICA plug-ins suite version.

#define kSPPluginsSuiteVersion6   6

PICA plug-ins suite version.

#define kSPRuntimePluginList   ((SPPluginListRef)NULL)

PICA global list of available plug-ins.

See also:

SPRuntimeSuite::GetRuntimePluginList()

---

Typedef Documentation

typedef struct _SPErrorData SPErrorData

PICA file-access error.

typedef struct _SPErrorData * SPErrorDataPtr

typedef SPAPI SPErr(* SPPluginEntryFunc)(const char *caller, const char *selector, void *message)

typedef struct SPPluginListIterator* SPPluginListIteratorRef

An iterator object for examining a plug-in list.

See SPPluginsSuite::NewPluginListIterator().

typedef struct SPPluginList* SPPluginListRef

A list of plug-in objects.

Create with SPPluginsSuite::AllocatePluginList(), or use the global list, kSPRuntimePluginList.

typedef struct SPPlugin* SPPluginRef

Opaque reference to a plug-in object.

Access with the SPPluginsSuite.

---

Function Documentation

SPErr SPAddHostPlugin	(	SPPluginListRef	pluginList,
		SPPluginEntryFunc	entry,
		void *	access,
		const char *	adapterName,
		void *	adapterInfo,
		SPPluginRef *	plugin,
		const char *	name
	)

Internal.

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

Internal.

SPAPI SPErr SPAddPlugin_v4_v5	(	SPPluginListRef	pluginList,
		const SPPlatformFileSpecification *	fileSpec,
		PIPropertyList *	PiPL,
		const char *	adapterName,
		void *	adapterInfo,
		SPPluginRef *	plugin
	)

Internal.

SPAPI SPErr SPAllocatePluginList	(	SPStringPoolRef	strings,
		SPPluginListRef *	pluginList
	)

Internal.

SPAPI SPErr SPDeletePluginListIterator

(

SPPluginListIteratorRef

iter

)

Internal.

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

Internal.

SPAPI SPErr SPFreePluginList

(

SPPluginListRef

pluginList

)

Internal.

SPAPI SPErr SPGetHostPluginEntry	(	SPPluginRef	plugin,
		SPPluginEntryFunc *	host
	)

Internal.

SPAPI SPErr SPGetNamedPlugin	(	const char *	name,
		SPPluginRef *	plugin
	)

Internal.

SPAPI SPErr SPGetPluginAdapter	(	SPPluginRef	plugin,
		SPAdapterRef *	adapter
	)

Internal.

SPAPI SPErr SPGetPluginAdapterInfo	(	SPPluginRef	plugin,
		void **	adapterInfo
	)

Internal.

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

Internal.

SPAPI SPErr SPGetPluginFileReference	(	SPPluginRef	plugin,
		SPPlatformFileReference *	fileSpec
	)

Internal.

SPAPI SPErr SPGetPluginFileReference_v4_v5	(	SPPluginRef	plugin,
		SPPlatformFileSpecification *	fileSpec
	)

Internal.

SPAPI SPErr SPGetPluginGlobals	(	SPPluginRef	plugin,
		void **	globals
	)

Internal.

SPAPI SPErr SPGetPluginHostInfo	(	SPPluginRef	plugin,
		void **	hostInfo
	)

Internal.

SPAPI SPErr SPGetPluginListNeededSuiteAvailable	(	SPPluginListRef	pluginList,
		SPBoolean *	available
	)

Internal.

SPAPI SPErr SPGetPluginName	(	SPPluginRef	plugin,
		const char **	name
	)

Internal.

SPAPI SPErr SPGetPluginPropertyList	(	SPPluginRef	plugin,
		SPPropertyListRef *	propertyList
	)

Internal.

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

Internal.

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

Internal.

SPAPI SPErr SPNewPluginListIterator	(	SPPluginListRef	pluginList,
		SPPluginListIteratorRef *	iter
	)

Internal.

SPAPI SPErr SPNextPlugin	(	SPPluginListIteratorRef	iter,
		SPPluginRef *	plugin
	)

Internal.

SPAPI SPErr SPSetPluginAdapterInfo	(	SPPluginRef	plugin,
		void *	adapterInfo
	)

Internal.

SPAPI SPErr SPSetPluginBroken	(	SPPluginRef	plugin,
		ai::int32	broken
	)

Internal.

SPAPI SPErr SPSetPluginGlobals	(	SPPluginRef	plugin,
		void *	globals
	)

Internal.

SPAPI SPErr SPSetPluginHostInfo	(	SPPluginRef	plugin,
		void *	hostInfo
	)

Internal.

SPAPI SPErr SPSetPluginName	(	SPPluginRef	plugin,
		const char *	name
	)

Internal.

SPAPI SPErr SPSetPluginPropertyList	(	SPPluginRef	plugin,
		SPFileRef	file
	)

Internal.

SPAPI SPErr SPSetPluginSkipShutdown	(	SPPluginRef	plugin,
		ai::int32	skipShutdown
	)

Internal.

SPAPI SPErr SPSetPluginStarted	(	SPPluginRef	plugin,
		ai::int32	started
	)

Internal.