Session.GetObjectsFromSprocParametrizedAsync(CancellationToken, XPClassInfo, List<XPMemberInfo>, String, SprocParameter[]) Method

Executes a stored procedure with named parameters 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 Task<ICollection> GetObjectsFromSprocParametrizedAsync(
    CancellationToken cancellationToken,
    XPClassInfo classInfo,
    List<XPMemberInfo> members,
    string sprocName,
    params SprocParameter[] parameters
)

VB.NET

Public Function GetObjectsFromSprocParametrizedAsync(
    cancellationToken As CancellationToken,
    classInfo As XPClassInfo,
    members As List(Of XPMemberInfo),
    sprocName As String,
    ParamArray parameters As SprocParameter()
) As Task(Of ICollection)

Parameters

Name	Type	Description
cancellationToken	CancellationToken	A CancellationToken object that delivers a cancellation notice to the running operation.
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	DevExpress.Xpo.DB.SprocParameter[]	An array of SprocParameter objects specifying parameters to pass to the stored procedure.

Returns

Type	Description
Task<ICollection>	A Task<TResult> that returns a collection of non-persistent classInfo objects instantiated with data obtained via the specified stored procedure.

Remarks

C#

XPClassInfo classInfo = session.GetClassInfo<CustOrderHistModel>();
List<XPMemberInfo> members = new List<XPMemberInfo>() {
    classInfo.GetMember(nameof(CustOrderHistModel.ProductName)),
    classInfo.GetMember(nameof(CustOrderHistModel.Total))
};
ICollection sprocResultData = await session.GetObjectsFromSprocParametrizedAsync(CancellationToken.None, classInfo, members, "CustOrderHist", new SprocParameter("CustomerID", "ALFKI"));

VB.NET

Dim classInfo As XPClassInfo = session.GetClassInfo(Of CustOrderHistModel)()
Dim members As New List(Of XPMemberInfo)() From { _
    classInfo.GetMember(nameof(CustOrderHistModel.ProductName)), _
    classInfo.GetMember(nameof(CustOrderHistModel.Total)) _
}
Dim sprocResultData As ICollection = Await session.GetObjectsFromSprocParametrizedAsync(CancellationToken.None, classInfo, members, "CustOrderHist", New SprocParameter("CustomerID", "ALFKI"))

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.

This method takes named parameters. The parameter order is arbitrary. The SprocParameter.Direction property should be set to Output for out parameters. Based on the current ADO.NET provider, the data type (SprocParameter.DbType), scale (SprocParameter.Scale) and precision (SprocParameter.Precision) may be required.

Note

The GetObjectsFromSprocParametrizedAsync 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.