InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IBlackBoxCmdData Class Referenceabstract

#include <IBlackBoxCmdData.h>

Inheritance diagram for IBlackBoxCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IBLACKBOXCMDDATA }
 

Public Member Functions

virtual void Set (const UIDRef &obj, BlackBoxKey clsID, void *buffer=nil, int32 length=0)=0
 
virtual void Set (const XMLReference &obj, BlackBoxKey clsID, void *buffer=nil, int32 length=0)=0
 
virtual IBlackBoxDataQueryTarget () const =0
 
virtual BlackBoxKey GetKey () const =0
 
virtual void * GetBuffer () const =0
 
virtual int32 GetLength () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Data interface for Black Box Commands. Normally you should go through IBlackBoxCommands.

See Also
IBlackBoxCommands

Member Function Documentation

virtual void* IBlackBoxCmdData::GetBuffer () const
pure virtual

Return the buffer to hold the data

Returns
the buffer containing the data
virtual BlackBoxKey IBlackBoxCmdData::GetKey () const
pure virtual

Return the key the data is stored under

Returns
the key the data is stored under
virtual int32 IBlackBoxCmdData::GetLength () const
pure virtual

Return the length of the data in the buffer

Returns
the length of the data in the buffer
virtual IBlackBoxData* IBlackBoxCmdData::QueryTarget () const
pure virtual

Return the object data is applied to

Returns
IBlackBoxData * pointer to the instantiated object
virtual void IBlackBoxCmdData::Set (const UIDRefobj,
BlackBoxKey clsID,
void * buffer = nil,
int32 length = 0 
)
pure virtual

Set the value of the data. Applies to UID-based elements.

Parameters
obj- object where the data is applied
clsID- key the data is stored under
buffer- buffer to hold the data
length- length of the data in the buffer
virtual void IBlackBoxCmdData::Set (const XMLReferenceobj,
BlackBoxKey clsID,
void * buffer = nil,
int32 length = 0 
)
pure virtual

Set the value of the data. Applies to XML Elements.

Parameters
obj- object where the data is applied
clsID- key the data is stored under
buffer- buffer to hold the data
length- length of the data in the buffer