IAAFKLVDataDefinition Interface Reference

List of all members.

---

Detailed Description

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

Objects that implement IAAFKLVDataDefinition also implement the following interfaces:

• IAAFDefObject
• IAAFObject

Definition at line 33965 of file AAF.idl.

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 KLV data 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.
HRESULT	GetKLVDataType ([out] IAAFTypeDef **ppTypeDef)
	/// Writes the data definition object attached to this KLV data definition into the *ppTypeDef argument if, and only if, the call succeeds.
HRESULT	SetKLVDataType ([in] IAAFTypeDef *pTypeDef)
	/// Sets the date type of this KLV data definition to be the given one.

---

Member Function Documentation

HRESULT IAAFKLVDataDefinition::AddParentProperty (  [in] IAAFPropertyDef *  pParentProperty  )

/// Add a property definition to the KLV data definition. Return codes: AAFRESULT_SUCCESS succeeded. AAFRESULT_NULL_PARAM pParentProperty is null. Parameters: pParentProperty  [in] Property definition to add.

HRESULT IAAFKLVDataDefinition::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 IAAFKLVDataDefinition::GetKLVDataType (  [out] IAAFTypeDef **  ppTypeDef  )

/// Writes the data definition object attached to this KLV data definition into the *ppTypeDef argument if, and only if, the call succeeds. If none exists, NULL is written to the *ppTypeDef argument. The returned data definition object, if it exists, is AddRef()ed before it is returned. Return codes: AAFRESULT_SUCCESS succeeded. (This is the only code indicating success.) AAFRESULT_NULL_PARAM ppTypeDef is null. Parameters: ppTypeDef  [out] Returned data definition object

HRESULT IAAFKLVDataDefinition::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 IAAFKLVDataDefinition::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 DeObject pName  [in, string] Name for new DefObject pDescription  [in, string] Description for new DefObject

HRESULT IAAFKLVDataDefinition::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.

HRESULT IAAFKLVDataDefinition::SetKLVDataType (  [in] IAAFTypeDef *  pTypeDef  )

/// Sets the date type of this KLV data definition to be the given one. Return codes: AAFRESULT_SUCCESS succeeded. AAFRESULT_NULL_PARAM pTypeDef is null. Parameters: pTypeDef  [in] Data definition object

---