SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE GetRemainingObjectsList
extern SE_Return_Code
SE_GetRemainingObjectsList
(
SE_Iterator iterator, (notes)
SE_Remaining_Objects_List *remaining_objects_out_ptr (notes)
);

Definition

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


Returns

SE_RET_CODE_SUCCESS and the remaining objects list is returned.
SE_RET_CODE_FAILUREand the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RET_CODE_SUCCESS is returned:

SE_STAT_CODE_SUCCESS set if valid parameters were passed in and the call was successful.
SE_STAT_CODE_DIFFERENT_TRANSMITTAL set if valid parameters were passed in, but one or more objects encountered were contained in different transmittals than the iterator's start_object.
SE_STAT_CODE_NO_OBJECT set if the iterator is out of objects to return.

SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

SE_STAT_CODE_UNRESOLVED_OUTPUT_OBJECT set 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_STAT_CODE_INACTIONABLE_FAILURE set if
  1. the iterator is not valid, or
  2. the call fails for any other reason.


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.


Prev: SE_GetRelationCounts. Next: SE_GetRemainingPackedHierarchiesList. Up:Index.

Last updated: July 16, 2004 Copyright © 2004 SEDRIS