Microsoft KB Archive/310070

= HOW TO: Call a Parameterized Stored Procedure by Using ADO.NET and Visual C# .NET =

Article ID: 310070

Article Last Modified on 9/4/2003

-

APPLIES TO


 * Microsoft .NET Framework 1.1 Service Pack 1
 * Microsoft ADO.NET 1.1
 * Microsoft Visual C# .NET 2002 Standard Edition
 * Microsoft Visual C# .NET 2003 Standard Edition

-



This article was previously published under Q310070



For a Microsoft Visual Basic .NET version of this article, see 308049.

For a Microsoft Visual C++ .NET version of this article, see 310071.

For a Microsoft Visual J# .NET version of this article, see 320627.

This article refers to the following Microsoft .NET Framework Class Library namespaces:
 * System.Data.SqlClient
 * System.Data.OleDb

IN THIS TASK
SUMMARY
 * Use DataReader to Return Rows and Parameters
 * Use the ExecuteScalar Method of the Command Object
 * Use the ExecuteNonQuery Method of the Command Object

REFERENCES



SUMMARY
There are several ways to use ADO.NET to call a stored procedure and to get back return values and return parameters, including:
 * Use a DataSet object to gather the returned rows and to work with these rows in addition to the return values and the return parameters.
 * Use a DataReader object to gather the returned rows, to move through these rows, and then to gather return values and return parameters.
 * Use the ExecuteScalar method to return the value from the first column of the results' first row with the return values and the return parameters. This is most useful with aggregate functions.
 * Use the ExecuteNonQuery method to return only the return parameters and the return values. Any returned rows are discarded. This is most useful for executing action queries.

This article demonstrates the last three methods and uses both the SqlCommand and the OleDbCommand objects. Make sure that you copy only the code for the managed provider that you are using. If you are not sure which managed provider you should use, visit the following Microsoft Developer Network Web site:

.NET Data Providers

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpguide/html/cpconadonetproviders.asp

In each of the samples in this article, the parameters are added to the Parameters collection of the Command object. When you use the SqlCommand object, you do not have add the parameters in any particular order, but the parameters must have the correct name. When you use the OleDbCommand object, you must add the parameters in the correct order, and you cannot use the parameters by name.

back to the top

Use DataReader to Return Rows and Parameters
You can use the DataReader object to return a read-only, forward-only stream of data. The information that the DataReader contains can come from a stored procedure. This example uses the DataReader object to run a stored procedure that has an input and an output parameter and then moves through the returned records to view the return parameters.   Create the following stored procedure on the server that is running Microsoft SQL Server: Create Procedure TestProcedure ( @au_idIN varchar (11),  @numTitlesOUT Integer OUTPUT ) AS

select A.au_fname, A.au_lname, T.title from authors as A join titleauthor as TA on A.au_id=TA.au_id join titles as T on T.title_id=TA.title_id where A.au_id=@au_idIN set @numTitlesOUT = @@Rowcount return (5)  Create a new Visual C# .NET Windows Application project.  Use the using statement on the System and the System.Data namespaces so that you do not have to qualify declarations in those namespaces later in your code. Add this code to the top of the Form code module. Make sure to copy only the code for the provider that you have chosen.SQL Client using System.Data.SqlClient; OLE DB Data Provider using System.Data.OleDb;   Replace the code in the private Form_Load event with the following code:SQL Client SqlConnection PubsConn = new SqlConnection (&quot;Data Source=server;integrated &quot; + &quot;Security=sspi;initial catalog=pubs;&quot;); SqlCommand testCMD = new SqlCommand (&quot;TestProcedure&quot;, PubsConn);

testCMD.CommandType = CommandType.StoredProcedure;

SqlParameter RetVal = testCMD.Parameters.Add (&quot;RetVal&quot;, SqlDbType.Int); RetVal.Direction = ParameterDirection.ReturnValue; SqlParameter IdIn = testCMD.Parameters.Add (&quot;@au_idIN&quot;, SqlDbType.VarChar, 11); IdIn.Direction = ParameterDirection.Input; SqlParameter NumTitles = testCMD.Parameters.Add (&quot;@numtitlesout&quot;, SqlDbType.VarChar, 11); NumTitles.Direction = ParameterDirection.Output ; IdIn.Value = &quot;213-46-8915&quot;; PubsConn.Open;

SqlDataReader myReader = testCMD.ExecuteReader; Console.WriteLine (&quot;Book Titles for this Author:&quot;); while (myReader.Read) {    Console.WriteLine (&quot;{0}&quot;, myReader.GetString (2)); }; myReader.Close ; Console.WriteLine(&quot;Number of Rows: &quot; + NumTitles.Value ); Console.WriteLine(&quot;Return Value: &quot; + RetVal.Value); OLE DB Data Provider OleDbConnection PubsConn = new OleDbConnection (&quot;Provider=SQLOLEDB;Data Source=server;&quot; +   &quot;integrated Security=sspi;initial catalog=pubs;&quot;); OleDbCommand testCMD = new OleDbCommand (&quot;TestProcedure&quot;, PubsConn);

