IBlackBoxCommands Class Reference

#include <IBlackBoxCommands.h>

Inheritance diagram for IBlackBoxCommands:

Public Types
enum	{ kDefaultIID = IID_IBLACKBOXCOMMANDS }

Public Member Functions
virtual ErrorCode	AddData (const UIDRef &obj, BlackBoxKey key, void *buffer, int32 length)=0
virtual ErrorCode	AddData (const XMLReference &obj, BlackBoxKey key, void *buffer, int32 length)=0
virtual ErrorCode	RemoveData (const UIDRef &obj, BlackBoxKey key)=0
virtual ErrorCode	RemoveData (const XMLReference &obj, BlackBoxKey key)=0
virtual int32	GetData (const UIDRef &obj, BlackBoxKey key, void *buffer, int32 amountToRead)=0
virtual int32	GetData (const XMLReference &obj, BlackBoxKey key, void *buffer, int32 amountToRead)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

This is an interface to a container for generic data. Use this interface if you want to attach data to an InDesign document, but you want complete control and responsibility over how the data is managed.

Member Function Documentation

virtual ErrorCode IBlackBoxCommands::AddData ( const UIDRef &  obj, BlackBoxKey  key, void *  buffer, int32  length  )

pure virtual

Processes a command to add data to a UID-based object's black box.

Parameters

obj	specify which object gets the data
key	what key the data will be stored under for later refetch
buffer	buffer containing the data to write
length	number of bytes to write

Returns

ErrorCode kSuccess or failure code if operation is unsuccessful

virtual ErrorCode IBlackBoxCommands::AddData ( const XMLReference &  obj, BlackBoxKey  key, void *  buffer, int32  length  )

pure virtual

Processes a command to add data to an XML element's black box.

Parameters

obj	specify which object gets the data
key	what key the data will be stored under for later refetch
buffer	buffer containing the data to write
length	number of bytes to write

Returns

ErrorCode kSuccess or failure code if operation is unsuccessful

virtual int32 IBlackBoxCommands::GetData ( const UIDRef &  obj, BlackBoxKey  key, void *  buffer, int32  amountToRead  )

pure virtual

Processes a command to retrieve data from the UID-based object's black box.

Parameters

obj	specify which object to get
key	what key the data was be stored under originally
buffer	OUT buffer where the data will be put
amountToRead	maximum amount to read

Returns

int32 number of bytes in output buffer

virtual int32 IBlackBoxCommands::GetData ( const XMLReference &  obj, BlackBoxKey  key, void *  buffer, int32  amountToRead  )

pure virtual

Processes a command to retrieve data from the XML element's black box.

Parameters

obj	specify which object to get
key	what key the data was be stored under originally
buffer	OUT buffer where the data will be put
amountToRead	maximum amount to read

Returns

int32 number of bytes in output buffer

virtual ErrorCode IBlackBoxCommands::RemoveData ( const UIDRef &  obj, BlackBoxKey  key  )

pure virtual

Processes a command to remove data from the UID-based object's black box.

Parameters

obj	specify which object to remove from
key	what key the data was be stored under originally

Returns

ErrorCode kSuccess or failure code if operation is unsuccessful

virtual ErrorCode IBlackBoxCommands::RemoveData ( const XMLReference &  obj, BlackBoxKey  key  )

pure virtual

Processes a command to remove data from an XML element's black box.

Parameters

obj	specify which object to remove from
key	what key the data was be stored under originally

Returns

ErrorCode kSuccess or failure code if operation is unsuccessful