DataServiceContext.DetachLink Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Removes the specified link from the list of links being tracked by the DataServiceContext.

Namespace:  System.Data.Services.Client
Assembly:  System.Data.Services.Client (in System.Data.Services.Client.dll)

Syntax

'Declaration
Public Function DetachLink ( _
    source As Object, _
    sourceProperty As String, _
    target As Object _
) As Boolean
public bool DetachLink(
    Object source,
    string sourceProperty,
    Object target
)

Parameters

  • source
    Type: System.Object
    The source object participating in the link to be marked for deletion.
  • sourceProperty
    Type: System.String
    The name of the property on the source object that represents the source in the link between the source and the target.
  • target
    Type: System.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.

Return Value

Type: System.Boolean
Returns true if the specified entity was detached; otherwise false.

Exceptions

Exception Condition
ArgumentNullException

When source or sourceProperty are null.

ArgumentException

When sourceProperty is empty.

Remarks

Any link being tracked by the DataServiceContext, regardless of its current state, can be detached.

Version Information

Silverlight

Supported in: 5, 4, 3

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.