IAAFDictionary2 Interface Reference

This interface is used to access dictionary services in an AAF file. More...

List of all members.

Public Member Functions
HRESULT	CreateInstance ([in, ref] aafUID_constref id,[in, ref] REFIID riid,[out, iid_is(riid)] IUnknown **ppvObject)
	Creates a single uninitialized AAF object of the class associated with a specified stored object id.
HRESULT	CreateMetaInstance ([in, ref] aafUID_constref id,[in, ref] REFIID riid,[out, iid_is(riid)] IUnknown **ppMetaDefinition)
	Creates a single uninitialized AAF meta class or type associated with a specified stored object id.
HRESULT	RegisterClassDef ([in] IAAFClassDef *pClassDef)
	Add the class definition object to the dictionary.
HRESULT	LookupClassDef ([in, ref] aafUID_constref classId,[out, retval] IAAFClassDef **ppClassDef)
	Return the class definition with the given id.
HRESULT	GetClassDefs ([out, retval] IEnumAAFClassDefs **ppEnum)
	Return an enumerator for all class definitions.
HRESULT	CountClassDefs ([out, retval] aafUInt32 *pResult)
	Writes the number of class definition objects into the pResult argument.
HRESULT	CreateForwardClassReference ([in, ref] aafUID_constref classId)
	Return the class definition with the given id.
HRESULT	HasForwardClassReference ([in, ref] aafUID_constref classId,[out, retval] aafBoolean_t *pResult)
	Return kAAFTrue if the given class identification is a forward reference.
HRESULT	RegisterTypeDef ([in] IAAFTypeDef *pTypeDef)
	Add the type definition object to the dictionary.
HRESULT	LookupTypeDef ([in, ref] aafUID_constref typeId,[out, retval] IAAFTypeDef **ppTypeDef)
	Return the type definition object with the given id.
HRESULT	GetTypeDefs ([out, retval] IEnumAAFTypeDefs **ppEnum)
	Return an enumerator for all type definitions.
HRESULT	CountTypeDefs ([out, retval] aafUInt32 *pResult)
	Writes the number of type definition objects into the pResult argument.
HRESULT	RegisterOpaqueTypeDef ([in] IAAFTypeDef *pTypeDef)
	Add the opaquetype definition object to the dictionary.
HRESULT	LookupOpaqueTypeDef ([in, ref] aafUID_constref typeId,[out, retval] IAAFTypeDef **ppTypeDef)
	Return the opaque type definition object with the given id.
HRESULT	GetOpaqueTypeDefs ([out, retval] IEnumAAFTypeDefs **ppEnum)
	Return an enumerator for all registered opaque type definitions.
HRESULT	CountOpaqueTypeDefs ([out, retval] aafUInt32 *pResult)
	Writes the number of opaque type definition objects into the pResult argument.
HRESULT	RegisterKLVDataKey ([in] aafUID_t pUID,[in] IAAFTypeDef *pTypeDef)
	Add the definition for the given KLV key to the runtime dictionary.
HRESULT	RegisterDataDef ([in] IAAFDataDef *pDataDef)
	Add the data definition object to the header's list of definitions.
HRESULT	LookupDataDef ([in, ref] aafUID_constref dataDefinitionId,[out, retval] IAAFDataDef **ppDataDef)
	Return the data definition object with the given id.
HRESULT	GetDataDefs ([out, retval] IEnumAAFDataDefs **ppEnum)
	Return an enumerator for aff data definitions.
HRESULT	CountDataDefs ([out, retval] aafUInt32 *pResult)
	Writes the number of data definition objects into the pResult argument.
HRESULT	RegisterOperationDef ([in] IAAFOperationDef *pOperationDef)
	Add the operation definition object to the header's list of definitions.
HRESULT	LookupOperationDef ([in, ref] aafUID_constref operationId,[out, retval] IAAFOperationDef **ppOperationDef)
	Return the operation definition object with the given id.
HRESULT	GetOperationDefs ([out, retval] IEnumAAFOperationDefs **ppEnum)
	Return an enumerator for all operation definitions.
HRESULT	CountOperationDefs ([out, retval] aafUInt32 *pResult)
	Writes the number of operation definition objects into the pResult argument.
