AIFileFormatMessage Struct Reference

Message data sent by the file format selectors. More...

#include <AIFileFormat.h>

List of all members.

Public Member Functions
void	SetFilePath (const ai::FilePath &fp)
	Use this function to set the file path of the file to read, write, or check (allows for deprecated file spec type).
const ai::FilePath &	GetFilePath () const
	Use this function to retrieve the file path of the file to read, write, or check (allows for deprecated file spec type).
	AIFileFormatMessage ()
Public Attributes
SPMessageData	d
	The message data.
AIFileFormatHandle	fileFormat
	The file format for which the message is intended.
ai::int32	option
	The requested operation (such as read or write).
FileFormatExtData *	m_pExtData
	Additional information required for specific operation (currently for placement and export).
void *	actionParm
	A pointer to additional parameter data, if kFileFormatContainsPartialParameters is set in the option field.
ai::int32	operationOptions
	Requested save/export file types.
AIArtboardRangeHandle	rangeHandle
	Handle of the artboard range specified by the user.

---

Detailed Description

Message data sent by the file format selectors.

---

Constructor & Destructor Documentation

AIFileFormatMessage::AIFileFormatMessage

(

)

[inline]

---

Member Function Documentation

const ai::FilePath & AIFileFormatMessage::GetFilePath

(

)

const [inline]

Use this function to retrieve the file path of the file to read, write, or check (allows for deprecated file spec type).

void AIFileFormatMessage::SetFilePath

(

const ai::FilePath &

fp

)

[inline]

Use this function to set the file path of the file to read, write, or check (allows for deprecated file spec type).

---

Member Data Documentation

void* AIFileFormatMessage::actionParm

A pointer to additional parameter data, if kFileFormatContainsPartialParameters is set in the option field.

SPMessageData AIFileFormatMessage::d

The message data.

AIFileFormatHandle AIFileFormatMessage::fileFormat

The file format for which the message is intended.

If your plug-in handles more than one type, compare to the format handle returned when the format was added.

FileFormatExtData* AIFileFormatMessage::m_pExtData

Additional information required for specific operation (currently for placement and export).

Used if the plug-in registered the format as handling extended data (kFileFormatHasExtendedData)

ai::int32 AIFileFormatMessage::operationOptions

Requested save/export file types.

Values # AIFFExtendedOptions

ai::int32 AIFileFormatMessage::option

The requested operation (such as read or write).

A logical OR of AIFileFormatOptions values.

AIArtboardRangeHandle AIFileFormatMessage::rangeHandle

Handle of the artboard range specified by the user.

---

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

• AIFileFormat.h