SE RemoveAssociateRelationship

SEDRIS Reference Manual APPENDIX A - Transmittal Access Level 0 API Functions SE RemoveAssociateRelationship

extern SE_Return_Code
SE_RemoveAssociateRelationship
(
SE_Object	from_object,	(notes)
SE_Object	to_object,	(notes)
SE_Object	link_object,	(notes)
SE_Boolean	remove_two_way	(notes)
);

Definition

Breaks the relationship between from_object and to_object (and link_object, if given), but does notremove any of the objects involved from the transmittal (see SE_RemoveFromTransmittal()).

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

Note that the relationship being removed may be 1-way or 2-way. If it is 2-way, and remove_two_way is true, both connections are broken, unless the to_object is unresolved.

Returns

SE_RET_CODE_SUCCESS and the relationship is removed.

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_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

SE_STAT_CODE_UNRESOLVED_INPUT_OBJECT set if

from_object is unresolved, or

link_object is provided but is unresolved.

SE_STAT_CODE_UNRESOLVED_OUTPUT_OBJECT set if remove_two_way was specified, and the DRM defines the relationship as bidirectional, but to_object is unresolved, so the relationship from to_object to from_object cannot be removed.

SE_STAT_CODE_INVALID_ACCESS_MODE set if

from_object is in a transmittal that is open in read-only mode,

link_object was provided but is in a transmittal that is open in read-only mode, and / or

to_object is resolved, has a relationship back to from_object and remove_two_way was specified, but to_object is in a transmittal that is open in read-only mode.

SE_STAT_CODE_INACTIONABLE_FAILURE set if

from_object and to_object are not related by an associate relationship,

if link_object is provided, and it is not the link object for the relationship, or

the call fails for any other reason.

Parameters Notes

from_object

 object whose relationship to one of its associates is being
    broken.

to_object

 object whose relationship from one of its associates (1-way
    or 2-way) is being broken.

link_object

 if specified, link object for the associate
    relationship being removed.

remove_two_way

 if the relationship is 2-way, and this flag is true,
    both connections are broken; otherwise, only one connection (from => to)
    is broken.

SE_RET_CODE_SUCCESS	and the relationship is removed.
SE_RET_CODE_FAILURE	and the status code is set appropriately if the call failed.

SE_STAT_CODE_UNRESOLVED_INPUT_OBJECT	set if from_object is unresolved, or link_object is provided but is unresolved.
SE_STAT_CODE_UNRESOLVED_OUTPUT_OBJECT	set if remove_two_way was specified, and the DRM defines the relationship as bidirectional, but to_object is unresolved, so the relationship from to_object to from_object cannot be removed.
SE_STAT_CODE_INVALID_ACCESS_MODE	set if from_object is in a transmittal that is open in read-only mode, link_object was provided but is in a transmittal that is open in read-only mode, and / or to_object is resolved, has a relationship back to from_object and remove_two_way was specified, but to_object is in a transmittal that is open in read-only mode.
SE_STAT_CODE_INACTIONABLE_FAILURE	set if from_object and to_object are not related by an associate relationship, if link_object is provided, and it is not the link object for the relationship, or the call fails for any other reason.