This interface is for the enumerator which is generated by IAAFMob and is used for enumerating over IAAFMobSlots attached to the mob. More...

Public Member Functions
HRESULT	NextOne ([out, retval] IAAFMobSlot **ppMobSlot)
	Enumerates to the next element in the enumerators list.
HRESULT	Next ([in] aafUInt32 count,[out, size_is(count), length_is(pNumFetched)] IAAFMobSlot ppMobSlots,[out, ref] aafUInt32 pNumFetched)
	Enumerates the next count elements (AAFMobSlot pointers) in the enumerator's list, returning them in the given array along with the actual number of enumerated elements in pNumFetched.
HRESULT	Skip ([in] aafUInt32 count)
	Instructs the enumerator to skip the next count elements in the enumeration so that the next call to EnumAAFMobSlots::Next will not return those elements.
HRESULT	Reset ()
	Instructs the enumerator to position itself at the beginning of the list of elements.
HRESULT	Clone ([out, retval] IEnumAAFMobSlots **ppEnum)
	Creates another mob slot enumerator with the same state as the current enumerator to iterate over the same list.

Detailed Description

This interface is for the enumerator which is generated by IAAFMob and is used for enumerating over IAAFMobSlots attached to the mob.

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.

Definition at line 36999 of file AAF.idl.

Member Function Documentation

HRESULT IEnumAAFMobSlots::Clone ( [out, retval] IEnumAAFMobSlots ** ppEnum )

Creates another mob slot enumerator with the same state as the current enumerator to iterate over the same list.

This method makes it possible to record a point in the enumeration sequence in order to return to that point at a later time.

Note: The caller must release this new enumerator separately from the first enumerator.

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

ppEnum is null.

Parameters:

ppEnum [out,retval] new enumeration

HRESULT IEnumAAFMobSlots::Next	(	[in] aafUInt32	count,
		[out, size_is(count), length_is(pNumFetched)] IAAFMobSlot *	ppMobSlots,
		[out, ref] aafUInt32 *	pNumFetched
	)

Enumerates the next count elements (AAFMobSlot pointers) in the enumerator's list, returning them in the given array along with the actual number of enumerated elements in pNumFetched.

The caller is responsible for properly releasing the returned pointers.

Succeeds if all of the following are true:

the ppMobSlots pointer is valid.
the pNumFetched pointer is valid.
there are Mob Slot objects remaining to be returned.

If this method fails nothing is written to *ppMobSlots or pNumFetched.

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

either ppMob or pNumFetched is null.

E_INVALIDARG

Hit the end of the list of slots being enumerated over.

Parameters:

count	[in] number of mob slots requested
ppMobSlots	[out, size_is(count), length_is(*pNumFetched)] array to receive mob slots
pNumFetched	[out,ref] number of actual MobSlots fetched into ppMobSlots array

HRESULT IEnumAAFMobSlots::NextOne ( [out, retval] IAAFMobSlot ** ppMobSlot )

Enumerates to the next element in the enumerators list.

The caller is responsible for properly releasing the returned pointer when it is no longer needed.

Succeeds if all of the following are true:

the ppMobSlot pointer is valid.
there are Mob Slot objects remaining to be returned.

If this method fails nothing is written to *ppMobSlot.

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

ppMobSlot is null.

AAFRESULT_NO_MORE_OBJECTS

Hit the end of the list of slots being enumerated over.

Parameters:

ppMobSlot [out,retval] The Next MobSlot

HRESULT IEnumAAFMobSlots::Reset ( )

Instructs the enumerator to position itself at the beginning of the list of elements.

Always succeeds.

This method will return the following code:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

HRESULT IEnumAAFMobSlots::Skip ( [in] aafUInt32 count )

Instructs the enumerator to skip the next count elements in the enumeration so that the next call to EnumAAFMobSlots::Next will not return those elements.

Succeeds if all of the following are true:

count is less than or equal to the number of remaining objects.

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_NO_MORE_OBJECTS

count exceeded number of remaining objects.

Parameters:

count [in] Number of elements to skip

Public Member Functions

Detailed Description

Member Function Documentation