SPProps.h File Reference

#include "SPTypes.h"
#include "SPMData.h"
#include "SPPiPL.h"
#include "AIBasicTypes.h"
#include "SPHeaderBegin.h"
#include "SPErrorCodes.h"
#include "SPHeaderEnd.h"

Go to the source code of this file.

Classes
struct	SPPropertiesMessage
	Message passed with the kSPPropertiesCaller. More...
struct	SPPropertiesSuite
	Use these functions to create, access, and manage plug-in property lists associated with a specific plug-in. More...
Defines
#define	kSPPropertiesSuite   "SP Properties Suite"
	PICA properties suite name.
#define	kSPPropertiesSuiteVersion2   2
	PICA properties suite version.
#define	kSPPropertiesSuiteVersion   kSPPropertiesSuiteVersion2
	PICA properties suite version.
#define	kSPPropertiesSuiteVersion3   3
	PICA properties suite version.
#define	kSPPropertiesCaller   "SP Properties"
	PICA plug-in property operation; sent with SPPropertiesMessage.
#define	kSPPropertiesAcquireSelector   "Acquire"
	Acquire PICA plug-in properties; sent with SPPropertiesMessage.
#define	kSPPropertiesReleaseSelector   "Release"
	Release PICA plug-in properties; sent with SPPropertiesMessage.
Typedefs
typedef struct SPProperty *	SPPropertyRef
	An opaque reference to a plug-in property.
typedef struct SPPropertyList *	SPPropertyListRef
	An opaque reference to a plug-in property list.
typedef struct SPPropertyListIterator *	SPPropertyListIteratorRef
	An opaque reference to an iterator for a plug-in property list.
Functions
SPAPI SPErr	SPAllocatePropertyList (SPPropertyListRef *propertyList)
	Internal.
SPAPI SPErr	SPFreePropertyList (SPPropertyListRef propertyList)
	Internal.
SPAPI SPErr	SPAddProperties (SPPropertyListRef propertyList, PIPropertyList *pList, ai::int32 refCon, ai::int32 cacheable)
	Internal.
SPAPI SPErr	SPAddProperty (SPPropertyListRef propertyList, PIType vendorID, PIType propertyKey, ai::int32 propertyID, PIProperty *p, ai::int32 refCon, ai::int32 cacheable, SPPropertyRef *property)
	Internal.
SPAPI SPErr	SPFindProperty (SPPropertyListRef propertyList, PIType vendorID, PIType propertyKey, ai::int32 propertyID, SPPropertyRef *property)
	Internal.
SPAPI SPErr	SPNewPropertyListIterator (SPPropertyListRef propertyList, SPPropertyListIteratorRef *iter)
	Internal.
SPAPI SPErr	SPNextProperty (SPPropertyListIteratorRef iter, SPPropertyRef *property)
	Internal.
SPAPI SPErr	SPDeletePropertyListIterator (SPPropertyListIteratorRef iter)
	Internal.
SPAPI SPErr	SPGetPropertyPIProperty (SPPropertyRef property, PIProperty **p)
	Internal.
SPAPI SPErr	SPGetPropertyRefCon (SPPropertyRef property, ai::int32 *refCon)
	Internal.
SPAPI SPErr	SPGetPropertyCacheable (SPPropertyRef property, ai::int32 *cacheable)
	Internal.
SPAPI SPErr	SPGetPropertyAllocatedByPlugin (SPPropertyRef property, ai::int32 *allocatedByPlugin)
	Internal.
SPAPI SPBoolean	SPHasMultiplePropertyLists (SPPropertyListRef propertyList)
	Internal.
SPAPI SPErr	SPGetNextPropertyList (SPPropertyListRef propertyList, SPPropertyListRef *nextPropertyList)
	Internal.
SPAPI SPErr	SPFindPropertyLocal (SPPropertyListRef propertyList, PIType vendorID, PIType propertyKey, ai::int32 propertyID, SPPropertyRef *property)
	Internal.

---

Define Documentation

#define kSPPropertiesSuite   "SP Properties Suite"

PICA properties suite name.

#define kSPPropertiesSuiteVersion   kSPPropertiesSuiteVersion2

PICA properties suite version.

#define kSPPropertiesSuiteVersion2   2

PICA properties suite version.

#define kSPPropertiesSuiteVersion3   3

PICA properties suite version.

---

Typedef Documentation

typedef struct SPPropertyListIterator* SPPropertyListIteratorRef

An opaque reference to an iterator for a plug-in property list.

Create and access with the SPPropertiesSuite.

typedef struct SPPropertyList* SPPropertyListRef

An opaque reference to a plug-in property list.

Create and access with the SPPropertiesSuite.

typedef struct SPProperty* SPPropertyRef

An opaque reference to a plug-in property.

Access with the SPPropertiesSuite.

---

Function Documentation

SPAPI SPErr SPAddProperties	(	SPPropertyListRef	propertyList,
		PIPropertyList *	pList,
		ai::int32	refCon,
		ai::int32	cacheable
	)

Internal.

SPAPI SPErr SPAddProperty	(	SPPropertyListRef	propertyList,
		PIType	vendorID,
		PIType	propertyKey,
		ai::int32	propertyID,
		PIProperty *	p,
		ai::int32	refCon,
		ai::int32	cacheable,
		SPPropertyRef *	property
	)

Internal.

SPAPI SPErr SPAllocatePropertyList

(

SPPropertyListRef *

propertyList

)

Internal.

SPAPI SPErr SPDeletePropertyListIterator

(

SPPropertyListIteratorRef

iter

)

Internal.

SPAPI SPErr SPFindProperty	(	SPPropertyListRef	propertyList,
		PIType	vendorID,
		PIType	propertyKey,
		ai::int32	propertyID,
		SPPropertyRef *	property
	)

Internal.

SPAPI SPErr SPFindPropertyLocal	(	SPPropertyListRef	propertyList,
		PIType	vendorID,
		PIType	propertyKey,
		ai::int32	propertyID,
		SPPropertyRef *	property
	)

Internal.

SPAPI SPErr SPFreePropertyList

(

SPPropertyListRef

propertyList

)

Internal.

SPAPI SPErr SPGetNextPropertyList	(	SPPropertyListRef	propertyList,
		SPPropertyListRef *	nextPropertyList
	)

Internal.

SPAPI SPErr SPGetPropertyAllocatedByPlugin	(	SPPropertyRef	property,
		ai::int32 *	allocatedByPlugin
	)

Internal.

SPAPI SPErr SPGetPropertyCacheable	(	SPPropertyRef	property,
		ai::int32 *	cacheable
	)

Internal.

SPAPI SPErr SPGetPropertyPIProperty	(	SPPropertyRef	property,
		PIProperty **	p
	)

Internal.

SPAPI SPErr SPGetPropertyRefCon	(	SPPropertyRef	property,
		ai::int32 *	refCon
	)

Internal.

SPAPI SPBoolean SPHasMultiplePropertyLists

(

SPPropertyListRef

propertyList

)

Internal.

SPAPI SPErr SPNewPropertyListIterator	(	SPPropertyListRef	propertyList,
		SPPropertyListIteratorRef *	iter
	)

Internal.

SPAPI SPErr SPNextProperty	(	SPPropertyListIteratorRef	iter,
		SPPropertyRef *	property
	)

Internal.