Session.ExecuteSproc(String, OperandValue[]) Method

Executes the specified stored procedure and returns its result set.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v18.2.dll

Declaration

C#

public SelectedData ExecuteSproc(
    string sprocName,
    params OperandValue[] parameters
)

VB.NET

Public Function ExecuteSproc(
    sprocName As String,
    ParamArray parameters As OperandValue()
) As SelectedData

Parameters

Name	Type	Description
sprocName	String	A String value that specifies the stored procedure’s name.
parameters	OperandValue[]	An array of OperandValue objects specifying parameters to pass to the stored procedure.

Returns

Type	Description
SelectedData	A SelectedData object specifying the result set returned by the specified stored procedure.

Remarks

This method takes in or in-out parameters. The paramerers array order should match the parameters order in the stored procedure’s signature. Out parameter values are returned in a supplementary ResultSet which includes two columns - parameter names and values. In this case the procedure returns nothing but out parameter values, the first result set will be empty and the second will contain result values. In the case where the stored procedure is a function, one more ResultSet, which contains a single cell with the function result, is returned.

Below is an example of a ExecuteSproc method call.

C#

SelectedData data = 
    session.ExecuteSproc("TestProc", new OperandValue(123), new OperandValue("abc"));

VB.NET

Dim data As SelectedData = _
session.ExecuteSproc("TestProc", New OperandValue(123), New OperandValue("abc"))

To visualize the result set returned by the ExecuteSproc method, use XPDataView. To learn how to access the resulting data, refer to How to: Access Data in SQL Query Results. For example, you can bind the GridControl control to the ExecuteSproc result as follows:

C#

using DevExpress.Xpo;
using DevExpress.Xpo.DB;
// ...
SelectedData sprocData = session.ExecuteSproc("MySproc");
gridControl1.DataSource = new XPDataView(session.Dictionary, session.GetClassInfo(typeof(MySproc)), sprocData);

VB.NET

Imports DevExpress.Xpo
Imports DevExpress.Xpo.DB
' ...
Private sprocData As SelectedData = session.ExecuteSproc("MySproc")
gridControl1.DataSource = New XPDataView(session.Dictionary, session.GetClassInfo(GetType(MySproc)), sprocData)

To learn more about executing stored procedures in XPO, refer to Stored Procedures.

Note

You can avoid an extra request that fills the parameters list and improve performance by using the Session.ExecuteSprocParametrized method instead of ExecuteSproc.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ExecuteSproc(String, OperandValue[]) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

XAF_how-to-execute-a-stored-procedure-from-the-workflow-activity-t287283/CS/ExecuteSprocWorkflowExample.Module/CustomNativeActivity2.cs#L16

    XPObjectSpace xpObjectSpace = this.XPObjectSpace.Get(context);
    xpObjectSpace.Session.ExecuteSproc("StoredProcName");
}

VB.NET

XAF_how-to-execute-a-stored-procedure-from-the-workflow-activity-t287283/VB/ExecuteSprocWorkflowExample.Module/CustomNativeActivity2.vb#L19

    Dim xpObjectSpace_Renamed As XPObjectSpace = Me.XPObjectSpace.Get(context)
    xpObjectSpace_Renamed.Session.ExecuteSproc("StoredProcName")
End Sub