Session.GetObjectsFromSprocAsync<T>(CancellationToken, List<XPMemberInfo>, String, OperandValue[]) Method
Asynchronously executes a stored procedure and returns its result set as a collection of non-persistent objects.
Namespace: DevExpress.Xpo
Assembly: DevExpress.Xpo.v24.2.dll
NuGet Package: DevExpress.Xpo
#Declaration
public Task<ICollection<T>> GetObjectsFromSprocAsync<T>(
CancellationToken cancellationToken,
List<XPMemberInfo> members,
string sprocName,
params OperandValue[] parameters
)
#Parameters
Name | Type | Description |
---|---|---|
cancellation |
Cancellation |
A Cancellation |
members | List<XPMember |
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. |
sproc |
String | A String value that specifies the stored procedure’s name. |
parameters | Operand |
An array of Operand |
#Type Parameters
Name | Description |
---|---|
T | The type of objects returned by the method. A class that implements this type sould be decorated with Non |
#Returns
Type | Description |
---|---|
Task<ICollection<T>> | A Task |
#Remarks
XPClassInfo classInfo = session.GetClassInfo<CustOrderHistModel>();
List<XPMemberInfo> members = new List<XPMemberInfo>() {
classInfo.GetMember(nameof(CustOrderHistModel.ProductName)),
classInfo.GetMember(nameof(CustOrderHistModel.Total))
};
ICollection<CustOrderHistModel> sprocResultData = await session.GetObjectsFromSprocAsync<CustOrderHistModel>(CancellationToken.None, members, "CustOrderHist", "ALFKI");
This method performs the following:
- Asynchronously 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. The type and the order of classInfo members should exactly match the result set’s columns. Note that classInfo should represent a non-persistent class decorated with a NonPersistentAttribute.
Note
The Get
- 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.