HRESULT	RegisterParameterDef ([in] IAAFParameterDef *pParmDef)
	Add the parameter definition object to the header's list of definitions.
HRESULT	LookupParameterDef ([in, ref] aafUID_constref parameterId,[out, retval] IAAFParameterDef **ppParmDef)
	Return the parameter definition object with the given id.
HRESULT	GetParameterDefs ([out, retval] IEnumAAFParameterDefs **ppEnum)
	Return an enumerator for all parameter definitions.
HRESULT	CountParameterDefs ([out, retval] aafUInt32 *pResult)
	Writes the number of parameter definition objects into the pResult argument.
HRESULT	RegisterCodecDef ([in] IAAFCodecDef *pParmDef)
	Add the codec definition object to the header's list of definitions.
HRESULT	LookupCodecDef ([in, ref] aafUID_constref parameterId,[out, retval] IAAFCodecDef **ppParmDef)
	Return the codec definition object with the given id.
HRESULT	GetCodecDefs ([out, retval] IEnumAAFCodecDefs **ppEnum)
	Return an enumerator for all codec definitions.
HRESULT	CountCodecDefs ([out, retval] aafUInt32 *pResult)
	Writes the number of codec definition objects into the pResult argument.
HRESULT	RegisterContainerDef ([in] IAAFContainerDef *pParmDef)
	Add the container definition object to the header's list of definitions.
HRESULT	LookupContainerDef ([in, ref] aafUID_constref parameterId,[out, retval] IAAFContainerDef **ppParmDef)
	Return the container definition object with the given id.
HRESULT	GetContainerDefs ([out, retval] IEnumAAFContainerDefs **ppEnum)
	Return an enumerator for all container definitions.
HRESULT	CountContainerDefs ([out, retval] aafUInt32 *pResult)
	Writes the number of container definition objects into the pResult argument.
HRESULT	RegisterInterpolationDef ([in] IAAFInterpolationDef *pInterpolationDef)
	Add the Interpolation definition object to the header's list of definitions.
HRESULT	LookupInterpolationDef ([in, ref] aafUID_constref parameterId,[out, retval] IAAFInterpolationDef **ppInterpolationDef)
	Return the Interpolation definition object with the given id.
HRESULT	GetInterpolationDefs ([out, retval] IEnumAAFInterpolationDefs **ppEnum)
	Return an enumerator for aff Interpolation definitions.
HRESULT	CountInterpolationDefs ([out, retval] aafUInt32 *pResult)
	Writes the number of interpolation definition objects into the pResult argument.
HRESULT	RegisterPluginDef ([in] IAAFPluginDef *pPlugDef)
	Add the plugin definition object to the header's list of definitions.
HRESULT	LookupPluginDef ([in, ref] aafUID_constref parameterId,[out, retval] IAAFPluginDef **ppPlugDef)
	Return the plugin descriptor object with the given id.
HRESULT	GetPluginDefs ([out, retval] IEnumAAFPluginDefs **ppEnum)
	Return an enumerator for all plugin descriptors.
HRESULT	CountPluginDefs ([out, retval] aafUInt32 *pResult)
	Writes the number of plugin definition objects into the pResult argument.
HRESULT	RegisterKLVDataDef ([in] IAAFKLVDataDefinition *pDef)
	Add the KLVData definition object to the header's list of definitions.
HRESULT	LookupKLVDataDef ([in, ref] aafUID_constref defId,[out, retval] IAAFKLVDataDefinition **ppDef)
	Return the KLVData descriptor object with the given id.
HRESULT	GetKLVDataDefs ([out, retval] IEnumAAFKLVDataDefs **ppEnum)
	Return an enumerator for all KLVData descriptors.
HRESULT	CountKLVDataDefs ([out, retval] aafUInt32 *pResult)
	Writes the number of KLVData definition objects into the pResult argument.
HRESULT	RegisterTaggedValueDef ([in] IAAFTaggedValueDefinition *pDef)
	Add the tagged value definition object to the header's list of definitions.
