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

Public Member Functions
HRESULT	Initialize ()
	Initializes a newly allocated, empty IAAFBWFImportDescriptor-supporting object.
HRESULT	SetFileSecurityReport ([in] aafUInt32 fileSecurityReport)
	Sets the fileSecurityReport property.
HRESULT	GetFileSecurityReport ([out] aafUInt32 *pFileSecurityReport)
	Gets the FileSecurityReport property.
HRESULT	SetFileSecurityWave ([in] aafUInt32 fileSecurityWave)
	Sets the FileSecurityWave property.
HRESULT	GetFileSecurityWave ([out] aafUInt32 *pFileSecurityWave)
	Gets the FileSecurityWave property.
HRESULT	CountUnknownBWFChunks ([out] aafUInt32 *pNumData)
	Return total number of RIFFChunk objects attached to this component.
HRESULT	AppendUnknownBWFChunk ([in] IAAFRIFFChunk *pData)
	Appends a pre-existing RIFFChunk object to end of this BWFImportDescriptor's list of UnknownBWFChunks.
HRESULT	PrependUnknownBWFChunk ([in] IAAFRIFFChunk *pData)
	Prepends a pre-existing RIFFChunk object to the beginning of this BWFImportDescriptor's list of UnknownBWFChunks.
HRESULT	InsertUnknownBWFChunkAt ([in] aafUInt32 index,[in] IAAFRIFFChunk *pData)
	Inserts the given RIFFChunk at the given index in this BWFImportDescriptor's list of UnknownBWFChunks.
HRESULT	GetUnknownBWFChunkAt ([in] aafUInt32 index,[out, retval] IAAFRIFFChunk **ppData)
	Retrieves the RIFFChunk at the given index in this BWFImportDescriptor's list of UnknownBWFChunks.
HRESULT	RemoveUnknownBWFChunkAt ([in] aafUInt32 index)
	Removes the RIFFChunk at the given index in this BWFImportDescriptor's list of UnknownBWFChunks.
HRESULT	GetUnknownBWFChunks ([out] IEnumAAFRIFFChunks **ppEnum)
	Return the enumeration for all RIFFChunk objects on this component.
HRESULT	SetCodingHistory ([in, string] aafCharacter_constptr pCodingHistory)
	Sets the CodingHistory string property.
HRESULT	GetCodingHistory ([out, string, size_is(bufSize)] aafCharacter *pCodingHistory,[in] aafUInt32 bufSize)
	Gets the CodingHistory string property.
HRESULT	GetCodingHistoryBufLen ([out] aafUInt32 *pBufSize)
	Returns size of buffer (in bytes) required for GetCodingHistory().
HRESULT	SetBasicData ([in, string] aafCharacter_constptr pBasicData)
	Sets the BasicData string property.
HRESULT	GetBasicData ([out, string, size_is(bufSize)] aafCharacter *pBasicData,[in] aafUInt32 bufSize)
	Gets the BasicData string property.
HRESULT	GetBasicDataBufLen ([out] aafUInt32 *pBufSize)
	Returns size of buffer (in bytes) required for GetBasicData().
HRESULT	SetStartOfModulation ([in, string] aafCharacter_constptr pStartOfModulation)
	Sets the StartOfModulation string property.
HRESULT	GetStartOfModulation ([out, string, size_is(bufSize)] aafCharacter *pStartOfModulation,[in] aafUInt32 bufSize)
	Gets the StartOfModulation string property.
HRESULT	GetStartOfModulationBufLen ([out] aafUInt32 *pBufSize)
	Returns size of buffer (in bytes) required for GetStartOfModulation().
HRESULT	SetQualityEvent ([in, string] aafCharacter_constptr pQualityEvent)
	Sets the QualityEvent string property.
HRESULT	GetQualityEvent ([out, string, size_is(bufSize)] aafCharacter *pQualityEvent,[in] aafUInt32 bufSize)
	Gets the QualityEvent string property.
HRESULT	GetQualityEventBufLen ([out] aafUInt32 *pBufSize)
	Returns size of buffer (in bytes) required for GetQualityEvent().
HRESULT	SetEndOfModulation ([in, string] aafCharacter_constptr pEndOfModulation)
	Sets the EndOfModulation string property.
HRESULT	GetEndOfModulation ([out, string, size_is(bufSize)] aafCharacter *pEndOfModulation,[in] aafUInt32 bufSize)
	Gets the EndOfModulation string property.
