Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CP_AE_Record Class Reference
[AppleEvents]

The CP_AE_Record class is a MacOS only class to deal with Apple Event records, and is a subclass of CP_AE_List. More...

Inheritance diagram for CP_AE_Record:

CP_AE_List CP_AE_Descriptor List of all members.

Public Member Functions

 operator AEDesc * ()
 operator const AEDesc * () const
 operator AEDesc & ()
 operator const AEDesc & () const
void swap (CP_AE_Descriptor &inOutDescriptor) throw ()
Creation
void Dispose ()
void CreateDescriptor (const DescType inTypeCode, const Ptr inData, const Size inLength)
void MakeNULL ()
Coercion
OSErr AttemptCoercion (DescType typeToCoerceTo)
void CoerceInPlace (DescType typeToCoerceTo)
CP_AE_Descriptor Coerce (DescType typeToCoerceTo) const
void CoerceToStandardType ()
Copiers
void CopyDesc (const CP_AE_Descriptor &desc)
Getters
DescType DescriptorType () const
Handle GetData ()
void GetDescriptor (const AEDesc &inDesc, AEKeyword inKey, DescType inDesiredType=typeWildCard)
OSErr GetOptionalDescriptor (const AEDesc &inDesc, AEKeyword inKey, DescType inDesiredType=typeWildCard)
void GetNthPtr (SInt32 inIndex, DescType inDesiredType, AEKeyword *inAEKeyword, DescType *inTypeCode, void *inDataPtr, Size inMaximumSize, Size *inOutActualSize)
void GetBlock (Ptr inData, Size inLength, DescType inDesiredType) const
SInt16 GetSInt16 () const
SInt32 GetSInt32 () const
bool GetBoolean () const
DescType GetDescType () const
AEKeyword GetKeyword () const
DescType GetEnumeration () const
DescType GetOrdinal () const
CP_Point GetPoint () const
CP_Rect GetRect () const
void GetPString (Str255 result) const
CP_String GetString () const
CP_FileSystemSpec GetFileSpec () const
SInt32 GetItemCount ()
OSErr GetNthItem (SInt32 inItemIndex, DescType *inOutDescType, CP_AE_Descriptor *inOutItem)
Setters
void CopyData (const DescType inTypeCode, const Ptr inData, const Size inLength)
void MakeBoolean (const Boolean inData)
void MakeBoolean (const bool inData)
void MakeSInt16 (const SInt16 inData)
void MakeSInt32 (const SInt32 inData)
void MakeUInt32 (const UInt32 inData)
void MakePoint (const CP_Point &inPoint)
void MakeRect (const CP_Rect &inRect)
void MakeString (Str255 inData)
void MakeString (const CP_String inData)
void MakeFileSpec (const FSSpec &spec)
void MakeFileSpec (const CP_FileSystemSpec &inFileSpec)
void AdoptAlias (Handle inAlias)
void MakeAlias (const CP_FileSystemSpec &inFileSpec)
void MakeProcessSerialNumber (ProcessSerialNumber inPSN)
void MakeObjectSpecifier (DescType inDesiredClass, CP_AE_Descriptor inContainer, DescType inKeyForm, CP_AE_Descriptor inKeyData, bool inDisposeInputs)
void MakeCompDescriptor (DescType inComparisonOperator, DescType inPropertyIdentifier, CP_AE_Descriptor inCompareWith, bool inDisposeInputs)
void MakeEnumeration (const DescType inEnumeration)
void MakeDescType (const DescType inData)
void MakeKeyword (const AEKeyword inKeyword)
void MakeOrdinal (const DescType inData)
void MakeTypeOrInteger (const DescType inData)
void AdoptHandle (DescType inDataType, Handle inDataHandle)
void AdoptDesc (const AEDesc &inDescriptor)
NULL Descriptor
bool IsNullDescriptor () const
bool IsNullDataHandle () const
Creation
void Dispose ()
void CreateDescriptor (const DescType inTypeCode, const Ptr inData, const Size inLength)
void MakeNULL ()
Coercion
OSErr AttemptCoercion (DescType typeToCoerceTo)
void CoerceInPlace (DescType typeToCoerceTo)
CP_AE_Descriptor Coerce (DescType typeToCoerceTo) const
void CoerceToStandardType ()
Getters
DescType DescriptorType () const
Handle GetData ()
void GetDescriptor (const AEDesc &inDesc, AEKeyword inKey, DescType inDesiredType=typeWildCard)
OSErr GetOptionalDescriptor (const AEDesc &inDesc, AEKeyword inKey, DescType inDesiredType=typeWildCard)
void GetNthPtr (SInt32 inIndex, DescType inDesiredType, AEKeyword *inAEKeyword, DescType *inTypeCode, void *inDataPtr, Size inMaximumSize, Size *inOutActualSize)
void GetBlock (Ptr inData, Size inLength, DescType inDesiredType) const
SInt16 GetSInt16 () const
SInt32 GetSInt32 () const
bool GetBoolean () const
DescType GetDescType () const
AEKeyword GetKeyword () const
DescType GetEnumeration () const
DescType GetOrdinal () const
CP_Point GetPoint () const
CP_Rect GetRect () const
void GetPString (Str255 result) const
CP_String GetString () const
CP_FileSystemSpec GetFileSpec () const
SInt32 GetItemCount ()
OSErr GetNthItem (SInt32 inItemIndex, DescType *inOutDescType, CP_AE_Descriptor *inOutItem)
Setters
void CopyData (const DescType inTypeCode, const Ptr inData, const Size inLength)
void MakeBoolean (const Boolean inData)
void MakeBoolean (const bool inData)
void MakeSInt16 (const SInt16 inData)
void MakeSInt32 (const SInt32 inData)
void MakeUInt32 (const UInt32 inData)
void MakePoint (const CP_Point &inPoint)
void MakeRect (const CP_Rect &inRect)
void MakeString (Str255 inData)
void MakeString (const CP_String inData)
void MakeFileSpec (const FSSpec &spec)
void MakeFileSpec (const CP_FileSystemSpec &inFileSpec)
void AdoptAlias (Handle inAlias)
void MakeAlias (const CP_FileSystemSpec &inFileSpec)
void MakeProcessSerialNumber (ProcessSerialNumber inPSN)
void MakeObjectSpecifier (DescType inDesiredClass, CP_AE_Descriptor inContainer, DescType inKeyForm, CP_AE_Descriptor inKeyData, bool inDisposeInputs)
void MakeCompDescriptor (DescType inComparisonOperator, DescType inPropertyIdentifier, CP_AE_Descriptor inCompareWith, bool inDisposeInputs)
void MakeEnumeration (const DescType inEnumeration)
void MakeDescType (const DescType inData)
void MakeKeyword (const AEKeyword inKeyword)
void MakeOrdinal (const DescType inData)
void MakeTypeOrInteger (const DescType inData)
void AdoptHandle (DescType inDataType, Handle inDataHandle)
void AdoptDesc (const AEDesc &inDescriptor)
NULL Descriptor
bool IsNullDescriptor () const
bool IsNullDataHandle () const
List Items
SInt32 CountItems () const
void MakeEmptyList ()
void MakeList ()
void CreateList (Boolean isRecord=false, Ptr inFactoringPtr=NULL, Size inFactoredSize=0)
CP_AE_Descriptor GetNthDescriptor (SInt32 inIndex, DescType inDesiredType, AEKeyword *inKey) const
Item Data
void AddDescriptor (SInt32 inIndex, AEDesc &inData)
void AddDescriptor (AEDesc &inData)
void AddData (SInt32 inIndex, DescType inDescType, Ptr inData, Size inLength)
void AddData (DescType inDescType, Ptr inData, Size inLength)
void AddLong (SInt32 inLong)
void AddType (DescType inDescType)
Creation
void Dispose ()
void CreateDescriptor (const DescType inTypeCode, const Ptr inData, const Size inLength)
void MakeNULL ()
Coercion
OSErr AttemptCoercion (DescType typeToCoerceTo)
void CoerceInPlace (DescType typeToCoerceTo)
CP_AE_Descriptor Coerce (DescType typeToCoerceTo) const
void CoerceToStandardType ()
Copiers
void CopyDesc (const CP_AE_Descriptor &desc)
Getters
DescType DescriptorType () const
Handle GetData ()
void GetDescriptor (const AEDesc &inDesc, AEKeyword inKey, DescType inDesiredType=typeWildCard)
OSErr GetOptionalDescriptor (const AEDesc &inDesc, AEKeyword inKey, DescType inDesiredType=typeWildCard)
void GetNthPtr (SInt32 inIndex, DescType inDesiredType, AEKeyword *inAEKeyword, DescType *inTypeCode, void *inDataPtr, Size inMaximumSize, Size *inOutActualSize)
void GetBlock (Ptr inData, Size inLength, DescType inDesiredType) const
SInt16 GetSInt16 () const
SInt32 GetSInt32 () const
bool GetBoolean () const
DescType GetDescType () const
AEKeyword GetKeyword () const
DescType GetEnumeration () const
DescType GetOrdinal () const
CP_Point GetPoint () const
CP_Rect GetRect () const
void GetPString (Str255 result) const
CP_String GetString () const
CP_FileSystemSpec GetFileSpec () const
SInt32 GetItemCount ()
OSErr GetNthItem (SInt32 inItemIndex, DescType *inOutDescType, CP_AE_Descriptor *inOutItem)
Setters
void CopyData (const DescType inTypeCode, const Ptr inData, const Size inLength)
void MakeBoolean (const Boolean inData)
void MakeBoolean (const bool inData)
void MakeSInt16 (const SInt16 inData)
void MakeSInt32 (const SInt32 inData)
void MakeUInt32 (const UInt32 inData)
void MakePoint (const CP_Point &inPoint)
void MakeRect (const CP_Rect &inRect)
void MakeString (Str255 inData)
void MakeString (const CP_String inData)
void MakeFileSpec (const FSSpec &spec)
void MakeFileSpec (const CP_FileSystemSpec &inFileSpec)
void AdoptAlias (Handle inAlias)
void MakeAlias (const CP_FileSystemSpec &inFileSpec)
void MakeProcessSerialNumber (ProcessSerialNumber inPSN)
void MakeObjectSpecifier (DescType inDesiredClass, CP_AE_Descriptor inContainer, DescType inKeyForm, CP_AE_Descriptor inKeyData, bool inDisposeInputs)
void MakeCompDescriptor (DescType inComparisonOperator, DescType inPropertyIdentifier, CP_AE_Descriptor inCompareWith, bool inDisposeInputs)
void MakeEnumeration (const DescType inEnumeration)
void MakeDescType (const DescType inData)
void MakeKeyword (const AEKeyword inKeyword)
void MakeOrdinal (const DescType inData)
void MakeTypeOrInteger (const DescType inData)
void AdoptHandle (DescType inDataType, Handle inDataHandle)
void AdoptDesc (const AEDesc &inDescriptor)
NULL Descriptor
bool IsNullDescriptor () const
bool IsNullDataHandle () const
Constructor / Destructor
 CP_AE_Record ()
 Constructor.
 CP_AE_Record (const AEDescList &inDesc)