HRESULT	LookupTaggedValueDef ([in, ref] aafUID_constref defId,[out, retval] IAAFTaggedValueDefinition **ppDef)
	Return the tagged value descriptor object with the given id.
HRESULT	GetTaggedValueDefs ([out, retval] IEnumAAFTaggedValueDefs **ppEnum)
	Return an enumerator for all tagged value descriptors.
HRESULT	CountTaggedValueDefs ([out, retval] aafUInt32 *pResult)
	Writes the number of tagged value definition objects into the pResult argument.
HRESULT	LookupAuxiliaryDataDef ([out, retval] IAAFDataDef **ppDataDef)
	Return the Auxiliary Data Definition Object.
HRESULT	LookupDescriptiveMetadataDataDef ([out, retval] IAAFDataDef **ppDataDef)
	Return the Descriptive Metadata Data Definition Object.
HRESULT	LookupEdgecodeDataDef ([out, retval] IAAFDataDef **ppDataDef)
	Return the Edgecode Data Definition Object.
HRESULT	LookupLegacyPictureDataDef ([out, retval] IAAFDataDef **ppDataDef)
	Return the legacy Picture Data Definition Object.
HRESULT	LookupLegacySoundDataDef ([out, retval] IAAFDataDef **ppDataDef)
	Return the legacy Sound Data Definition Object.
HRESULT	LookupLegacyTimecodeDataDef ([out, retval] IAAFDataDef **ppDataDef)
	Return the legacy Timecode Data Definition Object.
HRESULT	LookupMatteDataDef ([out, retval] IAAFDataDef **ppDataDef)
	Return the Matte Data Definition Object.
HRESULT	LookupPictureDataDef ([out, retval] IAAFDataDef **ppDataDef)
	Return the Picture Data Definition Object.
HRESULT	LookupPictureWithMatteDataDef ([out, retval] IAAFDataDef **ppDataDef)
	Return the PictureWithMatte Data Definition Object.
HRESULT	LookupSoundDataDef ([out, retval] IAAFDataDef **ppDataDef)
	Return the Sound Data Definition Object.
HRESULT	LookupTimecodeDataDef ([out, retval] IAAFDataDef **ppDataDef)
	Return the Timecode Data Definition Object.

---

Detailed Description

This interface is used to access dictionary services in an AAF file.

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 IAAFDictionary2 also implement the following interfaces:

• IAAFObject

Definition at line 41730 of file AAF.idl.

---

Member Function Documentation

HRESULT IAAFDictionary2::CountClassDefs

(

[out, retval] aafUInt32 *

pResult

)

Writes the number of class definition objects into the pResult argument.

Succeeds if all of the following are true:

• the pResult pointer is valid.

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

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

• pResult is null.

Parameters:

pResult

[out, retval] Total number of class definition objects

HRESULT IAAFDictionary2::CountCodecDefs

(

[out, retval] aafUInt32 *

pResult

)

Writes the number of codec definition objects into the pResult argument.

Succeeds if all of the following are true:

• the pResult pointer is valid.

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

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

• pResult is null.

Parameters:

pResult

[out, retval] Total number of codec definition objects

HRESULT IAAFDictionary2::CountContainerDefs

(

[out, retval] aafUInt32 *

pResult

)

Writes the number of container definition objects into the pResult argument.

Succeeds if all of the following are true:

• the pResult pointer is valid.

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

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

• pResult is null.

Parameters:

pResult

[out, retval] Total number of container definition objects

HRESULT IAAFDictionary2::CountDataDefs

(

[out, retval] aafUInt32 *

pResult

)

Writes the number of data definition objects into the pResult argument.

Succeeds if all of the following are true:

• the pResult pointer is valid.

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

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

• pResult is null.

Parameters:

pResult

[out, retval] Total number of data definition objects

HRESULT IAAFDictionary2::CountInterpolationDefs

(

[out, retval] aafUInt32 *

pResult

)

Writes the number of interpolation definition objects into the pResult argument.

Succeeds if all of the following are true:

• the pResult pointer is valid.

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

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

• pResult is null.

Parameters:

pResult

[out, retval] Total number of interpolation definition objects

HRESULT IAAFDictionary2::CountKLVDataDefs

(

[out, retval] aafUInt32 *

pResult

)

