AILiveEffectIsCompatibleMessage Struct Reference

Sent when saving a file to allow the live effect to make a detailed check for legacy compatibility. More...

#include <AILiveEffect.h>

List of all members.

Public Member Functions
	AILiveEffectIsCompatibleMessage (AILiveEffectHandle thisEffect=0, AIVersion version=kAIVersion1, ConstAILiveEffectParameters params=0, AIBoolean compat=false)
Public Attributes
SPMessageData	d
	The message data.
AILiveEffectHandle	effect
	The effect object.
AIVersion	appVersion
	Application version to check compatibility against.
ConstAILiveEffectParameters	parameters
	The current parameter block for the effect.
AIBoolean	compatible
	[out] Set to true if compatible with appVersion, false otherwise.

---

Detailed Description

Sent when saving a file to allow the live effect to make a detailed check for legacy compatibility.

This message is only sent if the kHandlesIsCompatibleMsg flag is set. If the flag is not set version compatibility is checked against values provided by SetLiveEffectAppVersion. The recipient must set the 'compatible' member below indicate version compatibility.

---

Constructor & Destructor Documentation

AILiveEffectIsCompatibleMessage::AILiveEffectIsCompatibleMessage	(	AILiveEffectHandle	thisEffect = 0,
		AIVersion	version = kAIVersion1,
		ConstAILiveEffectParameters	params = 0,
		AIBoolean	compat = false
	)			[inline, explicit]

---

Member Data Documentation

AIVersion AILiveEffectIsCompatibleMessage::appVersion

Application version to check compatibility against.

AIBoolean AILiveEffectIsCompatibleMessage::compatible

[out] Set to true if compatible with appVersion, false otherwise.

SPMessageData AILiveEffectIsCompatibleMessage::d

The message data.

AILiveEffectHandle AILiveEffectIsCompatibleMessage::effect

The effect object.

ConstAILiveEffectParameters AILiveEffectIsCompatibleMessage::parameters

The current parameter block for the effect.

---

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

• AILiveEffect.h