|
SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE GetRootObject |
|---|
| extern SE_Return_Code | |||
| SE_GetRootObject | |||
| ( | |||
| SE_Transmittal | transmittal_in, | (notes) | |
| SE_Object | * | root_object_out_ptr | (notes) |
| ); | |||
Given a handle to a Transmittal, return the object that has been stored as the root of the transmittal's object hierarchy.
| SE_RET_CODE_SUCCESS | and the root object is returned. |
| SE_RET_CODE_FAILURE | and the status code is set appropriately if the call failed. |
SE_Status_Code(s) when SE_RET_CODE_SUCCESS is returned:
| SE_STAT_CODE_SUCCESS | set if valid parameters were passed in and the root object was successfully returned. |
SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:
| SE_STAT_CODE_INACTIONABLE_FAILURE | set if the call fails for any reason. |
the SE_Transmittal for which the root object should be
returned.
a pointer to the SE_Object handle into which the
root object of the transmittal is stored.
Prev: SE_GetRemainingPackedHierarchiesList.
Next: SE_GetSRFInfo.
Up:Index.
|