Session.GetObjectsFromSprocParametrizedAsync<T>(CancellationToken, LoadDataMemberOrderItem[], 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<T>> GetObjectsFromSprocParametrizedAsync<T>(
    CancellationToken cancellationToken,
    LoadDataMemberOrderItem[] members,
    string sprocName,
    params SprocParameter[] parameters
)

VB.NET

Public Function GetObjectsFromSprocParametrizedAsync(Of T)(
    cancellationToken As CancellationToken,
    members As LoadDataMemberOrderItem(),
    sprocName As String,
    ParamArray parameters As SprocParameter()
) As Task(Of ICollection(Of T))

Parameters

Name	Type	Description
cancellationToken	CancellationToken	A CancellationToken object that delivers a cancellation notice to the running operation.
members	LoadDataMemberOrderItem[]	An array of LoadDataMemberOrderItem objects which provide mapping information for classInfo members and the stored procedure’s result 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.

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
Task<ICollection<T>>	A Task<TResult> that returns a collection of non-persistent objects of the specified type that are instantiated with data obtained via the specified stored procedure.

Remarks

C#

LoadDataMemberOrderItem[] members = new[] {
    new LoadDataMemberOrderItem(0, nameof(CustOrderHistModel.ProductName)),
    new LoadDataMemberOrderItem(1, nameof(CustOrderHistModel.Total))
};
ICollection<CustOrderHistModel> sprocResultData = await session.GetObjectsFromSprocParametrizedAsync<CustOrderHistModel>(CancellationToken.None, members, "CustOrderHist", new SprocParameter("CustomerID", "ALFKI"));

VB.NET

Dim members() As LoadDataMemberOrderItem = {
New SprocParameter("CustomerID", "ALFKI"))
    New LoadDataMemberOrderItem(0, nameof(CustOrderHistModel.ProductName)),
    New LoadDataMemberOrderItem(1, nameof(CustOrderHistModel.Total))
}
Dim sprocResultData As ICollection(Of CustOrderHistModel) = Await session.GetObjectsFromSprocParametrizedAsync(Of CustOrderHistModel)(CancellationToken.None, members, "CustOrderHist", 

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.