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	GetEssenceElementKey ([out] aafUID_t *pEssenceElementKey)
	This method returns essence element key associated with the essence stream.
HRESULT	SetEssenceElementKey ([in, ref] aafUID_constref key)
	Set the essence element key on the essence stream.

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.

Definition at line 46705 of file AAF.idl.

Member Function Documentation

HRESULT IAAFKLVEssenceDataParameters::GetEssenceElementKey ( [out] aafUID_t * pEssenceElementKey )

This method returns essence element key associated with the essence stream.

Succeeds if all of the following are true:

pEssenceElementKey is a valid pointer.
the essence stream supports essence element keys.

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

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_NOT_INITIALIZED

This object has not yet had Initialize() called on it.

AAFRESULT_NULL_PARAM

pEssenceElementKey arg is NULL.

AAFRESULT_OPERATION_NOT_PERMITTED

the essence stream does not support essence element keys.

Parameters:

pEssenceElementKey [out] Essence element key.

HRESULT IAAFKLVEssenceDataParameters::SetEssenceElementKey ( [in, ref] aafUID_constref key )

Set the essence element key on the essence stream.