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.2.dll
NuGet Package: DevExpress.Xpo
#Declaration
public Task<ICollection> GetObjectsFromSprocParametrizedAsync(
CancellationToken cancellationToken,
XPClassInfo classInfo,
List<XPMemberInfo> members,
string sprocName,
params SprocParameter[] parameters
)
#Parameters
Name | Type | Description |
---|---|---|
cancellation |
Cancellation |
A Cancellation |
class |
XPClass |
An XPClass |
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 | DevExpress. |
An array of Sproc |
#Returns
Type | Description |
---|---|
Task<ICollection> | 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 sprocResultData = 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 Get
- A property that is not defined within the class
Info 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.