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_GetRemainingPackedHierarchiesList().  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_packed_hierarchy_object
{
SE_Object this_object;1
SE_Boolean components_included;2
SE_Integer_Unsigned component_count;3
SE_Packed_Hierarchy_Reference *components;4
SE_Boolean aggregates_included;5
SE_Integer_Unsigned aggregate_count;6
SE_Packed_Hierarchy_Reference *aggregates;7
SE_DRM_Class_Fields fields;8
SE_Status_Code status_code;9
} 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 component_count is 0, then the object has no components.

component_count

A count of the number of component references (see components). 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 component_count is 0, then this_object has no components within the specified packed hierarchy.

components

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

aggregates_included

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

aggregate_count

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 aggregate_count is zero (0), then this_object has no aggregates within the specified packed hierarchy.

aggregates

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

fields

The fields of this_object.

status_code

Corresponds to this_object; used to provide ITR information in hierarchies that cross ITR boundaries. Possible values are:

  1. SE_STATCODE_SUCCESS - the corresponding object is in the same transmittal as the hierarchy's root object
  2. SE_STATCODE_DIFFERENT_TRANSMITTAL - the corresponding object is in a different transmittal than the hierarchy's root object, and is resolved
  3. SE_STATCODE_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_Access.

Return to: Top of this Page, Type Index

Last updated: July 1, 2011 Copyright © 2011 SEDRIS™