ObjectContext.GetObjectByKey(EntityKey) 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.

Returns an object that has the specified entity key.

public:
 System::Object ^ GetObjectByKey(System::Data::EntityKey ^ key);

public object GetObjectByKey (System.Data.EntityKey key);

member this.GetObjectByKey : System.Data.EntityKey -> obj

Public Function GetObjectByKey (key As EntityKey) As Object

Parameters

key: EntityKey

The key of the object to be found.

Returns

Object

An Object that is an instance of an entity type.

Exceptions

ArgumentNullException

The key parameter is null.

ObjectNotFoundException

The object is not found in either the ObjectStateManager or the data source.

Examples

This example creates an EntityKey for an entity of the given type and then fetches an entity by key.

using (AdventureWorksEntities context =
    new AdventureWorksEntities())
{
    try
    {
        // Define the entity key values.
        IEnumerable<KeyValuePair<string, object>> entityKeyValues =
            new KeyValuePair<string, object>[] {
            new KeyValuePair<string, object>("SalesOrderID", 43680) };

        // Create the  key for a specific SalesOrderHeader object.
        EntityKey key = new EntityKey("AdventureWorksEntities.SalesOrderHeaders", entityKeyValues);

        // Get the object from the context or the persisted store by its key.
        SalesOrderHeader order =
            (SalesOrderHeader)context.GetObjectByKey(key);

        Console.WriteLine("SalesOrderID: {0} Order Number: {1}",
            order.SalesOrderID, order.SalesOrderNumber);
    }
    catch (ObjectNotFoundException ex)
    {
        Console.WriteLine(ex.ToString());
    }
}

Remarks

GetObjectByKey tries to retrieve an object that has the specified EntityKey from the ObjectStateManager. If the object is currently not loaded into the object context, a query is executed in an attempt to return the object from the data source. For more information, see Object Queries.

GetObjectByKey raises an ObjectNotFoundException when the object cannot be found. To avoid handling this exception, instead use the TryGetObjectByKey method.

This method will return objects in the Deleted state.

A temporary key cannot be used to return an object from the data source.

Applies to