Function Name: Get Remaining Objects List

Definition

Iterates over the remaining objects available through an iterator, and returns all of all of them at one time.

Returns

SE_DIFFERENT_TRANSMITTAL - and *remaining_objects_out_ptr is filled in with the object list data, if valid parameters were passed in but one or more objects encountered were contained in different transmittals than the iterator's start_object.

SE_UNRESOLVED_OBJECT - and *remaining_objects_out_ptr is filled in with the object list data, if valid parameters were passed in but one or more objects encountered were not resolved.

NOTE: Unresolved objects can be identified using calls to the function SE_ObjectIsResolved().

SE_NULL_REQUIRED_PARAMETER - and *remaining_objects_out_ptr is left unaltered, if remaining_objects_out_ptr was NULL.

SE_NO_OBJECT - and the fields of *remaining_objects_out_ptr set to zero or NULL, if the iterator is out of objects to return.

SE_FAILURE - and the fields of *remaining_objects_out_ptr are left unaltered, if

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

Prototype

Parameters Notes

iterator

 the iterator whose remaining objects are being requested.

remaining_objects_out_ptr

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