Function Name: Remove Associate Relationship

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()).

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

SE_INVALID_OR_NULL_OBJECT - and no changes are made, if

SE_UNRESOLVED_START_OBJECT - and no changes are made, if

SE_UNRESOLVED_OBJECT - and no changes are made, if remove_two_way was specified, and the SDRM defines the relationship as bidirectional, but to_object is unresolved, so the relationship from to_object to from_object cannot be removed.

SE_INVALID_ACCESS_MODE - and no changes are made, if

SE_FAILURE - and no changes are made, if

  1. from_object and to_object are not related by an associate relationship,
  2. if link_object is provided, and it is not the link object for the relationship, or
  3. the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Prototype


extern SE_STATUS_CODE_ENUM
SE_RemoveAssociateRelationship
(
SE_OBJECT from_object, (notes)
SE_OBJECT to_object, (notes)
SE_OBJECT link_object, (notes)
SE_BOOLEAN remove_two_way (notes)
);

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.

Prev: Reference Published Object. Next: Remove Component Relationship. Up:Index.