Session.GetObjectsFromSproc<T>(LoadDataMemberOrderItem[], String, OperandValue[]) Method

Executes a stored procedure and returns its result set as a collection of objects of a non-persistent type specified by the generic type parameter.

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<T> GetObjectsFromSproc<T>(
    LoadDataMemberOrderItem[] members,
    string sprocName,
    params OperandValue[] parameters
)

VB.NET

Public Function GetObjectsFromSproc(Of T)(
    members As LoadDataMemberOrderItem(),
    sprocName As String,
    ParamArray parameters As OperandValue()
) As ICollection(Of T)

Parameters

Name	Type	Description
members	LoadDataMemberOrderItem[]	An array of LoadDataMemberOrderItem objects which provide mapping information for object members and the stored procedure’s result set columns.
sprocName	String	A String value that specifies the stored procedure’s name.
parameters	OperandValue[]	An array of OperandValue objects representing parameters to pass to the stored procedure.

Type Parameters

Name	Description
T	The type of objects returned by the method. A class that implements this type sould be decorated with NonPersistentAttribute.

Returns

Type	Description
ICollection<T>	A collection of non-persistent objects of the specified type that are instantiated with data obtained via the specified stored procedure.

Remarks

This method performs the following:

• Executes the specified stored procedure with parameters and obtains the result as a result set.
• Creates objects of the specified type and instantiates them with the result set’s data, based on the mapping information passed as the members parameter. Note that the GetObjectsFromSproc<T> method’s generic type parameter should specify a non-persistent class decorated with a NonPersistentAttribute.
• Populates a collection with these objects.

Note

The GetObjectsFromSproc<T> method throws an exception if the members list includes any of the following object members:

• A property that is not defined within the T type.
• 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 stored procedures in XPO and retrieving objects from the results, refer to Stored Procedures.