CommandText Property (SqlCommand)

In This Topic

Syntax
Remarks
Example
Requirements
See Also

Gets or sets the SQL statement to execute against SQL Server.

Syntax

Visual Basic
C#

public new string CommandText {get; set;}

'Declaration
 
Public Shadows Property CommandText As String

Property Value

The SQL statement or stored procedure to execute. The default value is an empty string ("").

Remarks

Sense of CommandText property depends on value of CommandType property.

When CommandType value is System.Data.CommandType.Text, property CommandText should contain text of a query that must be run on the server. It also may contain several SQL statements, separated with the semicolon. You may use parameters in all the statements. If there are several statements returning data, use Devart.Data.SqlShimDataReader.NextResult to get all reader results.

When the value is System.Data.CommandType.StoredProcedure, property CommandText must be a name of a procedure to execute.

When the value is set to System.Data.CommandType.TableDirect, CommandText must be name of a table you want to get all data from. All rows and columns are retrieved.

Example

The following example creates a SqlCommand and sets some of its properties.

csharp

public void CreateCommand()
{
  SqlCommand myCommand = new SqlCommand();
  myCommand.CommandText = "SELECT * FROM Test.Dept ORDER BY DeptNo";
}

Visual Basic

Public Sub CreateCommand()
  Dim myCommand As New SqlCommand()
  myCommand.CommandText = "SELECT * FROM Test.Dept ORDER BY DeptNo"
End Sub

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

SqlCommand Class
SqlCommand Members
Connection Property
CommandType Property
Parameters Property

Send Feedback