Microsoft KB Archive/320916

= HOW TO: Call SQL Server Stored Procedures in ASP.NET by Using Visual C# .NET =

Article ID: 320916

Article Last Modified on 12/5/2003

-

APPLIES TO


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

-



This article was previously published under Q320916



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

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

IN THIS TASK

 * SUMMARY
 * Requirements
 * Create an ASP.NET Project and Add Controls
 * Create the GetAuthorsByLastName Stored Procedure
 * Create and Run the Stored Procedure
 * Troubleshooting



SUMMARY
This article demonstrates how to use ASP.NET and ADO.NET with Visual C# .NET to create and to call a Microsoft SQL Server stored procedure with an input parameter and an output parameter.

The code sample in this article first checks whether the stored procedure that you will create exists in the Pubs database, which is included with a standard Microsoft SQL Server installation. If the stored procedure does not exist, the code creates a stored procedure that takes one parameter to search the Authors table based on the last name and returns the matching rows and number of rows that are returned in an output parameter.

This article also demonstrates how to create a Web Form that provides a simple user interface. The Web Form contains the following items:
 * A text box in which the user types the search condition.
 * A DataGrid control that displays the search results.
 * A Label control that displays the number of returned records.
 * A Button control that calls the stored procedure when the button is clicked.

back to the top

Requirements
The following list outlines the recommended hardware, software, network infrastructure, and service packs that are required:
 * Microsoft SQL Server version 7.0 or later
 * Microsoft Visual Studio .NET
 * Microsoft Visual C# .NET
 * Permissions to create the stored procedure in the database

This article assumes that you are familiar with the following topics:
 * ASP.NET
 * SQL Server stored procedures

back to the top

Create an ASP.NET Project and Add Controls
In this section, you create an ASP.NET project and build the basic user interface. Note that these steps use Microsoft Visual C# .NET code. To create the project, follow these steps:  Click Start, point to Programs, point to Microsoft Visual Studio .NET, and then click Microsoft Visual Studio .NET. On the Visual Studio .NET Start page, click New Project. In the New Project dialog box, click Visual C# Projects under Project Types, and then click ASP.NET Web Application under Templates. In the Name box, type a name for your Web application, and then click OK. Add the following server controls to the Web Form, and set the properties as they are listed in the table:

 Drag a DataGrid server control from the toolbox to the Web Form, and then set the Name property to GrdAuthors . Right-click the grid, and then click Autoformat.</li> Click Professional 1 for the scheme, and then click OK.</li></ol>

back to the top

Create the GetAuthorsByLastName Stored Procedure
Use the following Transact-SQL code to create the GetAuthorsByLastName stored procedure: Use Pubs Go Create Procedure GetAuthorsByLastName (@au_lname varchar(40), @RowCount int output) as

select * from authors where au_lname like @au_lname;

/* @@ROWCOUNT returns the number of rows that are affected by the last statement. */ select @RowCount=@@ROWCOUNT This code includes two parameters: @au_lname and @RowCount. The @au_lname parameter is an input parameter that obtains the search string to perform a &quot;like&quot; search in the Authors table. The @RowCount parameter is an output parameter that uses the @@ROWCOUNT variable to obtain the affected rows.

back to the top

Create and Run the Stored Procedure
To access SQL Server databases, you must import the System.Data.SqlClient namespace, which provides new objects such as the SqlDataReader and the SqlDataAdapter objects. You can use SqlDataReader to read a forward-only stream of rows from a SQL Server database. DataAdapter represents a set of data commands and a database connection that you can use to fill the DataSet object and to update a SQL Server database.

ADO.NET also introduces the DataSet object, which is a memory-resident representation of data that provides a consistent, relational programming model regardless of the data source. The code in this section uses all of these objects. <ol> Double-click the Web Form.</li>  Add the following code (the using directives) to the Declaration section of your Web Form, which appears at the top of the Code window: using System.Data; using System.Data.SqlClient; </li>  To make sure that the stored procedure exists and to create a new stored procedure, use a SqlCommand object with a SqlDataReader object. You can use SqlCommand to run any SQL commands against the database. Then call the ExecuteReader method of SqlCommand to return SqlDataReader, which contains matching rows for your query.