virtual ~CP_AE_Record ()
 Destructor.
Getters
OSErr GetNthPtr (UInt32 inIndex, DescType inDesiredType, void *inData, SInt32 inBytes, DescType *inKeyword, DescType *inTypeCode, SInt32 *inOutActualBytes) const
OSErr GetKey (AEKeyword inKeyword, DescType desiredType, AEDesc *inOutDescriptor) const
OSErr GetKey (AEKeyword inKeyword, DescType inDesiredType, void *inData, SInt32 inBytes) const
OSErr GetKey (AEKeyword inKeyword, DescType inDesiredType, DescType *inTypeCode, void *inData, SInt32 inBytes, SInt32 *inOutActualBytes) const
bool GetBoolean (AEKeyword inKey) const
SInt16 GetSInt16 (AEKeyword inKey) const
SInt32 GetSInt32 (AEKeyword inKey) const
float GetFloat (AEKeyword inKey) const
double GetDouble (AEKeyword inKey) const
CP_Rect GetRect (AEKeyword inKey) const
CP_RGBColor GetColor (AEKeyword inKey) const
ProcessSerialNumber GetPSN (AEKeyword inKey) const
CP_FileSystemSpec GetFileSpec (AEKeyword inKey) const
DescType GetEnum (AEKeyword inKey) const
AEDesc GetDesc (AEKeyword inKey, DescType inDesiredType) const
Setters
void Append (AEKeyword inKeyword, DescType inTypeCode, const void *inData, UInt32 InBytes)
void Append (AEKeyword inKeyword, const AEDesc &inDesc)
void SetKey (AEKeyword inKeyword, DescType inTypeCode, const void *inData, SInt32 inBytes)
void SetKey (AEKeyword keyword, const AEDesc &inDescriptor)
void SetBoolean (AEKeyword inKey, bool inValue)
void SetSInt16 (AEKeyword inKey, SInt16 inValue)
void SetSInt32 (AEKeyword inKey, SInt32 inValue)
void SetFloat (AEKeyword inKey, float inValue)
void SetDouble (AEKeyword inKey, double inValue)
void SetRect (AEKeyword inKey, const CP_Rect &inRect)
void SetColor (AEKeyword inKey, const CP_RGBColor &inColor)
void SetPSN (AEKeyword inKey, const ProcessSerialNumber &inValue)
void SetFilespec (AEKeyword inKey, const CP_FileSystemSpec &inValue)
void SetDesc (AEKeyword inKey, const AEDesc &inValue)
void SetEnum (AEKeyword inKey, const AEDesc &inValue)
void DeleteKey (AEKeyword inKeyword)
bool HasKeyword (AEKeyword inKeyword, DescType inDesiredType) const
List Items
SInt32 CountItems () const
void MakeEmptyList ()
void MakeList ()
void CreateList (Boolean isRecord=false, Ptr inFactoringPtr=NULL, Size inFactoredSize=0)
CP_AE_Descriptor GetNthDescriptor (SInt32 inIndex, DescType inDesiredType, AEKeyword *inKey) const
Item Data
void AddDescriptor (SInt32 inIndex, AEDesc &inData)
void AddDescriptor (AEDesc &inData)
void AddData (SInt32 inIndex, DescType inDescType, Ptr inData, Size inLength)
void AddData (DescType inDescType, Ptr inData, Size inLength)
void AddLong (SInt32 inLong)
void AddType (DescType inDescType)
Creation
void Dispose ()
void CreateDescriptor (const DescType inTypeCode, const Ptr inData, const Size inLength)
void MakeNULL ()
Coercion
OSErr AttemptCoercion (DescType typeToCoerceTo)
void CoerceInPlace (DescType typeToCoerceTo)
CP_AE_Descriptor Coerce (DescType typeToCoerceTo) const
void CoerceToStandardType ()
Copiers
void CopyDesc (const CP_AE_Descriptor &desc)
Getters
DescType DescriptorType () const
Handle GetData ()
void GetDescriptor (const AEDesc &inDesc, AEKeyword inKey, DescType inDesiredType=typeWildCard)
OSErr GetOptionalDescriptor (const AEDesc &inDesc, AEKeyword inKey, DescType inDesiredType=typeWildCard)
void GetNthPtr (SInt32 inIndex, DescType inDesiredType, AEKeyword *inAEKeyword, DescType *inTypeCode, void *inDataPtr, Size inMaximumSize, Size *inOutActualSize)
void GetBlock (Ptr inData, Size inLength, DescType inDesiredType) const
SInt16 GetSInt16 () const
SInt32 GetSInt32 () const
bool GetBoolean () const
DescType GetDescType () const
AEKeyword GetKeyword () const
DescType GetEnumeration () const
DescType GetOrdinal () const
CP_Point GetPoint () const
CP_Rect GetRect () const
void GetPString (Str255 result) const
CP_String GetString () const
CP_FileSystemSpec GetFileSpec () const
SInt32 GetItemCount ()
OSErr GetNthItem (SInt32 inItemIndex, DescType *inOutDescType, CP_AE_Descriptor *inOutItem)
Setters
void CopyData (const DescType inTypeCode, const Ptr inData, const Size inLength)
void MakeBoolean (const Boolean inData)
void MakeBoolean (const bool inData)
void MakeSInt16 (const SInt16 inData)
void MakeSInt32 (const SInt32 inData)
void MakeUInt32 (const UInt32 inData)
void MakePoint (const CP_Point &inPoint)
void MakeRect (const CP_Rect &inRect)
void MakeString (Str255 inData)
void MakeString (const CP_String inData)
void MakeFileSpec (const FSSpec &spec)
void MakeFileSpec (const CP_FileSystemSpec &inFileSpec)
void AdoptAlias (Handle inAlias)
void MakeAlias (const CP_FileSystemSpec &inFileSpec)
void MakeProcessSerialNumber (ProcessSerialNumber inPSN)
void MakeObjectSpecifier (DescType inDesiredClass, CP_AE_Descriptor inContainer, DescType inKeyForm, CP_AE_Descriptor inKeyData, bool inDisposeInputs)
void MakeCompDescriptor (DescType inComparisonOperator, DescType inPropertyIdentifier, CP_AE_Descriptor inCompareWith, bool inDisposeInputs)
void MakeEnumeration (const DescType inEnumeration)
void MakeDescType (const DescType inData)
void MakeKeyword (const AEKeyword inKeyword)
void MakeOrdinal (const DescType inData)
void MakeTypeOrInteger (const DescType inData)
void AdoptHandle (DescType inDataType, Handle inDataHandle)
void AdoptDesc (const AEDesc &inDescriptor)
NULL Descriptor
bool IsNullDescriptor () const
bool IsNullDataHandle () const

