SE GetNextObject

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

extern SE_Status_Code
SE_GetNextObject
(
SE_Iterator		iterator,	(notes)
SE_Object	*	next_object_out_ptr,	(notes)
SE_Object	*	link_class_object_out_ptr	(notes)
);

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_STAT_CODE_SUCCESS and *next_object_out_ptr is set to point to the next object from the iterator, and *link_class_object_out_ptr is set appropriately if provided, 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_STAT_CODE_DIFFERENT_TRANSMITTAL and the output parameter values are set as for SE_STAT_CODE_SUCCESS, 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_STAT_CODE_NULL_REQUIRED_PARAMETER and the output parameter values are left unaltered, if next_object_out_ptr was NULL.

SE_STAT_CODE_UNRESOLVED_OBJECT and the output parameters are set to NULL, 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_STAT_CODE_NO_OBJECT and the output parameters are set as for SE_STAT_CODE_UNRESOLVED_OBJECT, if the iterator is out of objects to return.

SE_STAT_CODE_OUT_OF_MEMORY and the output parameters are set as for SE_STAT_CODE_UNRESOLVED_OBJECT, if the API cannot allocate memory for the next object to be returned.

SE_STAT_CODE_FAILURE and the output parameter values are set as for SE_STAT_CODE_UNRESOLVED_OBJECT, if

the iterator is invalid, or

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

Parameters Notes

iterator

 the iterator whose next object is being requested.

next_object_out_ptr

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

link_class_object_out_ptr

 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_class_object_out_ptr will be set to NULL.

SE_STAT_CODE_SUCCESS	and next_object_out_ptr is set to point to the next object from the iterator, and link_class_object_out_ptr is set appropriately if provided, 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_STAT_CODE_DIFFERENT_TRANSMITTAL	and the output parameter values are set as for SE_STAT_CODE_SUCCESS, 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_STAT_CODE_NULL_REQUIRED_PARAMETER	and the output parameter values are left unaltered, if next_object_out_ptr was NULL.
SE_STAT_CODE_UNRESOLVED_OBJECT	and the output parameters are set to NULL, 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_STAT_CODE_NO_OBJECT	and the output parameters are set as for SE_STAT_CODE_UNRESOLVED_OBJECT, if the iterator is out of objects to return.
SE_STAT_CODE_OUT_OF_MEMORY	and the output parameters are set as for SE_STAT_CODE_UNRESOLVED_OBJECT, if the API cannot allocate memory for the next object to be returned.
SE_STAT_CODE_FAILURE	and the output parameter values are set as for SE_STAT_CODE_UNRESOLVED_OBJECT, if the iterator is invalid, or the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.