SPInterfaceSuite Struct Reference
[API Suite List]

This suite provides is the ability for a plug-in to call other plug-ins, by sending a message to the main entry point. More...

#include <SPInterf.h>

List of all members.

Public Attributes
SPAPI SPErr(*	SendMessage )(SPPluginRef plugin, const char *caller, const char *selector, void *message, SPErr *result)
	Sends a message to a PICA plug-in, loading it if needed and passing the caller, selector, and message to the main entry point.
SPAPI SPErr(*	SetupMessageData )(SPPluginRef plugin, SPMessageData *data)
	Initializes a message to be sent with SendMessage().
SPAPI SPErr(*	EmptyMessageData )(SPPluginRef plugin, SPMessageData *data)
	Terminates a call to another plug-in, releasing the basic suite and updating the target plug-in's globals pointer, in case it has changed.
SPAPI SPErr(*	StartupExport )(SPPluginListRef pluginList, const char *name, ai::int32 version, ai::int32 *started)
	Starts up the plug-in in a plug-in list that exports a given suite.

---

Detailed Description

This suite provides is the ability for a plug-in to call other plug-ins, by sending a message to the main entry point.

This is how the application communicates with plug-ins.

Use SetupMessageData() to prepare the message for a call, SendMessage() to send the call with the message, and EmptyMessageData() to terminate the operation, allowing PICA to release the basic suite and store global variables.

These calls work only with PICA plug-ins. Before making the calls, use SPAdaptersSuite::GetAdapterName() to determine that the target is a PICA plug-in. For non-PICA plug-ins, use the interface suite provided by the adapter. See SPAdaptersSuite.

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kSPInterfaceSuite and kSPInterfaceSuiteVersion.

---

Member Data Documentation

SPAPI SPErr(* SPInterfaceSuite::EmptyMessageData)(SPPluginRef plugin, SPMessageData *data)

Terminates a call to another plug-in, releasing the basic suite and updating the target plug-in's globals pointer, in case it has changed.

Use after a call to SendMessage().

Parameters:

	plugin	The target plug-in object.
	data	The message structure, updated during the call.

SPAPI SPErr(* SPInterfaceSuite::SendMessage)(SPPluginRef plugin, const char *caller, const char *selector, void *message, SPErr *result)

Sends a message to a PICA plug-in, loading it if needed and passing the caller, selector, and message to the main entry point.

Parameters:

	plug-in	The target plug-in object.
	caller	The caller constant. See Plug-in Callers.
	selector	The selector constant. See Plug-in Selectors.
	message	The message, initialized by SetupMessageData().
	result	[out] A buffer in which to return the result of the call, as returned by the target plug-in.

SPAPI SPErr(* SPInterfaceSuite::SetupMessageData)(SPPluginRef plugin, SPMessageData *data)

Initializes a message to be sent with SendMessage().

The function fills in the basic suite, the plug-in reference, and the globals pointer that PICA keeps for that plug-in. You must provide any additional data needed.

Parameters:

	plugin	The target plug-in object.
	data	The message structure, initialized with data required for the intended call.

SPAPI SPErr(* SPInterfaceSuite::StartupExport)(SPPluginListRef pluginList, const char *name, ai::int32 version, ai::int32 *started)

Starts up the plug-in in a plug-in list that exports a given suite.

Searches in the given plug-in list for the plug-in that exports the named suite, and, if found, sends it the startup message.

Parameters:

	pluginList	The plug-in list object. Access PICA's global plug-in list using SPRuntimeSuite::GetRuntimePluginList(), or create your own lists with SPPluginsSuite::AllocatePluginList().
	name	The suite name constant.
	version	The suite version number constant.
	started	[out] A buffer in which to return true (non-zero) if a plug-in that exports the suite was found, false (0) if not.

---

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

• SPInterf.h