HRESULT	GetEndOfModulationBufLen ([out] aafUInt32 *pBufSize)
	Returns size of buffer (in bytes) required for GetEndOfModulation().
HRESULT	SetQualityParameter ([in, string] aafCharacter_constptr pQualityParameter)
	Sets the QualityParameter string property.
HRESULT	GetQualityParameter ([out, string, size_is(bufSize)] aafCharacter *pQualityParameter,[in] aafUInt32 bufSize)
	Gets the QualityParameter string property.
HRESULT	GetQualityParameterBufLen ([out] aafUInt32 *pBufSize)
	Returns size of buffer (in bytes) required for GetQualityParameter().
HRESULT	SetOperatorComment ([in, string] aafCharacter_constptr pOperatorComment)
	Sets the OperatorComment string property.
HRESULT	GetOperatorComment ([out, string, size_is(bufSize)] aafCharacter *pOperatorComment,[in] aafUInt32 bufSize)
	Gets the OperatorComment string property.
HRESULT	GetOperatorCommentBufLen ([out] aafUInt32 *pBufSize)
	Returns size of buffer (in bytes) required for GetOperatorComment().
HRESULT	SetCueSheet ([in, string] aafCharacter_constptr pCueSheet)
	Sets the CueSheet string property.
HRESULT	GetCueSheet ([out, string, size_is(bufSize)] aafCharacter *pCueSheet,[in] aafUInt32 bufSize)
	Gets the CueSheet string property.
HRESULT	GetCueSheetBufLen ([out] aafUInt32 *pBufSize)
	Returns size of buffer (in bytes) required for GetCueSheet().

Detailed Description

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.

Objects that implement IAAFBWFImportDescriptor also implement the following interfaces:

Definition at line 765 of file AAF.idl.

Member Function Documentation

HRESULT IAAFBWFImportDescriptor::AppendUnknownBWFChunk ( [in] IAAFRIFFChunk * pData )

Appends a pre-existing RIFFChunk object to end of this BWFImportDescriptor's list of UnknownBWFChunks.

Succeeds if all of the following are true:

the pData pointer is valid.
the pData pointer indicates an object which is not already owned by any object

If this method fails no state will 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

the pData arg is NULL.

AAFRESULT_OBJECT_ALREADY_ATTACHED

the object pointed to by pData is already owned by this or another object.

Parameters:

pData [in] RIFFChunk object to append

HRESULT IAAFBWFImportDescriptor::CountUnknownBWFChunks ( [out] aafUInt32 * pNumData )

Return total number of RIFFChunk objects attached to this component.

Succeeds if all of the following are true:

the pNumData pointer is valid.

If this method fails nothing will be written to *pNumComments.

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

pNumData arg is NULL.

Parameters:

pNumData [out] Number of RIFFChunk objects

HRESULT IAAFBWFImportDescriptor::GetBasicData	(	[out, string, size_is(bufSize)] aafCharacter *	pBasicData,
		[in] aafUInt32	bufSize
	)

Gets the BasicData string property.

Writes the BasicData property, with a trailing null character, into the pBasicData buffer. The buffer is allocated by the caller. The size of the buffer is given by bufSize. If the BasicData property has not yet been set, a zero-length string will be written (that is, only the trailing null character).

Caller may call GetBasicDataBufLen() to determine the required buffer size.

If this method fails nothing will be written to pBasicData.

Succeeds if:

The pBasicData pointer is valid.
bufSize indicates that the buffer is large enough to hold BasicData.

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

pBasicData arg is NULL.

AAFRESULT_SMALL_BUF

bufSize indicates that the allocated buffer is not large enough to hold BasicData.

Parameters:

pBasicData	[out, string, size_is(bufSize)] buffer into which BasicData is to be written
bufSize	[in] size of *pBasicData buffer in bytes

HRESULT IAAFBWFImportDescriptor::GetBasicDataBufLen ( [out] aafUInt32 * pBufSize )

Returns size of buffer (in bytes) required for GetBasicData().

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 IAAFBWFImportDescriptor::GetCodingHistory	(	[out, string, size_is(bufSize)] aafCharacter *	pCodingHistory,
		[in] aafUInt32	bufSize
	)

Gets the CodingHistory string property.

Writes the CodingHistory property, with a trailing null character, into the pCodingHistory buffer. The buffer is allocated by the caller. The size of the buffer is given by bufSize. If the CodingHistory property has not yet been set, a zero-length string will be written (that is, only the trailing null character).

