Edit

ObjectContext.AttachTo(String, Object) Method

  • Reference

Definition

Namespace:
System.Data.Objects
Assembly:
System.Data.Entity.dll

Attaches an object or object graph to the object context in a specific entity set.

public:
 void AttachTo(System::String ^ entitySetName, System::Object ^ entity);
public void AttachTo (string entitySetName, object entity);
member this.AttachTo : string * obj -> unit
Public Sub AttachTo (entitySetName As String, entity As Object)

Parameters

entitySetName
String

Represents the entity set name, which may optionally be qualified by the entity container name.

entity
Object

The Object to attach.

Exceptions

ArgumentNullException

The entity is null.

InvalidOperationException

Invalid entity set.

-or-

The object has a temporary key.

-or-

The object has an EntityKey and the EntitySet does not match with the entity set passed in as an argument of the method.

-or-

The object does not have an EntityKey and no entity set is provided.

-or-

Any object from the object graph has a temporary EntityKey.

-or-

Any object from the object graph has an invalid EntityKey (for example, values in the key do not match values in the object).

-or-

The entity set could not be found from a given entitySetName name and entity container name.

-or-

Any object from the object graph already exists in another state manager.

Remarks

Call AttachTo on the ObjectContext to attach the object to a specific entity set in the object context or if the object has a null (Nothing in Visual Basic) EntityKey value. For more information, see Attaching and Detaching Objects.

The object being attached can be a single object or be part of the graph.

The rules for the entitySetName format are as follows:

  • If the DefaultContainerName property is null, then the entitySetName has to be fully qualified as in <Entity Container Name>.<Entity Set Name>.

  • If the DefaultContainerName is not null, then the entitySetName can be either <Entity Container Name>.<Entity Set Name> or <Entity Set Name>.

The object being attached is not required to have an EntityKey associated with it. If the object does not have an entity key, then entitySetName cannot be an empty string.

If the object being attached has an EntityKey and entitySetName has a value, then the EntitySet of the entity key must match the EntitySet that was found based on the entitySetName and entity container name.

Applies to

See also