SPAdaptersMessage Struct Reference

The message passed with all kSPAdaptersCaller calls. More...

#include <SPAdapts.h>

List of all members.

Public Attributes
SPMessageData	d
	The message data.
SPAdapterRef	adapter
	The adapter object.
struct SPPlugin *	targetPlugin
	For kSPAdaptersAboutSelector, kSPAdaptersLoadPluginSelector, kSPAdaptersReleasePluginSelector, kSPAdaptersSendMessageSelector, kSPAdaptersFindPropertySelector, the plug-in object which to act upon (display information, load, release, send a message to, or find properties for).
SPErr	targetResult
	For all selectors, the target result of the handler, if any.
PIType	vendorID
	For kSPAdaptersFindPropertySelector.
PIType	propertyKey
	For kSPAdaptersFindPropertySelector.
ai::int32	propertyID
	For kSPAdaptersFindPropertySelector.
void *	property
	For kSPAdaptersFindPropertySelector.
SPFlushCachesProc	flushProc
	For kSPAdaptersFlushSelector.
ai::int32	flushed
	For kSPAdaptersFlushSelector.
struct SPSuiteList *	suiteList
	For kSPAdaptersAcquireSuiteHostSelector and kSPAdaptersReleaseSuiteHostSelector.
struct SPSuite *	suite
	For kSPAdaptersAcquireSuiteHostSelector and kSPAdaptersReleaseSuiteHostSelector.
struct SPPlugin *	host
	For kSPAdaptersAcquireSuiteHostSelector and kSPAdaptersReleaseSuiteHostSelector.
const void *	suiteProcs
	For kSPAdaptersAcquireSuiteHostSelector and kSPAdaptersReleaseSuiteHostSelector.
ai::int32	acquired
	For kSPAdaptersAcquireSuiteHostSelector and kSPAdaptersReleaseSuiteHostSelector.
const char *	plugin_caller
	For kSPAdaptersSendMessageSelector.
const char *	plugin_selector
	For kSPAdaptersSendMessageSelector.
void *	plugin_message
	For kSPAdaptersSendMessageSelector.

---

Detailed Description

The message passed with all kSPAdaptersCaller calls.

Fields are used by specific selectors as indicated.

---

Member Data Documentation

ai::int32 SPAdaptersMessage::acquired

For kSPAdaptersAcquireSuiteHostSelector and kSPAdaptersReleaseSuiteHostSelector.

No longer used.

SPAdapterRef SPAdaptersMessage::adapter

The adapter object.

All selectors. If you add more than one adapter for a plug-in, use this to determine which handler to use.

SPMessageData SPAdaptersMessage::d

The message data.

All selectors.

ai::int32 SPAdaptersMessage::flushed

For kSPAdaptersFlushSelector.

Return the result of the flush procedure, the number of plug-ins removed.

SPFlushCachesProc SPAdaptersMessage::flushProc

For kSPAdaptersFlushSelector.

The procedure with which to flush caches, passed from the call to SPCachesSuite::SPFlushCaches(). The adapter should call this to determine which plug-ins are being removed from memory, and unload them.

struct SPPlugin* SPAdaptersMessage::host [read]

For kSPAdaptersAcquireSuiteHostSelector and kSPAdaptersReleaseSuiteHostSelector.

No longer used.

const char* SPAdaptersMessage::plugin_caller

For kSPAdaptersSendMessageSelector.

The caller to pass to the adapted plug-in.

void* SPAdaptersMessage::plugin_message

For kSPAdaptersSendMessageSelector.

The message to pass to the adapted plug-in.

const char* SPAdaptersMessage::plugin_selector

For kSPAdaptersSendMessageSelector.

The selector to pass to the adapted plug-in.

void* SPAdaptersMessage::property

For kSPAdaptersFindPropertySelector.

No longer used.

ai::int32 SPAdaptersMessage::propertyID

For kSPAdaptersFindPropertySelector.

No longer used.

PIType SPAdaptersMessage::propertyKey

For kSPAdaptersFindPropertySelector.

No longer used.

struct SPSuite* SPAdaptersMessage::suite [read]

For kSPAdaptersAcquireSuiteHostSelector and kSPAdaptersReleaseSuiteHostSelector.

No longer used.

struct SPSuiteList* SPAdaptersMessage::suiteList [read]

For kSPAdaptersAcquireSuiteHostSelector and kSPAdaptersReleaseSuiteHostSelector.

No longer used.

const void* SPAdaptersMessage::suiteProcs

For kSPAdaptersAcquireSuiteHostSelector and kSPAdaptersReleaseSuiteHostSelector.

No longer used.

struct SPPlugin* SPAdaptersMessage::targetPlugin [read]

For kSPAdaptersAboutSelector, kSPAdaptersLoadPluginSelector, kSPAdaptersReleasePluginSelector, kSPAdaptersSendMessageSelector, kSPAdaptersFindPropertySelector, the plug-in object which to act upon (display information, load, release, send a message to, or find properties for).

SPErr SPAdaptersMessage::targetResult

For all selectors, the target result of the handler, if any.

PIType SPAdaptersMessage::vendorID

For kSPAdaptersFindPropertySelector.

No longer used.

---

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

• SPAdapts.h