Caller may call GetCodingHistoryBufLen() to determine the required buffer size.

If this method fails nothing will be written to pCodingHistory.

Succeeds if:

The pCodingHistory pointer is valid.
bufSize indicates that the buffer is large enough to hold CodingHistory.

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

pCodingHistory arg is NULL.

AAFRESULT_SMALL_BUF

bufSize indicates that the allocated buffer is not large enough to hold CodingHistory.

Parameters:

pCodingHistory	[out, string, size_is(bufSize)] buffer into which CodingHistory is to be written
bufSize	[in] size of *pCodingHistory buffer in bytes

HRESULT IAAFBWFImportDescriptor::GetCodingHistoryBufLen ( [out] aafUInt32 * pBufSize )

Returns size of buffer (in bytes) required for GetCodingHistory().

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 IAAFBWFImportDescriptor::GetCueSheet	(	[out, string, size_is(bufSize)] aafCharacter *	pCueSheet,
		[in] aafUInt32	bufSize
	)

Gets the CueSheet string property.

Writes the CueSheet property, with a trailing null character, into the pCueSheet buffer. The buffer is allocated by the caller. The size of the buffer is given by bufSize. If the CueSheet property has not yet been set, a zero-length string will be written (that is, only the trailing null character).

Caller may call GetCueSheetBufLen() to determine the required buffer size.

If this method fails nothing will be written to pCueSheet.

Succeeds if:

The pCueSheet pointer is valid.
bufSize indicates that the buffer is large enough to hold CueSheet.

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

pCueSheet arg is NULL.

AAFRESULT_SMALL_BUF

bufSize indicates that the allocated buffer is not large enough to hold CueSheet.

Parameters:

pCueSheet	[out, string, size_is(bufSize)] buffer into which CueSheet is to be written
bufSize	[in] size of *pCueSheet buffer in bytes

HRESULT IAAFBWFImportDescriptor::GetCueSheetBufLen ( [out] aafUInt32 * pBufSize )

Returns size of buffer (in bytes) required for GetCueSheet().

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 IAAFBWFImportDescriptor::GetEndOfModulation	(	[out, string, size_is(bufSize)] aafCharacter *	pEndOfModulation,
		[in] aafUInt32	bufSize
	)

Gets the EndOfModulation string property.

Writes the EndOfModulation property, with a trailing null character, into the pEndOfModulation buffer. The buffer is allocated by the caller. The size of the buffer is given by bufSize. If the EndOfModulation property has not yet been set, a zero-length string will be written (that is, only the trailing null character).

Caller may call GetEndOfModulationBufLen() to determine the required buffer size.

If this method fails nothing will be written to pEndOfModulation.

Succeeds if:

The pEndOfModulation pointer is valid.
bufSize indicates that the buffer is large enough to hold EndOfModulation.

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

pEndOfModulation arg is NULL.

AAFRESULT_SMALL_BUF

bufSize indicates that the allocated buffer is not large enough to hold EndOfModulation.

Parameters:

pEndOfModulation	[out, string, size_is(bufSize)] buffer into which EndOfModulation is to be written
bufSize	[in] size of *pEndOfModulation buffer in bytes

HRESULT IAAFBWFImportDescriptor::GetEndOfModulationBufLen ( [out] aafUInt32 * pBufSize )

Returns size of buffer (in bytes) required for GetEndOfModulation().

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 IAAFBWFImportDescriptor::GetFileSecurityReport ( [out] aafUInt32 * pFileSecurityReport )

Gets the FileSecurityReport property.

Succeeds if all of the following are true:

pFileSecurityReport is a valid pointer
the property is present.

If this method fails, pFileSecurityReport will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pFileSecurityReport is NULL.

AAFRESULT_PROP_NOT_PRESENT

the property is not present.

Parameters:

pFileSecurityReport [out] value of the FileSecurityReport property

HRESULT IAAFBWFImportDescriptor::GetFileSecurityWave ( [out] aafUInt32 * pFileSecurityWave )

Gets the FileSecurityWave property.

Succeeds if all of the following are true:

pFileSecurityWave is a valid pointer
the property is present.

If this method fails, pFileSecurityWave will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pFileSecurityWave is NULL.

AAFRESULT_PROP_NOT_PRESENT

the property is not present.

Parameters:

pFileSecurityWave [out] value of the FileSecurityWave property

HRESULT IAAFBWFImportDescriptor::GetOperatorComment	(	[out, string, size_is(bufSize)] aafCharacter *	pOperatorComment,
		[in] aafUInt32	bufSize
	)

