Session.GetObjectsByKey(ObjectsByKeyQuery[], Boolean) Method

Returns reloaded persistent objects from a data store, using queries based on specified object types and key values.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v24.1.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap, DevExpress.Xpo

NuGet Package: DevExpress.Xpo

Declaration

C#

public ICollection[] GetObjectsByKey(
    ObjectsByKeyQuery[] queries,
    bool alwaysGetFromDataStore
)

VB.NET

Public Function GetObjectsByKey(
    queries As ObjectsByKeyQuery(),
    alwaysGetFromDataStore As Boolean
) As ICollection()

Parameters

Name	Type	Description
queries	ObjectsByKeyQuery[]	An array of ObjectsByKeyQuery objects, containing data for queries that retrieve persistent objects by specified object types and key values.
alwaysGetFromDataStore	Boolean	true to reload persistent objects from storage if they are found in memory; otherwise, false.

Returns

Type	Description
ICollection[]	An array of persistent object collections retrieved for query data passed as the queries parameter.

Remarks

Firstly, the GetObjectsByKey method searches in memory for persistent objects with specified values of the key property. If such objects are found, they are not reloaded. To get the up-to-date objects from storage, the alwaysGetFromDb parameter must be set to true.

Note

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