SPSuites.h File Reference

#include "SPTypes.h"
#include "SPAccess.h"
#include "SPPlugs.h"
#include "SPStrngs.h"
#include "SPHeaderBegin.h"
#include "SPErrorCodes.h"
#include "SPHeaderEnd.h"

Go to the source code of this file.

Classes
struct	SPSuitesSuite
	This suite allows you to create, manage, and access PICA function suites. More...
Defines
#define	kSPSuitesSuite   "SP Suites Suite"
	PICA suite-management suite name.
#define	kSPSuitesSuiteVersion   2
	PICA suite-management suite version.
#define	kSPLatestInternalVersion   0
	Internal.
#define	kSPRuntimeSuiteList   ((SPSuiteListRef)NULL)
	PICA global list of available suites.
#define	kAIAboutToLoadSuite   "About To Load SPSuite"
Typedefs
typedef struct SPSuite *	SPSuiteRef
	Opaque reference to a suite object.
typedef struct SPSuiteList *	SPSuiteListRef
	A list of suite objects.
typedef struct SPSuiteListIterator *	SPSuiteListIteratorRef
	An iterator object for examining a suite list.
Functions
SPAPI SPErr	SPAllocateSuiteList (SPStringPoolRef stringPool, SPPluginListRef plugins, SPSuiteListRef *suiteList)
	Internal.
SPAPI SPErr	SPFreeSuiteList (SPSuiteListRef suiteList)
	Internal.
SPAPI SPErr	SPAddSuite (SPSuiteListRef suiteList, SPPluginRef host, const char *name, ai::int32 apiVersion, ai::int32 internalVersion, const void *suiteProcs, SPSuiteRef *suite)
	Internal.
SPAPI SPErr	SPRemoveSuite (SPSuiteListRef suiteList, SPSuiteRef suite)
	Internal.
SPAPI SPErr	SPRemoveSuiteEx (SPSuiteListRef suiteList, const char *name, ai::int32 apiVersion, ai::int32 internalVersion)
	Internal.
SPAPI SPErr	SPAcquireSuite (SPSuiteListRef suiteList, const char *name, ai::int32 apiVersion, ai::int32 internalVersion, const void **suiteProcs)
	Internal.
SPAPI SPErr	SPReleaseSuite (SPSuiteListRef suiteList, const char *name, ai::int32 apiVersion, ai::int32 internalVersion)
	Internal.
SPAPI SPErr	SPFindSuite (SPSuiteListRef suiteList, const char *name, ai::int32 apiVersion, ai::int32 internalVersion, SPSuiteRef *suite)
	Internal.
SPAPI SPErr	SPNewSuiteListIterator (SPSuiteListRef suiteList, SPSuiteListIteratorRef *iter)
	Internal.
SPAPI SPErr	SPNextSuite (SPSuiteListIteratorRef iter, SPSuiteRef *suite)
	Internal.
SPAPI SPErr	SPDeleteSuiteListIterator (SPSuiteListIteratorRef iter)
	Internal.
SPAPI SPErr	SPGetSuiteHost (SPSuiteRef suite, SPPluginRef *plugin)
	Internal.
SPAPI SPErr	SPGetSuiteName (SPSuiteRef suite, const char **name)
	Internal.
SPAPI SPErr	SPGetSuiteAPIVersion (SPSuiteRef suite, ai::int32 *version)
	Internal.
SPAPI SPErr	SPGetSuiteInternalVersion (SPSuiteRef suite, ai::int32 *version)
	Internal.
SPAPI SPErr	SPGetSuiteProcs (SPSuiteRef suite, const void **suiteProcs)
	Internal.
SPAPI SPErr	SPGetSuiteAcquireCount (SPSuiteRef suite, ai::int32 *count)
	Internal.

---

Define Documentation

#define kAIAboutToLoadSuite   "About To Load SPSuite"

#define kSPLatestInternalVersion   0

Internal.

#define kSPRuntimeSuiteList   ((SPSuiteListRef)NULL)

PICA global list of available suites.

See also:

SPRuntimeSuite::GetRuntimeSuiteList().

#define kSPSuitesSuite   "SP Suites Suite"

PICA suite-management suite name.

#define kSPSuitesSuiteVersion   2

PICA suite-management suite version.

---

Typedef Documentation

typedef struct SPSuiteListIterator* SPSuiteListIteratorRef

An iterator object for examining a suite list.

See SPSuitesSuite::NewSuiteListIterator().

typedef struct SPSuiteList* SPSuiteListRef

A list of suite objects.

Create with SPSuitesSuite::AllocateSuiteList(), or use the global list, kSPRuntimeSuiteList.

typedef struct SPSuite* SPSuiteRef

Opaque reference to a suite object.

Access with the SPSuitesSuite.

---

Function Documentation

SPAPI SPErr SPAcquireSuite	(	SPSuiteListRef	suiteList,
		const char *	name,
		ai::int32	apiVersion,
		ai::int32	internalVersion,
		const void **	suiteProcs
	)

Internal.

SPAPI SPErr SPAddSuite	(	SPSuiteListRef	suiteList,
		SPPluginRef	host,
		const char *	name,
		ai::int32	apiVersion,
		ai::int32	internalVersion,
		const void *	suiteProcs,
		SPSuiteRef *	suite
	)

Internal.

SPAPI SPErr SPAllocateSuiteList	(	SPStringPoolRef	stringPool,
		SPPluginListRef	plugins,
		SPSuiteListRef *	suiteList
	)

Internal.

SPAPI SPErr SPDeleteSuiteListIterator

(

SPSuiteListIteratorRef

iter

)

Internal.

SPAPI SPErr SPFindSuite	(	SPSuiteListRef	suiteList,
		const char *	name,
		ai::int32	apiVersion,
		ai::int32	internalVersion,
		SPSuiteRef *	suite
	)

Internal.

SPAPI SPErr SPFreeSuiteList

(

SPSuiteListRef

suiteList

)

Internal.

SPAPI SPErr SPGetSuiteAcquireCount	(	SPSuiteRef	suite,
		ai::int32 *	count
	)

Internal.

SPAPI SPErr SPGetSuiteAPIVersion	(	SPSuiteRef	suite,
		ai::int32 *	version
	)

Internal.

SPAPI SPErr SPGetSuiteHost	(	SPSuiteRef	suite,
		SPPluginRef *	plugin
	)

Internal.

SPAPI SPErr SPGetSuiteInternalVersion	(	SPSuiteRef	suite,
		ai::int32 *	version
	)

Internal.

SPAPI SPErr SPGetSuiteName	(	SPSuiteRef	suite,
		const char **	name
	)

Internal.

SPAPI SPErr SPGetSuiteProcs	(	SPSuiteRef	suite,
		const void **	suiteProcs
	)

Internal.

SPAPI SPErr SPNewSuiteListIterator	(	SPSuiteListRef	suiteList,
		SPSuiteListIteratorRef *	iter
	)

Internal.

SPAPI SPErr SPNextSuite	(	SPSuiteListIteratorRef	iter,
		SPSuiteRef *	suite
	)

Internal.

SPAPI SPErr SPReleaseSuite	(	SPSuiteListRef	suiteList,
		const char *	name,
		ai::int32	apiVersion,
		ai::int32	internalVersion
	)

Internal.

SPAPI SPErr SPRemoveSuite	(	SPSuiteListRef	suiteList,
		SPSuiteRef	suite
	)

Internal.

SPAPI SPErr SPRemoveSuiteEx	(	SPSuiteListRef	suiteList,
		const char *	name,
		ai::int32	apiVersion,
		ai::int32	internalVersion
	)

Internal.