Public Attributes

AEDesc fAEDesc

Detailed Description

Constructor & Destructor Documentation

CPLAT_Begin_Namespace_CPLAT CP_AE_Record::CP_AE_Record (   ) 
 

Constructor.

Exceptions:
none 

CP_AE_Record::CP_AE_Record (  const AEDescList &  inDesc  ) 
 

Constructor.

Parameters:
inDesc The MacOS AEDescList structre containing the information we are copying.
inCopyDesc If true, then then a duplicate of the passed in inDesc is made, otherwise we just assign the fields to ourselves.
Exceptions:
none 

CP_AE_Record::~CP_AE_Record (   )  [virtual]
 

Destructor.

Exceptions:
none 

Member Function Documentation

OSErr CP_AE_Record::GetNthPtr (  UInt32  inIndex,
DescType  inDesiredType,
void *  inData,
SInt32  inBytes,
DescType *  inKeyword,
DescType *  inTypeCode,
SInt32 *  inOutActualBytes
)  const
 

Return the data at the nth ptr in the record. NOTE: &fAEDesc method returns the OSErr as a result, and does not throw an exception.

Parameters:
inIndex Contains the index of the item we are looking for.
inDesiredType A DescType describing the type we are looking for.
inData Location were are data will be returned.
inBytes Size of the inData location, ie the maximum size our data can be.
inKeyword DescType of the keyword we are getting.
inTypeCode DescType for the type code we are getting.
inOutActualBytes Location where the actual size of data retrieved in placed.
Exceptions:
none 
Returns:
OSErr const The result of operation.

