SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE RemoveFromTransmittal
extern SE_Return_Code
SE_RemoveFromTransmittal
(
SE_Object old_object,1
SE_Transmittal transmittal2
);

Definition

Removes the given object, old_object, from the given 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_RETCOD_SUCCESS and old_object is removed from the transmittal
SE_RETCOD_FAILURE and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:

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

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_INACTIONABLE_FAILURE 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_STATCODE_UNRESOLVED_INPUT_OBJECT set if old_object is unresolved (old_object was removed but the object it referenced in another transmittal was not).
SE_STATCODE_INVALID_ACCESS_MODE set if transmittal was opened in read-only mode.
SE_STATCODE_INACTIONABLE_FAILURE set if old_object has a relationship to any other object, or if the call fails for any other reason.

Parameters Notes

1 the object to be removed; must be resolved.

2 the transmittal containing old_object.


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

Last updated: July 26, 2006 Copyright © 2006 SEDRIS