Function Name: Get Root Object

Definition

Given an SE_TRANSMITTAL, return the SDRM object that has been stored is root of the transmittal object hierarchy.

Returns

SE_SUCCESS - if valid parameters were passed in and the root object was successfully returned.

SE_NULL_REQUIRED_PARAMETER - and *root_object_out_ptr is left unaltered, if root_object_out_ptr is NULL.

SE_INVALID_OR_NULL_TRANSMITTAL - and *root_object_out_ptr is set to NULL, if transmittal_in is not a handle to a valid, open SEDRIS transmittal.

SE_FAILURE - and *root_object_out_ptr is set to NULL, if

  1. transmittal_in does not have a root object (e.g. the transmittal was created using the write API but without calling SE_SetRootObject()).
  2. the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Prototype


extern SE_STATUS_CODE_ENUM
SE_GetRootObject
(
SE_TRANSMITTAL transmittal_in, (notes)
SE_OBJECT *root_object_out_ptr (notes)
);

Parameters Notes

transmittal_in

 the SE_TRANSMITTAL for which the root object should be
    returned.

root_object_out_ptr

 a pointer to the SE_OBJECT handle into which the
    root object of the transmittal is stored.
Prev: Get Remaining Packed Hierarchies. Next: Get SRF Parameters. Up:Index.