SqlCommand.CommandType Property

Reference

Definition

Namespace:: System.Data.SqlClient

Assembly:: System.Data.SqlClient.dll

Assembly:: System.Data.dll

Package:: System.Data.SqlClient v4.8.6

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets a value indicating how the CommandText property is to be interpreted.

public:
 virtual property System::Data::CommandType CommandType { System::Data::CommandType get(); void set(System::Data::CommandType value); };

public:
 property System::Data::CommandType CommandType { System::Data::CommandType get(); void set(System::Data::CommandType value); };

public override System.Data.CommandType CommandType { get; set; }

[System.Data.DataSysDescription("DbCommand_CommandType")]
public System.Data.CommandType CommandType { get; set; }

member this.CommandType : System.Data.CommandType with get, set

[<System.Data.DataSysDescription("DbCommand_CommandType")>]
member this.CommandType : System.Data.CommandType with get, set

Public Overrides Property CommandType As CommandType

Public Property CommandType As CommandType

Property Value

CommandType

One of the CommandType values. The default is Text.

Implements

CommandType

Attributes: DataSysDescriptionAttribute

Exceptions

ArgumentException

The value was not a valid CommandType.

Examples

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

public void CreateSqlCommand()
{
   SqlCommand command = new SqlCommand();
   command.CommandTimeout = 15;
   command.CommandType = CommandType.Text;
}

Public Sub CreateSqlCommand()
    Dim command As New SqlCommand()
    command.CommandTimeout = 15
    command.CommandType = CommandType.Text
End Sub

Remarks

When you set the CommandType property to StoredProcedure, you should set the CommandText property to the name of the stored procedure. The command executes this stored procedure when you call one of the Execute methods.

The Microsoft .NET Framework Data Provider for SQL Server does not support the question mark (?) placeholder for passing parameters to a SQL Statement or a stored procedure called with a CommandType of Text. In this case, named parameters must be used. For example:

SELECT * FROM Customers WHERE CustomerID = @CustomerID

For more information, see Configuring Parameters and Parameter Data Types.

Applies to