DbSet.FindAsync Method (Object[])
[This page is specific to the Entity Framework version 6. The latest version is available as the 'Entity Framework' NuGet package. For more information about Entity Framework, see msdn.com/data/ef.]
Asynchronously finds an entity with the given primary key values. If an entity with the given primary key values exists in the context, then it is returned immediately without making a request to the store. Otherwise, a request is made to the store for an entity with the given primary key values and this entity, if found, is attached to the context and returned. If no entity is found in the context or the store, then null is returned.
Namespace: System.Data.Entity
Assembly: EntityFramework (in EntityFramework.dll)
Syntax
'Declaration
Public Overridable Function FindAsync ( _
ParamArray keyValues As Object() _
) As Task(Of Object)
'Usage
Dim instance As DbSet
Dim keyValues As Object()
Dim returnValue As Task(Of Object)
returnValue = instance.FindAsync(keyValues)
public virtual Task<Object> FindAsync(
params Object[] keyValues
)
public:
virtual Task<Object^>^ FindAsync(
... array<Object^>^ keyValues
)
abstract FindAsync :
keyValues:Object[] -> Task<Object>
override FindAsync :
keyValues:Object[] -> Task<Object>
public function FindAsync(
... keyValues : Object[]
) : Task<Object>
Parameters
- keyValues
Type: System.Object[]
The values of the primary key for the entity to be found.
Return Value
Type: System.Threading.Tasks.Task<Object>
A task that represents the asynchronous find operation. The task result contains the entity found, or null.
Exceptions
| Exception | Condition |
|---|---|
| InvalidOperationException | Thrown if multiple entities exist in the context with the primary key values given. |
| InvalidOperationException | Thrown if the type of entity is not part of the data model for this context. |
| InvalidOperationException | Thrown if the types of the key values do not match the types of the key values for the entity type to be found. |
| InvalidOperationException | Thrown if the context has been disposed. |
Remarks
The ordering of composite key values is as defined in the EDM, which is in turn as defined in the designer, by the Code First fluent API, or by the DataMember attribute. Multiple active operations on the same context instance are not supported. Use 'await' to ensure that any asynchronous operations have completed before calling another method on this context.