This documentation is archived and is not being maintained.

IDbCommand.CommandText Property

Gets or sets the text command to run against the data source.

Namespace: System.Data
Assembly: System.Data (in system.data.dll)

'Declaration
Property CommandText As String
'Usage
Dim instance As IDbCommand
Dim value As String

value = instance.CommandText

instance.CommandText = value
/** @property */
String get_CommandText ()

/** @property */
void set_CommandText (String value)

function get CommandText () : String

function set CommandText (value : String)

Not applicable.

Property Value

The text command to execute. The default value is an empty string ("").

When the CommandType property is set to StoredProcedure, set the CommandText property to the name of the stored procedure. The user may be required to use escape character syntax if the stored procedure name contains any special characters. The command will call this stored procedure when you call one of the Execute methods.

The following example creates an instance of a derived class, OleDbCommand and sets some of its properties.

Public Sub CreateOleDbCommand()
    Dim command As New OleDbCommand()
    command.CommandText = "SELECT * FROM Categories ORDER BY CategoryID;"
    command.CommandType = CommandType.Text
End Sub

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0
Show: