ObjectContext.CreateEntityKey(String, Object) Method

Reference

Definition

Namespace:: System.Data.Entity.Core.Objects

Assembly:: EntityFramework.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.

Creates the entity key for a specific object, or returns the entity key if it already exists.

public virtual System.Data.Entity.Core.EntityKey CreateEntityKey (string entitySetName, object entity);

abstract member CreateEntityKey : string * obj -> System.Data.Entity.Core.EntityKey
override this.CreateEntityKey : string * obj -> System.Data.Entity.Core.EntityKey

Public Overridable Function CreateEntityKey (entitySetName As String, entity As Object) As EntityKey

Parameters

entitySetName: String

The fully qualified name of the entity set to which the entity object belongs.

entity: Object

The object for which the entity key is being retrieved.

Returns

EntityKey

The EntityKey of the object.

Exceptions

ArgumentNullException

When either parameter is null.

ArgumentException

When entitySetName is empty or when the type of the entity object does not exist in the entity set or when the entitySetName is not fully qualified.

InvalidOperationException

When the entity key cannot be constructed successfully based on the supplied parameters.

Applies to