AAFA Developer Support

Public Member Functions
IAAFPropertyValue Interface Reference

This interface is used to access the values of properties contained in AAF persistent objects. More...

List of all members.

Public Member Functions

HRESULT GetType ([out] IAAFTypeDef **ppTypeDef)
 Returns the type definition associated with this property value.
HRESULT IsDefinedType ([out] aafBoolean_t *pIsDefined)
 Returns false if this property value's type is not (necessarily) the one which was defined for it.

Detailed Description

This interface is used to access the values of properties contained in AAF persistent objects.

Values may be simple (e.g. integer), structured (e.g. aafTimecode_t), other AAF persistent objects, media, or arrays of other types.

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

Definition at line 22406 of file AAF.idl.


Member Function Documentation

HRESULT IAAFPropertyValue::GetType ( [out] IAAFTypeDef **  ppTypeDef)

Returns the type definition associated with this property value.

If this Property Value is not of a recognized type (such as from a damaged or incorrectly construct file) this method will return a raw access type which can be used to access the property data in a raw manner.

Succeeds if:

  • The ppTypeDef pointer is valid.
  • The associated type definition can be found in the dictionary.

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

  • ppTypeDef arg is NULL.
Parameters:
ppTypeDef[out] The type definition associated with this property value
HRESULT IAAFPropertyValue::IsDefinedType ( [out] aafBoolean_t *  pIsDefined)

Returns false if this property value's type is not (necessarily) the one which was defined for it.

That may be the case if this property value was read from a damaged file where type information was not available; in that case GetType() will return the raw access type for this value.

If this property value's type is the one which was defined for it, this method will return true and GetType() will return that defined type for this value.

Succeeds if:

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

  • pIsDefined arg is NULL.
Parameters:
pIsDefined[out] result

Generated on Wed Jul 4 2012 22:13:30 for AAF COM API by doxygen 1.7.4