SE GetNextObject

SEDRIS Reference Manual APPENDIX A - Transmittal Access Level 0 API Functions SE GetNextObject

extern SE_Return_Code
SE_GetNextObject
(
SE_Iterator		iterator,	¹
SE_Object	*	next_object,	²
SE_Object	*	link_object	³
);

Definition

Iterates over objects available through an iterator.

This function returns the following two items (via out parameters):

the next object from the iterator
the link class object (a.k.a. association class object) traversed to find the 'next object' that was returned from the iterator

Returns

SE_RETCOD_SUCCESS	and the requested object(s) is returned.
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 valid parameters were passed in and either no inter-transmittal references (ITRs) were encountered in searching for the next object, or the iterator is configured to ignore ITR.
SE_STATCODE_DIFFERENT_TRANSMITTAL	set if valid parameters were passed in, the iterator is configured to automatically resolve ITR, an ITR reference was encountered in searching for the next object, and the iterator successfully resolved it and continued to search in the new, different transmittal until the next object from the iterator was found.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_UNRESOLVED_OUTPUT_OBJECT	set if valid parameters were passed in, an ITR reference was encountered in searching for the next object, and either the iterator is configured to automatically resolve ITR references but was unable to do so, or it is configured to stop at ITR references.
SE_STATCODE_NO_OBJECT	set if the iterator is out of objects to return.
SE_STATCODE_INACTIONABLE_FAILURE	set if the iterator is invalid, or the call fails for any other reason.

Parameters Notes

¹ the iterator whose next object is being requested.

² a pointer to a variable in the user's memory space, into which the next object of the iterator will be copied.

³ a pointer to a variable in the user's memory space, into which then link object traversed to reach the 'next object' will be copied. If no association class object was attached to the link used to reach the next object, then *link_object will be set to NULL.