OSErr CP_AE_Record::GetKey (  AEKeyword  inKeyword,
DescType  inDesiredType,
AEDesc *  inOutDescriptor
)  const
 

Return the descriptor type for the keyword. NOTE: &fAEDesc method returns the OSErr as a result, and does not throw an exception.

Parameters:
inKeyword AEKeyword of the data we are looking for.
inDesiredType A DescType describing the type we are looking for.
inDescriptor Location were are data will be returned.
Exceptions:
none 
Returns:
OSErr const The result of operation.

OSErr CP_AE_Record::GetKey (  AEKeyword  inKeyword,
DescType  inDesiredType,
void *  inData,
SInt32  inBytes
)  const
 

Return the descriptor type for the keyword. NOTE: &fAEDesc method returns the OSErr as a result, and does not throw an exception.

Parameters:
inKeyword AEKeyword of the data we are looking for.
inDesiredType A DescType describing the type we are looking for.
inData Location were are data will be returned.
inBytes Size of the data to be returned.
Exceptions:
none 
Returns:
OSErr const The result of operation.

OSErr CP_AE_Record::GetKey (  AEKeyword  inKeyword,
DescType  inDesiredType,
DescType *  inTypeCode,
void *  inData,
SInt32  inBytes,
SInt32 *  inOutActualBytes
)  const
 

Return the descriptor type for the keyword. NOTE: &fAEDesc method returns the OSErr as a result, and does not throw an exception.

Parameters:
inKeyword AEKeyword of the data we are looking for.
inDesiredType A DescType describing the type we are looking for.
inTypeCode a DescType describing the type code we are looking for.
inData location were are data will be returned.
inBytes size of the data to be returned.
inOutActualBytes she actual size of the data returned.
Exceptions:
none 
Returns:
OSErr const The result of operation.

bool CP_AE_Record::GetBoolean (  AEKeyword  inKey  )  const
 

Return a bool value for the passed in AEKeyword.

Parameters:
inKey AEKeyword of the data we are looking for.
Exceptions:
OSErr exceptions.
Returns:
bool const The bool value.

SInt16 CP_AE_Record::GetSInt16 (  AEKeyword  inKey  )  const
 

Return a SInt16 value for the passed in AEKeyword.

Parameters:
inKey AEKeyword of the data we are looking for.
Exceptions:
OSErr exceptions.
Returns:
SInt16 const The SInt16 value.

SInt32 CP_AE_Record::GetSInt32 (  AEKeyword  inKey  )  const
 

Return a SInt32 value for the passed in AEKeyword.

Parameters:
inKey AEKeyword of the data we are looking for.
Exceptions:
OSErr exceptions.
Returns:
SInt32 const The SInt32 value.

float CP_AE_Record::GetFloat (  AEKeyword  inKey  )  const
 

Return a float value for the passed in AEKeyword.

Parameters:
inKey AEKeyword of the data we are looking for.
Exceptions:
OSErr exceptions.
Returns:
float const The float value.

double CP_AE_Record::GetDouble (  AEKeyword  inKey  )  const
 

Return a double value for the passed in AEKeyword.

Parameters:
inKey AEKeyword of the data we are looking for.
Exceptions:
OSErr exceptions.
Returns:
double const The double value.

CP_Rect CP_AE_Record::GetRect (  AEKeyword  inKey  )  const
 

Return a CP_Rect value for the passed in AEKeyword.

Parameters:
inKey AEKeyword of the data we are looking for.
Exceptions:
OSErr exceptions.
Returns:
CP_Rect const The CP_Rect value.

CP_RGBColor CP_AE_Record::GetColor (  AEKeyword  inKey  )  const
 

Return a CP_RGBColor value for the passed in AEKeyword.

Parameters:
inKey AEKeyword of the data we are looking for.
Exceptions:
OSErr exceptions.
Returns:
CP_RGBColor const The CP_RGBColor value.

ProcessSerialNumber CP_AE_Record::GetPSN (  AEKeyword  inKey  )  const
 

Return a Process Serial Number value for the passed in AEKeyword.

Parameters:
inKey AEKeyword of the data we are looking for.
Exceptions:
OSErr exceptions.
Returns:
ProcessSerialNumber const The ProcessSerialNumber value.

CP_FileSystemSpec CP_AE_Record::GetFileSpec (  AEKeyword  inKey  )  const
 

Return a CP_FileSystemSpec value for the passed in AEKeyword.

Parameters:
inKey AEKeyword of the data we are looking for.
Exceptions:
OSErr exceptions.
Returns:
CP_FileSystemSpec const The CP_FileSystemSpec value.

DescType CP_AE_Record::GetEnum (  AEKeyword  inKey  )  const
 

Return a DescType enumeration value for the passed in AEKeyword.

Parameters:
inKey AEKeyword of the data we are looking for.
Exceptions:
OSErr exceptions.
Returns:
DescType const The DescType of the enum.

AEDesc CP_AE_Record::GetDesc (  AEKeyword  inKey,
DescType  inDesiredType
)  const
 

Return a DescType enumeration value for the passed in AEKeyword.

Parameters:
inKey AEKeyword of the data we are looking for.
inDesiredType The type of data we are looking for.
Exceptions:
OSErr exceptions.
Returns:
AEDesc const The result descriptor.

void CP_AE_Record::Append (  AEKeyword  inKeyword,
DescType  inTypeCode,
const void *  inData,
UInt32  inBytes
) 
 

Append data to our Apple Event record.

Parameters:
inKeyword AEKeyword of the data we are adding.
inTypeCode The DescType type code of the data.
inData Pointer to the data to be added.
inBytes Length of the data pointed to by inData.
Exceptions:
OSErr exceptions.
Returns:
void

void CP_AE_Record::Append (  AEKeyword  inKeyword,
const AEDesc &  inDesc
) 
 

Append a descriptor.