testCMD.CommandType = CommandType.StoredProcedure;

OleDbParameter RetVal = testCMD.Parameters.Add (&quot;RetVal&quot;, OleDbType.Integer);RetVal.Direction = ParameterDirection.ReturnValue; OleDbParameter IdIn = testCMD.Parameters.Add (&quot;@au_idIN&quot;, OleDbType.VarChar, 11); IdIn.Direction = ParameterDirection.Input; OleDbParameter NumTitles = testCMD.Parameters.Add (&quot;@numtitlesout&quot;, OleDbType.VarChar, 11); NumTitles.Direction = ParameterDirection.Output; IdIn.Value = &quot;213-46-8915&quot;;

PubsConn.Open;

OleDbDataReader myReader = testCMD.ExecuteReader; Console.WriteLine (&quot;Book Titles for this Author:&quot;); while (myReader.Read) {    Console.WriteLine (&quot;{0}&quot;, myReader.GetString (2)); }; myReader.Close ; Console.WriteLine(&quot;Number of Rows: &quot; + NumTitles.Value ); Console.WriteLine(&quot;Return Value: &quot; + RetVal.Value);  Modify the connection string for the Connection object to point to the computer that is running SQL Server. Run the code. Notice that the DataReader retrieves the records and then returns the parameter values. You can use the Read method of the DataReader object to move through the returned records.

The Output window displays the titles of two books, the return value of 5, and the output parameter, which contains the number of records (2). Notice that you must close the DataReader in the code to see the parameter values. Additionally, note that you do not have to move through all of the records to see the return parameters if the DataReader is closed.</ol>

back to the top

Use the ExecuteScalar Method of the Command Object
You can use the ExecuteScalar method of the Command object to retrieve parameter values. Additionally, ExecuteScalar returns the first column of the first row of the stored procedure. This is most useful for aggregate functions as in the following example. <ol>  Create the following stored procedure on the server that is running SQL Server: Create Procedure TestProcedure2 ( @au_idIN varchar (11) ) As /* set nocount on */ select count (T.title) from authors as A join titleauthor as TA on A.au_id=TA.au_id join titles as T on T.title_id=TA.title_id where A.au_id=@au_idIN Return(5) </li> Create a new Visual C# .NET Windows Application project.</li>  Use the using statement on the System and the System.Data namespaces so that you do not have to qualify declarations in those namespaces later in your code. Add this code to the top of the Form code module. Make sure that you copy only the code for the provider that you have chosen.SQL Client using System.Data.SqlClient; OLE DB Data Provider using System.Data.OleDb; </li>  Add the following code to the Form_Load event:SQL Client string strCount; SqlConnection PubsConn = new SqlConnection (&quot;Data Source=server;integrated &quot; +   &quot;Security=sspi;initial catalog=pubs;&quot;); SqlCommand testCMD = new SqlCommand (&quot;TestProcedure2&quot;, PubsConn);

testCMD.CommandType = CommandType.StoredProcedure;

SqlParameter RetVal = testCMD.Parameters.Add (&quot;RetVal&quot;, SqlDbType.Int); RetVal.Direction = ParameterDirection.ReturnValue; SqlParameter IdIn = testCMD.Parameters.Add (&quot;@au_idIN&quot;, SqlDbType.VarChar, 11); IdIn.Direction = ParameterDirection.Input; IdIn.Value = &quot;213-46-8915&quot;;

PubsConn.Open;

strCount =testCMD.ExecuteScalar .ToString ;

Console.WriteLine(&quot;Number of Rows: &quot; + strCount ); Console.WriteLine(&quot;Return Value: &quot; + RetVal.Value); OLE DB Data Provider string strCount; OleDbConnection PubsConn = new OleDbConnection (&quot;Provider=SQLOLEDB;Data Source=server;&quot; +   &quot;integrated Security=sspi;initial catalog=pubs;&quot;); OleDbCommand testCMD = new OleDbCommand (&quot;TestProcedure2&quot;, PubsConn);

testCMD.CommandType = CommandType.StoredProcedure;

OleDbParameter RetVal = testCMD.Parameters.Add (&quot;RetVal&quot;, OleDbType.Integer); RetVal.Direction = ParameterDirection.ReturnValue; OleDbParameter IdIn = testCMD.Parameters.Add (&quot;@au_idIN&quot;, OleDbType.VarChar, 11); IdIn.Direction = ParameterDirection.Input;

