IAAFTypeDefCharacter Interface Reference

This interface is used to define Integer types used in AAF persistent objects. More...

List of all members.

Public Member Functions
HRESULT	CreateValueFromCharacter ([in] aafCharacter character,[out] IAAFPropertyValue **ppCharacterValue)
	Gets a property value corresponding to the character data.
HRESULT	GetCharacter ([in] IAAFPropertyValue *pCharacterValue,[out] aafCharacter *pCharacter)
	Gets a character from the property value.
HRESULT	SetCharacter ([in] IAAFPropertyValue *pCharacterValue,[in] aafCharacter character)
	Sets a character into the given property value.

---

Detailed Description

This interface is used to define Integer types used in AAF persistent objects.

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

• IAAFTypeDef
• IAAFMetaDefinition

Definition at line 28703 of file AAF.idl.

---

Member Function Documentation

HRESULT IAAFTypeDefCharacter::CreateValueFromCharacter	(	[in] aafCharacter	character,
		[out] IAAFPropertyValue **	ppCharacterValue
	)

Gets a property value corresponding to the character data.

Succeeds if:

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

• ppCharacterValue is not a valid pointer.

Parameters:

character	[in] character data to write the the new value
ppCharacterValue	[out] character property value with the given character

HRESULT IAAFTypeDefCharacter::GetCharacter	(	[in] IAAFPropertyValue *	pCharacterValue,
		[out] aafCharacter *	pCharacter
	)

Gets a character from the property value.

Succeeds if:

• Initialize() has already been called on this object.
• The pCharacterValue pointer is valid.
• The ppActualPropertyValue 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_ILLEGAL_VALUE

• pCharacterValue is not a valid character property value.

Parameters:

pCharacterValue	[in] character property value to read
pCharacter	[out] character that is read

HRESULT IAAFTypeDefCharacter::SetCharacter	(	[in] IAAFPropertyValue *	pCharacterValue,
		[in] aafCharacter	character
	)

Sets a character into the given property value.

Succeeds if:

• Initialize() has already been called on this object.
• The pCharacterValue 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_ILLEGAL_VALUE

• pCharacterValue is not a valid character property value.

Parameters:

pCharacterValue	[in] character property value to modify
character	[in] character that is written