SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Types
SE_Packed_Hierarchy_Object 
/*
 * STRUCT: SE_Packed_Hierarchy_Object
 *
 *   Part of the data returned from SE_GetPackedHierarchy() or
 *   SE_GetRemainingPackedHierarchies().  This structure represents
 *   an object in a Packed Hierarchy.
 *
 *  NOTE FOR AGGREGATE REFERENCES:
 *    Just because an object has no aggregates "within the hierarchy" does not
 *    mean the object has no aggregates.  Applications requiring this
 *    information should use an aggregate iterator to return all the aggregate
 *    objects.
 */
typedef structse_packed_hierarchy_object
{
SE_Object this_object; (notes)
SE_Boolean components_included; (notes)
SE_Integer_Unsigned num_component_refs; (notes)
SE_Packed_Hierarchy_Reference *component_refs; (notes)
SE_Boolean aggregates_included; (notes)
SE_Integer_Unsigned num_aggregate_refs; (notes)
SE_Packed_Hierarchy_Reference *aggregate_refs; (notes)
SE_Fields fields; (notes)
SE_Status_Code status; (notes)
} SE_Packed_Hierarchy_Object;

Field Notes


this_object

 A handle to the object represented by this structure. The user would
 need this in cases where the object is to be passed to other API
 functions.

components_included

 A boolean flag indicating whether the components of this_object are
 included in this packed hierarchy.  If components_included is SE_TRUE,
 but num_components_refs is 0, then the object has no components.

num_component_refs

 A count of the number of component references (see component_refs).
 The number of components of this_object that are included in
 this SE_Packed_Hierarchy.

 If components_included is SE_FALSE, this shall be zero (0).

 If components_included is SE_TRUE, but num_component_refs is 0, then
 this_object has no components within the specified packed hierarchy.

component_refs

 An array (of size num_component_refs) of references for the components
 of this_object.

aggregates_included

 A boolean flag indicating whether the aggregates of this_object are
 are included in the packed hierarchy.  If aggregates_included is
 SE_TRUE, but num_aggregate_refs is 0, then this_object has no
 aggregates within this packed hierarchy.

num_aggregate_refs

 The number of aggregates of this_object that are within this
 SE_Packed_Hierarchy.

 If aggregates_included is SE_FALSE, this shall be zero (0).

 If aggregates_included is SE_TRUE, but num_aggregate_refs is zero (0),
 then this_object has no aggregates within the specified
 packed hierarchy.

aggregate_refs

 An array (of size num_aggregate_refs) of references for the aggregates
 of this_object.

fields

 The fields of this_object.

status


 Corresponds to this_object; used to provide ITR information
 in hierarchies that cross ITR boundaries. Possible values
 are:
 1) SE_STAT_CODE_SUCCESS - the corresponding object is in the same
    transmittal as the hierarchy's root object

 2) SE_STAT_CODE_DIFFERENT_TRANSMITTAL - the corresponding object is
    in a different transmittal than the hierarchy's root
    object, and is resolved

 3) SE_STAT_CODE_UNRESOLVED_OUTPUT_OBJECT - the corresponding object is in
    a different transmittal than the hierarchy's root
    object, but was not resolved


Prev: SE_Packed_Hierarchy. Next: SE_Packed_Hierarchy_Object_Ptr.

Return to: Top of this Page, Type Index

Last updated: July 16, 2004 Copyright © 2004 SEDRIS™