AIPluginSuite Struct Reference
[API Suite List]

These functions access Illustrator-specific plug-in options, and allow Illustrator plug-ins to send messages to one another. More...

#include <AIPlugin.h>

List of all members.

Public Attributes
AIAPI AIErr(*	GetPluginOptions )(SPPluginRef plugin, ai::int32 *options)
	Retrieves the Illustrator-specific options for a plug-in.
AIAPI AIErr(*	SetPluginOptions )(SPPluginRef plugin, ai::int32 options)
	Sets the Illustrator-specific options for a plug-in.
AIAPI AIErr(*	SetupPluginData )(SPPluginRef plugin, void *data)
	Sets up data for sending a message to another plug-in.
AIAPI AIErr(*	CallPlugin )(SPPluginRef plugin, const char *selector, void *message)
	Sends a message to the main entry point of another Illustrator plug-in.
AIAPI AIErr(*	EmptyPluginData )(SPPluginRef plugin, void *data)
	Ensures that the destination plug-in's global data (as sent in SPMessageData::globals) is properly stored back into the plug-in that modified it when responding to the message.

---

Detailed Description

These functions access Illustrator-specific plug-in options, and allow Illustrator plug-ins to send messages to one another.

Note:

The original version of this suite, version 2, has been largely replaced by the PICA SPPluginsSuite, a core suite available to other Adobe applications. Use that suite to access the plug-in list, identify their type and location, and so on. Similarly, it is better to use the PICA SPInterfaceSuite to send messages.

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIPluginSuite and kAIPluginSuiteVersion.

---

Member Data Documentation

AIAPI AIErr(* AIPluginSuite::CallPlugin)(SPPluginRef plugin, const char *selector, void *message)

Sends a message to the main entry point of another Illustrator plug-in.

For example:

// The plug-in reference for the plug-in to call.
SPPluginRef somePlugin;
// A plug-in message structure, contains an SPMessageData as first member.
AISomePluginMessage message;

// fill out the message structure
error = sAIPluginSetupPluginData(somePlugin, &message.d);
// send the message to the plug-in
if (!error)
        error = sAIPluginCallPlugin(somePlugin, kSomePluginSelector, &message );
// release the message data memory.
if (!error)
        error = sAIPluginEmptyPluginData(somePlugin, &message.d);

Parameters:

	plugin	The destination plug-in.
	selector	The selector for the destination plug-in, see Plug-in Selectors.
	message	The message, of the type suitable for the selector.

Note:

It is recommended that you use the newer PICA SPInterfaceSuite to send messages.

AIAPI AIErr(* AIPluginSuite::EmptyPluginData)(SPPluginRef plugin, void *data)

Ensures that the destination plug-in's global data (as sent in SPMessageData::globals) is properly stored back into the plug-in that modified it when responding to the message.

Parameters:

	plugin	The destination plug-in.
	data	A pointer to the message data.

Note:

It is recommended that you use the newer PICA SPInterfaceSuite to send messages.

AIAPI AIErr(* AIPluginSuite::GetPluginOptions)(SPPluginRef plugin, ai::int32 *options)

Retrieves the Illustrator-specific options for a plug-in.

Parameters:

	plugin	The plug-in reference.
	options	[out] A buffer in which to return the options, an AIPluginOptions value.

AIAPI AIErr(* AIPluginSuite::SetPluginOptions)(SPPluginRef plugin, ai::int32 options)

Sets the Illustrator-specific options for a plug-in.

Parameters:

	plugin	The plug-in reference.
	options	The new options, an AIPluginOptions value.

AIAPI AIErr(* AIPluginSuite::SetupPluginData)(SPPluginRef plugin, void *data)

Sets up data for sending a message to another plug-in.

Parameters:

	plug-in	The destination plug-in.
	data	A pointer to the message data.

See also:

CallPlugin()

---

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

• AIPlugin.h