Writes the number of KLVData definition objects into the pResult argument.

Succeeds if all of the following are true:

• the pResult pointer is valid.

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

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

• pResult is null.

Parameters:

pResult

[out, retval] Total number of KLVData definition objects

HRESULT IAAFDictionary2::CountOpaqueTypeDefs

(

[out, retval] aafUInt32 *

pResult

)

Writes the number of opaque type definition objects into the pResult argument.

Succeeds if all of the following are true:

• the pResult pointer is valid.

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

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

• pResult is null.

Parameters:

pResult

[out, retval] Total number of opaque type definition objects

HRESULT IAAFDictionary2::CountOperationDefs

(

[out, retval] aafUInt32 *

pResult

)

Writes the number of operation definition objects into the pResult argument.

Succeeds if all of the following are true:

• the pResult pointer is valid.

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

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

• pResult is null.

Parameters:

pResult

[out, retval] Total number of operation definition objects

HRESULT IAAFDictionary2::CountParameterDefs

(

[out, retval] aafUInt32 *

pResult

)

Writes the number of parameter definition objects into the pResult argument.

Succeeds if all of the following are true:

• the pResult pointer is valid.

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

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

• pResult is null.

Parameters:

pResult

[out, retval] Total number of parameter definition objects

HRESULT IAAFDictionary2::CountPluginDefs

(

[out, retval] aafUInt32 *

pResult

)

Writes the number of plugin definition objects into the pResult argument.

Succeeds if all of the following are true:

• the pResult pointer is valid.

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

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

• pResult is null.

Parameters:

pResult

[out, retval] Total number of plugin definition objects

HRESULT IAAFDictionary2::CountTaggedValueDefs

(

[out, retval] aafUInt32 *

pResult

)

Writes the number of tagged value definition objects into the pResult argument.

Succeeds if all of the following are true:

• the pResult pointer is valid.

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

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

• pResult is null.

Parameters:

pResult

[out, retval] Total number of tagged value definition objects

HRESULT IAAFDictionary2::CountTypeDefs

(

[out, retval] aafUInt32 *

pResult

)

Writes the number of type definition objects into the pResult argument.

Succeeds if all of the following are true:

• the pResult pointer is valid.

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

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

• pResult is null.

Parameters:

pResult

[out, retval] Total number of type definition objects

HRESULT IAAFDictionary2::CreateForwardClassReference

(

[in, ref] aafUID_constref

classId

)

Return the class definition with the given id.

Succeeds if:

• The classId does not represent an existing forward class reference or a class definition that has already been successfully registered.

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_INVALID_PARAM

• The given ID is not recognized as a class definition ID.

Parameters:

classId

[in, ref] Class Unique ID

HRESULT IAAFDictionary2::CreateInstance	(	[in, ref] aafUID_constref	id,
		[in, ref] REFIID	riid,
		[out, iid_is(riid)] IUnknown **	ppvObject
	)

Creates a single uninitialized AAF object of the class associated with a specified stored object id.

Parameters:

[in]	id	Class identifier (id) of the stored object. This is the corresponding SMPTE identifier (as a GUID) for all predefined built-in classes.
[in]	riid	Reference to the identifier of the interface
[out]	ppvObject	Address of output variable that receives the interface pointer requested in riid

HRESULT IAAFDictionary2::CreateMetaInstance	(	[in, ref] aafUID_constref	id,
		[in, ref] REFIID	riid,
		[out, iid_is(riid)] IUnknown **	ppMetaDefinition
	)

Creates a single uninitialized AAF meta class or type associated with a specified stored object id.

Parameters:

[in]	id	Identifier (id) of a class or type definition. This is the corresponding SMPTE identifier (as a GUID) for all predefined built-in definitions.
[in]	riid	Reference to the identifier of the interface
[out]	ppMetaDefinition	Address of output variable that receives the interface pointer requested in riid

HRESULT IAAFDictionary2::GetClassDefs

(

[out, retval] IEnumAAFClassDefs **

ppEnum

)

Return an enumerator for all class definitions.

Succeeds if:

• The ppEnum 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

• ppEnum arg is NULL.

Parameters:

ppEnum

[out,retval] Class Definition Enumeration

HRESULT IAAFDictionary2::GetCodecDefs

(

[out, retval] IEnumAAFCodecDefs **

ppEnum

)

Return an enumerator for all codec definitions.

Parameters:

ppEnum

[out,retval] Definition Enumeration

HRESULT IAAFDictionary2::GetContainerDefs

(

[out, retval] IEnumAAFContainerDefs **

ppEnum

)

Return an enumerator for all container definitions.

Parameters:

ppEnum

[out,retval] Definition Enumeration

HRESULT IAAFDictionary2::GetDataDefs

(

[out, retval] IEnumAAFDataDefs **

ppEnum

)

Return an enumerator for aff data definitions.

Parameters:

ppEnum

[out,retval] Definition Enumeration

HRESULT IAAFDictionary2::GetInterpolationDefs

(

[out, retval] IEnumAAFInterpolationDefs **

ppEnum

)

Return an enumerator for aff Interpolation definitions.

Parameters:

ppEnum

[out,retval] Definition Enumeration

HRESULT IAAFDictionary2::GetKLVDataDefs

(

[out, retval] IEnumAAFKLVDataDefs **

ppEnum

)

Return an enumerator for all KLVData descriptors.

Parameters:

ppEnum

[out,retval] Definition Enumeration

HRESULT IAAFDictionary2::GetOpaqueTypeDefs

(

[out, retval] IEnumAAFTypeDefs **

ppEnum

)

Return an enumerator for all registered opaque type definitions.

Succeeds if:

• The ppEnum 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

• ppEnum arg is NULL.

Parameters:

ppEnum

[out,retval] Type Def Enumeration

HRESULT IAAFDictionary2::GetOperationDefs

(

[out, retval] IEnumAAFOperationDefs **

ppEnum

)

Return an enumerator for all operation definitions.

Parameters:

ppEnum

[out,retval] Definition Enumeration

HRESULT IAAFDictionary2::GetParameterDefs

(

[out, retval] IEnumAAFParameterDefs **

ppEnum

)

Return an enumerator for all parameter definitions.

Parameters:

ppEnum

[out,retval] Definition Enumeration

HRESULT IAAFDictionary2::GetPluginDefs

(

[out, retval] IEnumAAFPluginDefs **

ppEnum

)

Return an enumerator for all plugin descriptors.

Parameters:

ppEnum

[out,retval] Definition Enumeration

HRESULT IAAFDictionary2::GetTaggedValueDefs

(

[out, retval] IEnumAAFTaggedValueDefs **

ppEnum

)

Return an enumerator for all tagged value descriptors.

Parameters:

ppEnum

[out,retval] Definition Enumeration

HRESULT IAAFDictionary2::GetTypeDefs

(

[out, retval] IEnumAAFTypeDefs **

ppEnum

)

Return an enumerator for all type definitions.

Succeeds if:

• The ppEnum 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

• ppEnum arg is NULL.

Parameters:

ppEnum

[out,retval] Type Def Enumeration

HRESULT IAAFDictionary2::HasForwardClassReference	(	[in, ref] aafUID_constref	classId,
		[out, retval] aafBoolean_t *	pResult
	)

Return kAAFTrue if the given class identification is a forward reference.

Succeeds if:

• The pClassID pointer is valid.
• The ppClassDef pointer is valid.
• the ID is a recognized id for a class definition.

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

• Either pClassID or ppClassDef arg is NULL.

AAFRESULT_INVALID_PARAM

• The given ID is not recognized as a class definition ID.

Parameters:

classId	[in, ref] Class Unique ID
pResult	[out,retval] true if forward class reference; false if not a forward class reference

HRESULT IAAFDictionary2::LookupAuxiliaryDataDef

(

[out, retval] IAAFDataDef **

ppDataDef

)

Return the Auxiliary Data Definition Object.

Succeeds if:

• The ppDataDef 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

• ppDataDef arg is NULL.

Parameters:

ppDataDef

[out,retval] Data Definition Object

HRESULT IAAFDictionary2::LookupClassDef	(	[in, ref] aafUID_constref	classId,
		[out, retval] IAAFClassDef **	ppClassDef
	)