Gets the OperatorComment string property.

Writes the OperatorComment property, with a trailing null character, into the pOperatorComment buffer. The buffer is allocated by the caller. The size of the buffer is given by bufSize. If the OperatorComment property has not yet been set, a zero-length string will be written (that is, only the trailing null character).

Caller may call GetOperatorCommentBufLen() to determine the required buffer size.

If this method fails nothing will be written to pOperatorComment.

Succeeds if:

The pOperatorComment pointer is valid.
bufSize indicates that the buffer is large enough to hold OperatorComment.

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

pOperatorComment arg is NULL.

AAFRESULT_SMALL_BUF

bufSize indicates that the allocated buffer is not large enough to hold OperatorComment.

Parameters:

pOperatorComment	[out, string, size_is(bufSize)] buffer into which OperatorComment is to be written
bufSize	[in] size of *pOperatorComment buffer in bytes

HRESULT IAAFBWFImportDescriptor::GetOperatorCommentBufLen ( [out] aafUInt32 * pBufSize )

Returns size of buffer (in bytes) required for GetOperatorComment().

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 IAAFBWFImportDescriptor::GetQualityEvent	(	[out, string, size_is(bufSize)] aafCharacter *	pQualityEvent,
		[in] aafUInt32	bufSize
	)

Gets the QualityEvent string property.

Writes the QualityEvent property, with a trailing null character, into the pQualityEvent buffer. The buffer is allocated by the caller. The size of the buffer is given by bufSize. If the QualityEvent property has not yet been set, a zero-length string will be written (that is, only the trailing null character).

Caller may call GetQualityEventBufLen() to determine the required buffer size.

If this method fails nothing will be written to pQualityEvent.

Succeeds if:

The pQualityEvent pointer is valid.
bufSize indicates that the buffer is large enough to hold QualityEvent.

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

pQualityEvent arg is NULL.

AAFRESULT_SMALL_BUF

bufSize indicates that the allocated buffer is not large enough to hold QualityEvent.

Parameters:

pQualityEvent	[out, string, size_is(bufSize)] buffer into which QualityEvent is to be written
bufSize	[in] size of *pQualityEvent buffer in bytes

HRESULT IAAFBWFImportDescriptor::GetQualityEventBufLen ( [out] aafUInt32 * pBufSize )

Returns size of buffer (in bytes) required for GetQualityEvent().

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 IAAFBWFImportDescriptor::GetQualityParameter	(	[out, string, size_is(bufSize)] aafCharacter *	pQualityParameter,
		[in] aafUInt32	bufSize
	)

Gets the QualityParameter string property.

Writes the QualityParameter property, with a trailing null character, into the pQualityParameter buffer. The buffer is allocated by the caller. The size of the buffer is given by bufSize. If the QualityParameter property has not yet been set, a zero-length string will be written (that is, only the trailing null character).

Caller may call GetQualityParameterBufLen() to determine the required buffer size.

If this method fails nothing will be written to pQualityParameter.

Succeeds if:

The pQualityParameter pointer is valid.
bufSize indicates that the buffer is large enough to hold QualityParameter.

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

pQualityParameter arg is NULL.

AAFRESULT_SMALL_BUF

bufSize indicates that the allocated buffer is not large enough to hold QualityParameter.

Parameters:

pQualityParameter	[out, string, size_is(bufSize)] buffer into which QualityParameter is to be written
bufSize	[in] size of *pQualityParameter buffer in bytes

HRESULT IAAFBWFImportDescriptor::GetQualityParameterBufLen ( [out] aafUInt32 * pBufSize )

Returns size of buffer (in bytes) required for GetQualityParameter().

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 IAAFBWFImportDescriptor::GetStartOfModulation	(	[out, string, size_is(bufSize)] aafCharacter *	pStartOfModulation,
		[in] aafUInt32	bufSize
	)

Gets the StartOfModulation string property.

Writes the StartOfModulation property, with a trailing null character, into the pStartOfModulation buffer. The buffer is allocated by the caller. The size of the buffer is given by bufSize. If the StartOfModulation property has not yet been set, a zero-length string will be written (that is, only the trailing null character).

Caller may call GetStartOfModulationBufLen() to determine the required buffer size.

If this method fails nothing will be written to pStartOfModulation.

Succeeds if:

The pStartOfModulation pointer is valid.
bufSize indicates that the buffer is large enough to hold StartOfModulation.

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

