SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE GetRootObject
extern SE_Return_Code
SE_GetRootObject
(
SE_Transmittal  transmittal_in,1
SE_Object  *root_object_out_ptr2
);

Definition

Given the transmittal specified by transmittal_in, this function returns in root_object_out_ptr the DRM object that has been stored as the root of the transmittal DRM object hierarchy.


Returns

SE_RETCOD_SUCCESS and the root object 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 root object was successfully returned.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_INACTIONABLE_FAILURE set if the call fails for any reason.

Parameters Notes

1 the SE_Transmittal for which the root object should be returned.

2 a pointer to the SE_Object handle into which the root object of the transmittal is stored.


Prev: SE_GetRemainingPackedHierarchiesList. Next: SE_GetSRFContextInfo. Up:Index.