Remove Object And Links

Function Name: Remove Object And Links

Definition

Removes the specified object from the transmittal in which it resides, after breaking any relationships between it and its components, associations, and aggregates. Also removes any link objects involved in these relationships from the transmittal.

Returns

SE_SUCCESS - if a valid parameter was passed in and it was possible to break all relationships from object_to_remove to other objects.

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

SE_UNRESOLVED_START_OBJECT - and no changes are made, if object_to_remove is an unresolved object.

SE_UNRESOLVED_OBJECT - and no changes are made, if object_to_remove has relationships that the SDRM defines as bidirectional to unresolved component objects. This means that there may be a relationship from the component object back to object_to_remove that cannot be broken.

SE_INVALID_ACCESS_MODE - and no changes are made, if

object_to_remove is in a transmittal that is open in SE_READ_ONLY mode
object_to_remove has component relationships that the SDRM defines as bidirectional to resolved objects in other transmittals that are open in SE_READ_ONLY mode

Prototype

extern SE_STATUS_CODE_ENUM
SE_RemoveObjectAndLinks
(
SE_OBJECT	object_to_remove	(notes)
);

Parameters Notes

object_to_remove

 object to be removed from a transmittal

Prev: Rearrange Image Data. Next: Remove Object Tree. Up:Index.