SE GetRemainingPackedHierarchiesList

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

extern SE_Return_Code
SE_GetRemainingPackedHierarchiesList
(
SE_Iterator		iterator,	(notes)
SE_Integer_Unsigned		hierarchy_depth,	(notes)
SE_Remaining_Packed_Hierarchies_List	*	remaining_hierarchies_out_ptr	(notes)
);

Definition

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

Returns

SE_RET_CODE_SUCCESS and the data is returned.

SE_RET_CODE_FAILURE and 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, objects were left that have not yet been returned, and one or more objects encountered were contained in different transmittals than the iterator's start_object.

SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

SE_STAT_CODE_UNRESOLVED_OUTPUT_OBJECT set if valid parameters were passed in, objects were left that have not yet been returned, and one or more objects encountered were not resolved. In this case, the object_is_resolved field is set to SE_FALSE in each of the SE_Packed_Hierarchy_Object data structures for those objects that are unresolved.

SE_STAT_CODE_NO_OBJECT set if the iterator is out of objects to return.

SE_STAT_CODE_INACTIONABLE_FAILURE set if

the iterator is not valid, or

the call fails for any other reason.

Parameters Notes

iterator

 the iterator whose remaining objects will be the root of each
    hierarchy returned.

hierarchy_depth

 the depth to which the sub-hierarchy of each remaining
    object is extracted below that object.  A value of 1 indicates that only
    the components of each remaining object are to be returned.  A value of
    0 indicates that the entire sub-hierarchy of each remaining object is
    to be returned.

    NOTE: Care must be taken when passing "0" for the hierarchy_depth
          parameter.  The sub-hierarchies of non-primitive root objects can
          be potentially large, require large amounts of memory to
          to represent, and/or take a long time to return.

remaining_hierarchies_out_ptr

 a pointer to a
    SE_Remaining_Packed_Hierarchies_List structure that the function will
    fill in with the hierarchy list data.

SE_RET_CODE_SUCCESS	and the data is returned.
SE_RET_CODE_FAILURE	and the status code is set appropriately if the call failed.

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, objects were left that have not yet been returned, and one or more objects encountered were contained in different transmittals than the iterator's start_object.

SE_STAT_CODE_UNRESOLVED_OUTPUT_OBJECT	set if valid parameters were passed in, objects were left that have not yet been returned, and one or more objects encountered were not resolved. In this case, the object_is_resolved field is set to SE_FALSE in each of the SE_Packed_Hierarchy_Object data structures for those objects that are unresolved.
SE_STAT_CODE_NO_OBJECT	set if the iterator is out of objects to return.
SE_STAT_CODE_INACTIONABLE_FAILURE	set if the iterator is not valid, or the call fails for any other reason.