SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Types
SE_Remaining_Objects_List 
/*
 * STRUCT: SE_Remaining_Objects_List
 *
 *   Used by SE_GetRemainingObjectsList() to provide a data structure for
 *   retrieving multiple objects from an iterator.
 */
typedef struct
{
SE_Integer_Unsigned num_objects; (notes)
SE_Object *object_list; (notes)
SE_Object *link_object_list; (notes)
SE_Status_Code *object_status_list; (notes)
SE_Status_Code *link_object_status_list; (notes)
} SE_Remaining_Objects_List;

Field Notes


num_objects

 The number of objects selected by the iterator and returned in
 object_list within this data structure.

object_list

 A pointer to the list of objects returned; can be treated as an array.
 The list will be "num_objects" in length.  The order of the objects
 will be the same as the order specified when the iterator was created.

link_object_list

 A pointer to the list of link objects returned; can be treated as an
 array. The list will be "num_objects" in length. The i-th object in
 this list is the link object that would be returned by the iterator
 along with the i-th object in the objects_list. If the i-th object
 has no link object, then the i-th entry in this list will be NULL.

object_status_list


 An array of status codes, corresponding to the entries in
 object_list, and thus num_objects in length. For a valid,
 non-empty SE_Remaining_Objects_List, each entry in
 object_status_list will be one of the following:

 1) SE_STAT_CODE_SUCCESS - the corresponding object resides in the
    same transmittal as the iterator's start object.

 2) SE_STAT_CODE_DIFFERENT_TRANSMITTAL - the corresponding object
    resides in a different transmittal than the iterator's
    start object, and was successfully resolved.

 3) SE_STAT_CODE_UNRESOLVED_OUTPUT_OBJECT - the corresponding object resides
    in a different transmittal than the iterator's start
    object, but was not successfully resolved.

link_object_status_list


 An array of status codes, corresponding to the entries in
 link_object_list, and thus num_objects in length. For a
 valid, non-empty SE_Remaining_Objects_List, each entry in
 link_object_status_list will be one of the following:

 1) SE_STAT_CODE_SUCCESS - the corresponding link object resides in
    the same transmittal as the iterator's start object.

 2) SE_STAT_CODE_DIFFERENT_TRANSMITTAL - the corresponding link object
    resides in a different transmittal than the iterator's
    start object, and was successfully resolved.

 3) SE_STAT_CODE_UNRESOLVED_OUTPUT_OBJECT - the corresponding link object
    resides in a different transmittal than the iterator's
    start object, but was not successfully resolved.

 4) SE_STAT_CODE_NO_OBJECT - the corresponding link object is NULL,
    because there was no link object in the data for
    given relationship.


Prev: SE_Relative_To_Abs_Time_Point_Entry. Next: SE_Remaining_Packed_Hierarchies_List.

Return to: Top of this Page, Type Index

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