Function Name: Get Iteration Length Remaining

Definition

Returns the number of objects remaining for the given iterator.

This function may take a lot of time and/or a lot of memory; don't use it unless you need to know the length of an iterator. If you do need to know length of an iterator, don't be afraid to use this function; it will not damage anything, but the call may take a while.

Returns

SE_SUCCESS - if valid parameters were passed in. In this case, the number of objects left to be returned by the iterator is copied into *count_out_ptr.

SE_NULL_REQUIRED_PARAMETER - if count_out_ptr was NULL. In this case, *count_out_ptr is left unaltered.

SE_FAILURE - and *count_out_ptr is set to 0, if

  1. the iterator is not legal, or
  2. the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Prototype


extern SE_STATUS_CODE_ENUM
SE_GetIterationLengthRemaining
(
SE_ITERATOR iterator, (notes)
SE_UINT32 *count_out_ptr (notes)
);

Parameters Notes

iterator

 the iterator whose length will be returned.

count_out_ptr

 a pointer to a SE_UINT32 in the user's memory space
    to store the result.
Prev: Get Implementation Identifier. Next: Get Next Object. Up:Index.