Return the class definition with the given id.

Succeeds if:

• The pClassID pointer is valid.
• The ppClassDef pointer is valid.
• the ID is a recognized id for a class definition.

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

• Either pClassID or ppClassDef arg is NULL.

AAFRESULT_INVALID_PARAM

• The given ID is not recognized as a class definition ID.

Parameters:

classId	[in, ref] Class Unique ID
ppClassDef	[out,retval] Class Definition

HRESULT IAAFDictionary2::LookupCodecDef	(	[in, ref] aafUID_constref	parameterId,
		[out, retval] IAAFCodecDef **	ppParmDef
	)

Return the codec definition object with the given id.

Parameters:

parameterId	[in, ref] Parameter Unique ID
ppParmDef	[out,retval] Codec definition object

HRESULT IAAFDictionary2::LookupContainerDef	(	[in, ref] aafUID_constref	parameterId,
		[out, retval] IAAFContainerDef **	ppParmDef
	)

Return the container definition object with the given id.

Parameters:

parameterId	[in, ref] Parameter Unique ID
ppParmDef	[out,retval] Container definition object

HRESULT IAAFDictionary2::LookupDataDef	(	[in, ref] aafUID_constref	dataDefinitionId,
		[out, retval] IAAFDataDef **	ppDataDef
	)

Return the data definition object with the given id.

Parameters:

dataDefinitionId	[in, ref] Data Definition Unique ID
ppDataDef	[out,retval] Data Definition Object

HRESULT IAAFDictionary2::LookupDescriptiveMetadataDataDef

(

[out, retval] IAAFDataDef **

ppDataDef

)

Return the Descriptive Metadata Data Definition Object.

Succeeds if:

• The ppDataDef 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

• ppDataDef arg is NULL.

Parameters:

ppDataDef

[out,retval] Data Definition Object

HRESULT IAAFDictionary2::LookupEdgecodeDataDef

(

[out, retval] IAAFDataDef **

ppDataDef

)

Return the Edgecode Data Definition Object.

Succeeds if:

• The ppDataDef 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

• ppDataDef arg is NULL.

Parameters:

ppDataDef

[out,retval] Data Definition Object

HRESULT IAAFDictionary2::LookupInterpolationDef	(	[in, ref] aafUID_constref	parameterId,
		[out, retval] IAAFInterpolationDef **	ppInterpolationDef
	)

Return the Interpolation definition object with the given id.

Parameters:

parameterId	[in, ref] Parameter Unique ID
ppInterpolationDef	[out,retval] Interpolation definition object

HRESULT IAAFDictionary2::LookupKLVDataDef	(	[in, ref] aafUID_constref	defId,
		[out, retval] IAAFKLVDataDefinition **	ppDef
	)

Return the KLVData descriptor object with the given id.

Parameters:

defId	[in, ref] KLV data definition Unique ID
ppDef	[out,retval] KLVData descriptor object

HRESULT IAAFDictionary2::LookupLegacyPictureDataDef

(

[out, retval] IAAFDataDef **

ppDataDef

)

Return the legacy Picture Data Definition Object.

Succeeds if:

• The ppDataDef 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

• ppDataDef arg is NULL.

Parameters:

ppDataDef

[out,retval] Data Definition Object

HRESULT IAAFDictionary2::LookupLegacySoundDataDef

(

[out, retval] IAAFDataDef **

ppDataDef

)

Return the legacy Sound Data Definition Object.

Succeeds if:

• The ppDataDef 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

• ppDataDef arg is NULL.

Parameters:

ppDataDef

[out,retval] Data Definition Object

HRESULT IAAFDictionary2::LookupLegacyTimecodeDataDef

(

[out, retval] IAAFDataDef **

ppDataDef

)

Return the legacy Timecode Data Definition Object.

Succeeds if:

• The ppDataDef 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

• ppDataDef arg is NULL.

Parameters:

ppDataDef

[out,retval] Data Definition Object

HRESULT IAAFDictionary2::LookupMatteDataDef

(

[out, retval] IAAFDataDef **

ppDataDef

)

Return the Matte Data Definition Object.

