|
SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE IsIteratorComplete |
|---|
| extern SE_Boolean | |||
| SE_IsIteratorComplete | |||
| ( | |||
| SE_Iterator | iter | 1 | |
| ); | |||
Indicates whether the given SE_Iterator is empty (that is, whether any SE_Object is left to be returned by that iterator).
Note that this function does not return an SE_Return_Code, so its behaviour does not distinguish between having received valid and invalid input. If for some reason iter is not valid, the user will 'get an indication of this' when the user attempts to retrieve the next SE_Object from iter; SE_IsIteratorComplete()'s behaviour is undefined for the invalid input case.
| SE_TRUE | if iter is empty |
| SE_FALSE | if iter is not empty |
SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:
| SE_STATCODE_SUCCESS | set if call was successful. |
SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:
| SE_STATCODE_INACTIONABLE_FAILURE | set if call fails for any reason. |
1 the SE_Iterator to be tested
Prev: SE_InitializeInheritedComponentIterator.
Next: SE_ObjectIsPublished.
Up:Index.
|