Session.GetObjectsFromSprocParametrized(XPClassInfo, 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 ICollection GetObjectsFromSprocParametrized(
    XPClassInfo classInfo,
    string sprocName,
    params SprocParameter[] parameters
)

VB.NET

Public Function GetObjectsFromSprocParametrized(
    classInfo As XPClassInfo,
    sprocName As String,
    ParamArray parameters As SprocParameter()
) As ICollection

Parameters

Name	Type	Description
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.
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
ICollection	A collection of non-persistent classInfo objects instantiated with data obtained via the specified stored procedure.

Remarks

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

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 GetObjectsFromSprocParametrized method throws an exception if classInfo members include any of the following:

• 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.