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.GetObjectsFromQuery(XPClassInfo, LoadDataMemberOrderItem[], String) Method

Executes a SQL query and returns its result set as a collection of non-persistent objects.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v19.1.dll

Declaration

public ICollection GetObjectsFromQuery(XPClassInfo classInfo, LoadDataMemberOrderItem[] members, string sql)
Public Function GetObjectsFromQuery(classInfo As XPClassInfo, members As LoadDataMemberOrderItem(), sql As String) As ICollection
public ICollection GetObjectsFromQuery(XPClassInfo classInfo, LoadDataMemberOrderItem[] members, string sql)
Public Function GetObjectsFromQuery(classInfo As XPClassInfo, members As LoadDataMemberOrderItem(), sql As String) As ICollection

Parameters

Name Type Description
classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query's result set. The class must be decorated with NonPersistentAttribute.

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the query's result set columns.

sql String

A String value that specifies an SQL query.

Parameters

Name Type Description
classInfo XPClassInfo

An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the query's result set. The class must be decorated with NonPersistentAttribute.

members LoadDataMemberOrderItem[]

An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the query's result set columns.

sql String

A String value that specifies an SQL query.

Returns

Type Description
ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

Returns

Type Description
ICollection

A collection of non-persistent classInfo objects instantiated with data obtained via the specified SQL query.

Remarks

This method performs the following:

  • Executes the specified SQL query and obtains the query result as a result set.
  • Populates a collection with classInfo objects that are instantiated with the result set's data, based on the mapping information passed as the members parameter. Note that classInfo should represent a non-persistent class decorated with a NonPersistentAttribute.
Note

The GetObjectsFromQuery method throws an exception if the members array includes any of the following classInfo members:

  • A property that is not defined within the classInfo object.
  • A struct type member.
  • A reference to a class with a struct type member.
  • A collection used in object relations.

To learn more about executing SQL queries in XPO and retrieving objects from query results, refer to Direct SQL Queries.

See Also