|
SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE FreeIterator |
|---|
| extern SE_Return_Code | |||
| SE_FreeIterator | |||
| ( | |||
| SE_Iterator | to_free | (notes) | |
| ); | |||
Frees the memory directly associated with the specified iterator.
| SE_RET_CODE_SUCCESS | and the iterator is deallocated. |
| SE_RET_CODE_FAILURE | and the status code is set appropriately if the call failed. |
SE_Status_Code(s) when SE_RET_CODE_SUCCESS is returned:
| SE_STAT_CODE_SUCCESS | set if a valid parameter was passed in and all operations succeeded. |
SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:
| SE_STAT_CODE_INACTIONABLE_FAILURE |
set if
|
a handle to the iterator to be freed.
Prev: SE_DetermineSpatialInclusion.
Next: SE_FreeObject.
Up:Index.
|