ObjectContext.Detach(Object) Method

Reference

Definition

Namespace:: System.Data.Objects

Assembly:: System.Data.Entity.dll

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.

Removes the object from the object context.

public:
 void Detach(System::Object ^ entity);

public void Detach (object entity);

member this.Detach : obj -> unit

Public Sub Detach (entity As Object)

Parameters

entity: Object

Object to be detached. Only the entity is removed; if there are any related objects that are being tracked by the same ObjectStateManager, those will not be detached automatically.

Exceptions

ArgumentNullException

The entity is null.

InvalidOperationException

The entity is not associated with this ObjectContext (for example, was newly created and not associated with any context yet, or was obtained through some other context, or was already detached).

Examples

// This method is called to detach SalesOrderHeader objects and
// related SalesOrderDetail objects from the supplied object
// context when no longer needed by the application.
// Once detached, the resources can be garbage collected.
private static void DetachOrders(ObjectContext context,
    SalesOrderHeader order)
{
    try
    {
        // Detach each item from the collection.
        while (order.SalesOrderDetails.Count > 0)
        {
            // Detach the first SalesOrderDetail in the collection.
            context.Detach(order.SalesOrderDetails.First());
        }

        // Detach the order.
        context.Detach(order);
    }
    catch (InvalidOperationException ex)
    {
        Console.WriteLine(ex.ToString());
    }
}

Remarks

Removes the object from the ObjectStateManager. This disables change tracking and identity resolution for that object. For more information, see Attaching and Detaching Objects.

After the Detach method is called, the system will no longer keep references that point to this object and it can be collected by the garbage collector.

Note

Garbage collection can only occur if the user code does not have any references to the detached object.

The following considerations apply when detaching objects:

Detach only affects the specific object that is passed to the method. If the object being detached has related objects in the object context, those objects are not detached.
Detaching objects does not affect data in the data source.
Cascade delete directives and referential constraints are not enforced during a detach operation.

For more information, see Attaching and Detaching Objects.

Applies to

Jaa