Add the following code in the Page_Load event of the Web Form: private void Page_Load(object sender, System.EventArgs e)   { // Only run this code the first time the page is loaded. // The code inside the IF statement is skipped when you resubmit the page. if (!IsPostBack) {           //Create a connection to the SQL Server; modify the connection string for your environment //SqlConnection MyConnection = new SqlConnection(&quot;server=(local);database=pubs;Trusted_Connection=yes&quot;); SqlConnection MyConnection = new SqlConnection(&quot;server=(local);database=pubs;UID=myUser;PWD=myPassword;&quot;);

// Create a Command object, and then set the connection. // The following SQL statements check whether a GetAuthorsByLastName // stored procedure already exists. SqlCommand MyCommand = new SqlCommand(&quot;select * from sysobjects where id = object_id(N'GetAuthorsByLastName')&quot; +           &quot;  and OBJECTPROPERTY(id, N'IsProcedure') = 1&quot;, MyConnection);

// Set the command type that you will run. MyCommand.CommandType = CommandType.Text;

// Open the connection. MyCommand.Connection.Open;

// Run the SQL statement, and then get the returned rows to the DataReader. SqlDataReader MyDataReader = MyCommand.ExecuteReader;

// If any rows are returned, the stored procedure that you are trying // to create already exists. Therefore, try to create the stored procedure // only if it does not exist. if(!MyDataReader.Read) {               MyCommand.CommandText = &quot;create procedure GetAuthorsByLastName&quot; + &quot; (@au_lname varchar(40), select * from authors where&quot; +                   &quot; au_lname like @au_lname; select @RowCount=@@ROWCOUNT&quot;;                MyDataReader.Close;                MyCommand.ExecuteNonQuery;            }            else            {                MyDataReader.Close;            }

MyCommand.Dispose; //Dispose of the Command object. MyConnection.Close; //Close the connection. }

// Add the event handler to the Button_Click event. this.btnGetAuthors.Click += new System.EventHandler(this.btnGetAuthors_Click); }                   </li>  Call the stored procedure in the Click event of the btnGetAuthors button, and then use the SqlDataAdapter object to run your stored procedure. You must create parameters for the stored procedure and append it to the Parameters collection of the SqlDataAdapter object.

Add the following code after the Page_Load event: private void btnGetAuthors_Click(object sender, System.EventArgs e)   { //Create a connection to the SQL Server; modify the connection string for your environment. //SqlConnection MyConnection = new SqlConnection(&quot;server=(local);database=pubs;Trusted_Connection=yes&quot;); SqlConnection MyConnection = new SqlConnection(&quot;server=(local);database=pubs;UID=myUser;PWD=myPassword;&quot;);

//Create a DataAdapter, and then provide the name of the stored procedure. SqlDataAdapter MyDataAdapter = new SqlDataAdapter(&quot;GetAuthorsByLastName&quot;, MyConnection);

//Set the command type as StoredProcedure. MyDataAdapter.SelectCommand.CommandType = CommandType.StoredProcedure;

//Create and add a parameter to Parameters collection for the stored procedure. MyDataAdapter.SelectCommand.Parameters.Add(new SqlParameter(&quot;@au_lname&quot;, SqlDbType.VarChar, 40));

//Assign the search value to the parameter. MyDataAdapter.SelectCommand.Parameters[&quot;@au_lname&quot;].Value = (txtLastName.Text).Trim;

//Create and add an output parameter to the Parameters collection. MyDataAdapter.SelectCommand.Parameters.Add(new SqlParameter(&quot;@RowCount&quot;, SqlDbType.Int, 4));

//Set the direction for the parameter. This parameter returns the Rows that are returned. MyDataAdapter.SelectCommand.Parameters[&quot;@RowCount&quot;].Direction = ParameterDirection.Output;

//Create a new DataSet to hold the records. DataSet DS = new DataSet; //Fill the DataSet with the rows that are returned. MyDataAdapter.Fill(DS, &quot;AuthorsByLastName&quot;);

//Get the number of rows returned, and assign it to the Label control. //lblRowCount.Text = DS.Tables(0).Rows.Count.ToString & &quot; Rows Found!&quot; lblRowCount.Text = MyDataAdapter.SelectCommand.Parameters[1].Value + &quot; Rows Found!&quot;;

//Set the data source for the DataGrid as the DataSet that holds the rows. GrdAuthors.DataSource = DS.Tables[&quot;AuthorsByLastName&quot;].DefaultView;

//NOTE: If you do not call this method, the DataGrid is not displayed! GrdAuthors.DataBind;

MyDataAdapter.Dispose; //Dispose the DataAdapter. MyConnection.Close; //Close the connection. }                   </li> In Solution Explorer, right-click the .aspx page, and then click Set as Start Page.</li> Save the project, and then click Start in Visual Studio .NET. Notice that the project is compiled and that the default page runs.</li> Type the author's last name in the text box, and then click Get Author. Notice that the stored procedure is called and that the returned rows populate the DataGrid.

You can provide SQL Server-type search strings such as G%, which returns all the authors by last names that start with the letter &quot;G.&quot;</li></ol>

back to the top

Troubleshooting

 * If you cannot connect to the database, make sure that the ConnectionString properly points to the server that is running SQL Server.
 * If you can connect to the database, but if you experience problems when you try to create the stored procedure, make sure that you have the correct permissions to create stored procedures in the database to which you are connecting.

back to the top

Keywords: kbhowtomaster kbstoredproc kbsqlclient kbsystemdata KB320916

-

[mailto:TECHNET@MICROSOFT.COM Send feedback to Microsoft]

© Microsoft Corporation. All rights reserved.