SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE FreeIterator
extern SE_Return_Code
SE_FreeIterator
(
SE_Iterator to_free_iterator1
);

Definition

This function frees the memory directly associated with the iterator specified by to_free_iterator. The handle to the iterator is invalid following a call to this function.


Returns

SE_RETCOD_SUCCESS and the iterator is deallocated.
SE_RETCOD_FAILURE and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:

SE_STATCODE_SUCCESS set if a valid parameter was passed in and all operations succeeded.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_INACTIONABLE_FAILURE set if
  1. to_free_iterator wasn't a valid iterator, or
  2. the call failed for any other reason.

Parameters Notes

1 a handle to the iterator to be freed.

Prev: SE_DetermineSpatialInclusion. Next: SE_FreeObject. Up:Index.

Last updated: July 26, 2006 Copyright © 2006 SEDRIS™