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.2.dll
NuGet Package: DevExpress.Xpo
#Declaration
public Task<ICollection<T>> GetObjectsFromSprocParametrizedAsync<T>(
CancellationToken cancellationToken,
LoadDataMemberOrderItem[] members,
string sprocName,
params SprocParameter[] parameters
)
#Parameters
Name | Type | Description |
---|---|---|
cancellation |
Cancellation |
A Cancellation |
members | Load |
An array of Load |
sproc |
String | A String value that specifies the stored procedure’s name. |
parameters | DevExpress. |
An array of Sproc |
#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
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"));
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.