DataServiceContext.DeleteLink(Object, String, Object) Method

Reference

Definition

Namespace:: Microsoft.OData.Client

Assembly:: Microsoft.OData.Client.dll

Package:: Microsoft.OData.Client v7.9.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Changes the state of the link to deleted in the list of links being tracked by the DataServiceContext.

public virtual void DeleteLink (object source, string sourceProperty, object target);

abstract member DeleteLink : obj * string * obj -> unit
override this.DeleteLink : obj * string * obj -> unit

Public Overridable Sub DeleteLink (source As Object, sourceProperty As String, target As Object)

Parameters

source: Object

The source object in the link to be marked for deletion.

sourceProperty: String

The name of the navigation property on the source object that is used to access the target object.

target: Object

The target object involved in the link that is bound to the source object. The target object must be of the type identified by the source property or a subtype.

Exceptions

ArgumentNullException

When source, sourceProperty, or target is null.

InvalidOperationException

When source or target is in a Detached or Added state.-or-When sourceProperty is not a collection.

Remarks

Notifies the context that a link exists between the source and target object and that the link is represented via the source.sourceProperty which is a collection. The context adds this link to the set of deleted links to be sent to the data service on the next call to SaveChanges(). If the specified link exists in the "Added" state, then the link is detached (see DetachLink method) instead.

Applies to