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(XPClassInfo, Object) Method

Returns a persistent object with the specified value of the key property.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v19.2.dll

Declaration

public object GetObjectByKey(
    XPClassInfo classInfo,
    object id
)
Public Function GetObjectByKey(
    classInfo As XPClassInfo,
    id As Object
) As Object
public object GetObjectByKey(
    XPClassInfo classInfo,
    object id
)
Public Function GetObjectByKey(
    classInfo As XPClassInfo,
    id As Object
) As Object

Parameters

Name Type Description
classInfo XPClassInfo

An XPClassInfo object which contains the metadata information of the class.

id Object

An object which represents the key property's value of the persistent object.

Parameters

Name Type Description
classInfo XPClassInfo

An XPClassInfo object which contains the metadata information of the class.

id Object

An object which represents the key property's value of the persistent object.

Returns

Type Description
Object

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

Returns

Type Description
Object

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

Remarks

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

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

Firstly, the GetObjectByKey method searches in memory for the object with the specified value of the key property. If such an object is found, it is not reloaded. To get the up-to-date object from the data store, 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