RelationshipCol Remove Method

Meta Data Services Programming

Meta Data Services Programming

RelationshipCol Remove Method

This method deletes a relationship from its relationship collection. The exact behavior of this method depends on whether the relationship collection is an origin collection or a destination collection.

If the relationship collection is an origin collection, this method deletes the versioned relationship.

If the relationship collection is a destination collection, this method first performs object-version resolution to yield a single target-object version, and then it removes that target-object version from the relationship's TargetVersions collection.

Syntax

Call object.Remove(index) Call object.Remove(objID)
Call
object.Remove(objName)

The Remove method syntax has the following parts.

Part Description
object An object expression that evaluates to a RelationshipCol object
index The index of the relationship to be removed from the collection
objID The object identifier for the relationship object to be removed from the collection
objName The relationship that uses this name for its destination object is to be removed from the collection

Remarks

A relationship can be removed by name only if it is a unique-naming relationship.

If the source is the origin, the origin version must be unfrozen.

If the relationship is a destination relationship and the resolution strategy yields a target object version that is frozen, this method fails.

Removal from a sequenced collection does not update the collection sequence order.

See Also

Naming and Unique-Naming Collections

RelationshipCol Object

Resolution Strategy for Objects and Object Versions