AAFA Developer Support

Public Member Functions
IEnumAAFSegments Interface Reference

List of all members.

Public Member Functions

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

Detailed Description

Definition at line 38839 of file AAF.idl.


Member Function Documentation

HRESULT IEnumAAFSegments::Clone ( [out, retval] IEnumAAFSegments **  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 IEnumAAFSegments::Next ( [in] aafUInt32  count,
[out, size_is(count), length_is(*pNumFetched)] IAAFSegment **  ppSegments,
[out, ref] aafUInt32 *  pNumFetched 
)

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

If this method fails nothing is written to *ppSegments 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 ppSegments or pNumFetched arg is NULL.
Parameters:
count[in] number of Segments requested
ppSegments[out, size_is(count), length_is(*pNumFetched)] array to receive elements
pNumFetched[out,ref] number of actual Segment objects fetched into ppSegments array
HRESULT IEnumAAFSegments::NextOne ( [out, retval] IAAFSegment **  ppSegments)

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 ppSegments pointer is valid.
  • there are Segment objects remaining to be returned.

If this method fails nothing is written to *ppSegments.

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

  • ppSegments arg is NULL.

AAFRESULT_NO_MORE_OBJECTS

  • no Segment objects remaining to be returned.
Parameters:
ppSegments[out,retval] The Next Segment
HRESULT IEnumAAFSegments::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 IEnumAAFSegments::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

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