Parameters:
inKeyword AEKeyword of the data we are adding.
inDesc A AEDesc object with the data to add to &fAEDesc record.
Exceptions:
OSErr exceptions.
Returns:
void

void CP_AE_Record::SetKey (  AEKeyword  inKeyword,
DescType  inTypeCode,
const void *  inData,
SInt32  inBytes
) 
 

Set a key for &fAEDesc record.

Parameters:
inKeyword AEKeyword of the data we are adding.
inTypeCode DescType type code for the data we are setting..
inData The data we are adding to &fAEDesc record..
inBytes The length of data we are adding.
Exceptions:
OSErr exceptions.
Returns:
void

void CP_AE_Record::SetKey (  AEKeyword  inKeyword,
const AEDesc &  inDescriptor
) 
 

Set a key for &fAEDesc record.

Parameters:
inKeyword AEKeyword of the data we are adding.
inDescriptor AEDesc object containing the information we are adding.
Exceptions:
OSErr exceptions.
Returns:
void

void CP_AE_Record::SetBoolean (  AEKeyword  inKey,
bool  inValue
) 
 

Set a boolean for &fAEDesc record.

Parameters:
inKeyword AEKeyword of the key description we are setting.
inValue The value we are setting the key for.
Exceptions:
none 
Returns:
void

void CP_AE_Record::SetSInt16 (  AEKeyword  inKey,
SInt16  inValue
) 
 

Set a SInt16 for &fAEDesc record.

Parameters:
inKeyword AEKeyword of the key description we are setting.
inValue The value we are setting the key for.
Exceptions:
none 
Returns:
void

void CP_AE_Record::SetSInt32 (  AEKeyword  inKey,
SInt32  inValue
) 
 

Set a SInt16 for &fAEDesc record.

Parameters:
inKeyword AEKeyword of the key description we are setting.
inValue The value we are setting the key for.
Exceptions:
none 
Returns:
void

void CP_AE_Record::SetFloat (  AEKeyword  inKey,
float  inValue
) 
 

Set a float for &fAEDesc record.

Parameters:
inKeyword AEKeyword of the key description we are setting.
inValue The value we are setting the key for.
Exceptions:
none 
Returns:
void

void CP_AE_Record::SetDouble (  AEKeyword  inKey,
double  inValue
) 
 

Set a double for &fAEDesc record.

Parameters:
inKeyword AEKeyword of the key description we are setting.
inValue The value we are setting the key for.
Exceptions:
none 
Returns:
void

void CP_AE_Record::SetRect (  AEKeyword  inKey,
const CP_Rect &  inRect
) 
 

Set a CP_Rect for &fAEDesc record.

Parameters:
inKeyword AEKeyword of the key description we are setting.
inRect The CP_Rect value we are setting the key for.
Exceptions:
none 
Returns:
void

void CP_AE_Record::SetColor (  AEKeyword  inKey,
const CP_RGBColor &  inColor
) 
 

Set a CP_RGBColor for &fAEDesc record.

Parameters:
inKeyword AEKeyword of the key description we are setting.
inColor The CP_RGBColor value we are setting the key for.
Exceptions:
none 
Returns:
void

void CP_AE_Record::SetPSN (  AEKeyword  inKey,
const ProcessSerialNumber &  inValue
) 
 

Set a Process Serial Number for &fAEDesc record.

Parameters:
inKeyword AEKeyword of the key description we are setting.
inValue The Process Serial Number value we are setting the key for.
Exceptions:
none 
Returns:
void

void CP_AE_Record::SetFilespec (  AEKeyword  inKey,
const CP_FileSystemSpec &  inValue
) 
 

Set a CP_FileSystemSpec for &fAEDesc record.

Parameters:
inKeyword AEKeyword of the key description we are setting.
inValue The CP_FileSystemSpec value we are setting the key for.
Exceptions:
none 
Returns:
void

void CP_AE_Record::SetDesc (  AEKeyword  inKey,
const AEDesc &  inValue
) 
 

Set a AEDesc for &fAEDesc record.

Parameters:
inKey AEKeyword of the key description we are setting.
inValue The AEDesc value we are setting the key for.
Exceptions:
OSErr exceptions
Returns:
void

void CP_AE_Record::SetEnum (  AEKeyword  inKey,
const AEDesc &  inValue
) 
 

Set a AEDesc enumeration for &fAEDesc record.

Parameters:
inKey AEKeyword of the key description we are setting.
inValue The AEDesc enumeration value we are setting the key for.
Exceptions:
none 
Returns:
void

void CP_AE_Record::DeleteKey (  AEKeyword  inKeyword  ) 
 

Delete a key from &fAEDesc record.

Parameters:
inKeyword AEKeyword of the key description we are deleting.
Exceptions:
OSErr exceptions.
Returns:
void

bool CP_AE_Record::HasKeyword (  AEKeyword  inKeyword,
DescType  inDesiredType
)  const
 

Return true if &fAEDesc record has the passed in inKeyword.

Parameters:
inKeyword AEKeyword we are looking for.
inDesiredType A DescType describing the type we are looking for.
Exceptions:
none 
Returns:
bool True if the keyword was found.

SInt32 CP_AE_List::CountItems (   )  const [inherited]
 

Count the items in the list. If the descriptor is not of typeAEList, then it has only 1 item. If the descriptor is NULL, then there are no items.

Exceptions:
none 
Returns:
SInt32 const The number of items.

void CP_AE_List::MakeEmptyList (   )  [inherited]
 

Make an empty descriptor list. It is usually not necessary to make an empty list, because all of the AEDesc routines will interpret null descriptors as empty lists. Sometimes it is necessary to return an empty list as the result of an AppleEvent handler, though, and in &fAEDesc case a null descriptor is _not_ equivalent.

Exceptions:
none 
Returns:
void

void CP_AE_List::MakeList (   )  [inherited]
 

If &fAEDesc descriptor is null, an empty list is created. If &fAEDesc descriptor is not empty, then a list is created and &fAEDesc descriptor is placed inside it. If &fAEDesc descriptor is already a list, then no action is taken.

Exceptions:
none 
Returns:
void

void CP_AE_List::CreateList (  Boolean  isRecord = false,
Ptr  inFactoringPtr = NULL,
Size  inFactoredSize = 0
)  [inherited]
 

Create an empty descriptor list or AERecord with factored data.

It is better to call MakeList, MakeEmptyList or MakeAERecord rather than using AEDesc::CreateList directly.

