IAAFTypeDefObjectRef Interface Reference

This interface is used to define Object references (either strong or weak) used in AAF persistent objects. More...

List of all members.

Public Member Functions
HRESULT	GetObjectType ([out] IAAFClassDef **ppObjType)
	Returns the class def representing objects to which this type def can refer.
HRESULT	CreateValue ([in] IUnknown *pObj,[out] IAAFPropertyValue **ppPropVal)
	Creates a property value which contains an object reference.
HRESULT	GetObject ([in] IAAFPropertyValue *pPropVal,[in] REFIID iid,[out, iid_is(iid)] IUnknown **ppObject)
	Returns the object contained in the named property value.
HRESULT	SetObject ([in] IAAFPropertyValue *pPropVal,[in] IUnknown *pObject)
	Sets the named property value to refer to the named object.

---

Detailed Description

This interface is used to define Object references (either strong or weak) 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 IAAFTypeDefObjectRef also implement the following interfaces:

• IAAFTypeDef
• IAAFMetaDefinition

Definition at line 30976 of file AAF.idl.

---

Member Function Documentation

HRESULT IAAFTypeDefObjectRef::CreateValue	(	[in] IUnknown *	pObj,
		[out] IAAFPropertyValue **	ppPropVal
	)

Creates a property value which contains an object reference.

Initializes it to refer to the given object, and returns the newly-created property value in ppPropVal.

Succeeds if:

• The pObj pointer is valid.
• The ppPropVal 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 pObj or ppPropVal arg is NULL.

Parameters:

pObj	[in] object with which to initialize this object reference
ppPropVal	[out] newly created property value

HRESULT IAAFTypeDefObjectRef::GetObject	(	[in] IAAFPropertyValue *	pPropVal,
		[in] REFIID	iid,
		[out, iid_is(iid)] IUnknown **	ppObject
	)

Returns the object contained in the named property value.

Requires that pPropVal be a strong object reference or a weak object reference.

Succeeds if:

• The pPropVal pointer is valid.
• The ppObject 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 pPropVal or ppObject arg is NULL.

Parameters:

pPropVal	[in] property value from which value is to be read
iid	[in] interface id of the required output
ppObject	[out, iid_is(iid)] pointer to object value

HRESULT IAAFTypeDefObjectRef::GetObjectType

(

[out] IAAFClassDef **

ppObjType

)

Returns the class def representing objects to which this type def can refer.

The returned type def is the class definition of the least-derived type which is permissible to be represented.

Succeeds if:

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

• ppObjType arg is NULL.

Parameters:

ppObjType

[out] class def of objects permitted to be referenced

HRESULT IAAFTypeDefObjectRef::SetObject	(	[in] IAAFPropertyValue *	pPropVal,
		[in] IUnknown *	pObject
	)

Sets the named property value to refer to the named object.

Requires that pPropVal be a strong object reference or a weak object reference.

Succeeds if:

• The pPropVal pointer is valid.
• The ppObject 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 pPropVal or ppObject arg is NULL.

Parameters:

pPropVal	[in] property value from which value is to be read
pObject	[in] pointer to object value