IAAFScopeReference Interface Reference

This interface is used with an object representing a reference to a segment on another slot of this scope (AAFNestedScope or AAFMob) or an enclosing scope. More...

List of all members.

Public Member Functions
HRESULT	Create ([in] aafUInt32 RelativeScope,[in] aafUInt32 RelativeSlot)
	Constructs a Scope Reference object.
HRESULT	Initialize ([in] IAAFDataDef *pDataDef,[in] aafUInt32 RelativeScope,[in] aafUInt32 RelativeSlot)
	Constructs a Scope Reference object.
HRESULT	GetRelativeScope ([retval][out] aafUInt32 *pnRelativeScope)
	Gets the number of nested scopes to pass to find the Nested Scope slot.
HRESULT	GetRelativeSlot ([retval][out] aafUInt32 *pnRelativeSlot)
	Gets the number of slots that preced the slot containing the Scope Reference.

---

Detailed Description

This interface is used with an object representing a reference to a segment on another slot of this scope (AAFNestedScope or AAFMob) or an enclosing scope.

Scope references are specified in terms of a relative slot offset, and the number of scopes to skip outward. For example a slot offset of 1 and a scope of 0 means to look 1 track back in the current scope. A slot offset of 1 and a scope of 1 means to look one slot lower in the enslosing scope.

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

• IAAFSegment
• IAAFComponent
• IAAFComponent2
• IAAFObject

Definition at line 23991 of file AAF.idl.

---

Member Function Documentation

HRESULT IAAFScopeReference::Create	(	[in] aafUInt32	RelativeScope,
		[in] aafUInt32	RelativeSlot
	)

Constructs a Scope Reference object.

If this method fails the length property will not be changed.

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.)

Parameters:

RelativeScope	[in] Number of nested scopes to pass to find the Nested Scope slot
RelativeSlot	[in] Number of slots to look backwards from the slot containing the Scope Reference

HRESULT IAAFScopeReference::GetRelativeScope

(

[out] aafUInt32 *

pnRelativeScope

)

Gets the number of nested scopes to pass to find the Nested Scope slot.

Succeeds if all of the following are true:

• the pnRelativeScope pointer is valid.

If this method fails nothing will be written to *pnRelativeScope.

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

• pnRelativeScope arg is NULL.

Parameters:

pnRelativeScope

[retval][out] Pointer to a Relative Scope

HRESULT IAAFScopeReference::GetRelativeSlot

(

[out] aafUInt32 *

pnRelativeSlot

)

Gets the number of slots that preced the slot containing the Scope Reference.

Succeeds if all of the following are true:

• the pnRelativeScope pointer is valid.

If this method fails nothing will be written to *pnRelativeSlot.

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

• pnRelativeSlot arg is NULL.

Parameters:

pnRelativeSlot

[retval][out] Pointer to a Relative Slot

HRESULT IAAFScopeReference::Initialize	(	[in] IAAFDataDef *	pDataDef,
		[in] aafUInt32	RelativeScope,
		[in] aafUInt32	RelativeSlot
	)

Constructs a Scope Reference object.

If this method fails the length property will not be changed.

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.)

Parameters:

pDataDef	[in] Data definition for referenced slot
RelativeScope	[in] Number of nested scopes to pass to find the Nested Scope slot
RelativeSlot	[in] Number of slots to look backwards from the slot containing the Scope Reference