Parameters:
isRecord Flag to indicate if &fAEDesc is a record.
inFactoringPtr Points to the data.
inFactoredSize The size of the passed in data.
Exceptions:
none 
Returns:
void

CP_AE_Descriptor CP_AE_List::GetNthDescriptor (  SInt32  inIndex,
DescType  inDesiredType,
AEKeyword *  inKey
)  const [inherited]
 

Get the indexed descriptor from an event. &fAEDesc method will fail if given an index less than one or greater than the count returned by CountItems. The descriptor returned is _always_ a copy that must be disposed of with Dispose.

Parameters:
inIndex 1 based index of the item to retrieve.
inDesiredType The desired type of item to retrieve.
inKey Key of the item to retrieve.
Exceptions:
none 
Returns:
AEDesc The descriptor for the item.

void CP_AE_List::AddDescriptor (  SInt32  inIndex,
AEDesc &  inData
)  [inherited]
 

Add data to a descriptor list at a specified index, replacing any item already stored at that position.

Parameters:
inIndex 1 based index of the item.
inData AEDesc containing the data to be placed at inIndex in the list.
Exceptions:
none 
Returns:
void

void CP_AE_List::AddDescriptor (  AEDesc &  inData  )  [inherited]
 

Add data to a descriptor list at the end of the list.

Parameters:
inData AEDesc containing the data to be placed at inIndex in the list.
Exceptions:
none 
Returns:
void

void CP_AE_List::AddData (  SInt32  inIndex,
DescType  inDescType,
Ptr  inData,
Size  inLength
)  [inherited]
 

Add data to our list at inIndex.

Parameters:
inIndex The index where we are going to put inData.
inDescType The DescType of the data we are adding.
inData Points to the data we adding at inIndex in our list.
inLength The length of the data pointed to by inData.
Exceptions:
none 
Returns:
void

void CP_AE_List::AddData (  DescType  inDescType,
Ptr  inData,
Size  inLength
)  [inherited]
 

Add data to our list at the end.

Parameters:
inDescType The DescType of the data we are adding.
inData Points to the data we adding at inIndex in our list.
inLength The length of the data pointed to by inData.
Exceptions:
none 
Returns:
void

void CP_AE_List::AddLong (  SInt32  inLong  )  [inherited]
 

Add a SInt32 to our list.

Parameters:
inLong The SInt32 to add to the list.
Exceptions:
none 
Returns:
void

void CP_AE_List::AddType (  DescType  inDescType  )  [inherited]
 

Add a DescType to our list.

Parameters:
inDescType The DescType to add to the list.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::Dispose (   )  [inherited]
 

Dispose of the memory allocated for &fAEDesc object.

Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_Descriptor::CreateDescriptor (  const DescType  inTypeCode,
const Ptr  inData,
const Size  inLength
)  [inherited]
 

Create a new descriptor ffrom the passed in data and data type code.

Parameters:
inTypeCode The DescType type code.
inData Pointer to the data to be used.
inLength Length of the data to be used.
Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_Descriptor::MakeNULL (   )  [inherited]
 

Make &fAEDesc descriptor into a NULL descriptor.

Exceptions:
none 
Returns:
void

OSErr CP_AE_Descriptor::AttemptCoercion (  DescType  typeToCoerceTo  )  [inherited]
 

Try to coerce the type of the descriptor to something else. &fAEDesc method will NOT fail if the coercion could not be done. NOTE: &fAEDesc method does not throw an exception, but returns the error code, as it is ok for &fAEDesc routine to fail.

Parameters:
typetoCoerceTo The desired type we want.
Exceptions:
none 
Returns:
OSErr The result of the coercion.

void CP_AE_Descriptor::CoerceInPlace (  DescType  typeToCoerceTo  )  [inherited]
 

Require that &fAEDesc object be coerced to the specified data type. &fAEDesc method will fail if the coercion does not work.

Parameters:
typetoCoerceTo The desired type we want.
Exceptions:
OSError exception.
Returns:
OSErr The result of the coercion.

CP_AE_Descriptor CP_AE_Descriptor::Coerce (  DescType  typeToCoerceTo  )  const [inherited]
 

Require that &fAEDesc object be coerced to the specified data type. &fAEDesc method will fail if the coercion does not work.

Parameters:
typetoCoerceTo The desired type we want.
Exceptions:
OSError exception.
Returns:
CP_AE_Descriptor The result of the coecion.

void CP_AE_Descriptor::CoerceToStandardType (   )  [inherited]
 

&fAEDesc method attempts to coerce its data into some form of standard type (e.g. typeChar or typeLongInteger). The following conversions are tried: From: typeAEText, typeIntlText or typeStyledText to typeChar, and typeLongInteger to typeLongInteger.

Exceptions:
OSError exception.
Returns:
void

void CP_AE_Descriptor::CopyDesc (  const CP_AE_Descriptor &  inDescriptor  )  [inherited]
 

Duplicate the information from the passed in descriptor.

Parameters:
inDescriptor The object to copy the data from.
Exceptions:
OSError exceptions.
Returns:
void

DescType CP_AE_Descriptor::DescriptorType (   )  const [inherited]
 

Return a DescType that describes the type of descriptor this is.

Exceptions:
none 
Returns:
DescType const The DescType for this descriptor.

Handle CP_AE_Descriptor::GetData (   )  [inherited]
 

Return a Handle to our data. &fAEDesc handle is a copy of the data and must be deleted by the caller.

Exceptions:
OSError exceptions.
Returns:
Handle The returned handle.

void CP_AE_Descriptor::GetDescriptor (  const AEDesc &  inDescriptor,
AEKeyword  inKey,
DescType  inDesiredType = typeWildCard
)  [inherited]
 

Get the descriptor from an event. If the desired type is not specified, it is assumed to be typeWildCard.

Parameters:
inDescriptor The descriptor to retrieve the paramDesc from.
inKey The key of the descriptor.
inDesiredType The desired type we want.
Exceptions:
OSError exception.
Returns:
void

OSErr CP_AE_Descriptor::GetOptionalDescriptor (  const AEDesc &  inDescriptor,
AEKeyword  inKey,
DescType  inDesiredType = typeWildCard
)  [inherited]
 

Get the descriptor from an event. If the desired type is not specified, it is assumed to be typeWildCard. NOTE: &fAEDesc method is used for retrieving optional descriptors, so we will just return the err code and let the called do with the result as it sees fit.

