AAFA Developer Support

Public Member Functions
IAAFTypeDefRename Interface Reference

This interface is used to define Renamed types (analogous to C typedefs) used in AAF persistent objects. More...

List of all members.

Public Member Functions

HRESULT Initialize ([in, ref] aafUID_constref id,[in] IAAFTypeDef *pBaseType,[in, string] aafCharacter_constptr pTypeName)
 Initializes this type def to be an alias for the given type (similar to a C typedef).
HRESULT GetBaseType ([out] IAAFTypeDef **ppBaseType)
 Returns the type definition to which this type def is an alias.
HRESULT GetBaseValue ([in] IAAFPropertyValue *pInPropVal,[out] IAAFPropertyValue **ppOutPropVal)
 Gets the property value of the base type from the given property value of the typedef type and places a pointer to the base type's property value into *ppOutPropVal.
HRESULT CreateValue ([in] IAAFPropertyValue *pInPropVal,[out] IAAFPropertyValue **ppOutPropVal)
 Gets the property value of the typedef type from the given property value of the base type and places a pointer to the base type's property value into *ppOutPropVal.

Detailed Description

This interface is used to define Renamed types (analogous to C typedefs) 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

Objects that implement IAAFTypeDefRename also implement the following interfaces:

Definition at line 31938 of file AAF.idl.


Member Function Documentation

HRESULT IAAFTypeDefRename::CreateValue ( [in] IAAFPropertyValue pInPropVal,
[out] IAAFPropertyValue **  ppOutPropVal 
)

Gets the property value of the typedef type from the given property value of the base type and places a pointer to the base type's property value into *ppOutPropVal.

Succeeds if:

  • 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

AAFRESULT_NULL_PARAM

  • pInPropVal or ppOutPropVal is NULL.
Parameters:
pInPropVal[in] property value from which value is to be read
ppOutPropVal[out] pointer to property value represented by rename type
HRESULT IAAFTypeDefRename::GetBaseType ( [out] IAAFTypeDef **  ppBaseType)

Returns the type definition to which this type def is an alias.

Succeeds if:

  • this object has been Initialize()d.
  • The ppBaseType 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

AAFRESULT_NULL_PARAM

  • ppBaseType pointer is NULL.
Parameters:
ppBaseType[out] type definition for which this is an alias
HRESULT IAAFTypeDefRename::GetBaseValue ( [in] IAAFPropertyValue pInPropVal,
[out] IAAFPropertyValue **  ppOutPropVal 
)

Gets the property value of the base type from the given property value of the typedef type and places a pointer to the base type's property value into *ppOutPropVal.

Succeeds if:

  • 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

AAFRESULT_NULL_PARAM

  • pInPropVal or ppOutPropVal is NULL.
Parameters:
pInPropVal[in] property value from which value is to be read
ppOutPropVal[out] pointer to property value represented by base type
HRESULT IAAFTypeDefRename::Initialize ( [in, ref] aafUID_constref  id,
[in] IAAFTypeDef pBaseType,
[in, string] aafCharacter_constptr  pTypeName 
)

Initializes this type def to be an alias for the given type (similar to a C typedef).

This method must be called after allocation, and before any other method can be called.

Succeeds if:

  • Initialize() has not yet been called on this object.
  • pBaseType is a valid pointer.
  • pTypeName is a valid pointer.

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

  • pBaseType or pTypeName is null.

AAFRESULT_ALREADY_INITIALIZED

Parameters:
id[in, ref] auid to be used to identify this type
pBaseType[in] type to which this is an alias
pTypeName[in, string] friendly name of this type definition

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