IdIn.Value = &quot;213-46-8915&quot;;

PubsConn.Open;

strCount = testCMD.ExecuteScalar.ToString ;

Console.WriteLine(&quot;Number of Rows: &quot; + strCount); Console.WriteLine(&quot;Return Value: &quot; + RetVal.Value); </li> Modify the connection string for the Connection object to point to the computer that is running SQL Server.</li> Run the code. Notice that the ExecuteScalar method of the Command object returns the parameters. ExecuteScalar also returns the value of column 1, row 1 of the returned rowset. Therefore, the value of intCount is the result of the count function from the stored procedure.</li></ol>

back to the top

Use the ExecuteNonQuery Method of the Command Object
This sample uses the ExecuteNonQuery method to run the query and to return the parameter values. ExecuteNonQuery also returns the number of records that are affected after the query runs. However, ExecuteNonQuery does not return any rows or columns from the stored procedure.

The ExecuteNonQuery method is most useful when you use INSERT, UPDATE, or DELETE statements if you only have to know how many rows are changed. In a stored procedure in which you are using only a SELECT statement, you receive -1 because no rows are affected by the query. <ol>  Create the following stored procedure on the computer that is running SQL Server: Create Procedure TestProcedure3 ( @au_idIN varchar (11),  @au_fnam varchar (30) )

As /* set nocount on */ Update authors set au_fname = @au_fnam where au_id = @au_idin return (5) </li> Create a new Visual C# .NET Windows Application project.</li>  Use the using statement on the System and the System.Data namespaces so that you do not have to qualify declarations in those namespaces later in your code. Add this code to the top of the Form code module. Make sure that you copy only the code for the provider that you have chosen.SQL Client using System.Data.SqlClient; OLE DB Data Provider using System.Data.OleDb; </li>  Replace the code below the private Form1_Load event in the Form1 code module with the following code:SQL Client string strRowAffect; SqlConnection PubsConn = new SqlConnection (&quot;Data Source=server;integrated Security=sspi;&quot; +   &quot;initial catalog=pubs;&quot;); SqlCommand testCMD = new SqlCommand (&quot;TestProcedure3&quot;, PubsConn);

testCMD.CommandType = CommandType.StoredProcedure;

SqlParameter RetVal = testCMD.Parameters.Add (&quot;RetVal&quot;, SqlDbType.Int); RetVal.Direction = ParameterDirection.ReturnValue; SqlParameter IdIn = testCMD.Parameters.Add (&quot;@au_idIN&quot;, SqlDbType.VarChar, 11); IdIn.Direction = ParameterDirection.Input; SqlParameter FnameIn = testCMD.Parameters.Add (&quot;@au_fnam&quot;, SqlDbType.VarChar, 30); FnameIn.Direction = ParameterDirection.Input;

IdIn.Value = &quot;213-46-8915&quot;; FnameIn.Value = &quot;Marjorie&quot;;

PubsConn.Open;

strRowAffect =testCMD.ExecuteNonQuery .ToString ;

Console.WriteLine(&quot;Number of Rows: &quot; + strRowAffect ); Console.WriteLine(&quot;Return Value: &quot; + RetVal.Value); OLE DB Data Provider int intRowAffected; OleDbConnection PubsConn = new OleDbConnection (&quot;Provider=SQLOLEDB;Data Source=server;&quot; +   &quot;integrated Security=sspi;initial catalog=pubs;&quot;); OleDbCommand testCMD = new OleDbCommand (&quot;TestProcedure3&quot;, PubsConn);

testCMD.CommandType = CommandType.StoredProcedure;

OleDbParameter RetVal = testCMD.Parameters.Add (&quot;RetVal&quot;, OleDbType.Integer); RetVal.Direction = ParameterDirection.ReturnValue; OleDbParameter IdIn = testCMD.Parameters.Add (&quot;@au_idIN&quot;, OleDbType.VarChar, 11); IdIn.Direction = ParameterDirection.Input; OleDbParameter FnameIn = testCMD.Parameters.Add (&quot;@au_fname&quot;, OleDbType.VarChar, 30); FnameIn.Direction = ParameterDirection.Input;

IdIn.Value = &quot;213-46-8915&quot;; FnameIn.Value = &quot;Marjorie&quot;;

PubsConn.Open; intRowAffected = testCMD.ExecuteNonQuery;

Console.WriteLine(&quot;Number of Rows affected: &quot; + intRowAffected); Console.WriteLine(RetVal.Value); </li> Modify the connection string for the Connection object to point to the computer that is running SQL Server.</li> Run the code. The Output window displays the number of affected rows (intRowAffect) and the value of the return parameter.</li></ol>

back to the top

<div class="references_section">