/*
 * STRUCT: SE_PACKED_HIERARCHY
 *
 *   The primary data structure returned from SE_GetPackedHierarchy() or
 *   SE_GetRemainingPackedHierarchies(). This structure represents the
 *   entry point in the the packed hierarchy.
 */
typedef struct SE_PackedHierarchy
{
SE_PACKED_HIERARCHY_OBJECT_PTR hierarchy_root_object; (notes)
SE_UINT32 object_list_size; (notes)
SE_PACKED_HIERARCHY_OBJECT_PTR object_list; (notes)
SE_UINT32 reference_list_size; (notes)
SE_PACKED_HIERARCHY_REFERENCE_PTR reference_list; (notes)
} SE_PACKED_HIERARCHY;


Field Notes

hierarchy_root_object

 A pointer to a structure representing the root object of the packed
 hierarchy. This root object will be the object that was passed in as
 the root of the call to SE_GetPackedHierarchy().

object_list_size

 The number of entries in object_list, including the entry for the
 root object of the packed hierarchy.

object_list

 A pointer to a list of the objects of the packed hierarchy; can be
 treated as an array of SE_PACKED_HIERARCHY_OBJECTs. This list is
 provided as an alternate access method to walking the hierarchy tree.
 The root object will be included in this list. All references included
 in the references will contain pointers into this list of objects.

reference_list_size

 The number of entries in reference_list.

reference_list

 A pointer to the references within the packed hierarchy; can be treated
 as an array of SE_PACKED_HIERARCHY_REFERENCEs. This list is provided as
 an alternate access point to the references.  However, the primary
 access will be through the component_refs and aggregate_refs within the
 SE_PACKED_HIERARCHY_OBJECT structure.  These "arrays" of references will
 be contiguous sections of this reference_list. All references in the
 component_refs and aggregate_refs must resolve to
 SE_PACKED_HIERARCHY_REFERENCE structures within this list.
Prev: SE_OCT_TREE_SELECT_PARAMETERS. Next: SE_PACKED_HIERARCHY_OBJECT. Up:Index