IAAFTaggedValueDefinition Interface Reference

This interface is used to describe the data type of a value stored in an AAFTaggedValue object. More...

List of all members.

Public Member Functions
HRESULT	Initialize ([in, ref] aafUID_constref id,[in, string] aafCharacter_constptr pName,[in, string] aafCharacter_constptr pDescription)
	Init all fields of a definition object.
HRESULT	AddParentProperty ([in] IAAFPropertyDef *pParentProperty)
	Add a property definition to the tagged value definition.
HRESULT	GetParentProperties ([out] IEnumAAFPropertyDefs **ppEnum)
	Writes an enumerator for the property definitions into *ppEnum.
HRESULT	CountParentProperties ([out] aafUInt32 *pNumProperties)
	Writes the total number of property definitions into *pNumProperties if, and only if, the method succeeds.
HRESULT	RemoveParentProperty ([in] IAAFPropertyDef *pParentProperty)
	Removes the given property definition.

---

Detailed Description

This interface is used to describe the data type of a value stored in an AAFTaggedValue object.

Objects that implement IAAFTaggedValueDefinition also implement the following interfaces:

• IAAFDefObject
• IAAFObject

Definition at line 27074 of file AAF.idl.

---

Member Function Documentation

HRESULT IAAFTaggedValueDefinition::AddParentProperty

(

[in] IAAFPropertyDef *

pParentProperty

)

Add a property definition to the tagged value definition.

Return codes:

AAFRESULT_SUCCESS

• succeeded.

AAFRESULT_NULL_PARAM

• pParentProperty is null.

Parameters:

pParentProperty

[in] Property definition to add.

HRESULT IAAFTaggedValueDefinition::CountParentProperties

(

[out] aafUInt32 *

pNumProperties

)

Writes the total number of property definitions into *pNumProperties if, and only if, the method succeeds.

Return codes:

AAFRESULT_SUCCESS

• succeeded.

AAFRESULT_NULL_PARAM

• ppEnum is null.

Parameters:

pNumProperties

[out] Number of property definitions.

HRESULT IAAFTaggedValueDefinition::GetParentProperties

(

[out] IEnumAAFPropertyDefs **

ppEnum

)

Writes an enumerator for the property definitions into *ppEnum.

A reference is added to the new enumerator before it is returned.

Return codes:

AAFRESULT_SUCCESS

• succeeded.

AAFRESULT_NULL_PARAM

• ppEnum is null.

Parameters:

ppEnum

[out] Property definition enumerator.

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

Init all fields of a definition object.

Parameters:

id	[in, ref] AUID for new DefObject
pName	[in, string] Name for new DefObject
pDescription	[in, string] Description for new DefObject

HRESULT IAAFTaggedValueDefinition::RemoveParentProperty

(

[in] IAAFPropertyDef *

pParentProperty

)

Removes the given property definition.

Return codes:

AAFRESULT_SUCCESS

• succeeded.

AAFRESULT_NULL_PARAM

• ppEnum is null.

AAFRESULT_NO_MORE_OBJECTS

• The property definition is not in this tagged value definition.

Parameters:

pParentProperty

[in] Property to remove.