SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE GetRemainingPackedHierarchiesList
extern SE_Return_Code
SE_GetRemainingPackedHierarchiesList
(
SE_Iterator iterator,1
SE_Integer_Unsigned hierarchy_depth,2
SE_Remaining_Packed_Hierarchies_List *remaining_hierarchies3
);

Definition

This function iterates over the remaining objects available through the iterator specified by iterator and returns packed hierarchies for all of them at one time. The number of remaining packed hierarchies and each packed hierarchy are returned in remaining_hierarchies.


Returns

SE_RETCOD_SUCCESS and the data 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 the call was successful.
SE_STATCODE_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_RETCOD_FAILURE is returned:

SE_STATCODE_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 status_code field is set to SE_STATCODE_UNRESOLVED_OUTPUT_OBJECT in each of the SE_Packed_Hierarchy_Object data structures for those objects that are unresolved.
SE_STATCODE_NO_OBJECT set if the iterator is out of objects to return.
SE_STATCODE_INACTIONABLE_FAILURE set if
  1. iterator is not valid, or
  2. the call fails for any other reason.

Parameters Notes

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

2 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.

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


Prev: SE_GetRemainingObjectsList. Next: SE_GetRootObject. Up:Index.

Last updated: July 26, 2006 Copyright © 2006 SEDRIS