Share via


EntitySetController<TEntity, TKey>.GetEntityByKey Method

This method should be overridden to retrieve an entity by key from the entity set.

Namespace:  System.Web.Http.OData
Assembly:  System.Web.Http.OData (in System.Web.Http.OData.dll)

Syntax

'Declaration
Protected Friend Overridable Function GetEntityByKey ( _
    key As TKey _
) As TEntity
'Usage
Dim key As TKey
Dim returnValue As TEntity

returnValue = Me.GetEntityByKey(key)
protected internal virtual TEntity GetEntityByKey(
    TKey key
)
protected public:
virtual TEntity GetEntityByKey(
    TKey key
)
abstract GetEntityByKey : 
        key:'TKey -> 'TEntity 
override GetEntityByKey : 
        key:'TKey -> 'TEntity 
function GetEntityByKey(
    key : TKey
) : TEntity

Parameters

  • key
    Type: TKey
    The entity key of the entity to retrieve.

Return Value

Type: TEntity
The retrieved entity, or null if an entity with the specified entity key cannot be found in the entity set.

See Also

Reference

EntitySetController<TEntity, TKey> Class

System.Web.Http.OData Namespace