AAFA Developer Support

Public Member Functions
IEnumAAFLoadedPlugins Interface Reference

An object which allows iteration over all of the AAFDefObject managed by the AAFPluginManager. More...

List of all members.

Public Member Functions

HRESULT NextOne ([out, retval] aafUID_t *ppAAFPluginID)
 Enumerates to the next element in the enumerators list.
HRESULT Next ([in] aafUInt32 count,[out, size_is(count), length_is(*pFetched)] aafUID_t *pAAFPluginIDs,[out, ref] aafUInt32 *pFetched)
 Enumerates the next count elements (AAFPluginDesc pointers) in the enumerator's list, returning them in the given array along with the actual number of enumerated elements in pFetched.
HRESULT Skip ([in] aafUInt32 count)
 Instructs the enumerator to skip the next count elements in the enumeration so that the next call to EnumAAFLoadedPlugins::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] IEnumAAFLoadedPlugins **ppEnum)
 Creates another EnumAAFLoadedPlugins enumerator with the same state as the current enumerator to iterate over the same list.

Detailed Description

An object which allows iteration over all of the AAFDefObject managed by the AAFPluginManager.

This is useful when adding something pluggable into an AAF file, as you know what choices are locally available.

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

Definition at line 36724 of file AAF.idl.


Member Function Documentation

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

Creates another EnumAAFLoadedPlugins 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. The caller must release this new enumerator separately from the first enumerator.

Parameters:
ppEnum[out,retval] new enumeration
HRESULT IEnumAAFLoadedPlugins::Next ( [in] aafUInt32  count,
[out, size_is(count), length_is(*pFetched)] aafUID_t *  pAAFPluginIDs,
[out, ref] aafUInt32 *  pFetched 
)

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

The caller is responsible for properly releasing the returned pointers.

Parameters:
count[in] number of AAFPluginDef requested
pAAFPluginIDs[out, size_is(count), length_is(*pFetched)] array to receive aafUID_t
pFetched[out,ref] number of actual AAFPluginDef fetched into ppAAFPluginDef array
HRESULT IEnumAAFLoadedPlugins::NextOne ( [out, retval] aafUID_t *  ppAAFPluginID)

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. This is a just simplified version of the Next method.

Parameters:
ppAAFPluginID[out,retval] The Next AAFPluginID
HRESULT IEnumAAFLoadedPlugins::Reset ( )

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

There is no guarantee that the same set of elements will be enumerated on each pass through the list, nor will the elements necessarily be enumerated in the same order. The exact behavior depends on the collection being enumerated.

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

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

Parameters:
count[in] Number of elements to skip

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