SE GetRootObject

SEDRIS Reference Manual APPENDIX A - LEVEL 0 READ and WRITE API Functions SE GetRootObject

extern SE_Status_Code
SE_GetRootObject
(
SE_Transmittal		transmittal_in,	(notes)
SE_Object	*	root_object_out_ptr	(notes)
);

Definition

Given a handle to a Transmittal, return the object that has been stored as the root of the transmittal's object hierarchy.

Returns

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

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and *root_object_out_ptr is left unaltered, if root_object_out_ptr is NULL.

SE_STAT_CODE_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_STAT_CODE_FAILURE and *root_object_out_ptr is set to NULL, if

transmittal_in does not have a root object (e.g. the transmittal was created using the write API but without calling SE_SetRootObject()).

the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

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.

SE_STAT_CODE_SUCCESS	if valid parameters were passed in and the root object was successfully returned.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and *root_object_out_ptr is left unaltered, if root_object_out_ptr is NULL.
SE_STAT_CODE_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_STAT_CODE_FAILURE	and *root_object_out_ptr is set to NULL, if transmittal_in does not have a root object (e.g. the transmittal was created using the write API but without calling SE_SetRootObject()). the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.