Definition

Removes the given object, old_object, from the given SEDRIS transmittal.

Prior to calling this function, the user must remove any relationships that old_object has with other objects. Otherwise, dangling references to old_object will still exist.

In addition, note that removing old_object does not automatically remove its component sub-tree. (This would not be valid for the general case, since part of old_object's component sub-tree might be shared with other objects). Similarly, none of old_object's associates are removed when old_object is removed.

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

Returns

SE_RET_CODE_SUCCESS	and the object is removed from the transmittal
SE_RET_CODE_FAILURE	and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RET_CODE_SUCCESS is returned:

SE_STAT_CODE_SUCCESS	set if valid parameters were passed in and all operations succeeded.
SE_STAT_CODE_DIFFERENT_TRANSMITTAL	set if old_object is in a different transmittal than the transmittal specified.

SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

set if transmittal is not a handle to a valid, active (i.e., not closed and not freed) transmittal. In this case, no changes are made.

SE_STAT_CODE_INACTIONABLE_FAILURE
SE_STAT_CODE_UNRESOLVED_INPUT_OBJECT	set if old_object is unresolved (old_object was removed but the object it referenced in another transmittal was not).
SE_STAT_CODE_INVALID_ACCESS_MODE	set if transmittal was opened in read-only mode.
SE_STAT_CODE_INACTIONABLE_FAILURE	set if old_object has a relationship to any other object, or if the call fails for any other reason.

Parameters Notes

old_object

 the object to be removed; must be resolved.

transmittal

 the transmittal containing old_object.

Prev: SE_RemoveComponentRelationship. Next: SE_ResolveObject. Up:Index.

Last updated: July 16, 2004 Copyright © 2004 SEDRIS™