Succeeds if:

• The ppDataDef 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

• ppDataDef arg is NULL.

Parameters:

ppDataDef

[out,retval] Data Definition Object

HRESULT IAAFDictionary2::LookupOpaqueTypeDef	(	[in, ref] aafUID_constref	typeId,
		[out, retval] IAAFTypeDef **	ppTypeDef
	)

Return the opaque type definition object with the given id.

Succeeds if:

• The pTypeID pointer is valid.
• The ppTypeDef pointer is valid.
• the ID is a recognized id for an opaque type definition.

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

• Either typeId or ppTypeDef arg is NULL.

AAFRESULT_INVALID_PARAM

• The given ID is not recognized as a type definition ID.

Parameters:

typeId	[in, ref] Type Unique ID
ppTypeDef	[out,retval] Type Definition Object

HRESULT IAAFDictionary2::LookupOperationDef	(	[in, ref] aafUID_constref	operationId,
		[out, retval] IAAFOperationDef **	ppOperationDef
	)

Return the operation definition object with the given id.

Parameters:

operationId	[in, ref] Operation Def Unique ID
ppOperationDef	[out,retval] Operation definition object

HRESULT IAAFDictionary2::LookupParameterDef	(	[in, ref] aafUID_constref	parameterId,
		[out, retval] IAAFParameterDef **	ppParmDef
	)

Return the parameter definition object with the given id.

Parameters:

parameterId	[in, ref] Parameter Unique ID
ppParmDef	[out,retval] Parameter definition object

HRESULT IAAFDictionary2::LookupPictureDataDef

(

[out, retval] IAAFDataDef **

ppDataDef

)

Return the Picture Data Definition Object.

Succeeds if:

• The ppDataDef 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

• ppDataDef arg is NULL.

Parameters:

ppDataDef

[out,retval] Data Definition Object

HRESULT IAAFDictionary2::LookupPictureWithMatteDataDef

(

[out, retval] IAAFDataDef **

ppDataDef

)

Return the PictureWithMatte Data Definition Object.

Succeeds if:

• The ppDataDef 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

• ppDataDef arg is NULL.

Parameters:

ppDataDef

[out,retval] Data Definition Object

HRESULT IAAFDictionary2::LookupPluginDef	(	[in, ref] aafUID_constref	parameterId,
		[out, retval] IAAFPluginDef **	ppPlugDef
	)

Return the plugin descriptor object with the given id.

Parameters:

parameterId	[in, ref] Parameter Unique ID
ppPlugDef	[out,retval] plugin descriptor object

HRESULT IAAFDictionary2::LookupSoundDataDef

(

[out, retval] IAAFDataDef **

ppDataDef

)

Return the Sound Data Definition Object.

Succeeds if:

• The ppDataDef 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

• ppDataDef arg is NULL.

Parameters:

ppDataDef

[out,retval] Data Definition Object

HRESULT IAAFDictionary2::LookupTaggedValueDef	(	[in, ref] aafUID_constref	defId,
		[out, retval] IAAFTaggedValueDefinition **	ppDef
	)

Return the tagged value descriptor object with the given id.

Parameters:

defId	[in, ref] tagged value definition ID
ppDef	[out,retval] tagged value descriptor object

HRESULT IAAFDictionary2::LookupTimecodeDataDef

(

[out, retval] IAAFDataDef **

ppDataDef

)

Return the Timecode Data Definition Object.

Succeeds if:

• The ppDataDef 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

• ppDataDef arg is NULL.

Parameters:

ppDataDef

[out,retval] Data Definition Object

HRESULT IAAFDictionary2::LookupTypeDef	(	[in, ref] aafUID_constref	typeId,
		[out, retval] IAAFTypeDef **	ppTypeDef
	)

Return the type definition object with the given id.

Succeeds if:

• The pTypeID pointer is valid.
• The ppTypeDef pointer is valid.
• the ID is a recognized id for a type definition.

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

• Either pTypeID or ppTypeDef arg is NULL.

AAFRESULT_INVALID_PARAM

• The given ID is not recognized as a type definition ID.

Parameters:

typeId	[in, ref] Type Unique ID
ppTypeDef	[out,retval] Type Definition Object

