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 object_count;1
SE_Object *remaining_objects_list;2
SE_Object *remaining_link_objects_list;3
SE_Status_Code *object_status_list;4
SE_Status_Code *link_object_status_list;5
} SE_Remaining_Objects_List;

Field Notes

object_count

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

remaining_objects_list

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

remaining_link_objects_list

A pointer to the list of link objects returned; can be treated as an array. The list will be object_count 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 remaining_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 remaining_objects_list, and thus object_count 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_STATCODE_SUCCESS - the corresponding object resides in the same transmittal as the iterator's start object.
  2. SE_STATCODE_DIFFERENT_TRANSMITTAL - the corresponding object resides in a different transmittal than the iterator's start object, and was successfully resolved.
  3. SE_STATCODE_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 remaining_link_objects_list, and thus object_count 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_STATCODE_SUCCESS - the corresponding link object resides in the same transmittal as the iterator's start object.
  2. SE_STATCODE_DIFFERENT_TRANSMITTAL - the corresponding link object resides in a different transmittal than the iterator's start object, and was successfully resolved.
  3. SE_STATCODE_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_STATCODE_NO_OBJECT - the corresponding link object is NULL, because there was no link object in the data for given relationship.


Prev: SE_Relative_To_Absolute_Time_Interval_Entry. Next: SE_Remaining_Packed_Hierarchies_List.

Return to: Top of this Page, Type Index

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