SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE GetIterationLengthRemaining
extern SE_Return_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_RET_CODE_SUCCESS and the length is returned.
SE_RET_CODE_FAILURE and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RET_CODE_SUCCESS is returned:

SE_STAT_CODE_SUCCESS set if valid parameters were passed in and call was successful.

SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

SE_STAT_CODE_INACTIONABLE_FAILURE set if
  1. the iterator is invalid, or
  2. the call fails for any other reason.

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.

Prev: SE_GetImageData. Next: SE_GetLastFunctionStatus. Up:Index.

Last updated: July 16, 2004 Copyright © 2004 SEDRIS™