The requested page is not available for the requested platform. You are viewing the content for .NET Framework 4.5.2+ platform.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

Session.GetObjectByKey(Type, Object) Method

Returns the persistent object that has the specified value for its key property.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v19.2.dll

Declaration

public object GetObjectByKey(
    Type classType,
    object id
)
Public Function GetObjectByKey(
    classType As Type,
    id As Object
) As Object
public object GetObjectByKey(
    Type classType,
    object id
)
Public Function GetObjectByKey(
    classType As Type,
    id As Object
) As Object

Parameters

Name Type Description
classType Type

A Type object which represents the type of objects to search for.

id Object

An object that represents the persistent object's key property value.

Parameters

Name Type Description
classType Type

A Type object which represents the type of objects to search for.

id Object

An object that represents the persistent object's key property value.

Returns

Type Description
Object

An object which represents the persistent object with the specified value for its key property.

Returns

Type Description
Object

An object which represents the persistent object with the specified value for its key property.

Remarks

Below is an example of using the GetObjectByKey method. Here, session is the Session instance.

using DevExpress.Xpo;
// ...
Person personToDelete = (Person)session.GetObjectByKey(typeof(Person), 152);
personToDelete.Delete();

Firstly, the GetObjectByKey method searches the memory for the object that has the specified value for its key property. If such an object is found, it is not reloaded. To get the up-to-date object from storage, use the overloaded Session.GetObjectByKey method with the alwaysGetFromDb parameter set to true.

Note

The GetObjectByKey method does not find objects until they are saved to a data store.

See Also