/*
 * 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 struct SE_PackedHierarchyObject
{
SE_OBJECT this_object; (notes)
SE_BOOLEAN components_included; (notes)
SE_UINT32 num_component_refs; (notes)
SE_PACKED_HIERARCHY_REFERENCE_PTR component_refs; (notes)
SE_BOOLEAN aggregates_included; (notes)
SE_UINT32 num_aggregate_refs; (notes)
SE_PACKED_HIERARCHY_REFERENCE_PTR aggregate_refs; (notes)
SE_FIELDS fields; (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).
 This will be the number of components of this_object (unless
 components_included is SE_FALSE, in which case it will be 0). If
 components_included is SE_TRUE, but num_component_refs is 0, then
 this_object has no components.

component_refs

 A pointer to the list of references for the components of this_object.
 This field can be treated as an array of size "num_component_refs".

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_aggregates_refs is 0, then this_object has no
 aggregates within this packed hierarchy.

num_aggregate_refs

 A count of the number of aggregate references.  This will be the number
 of aggregates of this_object that are within this packed hierarchy,
 (unless aggregates_included is SE_FALSE, in which case
 num_aggregate_refs will be 0).  If aggregates_included is SE_TRUE, but
 num_aggregate_refs is 0, then the object has no aggregates within the
 packed hierarchy that was retrieved.

aggregate_refs

 A pointer to a list of references for the aggregates of this_object.
 This list can be treated as an array of size "num_aggregate_refs".

fields

 The fields of this_object.
Prev: SE_PACKED_HIERARCHY. Next: SE_PACKED_HIERARCHY_OBJECT_PTR. Up:Index