pStartOfModulation arg is NULL.

AAFRESULT_SMALL_BUF

bufSize indicates that the allocated buffer is not large enough to hold StartOfModulation.

Parameters:

pStartOfModulation	[out, string, size_is(bufSize)] buffer into which StartOfModulation is to be written
bufSize	[in] size of *pStartOfModulation buffer in bytes

HRESULT IAAFBWFImportDescriptor::GetStartOfModulationBufLen ( [out] aafUInt32 * pBufSize )

Returns size of buffer (in bytes) required for GetStartOfModulation().

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 IAAFBWFImportDescriptor::GetUnknownBWFChunkAt	(	[in] aafUInt32	index,
		[out, retval] IAAFRIFFChunk **	ppData
	)

Retrieves the RIFFChunk at the given index in this BWFImportDescriptor's list of UnknownBWFChunks.

Succeeds if all of the following are true:

the pData pointer is valid.
index is less than the value returned by CountUnknownBWFChunks().

If this method fails no state will 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

ppData is null.

AAFRESULT_BADINDEX

index is greater than or equal to the value returned by CountUnknownBWFChunks().

Parameters:

index	[in] index of chunk to retrieve
ppData	[out, retval] returned RIFFChunk

HRESULT IAAFBWFImportDescriptor::GetUnknownBWFChunks ( [out] IEnumAAFRIFFChunks ** ppEnum )

Return the enumeration for all RIFFChunk objects on this component.

The returned enumerator is AddRef()ed before it is returned. The enumerator is implemented as an EnumAAFRIFFChunks.

Succeeds if all of the following are true:

the ppEnum pointer is valid.

If this method fails nothing will be written to *ppEnum.

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

ppEnum is null.

Parameters:

ppEnum [out] RIFFChunk objects

HRESULT IAAFBWFImportDescriptor::Initialize ( )

Initializes a newly allocated, empty IAAFBWFImportDescriptor-supporting object.

This method must be called after allocation, and before any other method can be called.

Succeeds if:

Initialize() has not yet been called on this object.

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_ALREADY_INITIALIZED

Initialize() has already been called on this object.

HRESULT IAAFBWFImportDescriptor::InsertUnknownBWFChunkAt	(	[in] aafUInt32	index,
		[in] IAAFRIFFChunk *	pData
	)

Inserts the given RIFFChunk at the given index in this BWFImportDescriptor's list of UnknownBWFChunks.

Chunks already existing at the given and higher indices will be moved to the next higher index to accommodate.

Succeeds if all of the following are true:

the pData pointer is valid.
the pData pointer indicates an object which is not already owned by any object
index is less than or equal to the value returned by CountUnknownBWFChunks().

If this method fails no state will 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

pData is null.

AAFRESULT_OBJECT_ALREADY_ATTACHED

the object pointed to by pData is already owned by this or another object.

AAFRESULT_BADINDEX

index is greater than the value returned by CountUnknownBWFChunks().

Parameters:

index	[in] index at which chunk is to be inserted
pData	[in] RIFFChunk to append

HRESULT IAAFBWFImportDescriptor::PrependUnknownBWFChunk ( [in] IAAFRIFFChunk * pData )

Prepends a pre-existing RIFFChunk object to the beginning of this BWFImportDescriptor's list of UnknownBWFChunks.

Succeeds if all of the following are true:

the pData pointer is valid.
the pData pointer indicates an object which is not already owned by any object

If this method fails no state will 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

pData is null.

AAFRESULT_OBJECT_ALREADY_ATTACHED

the object pointed to by pData is already owned by this or another object.

Parameters:

pData [in] RIFFChunk object to prepend

HRESULT IAAFBWFImportDescriptor::RemoveUnknownBWFChunkAt ( [in] aafUInt32 index )

Removes the RIFFChunk at the given index in this BWFImportDescriptor's list of UnknownBWFChunks.

Chunks already existing at indices higher than the given index will be moved to the next lower index to accommodate.

Succeeds if all of the following are true:

index is less than the value returned by CountUnknownBWFChunks().

If this method fails no state will 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_BADINDEX

index is greater than or equal to the value returned by CountUnknownBWFChunks().

Parameters:

index [in] index of chunk to remove

HRESULT IAAFBWFImportDescriptor::SetBasicData ( [in, string] aafCharacter_constptr pBasicData )

Sets the BasicData string property.

Set the BasicData property to the value specified in pBasicData. A copy is made of the data so the caller retains ownership of the *pBasicData 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 pBasicData pointer is valid.

