Function Name: Remove Object Tree

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.

Returns

SE_INVALID_OR_NULL_OBJECT - and no changes are made, if start_object is NULL or unsaved (i.e., does not belong to a transmittal).

SE_UNRESOLVED_START_OBJECT - and no changes are made, if start_object is unresolved.

SE_UNRESOLVED_OBJECT - and no changes are made, if some objects in the tree are unresolved.

SE_DIFFERENT_TRANSMITTAL - and no changes are made, if part of the object tree is in a different transmittal than start_object.

SE_INVALID_ACCESS_MODE - and no changes are made, if start_object is in a transmittal that is open in SE_READ_ONLY mode.

SE_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.)

Prototype

Parameters Notes

start_object

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