SE GetIterationLengthRemaining

SEDRIS Reference Manual APPENDIX A - LEVEL 0 READ and WRITE API Functions SE GetIterationLengthRemaining

extern SE_Status_Code
SE_GetIterationLengthRemaining
(
SE_Iterator		iterator,	(notes)
SE_Integer_Unsigned	*	count_out_ptr	(notes)
);

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_STAT_CODE_SUCCESS and the number of objects left to be returned by the iterator is copied into *count_out_ptr, if valid parameters were passed in.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and *count_out_ptr is left unaltered, if count_out_ptr was NULL.

SE_STAT_CODE_FAILURE and *count_out_ptr is set to 0, if

the iterator is invalid, or

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

Parameters Notes

iterator

 the iterator whose length will be returned.

count_out_ptr

 a pointer to a SE_Integer_Unsigned in the user's memory
    space to store the result.

SE_STAT_CODE_SUCCESS	and the number of objects left to be returned by the iterator is copied into *count_out_ptr, if valid parameters were passed in.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and *count_out_ptr is left unaltered, if count_out_ptr was NULL.
SE_STAT_CODE_FAILURE	and *count_out_ptr is set to 0, if the iterator is invalid, or the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.