SE RemoveObjectTree

SEDRIS Reference Manual APPENDIX B - Transmittal Access Level 1 API Functions SE RemoveObjectTree

extern SE_Status_Code
SE_RemoveObjectTree
(
SE_Object	start_object	¹
);

Definition

Starts at the given start_object and recursively calls SE_RemoveObjectAndLinks() on all objects below the start_object.

NOTE: Will only remove objects within the start_object's transmittal since continuing removal across ITR boundaries into other transmittals would involve deleting published objects. As this would change the transmittal's interface in a non-backwards compatible manner, it would also require a change to the transmittal's name.

The transmittal whose object is to be edited must be explicitly opened in UPDATE mode for this operation to succeed.

Returns

SE_STATCODE_SUCCESS	and the entire tree rooted at start_object is deleted, if a valid parameter was passed in and all operations succeeded.
SE_STATCODE_UNRESOLVED_INPUT_OBJECT	and no changes are made, if start_object is unresolved.
SE_STATCODE_UNRESOLVED_OUTPUT_OBJECT	and no changes are made, if any objects in the tree are unresolved.
SE_STATCODE_DIFFERENT_TRANSMITTAL	and no changes are made, if part of the object tree is in a different transmittal than start_object.
SE_STATCODE_INVALID_ACCESS_MODE	and no changes are made, if start_object is in a transmittal that is open in SE_AM_READ_ONLY mode.
SE_STATCODE_INACTIONABLE_FAILURE	and no changes are made, if start_object is a <Transmittal Root>. (If you really want to do this, just delete the transmittal files.) the API implementation specified does not provide the necessary underlying functions in its shared library, and dynamic binding is specified at compile time.

Parameters Notes

¹ object at which is rooted the component tree to be removed from the transmittal