If this method fails the BasicData 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

pBasicData arg is NULL.

Parameters:

pBasicData [in, string] buffer from which BasicData is to be read

HRESULT IAAFBWFImportDescriptor::SetCodingHistory ( [in, string] aafCharacter_constptr pCodingHistory )

Sets the CodingHistory string property.

Set the CodingHistory property to the value specified in pCodingHistory. A copy is made of the data so the caller retains ownership of the *pCodingHistory 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 pCodingHistory pointer is valid.

If this method fails the CodingHistory 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

pCodingHistory arg is NULL.

Parameters:

pCodingHistory [in, string] buffer from which CodingHistory is to be read

HRESULT IAAFBWFImportDescriptor::SetCueSheet ( [in, string] aafCharacter_constptr pCueSheet )

Sets the CueSheet string property.

Set the CueSheet property to the value specified in pCueSheet. A copy is made of the data so the caller retains ownership of the *pCueSheet 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 pCueSheet pointer is valid.

If this method fails the CueSheet 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

pCueSheet arg is NULL.

Parameters:

pCueSheet [in, string] buffer from which CueSheet is to be read

HRESULT IAAFBWFImportDescriptor::SetEndOfModulation ( [in, string] aafCharacter_constptr pEndOfModulation )

Sets the EndOfModulation string property.

Set the EndOfModulation property to the value specified in pEndOfModulation. A copy is made of the data so the caller retains ownership of the *pEndOfModulation 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 pEndOfModulation pointer is valid.

If this method fails the EndOfModulation 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

pEndOfModulation arg is NULL.

Parameters:

pEndOfModulation [in, string] buffer from which EndOfModulation is to be read

HRESULT IAAFBWFImportDescriptor::SetFileSecurityReport ( [in] aafUInt32 fileSecurityReport )

Sets the fileSecurityReport property.

This is an optional property.

If this method fails, the FileSecurityReport property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded.

Parameters:

fileSecurityReport [in] value to assign to the FileSecurityReport property

HRESULT IAAFBWFImportDescriptor::SetFileSecurityWave ( [in] aafUInt32 fileSecurityWave )

Sets the FileSecurityWave property.

This is an optional property.

If this method fails, the FileSecurityWave property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded.

Parameters:

fileSecurityWave [in] value to assign to the FileSecurityWave property

HRESULT IAAFBWFImportDescriptor::SetOperatorComment ( [in, string] aafCharacter_constptr pOperatorComment )

Sets the OperatorComment string property.

Set the OperatorComment property to the value specified in pOperatorComment. A copy is made of the data so the caller retains ownership of the *pOperatorComment 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 pOperatorComment pointer is valid.

If this method fails the OperatorComment 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

pOperatorComment arg is NULL.

Parameters:

pOperatorComment [in, string] buffer from which OperatorComment is to be read

HRESULT IAAFBWFImportDescriptor::SetQualityEvent ( [in, string] aafCharacter_constptr pQualityEvent )

Sets the QualityEvent string property.

Set the QualityEvent property to the value specified in pQualityEvent. A copy is made of the data so the caller retains ownership of the *pQualityEvent 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 pQualityEvent pointer is valid.

If this method fails the QualityEvent 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

pQualityEvent arg is NULL.

Parameters:

pQualityEvent [in, string] buffer from which QualityEvent is to be read

HRESULT IAAFBWFImportDescriptor::SetQualityParameter ( [in, string] aafCharacter_constptr pQualityParameter )

Sets the QualityParameter string property.

Set the QualityParameter property to the value specified in pQualityParameter. A copy is made of the data so the caller retains ownership of the *pQualityParameter 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 pQualityParameter pointer is valid.

If this method fails the QualityParameter 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

pQualityParameter arg is NULL.

Parameters:

pQualityParameter [in, string] buffer from which QualityParameter is to be read

HRESULT IAAFBWFImportDescriptor::SetStartOfModulation ( [in, string] aafCharacter_constptr pStartOfModulation )

Sets the StartOfModulation string property.

Set the StartOfModulation property to the value specified in pStartOfModulation. A copy is made of the data so the caller retains ownership of the *pStartOfModulation 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 pStartOfModulation pointer is valid.

If this method fails the StartOfModulation 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

pStartOfModulation arg is NULL.

Parameters:

pStartOfModulation [in, string] buffer from which StartOfModulation is to be read

Public Member Functions

Detailed Description

Member Function Documentation