SE RemoveFromTransmittal

SEDRIS Reference Manual APPENDIX A - LEVEL 0 READ and WRITE API Functions SE RemoveFromTransmittal

extern SE_Status_Code
SE_RemoveFromTransmittal
(
SE_Object	old_object,	(notes)
SE_Transmittal	transmittal	(notes)
);

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_STAT_CODE_SUCCESS if valid parameters were passed in and all operations succeeded.

SE_STAT_CODE_INVALID_OR_NULL_OBJECT and no changes are made, if old_object is not a handle to a valid, active (i.e., unfreed) saved object. (That is, if old_object was never added to a transmittal, it cannot be removed from a transmittal).

SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL and no changes are made, 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_DIFFERENT_TRANSMITTAL and no changes are made, if old_object is in a different transmittal than the transmittal specified.

SE_STAT_CODE_UNRESOLVED_START_OBJECT and no changes are made, 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 and no changes are made, if transmittal was opened in read-only mode.

SE_STAT_CODE_FAILURE and no changes are made, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Parameters Notes

old_object

 the object to be removed; must be resolved.

transmittal

 the transmittal containing old_object.

SE_STAT_CODE_SUCCESS	if valid parameters were passed in and all operations succeeded.
SE_STAT_CODE_INVALID_OR_NULL_OBJECT	and no changes are made, if old_object is not a handle to a valid, active (i.e., unfreed) saved object. (That is, if old_object was never added to a transmittal, it cannot be removed from a transmittal).
SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL	and no changes are made, 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_DIFFERENT_TRANSMITTAL	and no changes are made, if old_object is in a different transmittal than the transmittal specified.
SE_STAT_CODE_UNRESOLVED_START_OBJECT	and no changes are made, 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	and no changes are made, if transmittal was opened in read-only mode.
SE_STAT_CODE_FAILURE	and no changes are made, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.