IAAFTypeDefVariableArrayEx Interface Reference

This interface is an extension to the previously definined TypeDefVariableArray interface. More...

List of all members.

Public Member Functions
HRESULT	PrependElement ([in] IAAFPropertyValue *pInPropVal,[in] IAAFPropertyValue *pMemberPropVal)
	Prepends an element to the end of the array, setting it to the value given in pMemberPropVal.
HRESULT	RemoveElement ([in] IAAFPropertyValue *pInPropVal,[in] aafUInt32 index)
	Remove an element from the Array, given an index.
HRESULT	InsertElement ([in] IAAFPropertyValue *pInPropVal,[in] aafUInt32 index,[in] IAAFPropertyValue *pMemberPropVal)
	Inserts the value of the single, indicated element of the fixed array contained in pInPropVal, to the value contained in pMemberPropVal.

---

Detailed Description

This interface is an extension to the previously definined TypeDefVariableArray interface.

Hence the suffix "Ex" to the name. Additional methods are now included.

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

• IAAFTypeDef
• IAAFMetaDefinition

Definition at line 52008 of file AAF.idl.

---

Member Function Documentation

HRESULT IAAFTypeDefVariableArrayEx::InsertElement	(	[in] IAAFPropertyValue *	pInPropVal,
		[in] aafUInt32	index,
		[in] IAAFPropertyValue *	pMemberPropVal
	)

Inserts the value of the single, indicated element of the fixed array contained in pInPropVal, to the value contained in pMemberPropVal.

Index is zero-based, and must be less than the value returned by GetCount(). Property value must be of the same type as returned by GetType().

Succeeds if:

• Initialize() has already been called on this object.
• the index exists in this array type def.
• The pInPropVal pointer is valid.
• The ppOutPropVal 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_NOT_INITIALIZED

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

AAFRESULT_NULL_PARAM

• either pInPropVal or ppOutPropVal arg is NULL.

AAFRESULT_BADINDEX

• The given index is out of range for this array type def.

Parameters:

pInPropVal	[in] property value corresponding to array
index	[in] zero-based index into elements in this array type
pMemberPropVal	[in] value to be inserted into this array

HRESULT IAAFTypeDefVariableArrayEx::PrependElement	(	[in] IAAFPropertyValue *	pInPropVal,
		[in] IAAFPropertyValue *	pMemberPropVal
	)

Prepends an element to the end of the array, setting it to the value given in pMemberPropVal.

Succeeds if:

• Initialize() has already been called on this object.
• pInPropVal pointer is valid.
• pMemberPropVal 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

• either pInPropVal or pMemberPropVal arg is NULL.

Parameters:

pInPropVal	[in] property value corresponding to array to which element is prepended
pMemberPropVal	[in] value to be prepended to this array

HRESULT IAAFTypeDefVariableArrayEx::RemoveElement	(	[in] IAAFPropertyValue *	pInPropVal,
		[in] aafUInt32	index
	)

Remove an element from the Array, given an index.

Index is zero-based, and must be less than the value returned by GetCount().

Succeeds if:

• Initialize() has already been called on this object.
• the index exists in this array type def.
• The pInPropVal 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_NOT_INITIALIZED

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

AAFRESULT_NULL_PARAM

• pInPropVal arg is NULL.

AAFRESULT_BADINDEX

• The given index is out of range for this array type def.

Parameters:

pInPropVal	[in] property value corresponding to array
index	[in] zero-based index into elements in this array type