IAAFDefObject Interface Reference

List of all members.

---

Detailed Description

This interface is defines an item to be referenced in the AAF file.

It specifies the AUID unique identifier used to define types used in AAF persistent objects.

In addition to the specific error results listed for each method, all methods in this interface may also return one of the following values:

AAFRESULT_NOMEMORY

• insufficient system memory is available to perform the operation.

AAFRESULT_NOT_INITIALIZED

• This object has not yet had Initialize() called on it through this object's primary interface. Note that IAAFObject is a primary interface for an abstract class, so it is not appropriate for the Initialize() method to exist in this interface. The Initialize() method is available through the concrete object's primary interface.

Objects that implement IAAFDefObject also implement the following interfaces:

• IAAFObject

Definition at line 2856 of file AAF.idl.

Public Member Functions
HRESULT	SetName ([in, string] aafCharacter_constptr pName)
	Sets the Name of this definition.
HRESULT	GetName ([out, string, size_is(bufSize)] aafCharacter *pName,[in] aafUInt32 bufSize)
	Gets the Name of this definition.
HRESULT	GetNameBufLen ([out] aafUInt32 *pBufSize)
	Returns size of buffer (in bytes) required for GetName().
HRESULT	SetDescription ([in, string] aafCharacter_constptr pDescription)
	Sets the Description of this definition.
HRESULT	GetDescription ([out, string, size_is(bufSize)] aafCharacter *pDescription,[in] aafUInt32 bufSize)
	Gets the Description of this definition.
HRESULT	GetDescriptionBufLen ([out] aafUInt32 *pBufSize)
	Returns size of buffer (in bytes) required for GetDescription().
HRESULT	Initialize ([in, ref] aafUID_constref id,[in, string] aafCharacter_constptr pName)
	Init all fields of a definition object.
HRESULT	GetAUID ([retval, out] aafUID_t *pAuid)
	Gets the AUID for this object.

---

Member Function Documentation

HRESULT IAAFDefObject::GetAUID (  [retval, out] aafUID_t *  pAuid  )

Gets the AUID for this object. Parameters: pAuid  [retval,out] Pointer to an AUID reference

HRESULT IAAFDefObject::GetDescription (  [out, string, size_is(bufSize)] aafCharacter *  pDescription, [in] aafUInt32  bufSize )

Gets the Description of this definition. Writes the Description property, with a trailing null character, into the pDescription buffer. The buffer is allocated by the caller. The size of the buffer is given by bufSize. If the Description property has not yet been set, a zero-length string will be written (that is, only the trailing null character). Caller may call GetDescriptionBufLen() to determine the required buffer size. If this method fails nothing will be written to pDescription. Succeeds if: The pDescription pointer is valid. bufSize indicates that the buffer is large enough to hold Description. This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below: AAFRESULT_SUCCESS succeeded. (This is the only code indicating success.) AAFRESULT_NULL_PARAM pDescription arg is NULL. AAFRESULT_SMALL_BUF bufSize indicates that the allocated buffer is not large enough to hold Description. Parameters: pDescription  [out, string, size_is(bufSize)] buffer into which Description is to be written bufSize  [in] size of *pDescription buffer in bytes

HRESULT IAAFDefObject::GetDescriptionBufLen (  [out] aafUInt32 *  pBufSize  )

Returns size of buffer (in bytes) required for GetDescription(). Succeeds if: The pBufSize pointer is valid. This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below: AAFRESULT_SUCCESS succeeded. (This is the only code indicating success.) AAFRESULT_NULL_PARAM pBufSize arg is NULL. Parameters: pBufSize  [out] size of required buffer, in bytes

HRESULT IAAFDefObject::GetName (  [out, string, size_is(bufSize)] aafCharacter *  pName, [in] aafUInt32  bufSize )

Gets the Name of this definition. Writes the Name property, with a trailing null character, into the pName buffer. The buffer is allocated by the caller. The size of the buffer is given by bufSize. If the Name property has not yet been set, a zero-length string will be written (that is, only the trailing null character). Caller may call GetNameBufLen() to determine the required buffer size. If this method fails nothing will be written to pName. Succeeds if: The pName pointer is valid. bufSize indicates that the buffer is large enough to hold Name. This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below: AAFRESULT_SUCCESS succeeded. (This is the only code indicating success.) AAFRESULT_NULL_PARAM pName arg is NULL. AAFRESULT_SMALL_BUF bufSize indicates that the allocated buffer is not large enough to hold Name. Parameters: pName  [out, string, size_is(bufSize)] buffer into which Name is to be written bufSize  [in] size of *pName buffer in bytes

HRESULT IAAFDefObject::GetNameBufLen (  [out] aafUInt32 *  pBufSize  )

Returns size of buffer (in bytes) required for GetName(). Succeeds if: The pBufSize pointer is valid. This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below: AAFRESULT_SUCCESS succeeded. (This is the only code indicating success.) AAFRESULT_NULL_PARAM pBufSize arg is NULL. Parameters: pBufSize  [out] size of required buffer, in bytes

HRESULT IAAFDefObject::Initialize (  [in, ref] aafUID_constref  id, [in, string] aafCharacter_constptr  pName )

Init all fields of a definition object. Parameters: id  [in, ref] AUID for new DeObject pName  [in, string] Name for new DefObject

HRESULT IAAFDefObject::SetDescription (  [in, string] aafCharacter_constptr  pDescription  )

Sets the Description of this definition. Set the Description property to the value specified in pDescription. A copy is made of the data so the caller retains ownership of the *pDescription buffer and is responsible for de-allocating it. There is no pre-set limit to the length of the name, other than available system memory or disk space. Succeeds if all of the following are true: the pDescription pointer is valid. If this method fails the Description property will not be changed. This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below: AAFRESULT_SUCCESS succeeded. (This is the only code indicating success.) AAFRESULT_NULL_PARAM pDescription arg is NULL. Parameters: pDescription  [in, string] buffer from which Description is to be read

HRESULT IAAFDefObject::SetName (  [in, string] aafCharacter_constptr  pName  )

Sets the Name of this definition. Set the Name property to the value specified in pName. A copy is made of the data so the caller retains ownership of the *pName buffer and is responsible for de-allocating it. There is no pre-set limit to the length of the name, other than available system memory or disk space. Succeeds if all of the following are true: the pName pointer is valid. If this method fails the Name property will not be changed. This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below: AAFRESULT_SUCCESS succeeded. (This is the only code indicating success.) AAFRESULT_NULL_PARAM pName arg is NULL. Parameters: pName  [in, string] buffer from which Name is to be read

---