Parameters:
inDescriptor The descriptor to retrieve the paramDesc from.
inKey The key of the descriptor.
inDesiredType The desired type we want.
Exceptions:
none 
Returns:
OSErr Result of the operation.

void CP_AE_Descriptor::GetNthPtr (  SInt32  inIndex,
DescType  inDesiredType,
AEKeyword *  inAEKeyword,
DescType *  inTypeCode,
void *  inDataPtr,
Size  inMaximumSize,
Size *  inOutActualSize
)  [inherited]
 

Retrurns a pointer to the nth item in &fAEDesc descriptor.

Parameters:
inIndex Index of the item we want.
inDesiredType The type we want converted to.
inAEKeyword Keyword for item.
inTypeCode TypeCode for item.
inDataPtr Pointer to the location to return the items data.
inMaximumSize Maximum size of the data to be returned.
inOutActualSize Actual size of the returned data.
Exceptions:
none 
Returns:
OSErr Result of the operation.

void CP_AE_Descriptor::GetBlock (  Ptr  inData,
Size  inLength,
DescType  inDesiredType
)  const [inherited]
 

Get a block of data of the inDesiredType.

Parameters:
inData Ptr to the data.
inLength Size of the data length.
inDesiredType The desired type of data.
Exceptions:
none 
Returns:
void

SInt16 CP_AE_Descriptor::GetSInt16 (   )  const [inherited]
 

Return the data from &fAEDesc descriptor as a SInt16.

Exceptions:
none 
Returns:
SInt16 const The data as a SInt16.

SInt32 CP_AE_Descriptor::GetSInt32 (   )  const [inherited]
 

Return the data from &fAEDesc descriptor as a SInt32.

Exceptions:
none 
Returns:
SInt32 const The data as a SInt32.

bool CP_AE_Descriptor::GetBoolean (   )  const [inherited]
 

Return the data from &fAEDesc descriptor as a bool.

Exceptions:
none 
Returns:
bool const The data as a bool.

DescType CP_AE_Descriptor::GetDescType (   )  const [inherited]
 

Return the type of information contained in &fAEDesc object as a DescType.

Exceptions:
none 
Returns:
DescType const The data as a DescType.

AEKeyword CP_AE_Descriptor::GetKeyword (   )  const [inherited]
 

Return the type of information contained in &fAEDesc object as a AEKeyword.

Exceptions:
none 
Returns:
AEKeyword const The data as a AEKeyword.

DescType CP_AE_Descriptor::GetEnumeration (   )  const [inherited]
 

Return the data from &fAEDesc descriptor as a DescType enumeration.

Exceptions:
none 
Returns:
DescType const The data as a Desctype enumeration.

DescType CP_AE_Descriptor::GetOrdinal (   )  const [inherited]
 

Return the data from &fAEDesc descriptor as a DescType typeAbsoluteOrdinal.

Exceptions:
none 
Returns:
DescType const The data as a Desctype ordinal.

CP_Point CP_AE_Descriptor::GetPoint (   )  const [inherited]
 

Return the data from &fAEDesc descriptor as a CP_Point object.

Exceptions:
none 
Returns:
CP_Point const The converted CP_Point object.

CP_Rect CP_AE_Descriptor::GetRect (   )  const [inherited]
 

Return the data from &fAEDesc descriptor as a CP_Rect object.

Exceptions:
none 
Returns:
CP_Rect const The converted CP_Rect object.

void CP_AE_Descriptor::GetPString (  Str255  result  )  const [inherited]
 

Return the data from &fAEDesc descriptor as a Str255 object.

Parameters:
result Location to return the result in.
Exceptions:
none 
Returns:
void

CP_String CP_AE_Descriptor::GetString (   )  const [inherited]
 

Return the data from &fAEDesc descriptor as a CP_String object.

Exceptions:
none 
Returns:
CP_String const The converted CP_String object.

CP_FileSystemSpec CP_AE_Descriptor::GetFileSpec (   )  const [inherited]
 

Return the data from &fAEDesc descriptor as a CP_FileSystemSpec.

Exceptions:
none 
Returns:
CP_FileSystemSpec const The converted file system spec.

SInt32 CP_AE_Descriptor::GetItemCount (   )  [inherited]
 

Return the number of items in &fAEDesc descriptor.

Exceptions:
none 
Returns:
SInt32 The number of items in &fAEDesc descriptor.

OSErr CP_AE_Descriptor::GetNthItem (  SInt32  inItemIndex,
DescType *  inOutDescType,
CP_AE_Descriptor *  inOutItem
)  [inherited]
 

Return the nth item from &fAEDesc descriptor.

Parameters:
inItemIndex Index of the item to return.
inOutDescType Location to return the DescType of the item.
inOutItem Location to return the item.
Exceptions:
none 
Returns:
OSErr Result of the operation.

CP_AE_Descriptor::operator AEDesc * (   )  [inherited]
 

CP_AE_Descriptor::operator const AEDesc * (   )  const [inherited]
 

CP_AE_Descriptor::operator AEDesc & (   )  [inherited]
 

CP_AE_Descriptor::operator const AEDesc & (   )  const [inherited]
 

void CP_AE_Descriptor::CopyData (  const DescType  inTypeCode,
const Ptr  inData,
const Size  inLength
)  [inherited]
 

Make a new descriptor from the passed in data and data type code.

Parameters:
inTypeCode The DescType type code.
inData Pointer to the data to be used.
inLength Length of the data to be used.
Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_Descriptor::MakeBoolean (  const Boolean  inData  )  [inherited]
 

Make &fAEDesc into a Boolean descriptor from the passed in Boolean data.

Parameters:
inData Data to be used for the descriptor.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::MakeBoolean (  const bool  inData  )  [inherited]
 

Make &fAEDesc into a Boolean descriptor from the passed in bool data.

Parameters:
inData Data to be used for the descriptor.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::MakeSInt16 (  const SInt16  inData  )  [inherited]
 

Make &fAEDesc into a SInt16 descriptor from the passed in data.

Parameters:
inData Data to be used for the descriptor.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::MakeSInt32 (  const SInt32  inData  )  [inherited]
 

Make &fAEDesc into a SInt32 descriptor from the passed in data.

Parameters:
inData Data to be used for the descriptor.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::MakeUInt32 (  const UInt32  inData  )  [inherited]
 

