An object which allows iteration over all of the AAFLocators attached to an AAFPluginDescriptor. More...
Public Member Functions | |
| HRESULT | NextOne ([out, retval] IAAFLocator **ppAAFLocator) |
| Enumerates to the next element in the enumerators list. | |
| HRESULT | Next ([in] aafUInt32 count,[out, size_is(count), length_is(*pFetched)] IAAFLocator **ppAAFLocators,[out, ref] aafUInt32 *pFetched) |
| Enumerates the next count elements (AAFLocator 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 EnumAAFPluginLocators::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] IEnumAAFPluginLocators **ppEnum) |
| Creates another AAFPluginLocators enumerator with the same state as the current enumerator to iterate over the same list. | |
An object which allows iteration over all of the AAFLocators attached to an AAFPluginDescriptor.
These locators describe how to locate the exact object code described in the AAFPluginDescriptor.
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
| HRESULT IEnumAAFPluginLocators::Clone | ( | [out, retval] IEnumAAFPluginLocators ** | ppEnum | ) |
Creates another AAFPluginLocators 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.
| ppEnum | [out,retval] new enumeration |
| HRESULT IEnumAAFPluginLocators::Next | ( | [in] aafUInt32 | count, |
| [out, size_is(count), length_is(*pFetched)] IAAFLocator ** | ppAAFLocators, | ||
| [out, ref] aafUInt32 * | pFetched | ||
| ) |
Enumerates the next count elements (AAFLocator 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.
| count | [in] number of AAFLocators requested |
| ppAAFLocators | [out, size_is(count), length_is(*pFetched)] array to receive AAFLocators |
| pFetched | [out,ref] number of actual AAFLocators fetched into ppAAFLocators array |
| HRESULT IEnumAAFPluginLocators::NextOne | ( | [out, retval] IAAFLocator ** | ppAAFLocator | ) |
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.
| ppAAFLocator | [out,retval] The Next AAFLocator |
| HRESULT IEnumAAFPluginLocators::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 inthe same order. The exact behavior depends on the collection being enumerated.
| HRESULT IEnumAAFPluginLocators::Skip | ( | [in] aafUInt32 | count | ) |
Instructs the enumerator to skip the next count elements in the enumeration so that the next call to EnumAAFPluginLocators::Next will not return those elements.
| count | [in] Number of elements to skip |
1.7.4