SE FreeIterator

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

extern SE_Status_Code
SE_FreeIterator
(
SE_Iterator	to_free	(notes)
);

Definition

Frees the memory directly associated with the specified iterator.

Returns

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

SE_STAT_CODE_FAILURE and no changes are made, if

to_free wasn't a valid iterator, or

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

Parameters Notes

to_free

 a handle to the iterator to be freed.

SE_STAT_CODE_SUCCESS	and the iterator is freed, if a valid parameter was passed in and all operations succeeded.
SE_STAT_CODE_FAILURE	and no changes are made, if to_free wasn't a valid iterator, or the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.