IAAFAuxiliaryDescriptor Interface Reference

List of all members.

---

Detailed Description

The IAAFAuxiliaryDescriptor interface is implemented by objects that describe a file source which has no physical source.

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.

Objects that implement IAAFAuxiliaryDescriptor also implement the following interfaces:

• IAAFPhysicalDescriptor
• IAAFEssenceDescriptor
• IAAFObject

Definition at line 34528 of file AAF.idl.

Public Member Functions
HRESULT	Initialize ()
	Initializes a newly allocated, IAAFAuxiliaryDescriptor object.
HRESULT	SetMimeType ([in, string] aafCharacter_constptr pMimeType)
	Sets The registered mime type of the data per RFC 2046 and RFC 2048.
HRESULT	GetMimeType ([out, string, size_is(bufSize)] aafCharacter *pMimeType,[in] aafUInt32 bufSize)
	Gets The registered mime type of the data per RFC 2046 and RFC 2048.
HRESULT	GetMimeTypeBufLen ([out] aafUInt32 *pBufSize)
	Returns size of buffer (in bytes) required for GetMimeType().
HRESULT	SetCharSet ([in, string] aafCharacter_constptr pCharSet)
	Sets The registered character set per RFC 2048.
HRESULT	GetCharSet ([out, string, size_is(bufSize)] aafCharacter *pCharSet,[in] aafUInt32 bufSize)
	Gets The registered character set per RFC 2048.
HRESULT	GetCharSetBufLen ([out] aafUInt32 *pBufSize)
	Returns size of buffer (in bytes) required for GetCharSet().

---

Member Function Documentation

HRESULT IAAFAuxiliaryDescriptor::GetCharSet (  [out, string, size_is(bufSize)] aafCharacter *  pCharSet, [in] aafUInt32  bufSize )

Gets The registered character set per RFC 2048. Writes the CharSet property, with a trailing null character, into the pCharSet buffer. The buffer is allocated by the caller. The size of the buffer is given by bufSize. If the CharSet property has not yet been set, a zero-length string will be written (that is, only the trailing null character). Caller may call GetCharSetBufLen() to determine the required buffer size. If this method fails nothing will be written to pCharSet. Succeeds if: The pCharSet pointer is valid. bufSize indicates that the buffer is large enough to hold CharSet. 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 pCharSet arg is NULL. AAFRESULT_SMALL_BUF bufSize indicates that the allocated buffer is not large enough to hold CharSet. Parameters: pCharSet  [out, string, size_is(bufSize)] buffer into which CharSet is to be written bufSize  [in] size of *pCharSet buffer in bytes

HRESULT IAAFAuxiliaryDescriptor::GetCharSetBufLen (  [out] aafUInt32 *  pBufSize  )

Returns size of buffer (in bytes) required for GetCharSet(). 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 IAAFAuxiliaryDescriptor::GetMimeType (  [out, string, size_is(bufSize)] aafCharacter *  pMimeType, [in] aafUInt32  bufSize )

Gets The registered mime type of the data per RFC 2046 and RFC 2048. Writes the MimeType property, with a trailing null character, into the pMimeType buffer. The buffer is allocated by the caller. The size of the buffer is given by bufSize. If the MimeType property has not yet been set, a zero-length string will be written (that is, only the trailing null character). Caller may call GetMimeTypeBufLen() to determine the required buffer size. If this method fails nothing will be written to pMimeType. Succeeds if: The pMimeType pointer is valid. bufSize indicates that the buffer is large enough to hold MimeType. 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 pMimeType arg is NULL. AAFRESULT_SMALL_BUF bufSize indicates that the allocated buffer is not large enough to hold MimeType. Parameters: pMimeType  [out, string, size_is(bufSize)] buffer into which MimeType is to be written bufSize  [in] size of *pMimeType buffer in bytes

HRESULT IAAFAuxiliaryDescriptor::GetMimeTypeBufLen (  [out] aafUInt32 *  pBufSize  )

Returns size of buffer (in bytes) required for GetMimeType(). 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 IAAFAuxiliaryDescriptor::Initialize (   )

Initializes a newly allocated, IAAFAuxiliaryDescriptor object. This method must be called after allocation, and before any other method can be called. Return codes: AAFRESULT_SUCCESS succeeded. (This is the only code indicating success.) AAFRESULT_ALREADY_INITIALIZED Initialize() has already been called on this object.

HRESULT IAAFAuxiliaryDescriptor::SetCharSet (  [in, string] aafCharacter_constptr  pCharSet  )

Sets The registered character set per RFC 2048. Set the CharSet property to the value specified in pCharSet. A copy is made of the data so the caller retains ownership of the *pCharSet 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 pCharSet pointer is valid. If this method fails the CharSet 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 pCharSet arg is NULL. Parameters: pCharSet  [in, string] buffer from which CharSet is to be read

HRESULT IAAFAuxiliaryDescriptor::SetMimeType (  [in, string] aafCharacter_constptr  pMimeType  )

Sets The registered mime type of the data per RFC 2046 and RFC 2048. Set the MimeType property to the value specified in pMimeType. A copy is made of the data so the caller retains ownership of the *pMimeType 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 pMimeType pointer is valid. If this method fails the MimeType 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 pMimeType arg is NULL. Parameters: pMimeType  [in, string] buffer from which MimeType is to be read

---