Make &fAEDesc into a UInt32 descriptor from the passed in data.

Parameters:
inData Data to be used for the descriptor.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::MakePoint (  const CP_Point &  inPoint  )  [inherited]
 

Make &fAEDesc into a point descriptor from the passed in data.

Parameters:
inPoint CP_Point data to be used for the descriptor.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::MakeRect (  const CP_Rect &  inRect  )  [inherited]
 

Make &fAEDesc into a rect descriptor from the passed in data.

Parameters:
inPoint CP_Rect data to be used for the descriptor.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::MakeString (  Str255  inData  )  [inherited]
 

Make &fAEDesc into a p-style string descriptor from the passed in data.

Parameters:
inPoint Str255 data to be used for the descriptor.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::MakeString (  const CP_String  inData  )  [inherited]
 

Make &fAEDesc into a string descriptor from the passed in data.

Parameters:
inPoint CP_String data to be used for the descriptor.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::MakeFileSpec (  const FSSpec &  inFileSpec  )  [inherited]
 

Make &fAEDesc into a file spec descriptor from the passed in data.

Parameters:
inPoint FSSpec data to be used for the descriptor.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::MakeFileSpec (  const CP_FileSystemSpec &  inFileSpec  )  [inherited]
 

Make &fAEDesc into a file spec descriptor from the passed in data.

Parameters:
inPoint CP_FileSystemSpec data to be used for the descriptor.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::AdoptAlias (  Handle  inAlias  )  [inherited]
 

Takes the provided alias handle and uses it to set the data for &fAEDesc descriptor.

Parameters:
Handle Alias to the data to be converted.
Exceptions:
none 
Returns:
void

void CP_AE_Descriptor::MakeAlias (  const CP_FileSystemSpec &  inFileSpec  )  [inherited]
 

Make a descriptor for the passed in CP_FileSystemSpec inData as a MacOS Alias.

Parameters:
inFileSpec CP_FileSystemSpec to convert.
Exceptions:
OSError exceptions.
Returns:
void

void CP_AE_Descriptor::MakeProcessSerialNumber (  ProcessSerialNumber  inPSN  )  [inherited]
 

Make a descriptor for the passed in MacOS ProcessSerialNumber.

Parameters:
inPSN The process serial number to use.
Exceptions:
none. 
Returns:
void

void CP_AE_Descriptor::MakeObjectSpecifier (  DescType  inDesiredClass,
CP_AE_Descriptor  inContainer,
DescType  inKeyForm,
CP_AE_Descriptor  inKeyData,
bool  inDisposeInputs
)  [inherited]
 

Make an object specifier from the passed in data.

Parameters:
inDesirecClass The DescType type of class we are trying to create.
inContainer The CP_AE_Descriptor that is the container of ourselves.
inKeyForm The DescType inKeyForm of the specifier.
inKeyData The CP_AE_Descriptor of the key data.
inDisposeInputs If true, the memory for the input data is disposed of.
Exceptions:
none. 
Returns:
void

void CP_AE_Descriptor::MakeCompDescriptor (  DescType  inComparisonOperator,
DescType  inPropertyIdentifier,
CP_AE_Descriptor  inCompareWith,
bool  inDisposeInputs
)  [inherited]
 

Make an comp descriptor.

Parameters:
inComparisonOperator The DescType of the comparison operator.
inPropertyIdentifier The property identifier.
inCompareWith Objecct to compare with &fAEDesc objecct.
inDisposeInputs Flag to indicate the input objects should be disposed of.
Exceptions:
none. 
Returns:
void

void CP_AE_Descriptor::MakeEnumeration (  const DescType  inEnumeration  )  [inherited]
 

Make an enumeration for &fAEDesc descriptor.

Parameters:
inEnumeration The enumeration to use.
Exceptions:
none. 
Returns:
void

void CP_AE_Descriptor::MakeDescType (  const DescType  inData  )  [inherited]
 

Make a DescType descriptor.

Parameters:
inData DescType to use.
Exceptions:
none. 
Returns:
void

void CP_AE_Descriptor::MakeKeyword (  const AEKeyword  inKeyword  )  [inherited]
 

Make an an AEKeyword for &fAEDesc descriptor.

Parameters:
inKeyword The keyword to use.
Exceptions:
none. 
Returns:
void

void CP_AE_Descriptor::MakeOrdinal (  const DescType  inData  )  [inherited]
 

Make an an ordinal for &fAEDesc descriptor.

Parameters:
inData The data to use.
Exceptions:
none. 
Returns:
void

void CP_AE_Descriptor::MakeTypeOrInteger (  const DescType  inData  )  [inherited]
 

Make &fAEDesc object either a type or an integer based upon inData. &fAEDesc is useful for debugging; it makes a 'type' if the data appears to consist of printable characters (e.g. 'ABCD'), but otherwise it makes an integer (e.g. -12).

Parameters:
inData The DescType of the type we want to become.
Exceptions:
none. 
Returns:
void

void CP_AE_Descriptor::AdoptHandle (  DescType  inDataType,
Handle  inHandle
)  [inherited]
 

Assign the inDataType and inHandle to &fAEDesc object.

Parameters:
inDataType The type of data we want.
inHandle The data to convert.
Exceptions:
none. 
Returns:
void

void CP_AE_Descriptor::AdoptDesc (  const AEDesc &  inDescriptor  )  [inherited]
 

Adopt the passed in CP_AE_Descriptor object.

Parameters:
inDescriptor The descriptor to use in the conversion.
Exceptions:
none. 
Returns:
void

bool CP_AE_Descriptor::IsNullDescriptor (   )  const [inherited]
 

Return true if this is a NULL descriptor, ie doesn't describe anything.

Exceptions:
none 
Returns:
bool const True if this is a NULL desciptor.

bool CP_AE_Descriptor::IsNullDataHandle (   )  const [inherited]
 

Return true if the data handle is NULL.

Exceptions:
none 
Returns:
bool const True if the data handle is NULL.

void CP_AE_Descriptor::swap (  CP_AE_Descriptor &  inOutDescriptor  )  throw () [inherited]
 

Member Data Documentation

AEDesc CP_AE_Descriptor::fAEDesc [inherited]
 

The documentation for this class was generated from the following files:
Generated on Tue Sep 20 20:21:32 2005 for CPLAT_MacOS by  doxygen 1.4.0