Session.GetObjectsFromSproc(XPClassInfo, List<XPMemberInfo>, String, OperandValue[]) Method

Executes a stored procedure and returns its result set as a collection of non-persistent objects.

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 GetObjectsFromSproc(
    XPClassInfo classInfo,
    List<XPMemberInfo> members,
    string sprocName,
    params OperandValue[] parameters
)

VB.NET

Public Function GetObjectsFromSproc(
    classInfo As XPClassInfo,
    members As List(Of XPMemberInfo),
    sprocName As String,
    ParamArray parameters As OperandValue()
) As ICollection

Parameters

Name	Type	Description
classInfo	XPClassInfo	An XPClassInfo object which contains the metadata information on a non-persistent class corresponding to the stored procedure’s result set. The class must be decorated with NonPersistentAttribute.
members	List<XPMemberInfo>	Specifies object members mapped to columns in the resulting set. The order of list elements should correspond to the order of the resulting 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.

Returns

Type	Description
ICollection	A collection of non-persistent classInfo objects 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.
• 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 GetObjectsFromSproc method throws an exception if the members list 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 stored procedures in XPO and retrieving objects from the results, refer to Stored Procedures.