This interface is used to enumerate across File Descriptor objects. More...

Public Member Functions
HRESULT	NextOne ([out, retval] IAAFFileDescriptor **ppFileDescriptors)
	Enumerates to the next element in the enumerators list.
HRESULT	Next ([in] aafUInt32 count,[out, size_is(count), length_is(pNumFetched)] IAAFFileDescriptor ppFileDescriptors,[out, ref] aafUInt32 pNumFetched)
	Enumerates the next count elements (AAFFileDescriptor 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 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] IEnumAAFFileDescriptors **ppEnum)
	Creates another enumerator with the same state as the current enumerator to iterate over the same list.

Detailed Description

This interface is used to enumerate across File Descriptor 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.

Definition at line 35710 of file AAF.idl.

Member Function Documentation

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

Creates another 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.

Succeeds if all of the following are true:

the ppEnum 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

ppEnum arg is NULL.

Parameters:

ppEnum [out,retval] new enumeration

HRESULT IEnumAAFFileDescriptors::Next	(	[in] aafUInt32	count,
		[out, size_is(count), length_is(pNumFetched)] IAAFFileDescriptor *	ppFileDescriptors,
		[out, ref] aafUInt32 *	pNumFetched
	)

Enumerates the next count elements (AAFFileDescriptor 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 ppFileDescriptors pointer is valid.
The pNumFetched pointer is valid. If count is 1, pNumFetched can be NULL.
There are FileDescriptor objects remaining to be returned.

If this method fails nothing is written to *ppFileDescriptors 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 ppFileDescriptors or pNumFetched arg is NULL.

Parameters:

count	[in] number of FileDescriptors requested
ppFileDescriptors	[out, size_is(count), length_is(*pNumFetched)] array to receive elements
pNumFetched	[out,ref] number of actual FileDescriptor objects fetched into ppFileDescriptors array

HRESULT IEnumAAFFileDescriptors::NextOne ( [out, retval] IAAFFileDescriptor ** ppFileDescriptors )

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 ppFileDescriptors pointer is valid.
there are FileDescriptor objects remaining to be returned.

If this method fails nothing is written to *ppFileDescriptors.

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

ppFileDescriptors arg is NULL.

AAFRESULT_NO_MORE_OBJECTS

no FileDescriptor objects remaining to be returned.

Parameters:

ppFileDescriptors [out,retval] The Next FileDescriptor

HRESULT IEnumAAFFileDescriptors::Reset ( )

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

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

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

Instructs the enumerator to skip the next count elements in the enumeration so that the next call to 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