HRESULT IAAFDictionary2::RegisterClassDef

(

[in] IAAFClassDef *

pClassDef

)

Add the class definition object to the dictionary.

Succeeds if:

• The pClassDef pointer is valid.
• the ID contained in the class def is not already been registered.

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

• pClassDef arg is NULL.

AAFRESULT_INVALID_PARAM

• The class def ID has already been registered.

Parameters:

pClassDef

[in] Class Definition

HRESULT IAAFDictionary2::RegisterCodecDef

(

[in] IAAFCodecDef *

pParmDef

)

Add the codec definition object to the header's list of definitions.

Parameters:

pParmDef

[in] Codec Definition Object

HRESULT IAAFDictionary2::RegisterContainerDef

(

[in] IAAFContainerDef *

pParmDef

)

Add the container definition object to the header's list of definitions.

Parameters:

pParmDef

[in] Container Definition Object

HRESULT IAAFDictionary2::RegisterDataDef

(

[in] IAAFDataDef *

pDataDef

)

Add the data definition object to the header's list of definitions.

Parameters:

pDataDef

[in] Data Definition Object

HRESULT IAAFDictionary2::RegisterInterpolationDef

(

[in] IAAFInterpolationDef *

pInterpolationDef

)

Add the Interpolation definition object to the header's list of definitions.

Parameters:

pInterpolationDef

[in] Interpolation Definition Object

HRESULT IAAFDictionary2::RegisterKLVDataDef

(

[in] IAAFKLVDataDefinition *

pDef

)

Add the KLVData definition object to the header's list of definitions.

Parameters:

pDef	[in] plugin definition object

HRESULT IAAFDictionary2::RegisterKLVDataKey	(	[in] aafUID_t	pUID,
		[in] IAAFTypeDef *	pTypeDef
	)

Add the definition for the given KLV key to the runtime dictionary.

The pTypeDef will often be kAAFTypeID_UInt8Array, but may be something else.

Succeeds if:

• The pTypeDef pointer is valid.
• the definition is not already been registered with RegisterTypeDef.

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

• pTypeDef arg is NULL.

AAFRESULT_INVALID_PARAM

• The given type has already been registered.

Parameters:

pUID	[in] Key to define
pTypeDef	[in] Type Definition Object

HRESULT IAAFDictionary2::RegisterOpaqueTypeDef

(

[in] IAAFTypeDef *

pTypeDef

)

Add the opaquetype definition object to the dictionary.

Succeeds if:

• The pTypeDef pointer is valid.
• the definition is not already been registered with RegisterTypeDef.

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

• pTypeDef arg is NULL.

AAFRESULT_INVALID_PARAM

• The given type has already been registered.

Parameters:

pTypeDef

[in] Type Definition Object

HRESULT IAAFDictionary2::RegisterOperationDef

(

[in] IAAFOperationDef *

pOperationDef

)

Add the operation definition object to the header's list of definitions.

Parameters:

pOperationDef

[in] Operation Definition Object

HRESULT IAAFDictionary2::RegisterParameterDef

(

[in] IAAFParameterDef *

pParmDef

)

Add the parameter definition object to the header's list of definitions.

Parameters:

pParmDef

[in] Parameter Definition Object

HRESULT IAAFDictionary2::RegisterPluginDef

(

[in] IAAFPluginDef *

pPlugDef

)

Add the plugin definition object to the header's list of definitions.

Parameters:

pPlugDef

[in] plugin definition Object

HRESULT IAAFDictionary2::RegisterTaggedValueDef

(

[in] IAAFTaggedValueDefinition *

pDef

)

Add the tagged value definition object to the header's list of definitions.

Parameters:

pDef	[in] tagged value definition Object

HRESULT IAAFDictionary2::RegisterTypeDef

(

[in] IAAFTypeDef *

pTypeDef

)

Add the type definition object to the dictionary.

Succeeds if:

• The pTypeDef pointer is valid.
• the ID is not already been registered.

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

• pClassDef arg is NULL.

AAFRESULT_INVALID_PARAM

• The given type has already been registered.

Parameters:

pTypeDef

[in] Type Definition Object