SE GetRemainingObjectsList

SEDRIS Reference Manual APPENDIX A - Transmittal Access Level 0 API Functions SE GetRemainingObjectsList

extern SE_Return_Code
SE_GetRemainingObjectsList
(
SE_Iterator		iterator,	¹
SE_Remaining_Objects_List	*	remaining_objects_out_ptr	²
);

Definition

This function iterates over the remaining DRM objects available through the iterator specified by iterator, returning all of the remaining DRM objects at one time. Following this call, the iterator is left such that no more DRM objects will be returned by the iterator.

The object_count field of the output parameter is set to the number of DRM objects remaining in the iterator prior to the call, and is the number of items in each of the other array fields in the output record. The nth entry in the remaining_objects_list and remaining_link_objects_list arrays correspond to the nth DRM object returned by the iterator and its related link object, if one exists. The nth entry in the object_status_list and link_object_status_list arrays correspond to the status codes indicating the results of the DRM object retrieval for the nth DRM object.

Returns

SE_RETCOD_SUCCESS	and the remaining objects list is returned.
SE_RETCOD_FAILURE	and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:

SE_STATCODE_SUCCESS	set if valid parameters were passed in and the call was successful.
SE_STATCODE_DIFFERENT_TRANSMITTAL	set if valid parameters were passed in, but one or more objects encountered were contained in different transmittals than iterator's start object.
SE_STATCODE_NO_OBJECT	set if iterator is out of objects to return.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_UNRESOLVED_OUTPUT_OBJECT

set if valid parameters were passed in, but one or more objects encountered were not resolved.

NOTE	Unresolved objects can be identified using calls to the function SE_ObjectIsResolved().

SE_STATCODE_INACTIONABLE_FAILURE

set if

the iterator is not valid, or
the call fails for any other reason.

Parameters Notes

¹ the iterator whose remaining objects are being requested.

² a pointer to a variable in the user's memory space, into which the next object list will be copied.