Function Name: Free Iterator

Definition

Frees the memory directly associated with the specified iterator.

Returns

SE_SUCCESS - and the iterator is freed, if a valid parameter was passed in and all operations succeeded.

SE_FAILURE - and no changes are made, if

  1. to_free wasn't a valid iterator, 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_FreeIterator
(
SE_ITERATOR to_free (notes)
);

Parameters Notes

to_free

 the iterator to be freed.
Prev: Determine Spatial Inclusion. Next: Free Object. Up:Index.