This documentation is archived and is not being maintained.

OleDbCommand.CommandText Property

Gets or sets the SQL statement or stored procedure to execute at the data source.

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

public override string CommandText { get; set; }
/** @property */
public String get_CommandText ()

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

public override function get CommandText () : String

public override function set CommandText (value : String)

Not applicable.

Property Value

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

When the CommandType property is set to StoredProcedure, the CommandType property should be set 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 executes this stored procedure when you call one of the Execute methods.

When CommandType is set to TableDirect, the CommandType property should be set to the name of the table or tables to be accessed. The user may be required to use escape character syntax if any of the named tables contain any special characters. All rows and columns of the named table or tables will be returned when you call one of the Execute methods.

You cannot set the Connection, CommandType, and CommandText properties if the current connection is performing an execute or fetch operation.

The OLE DB.NET Provider does not support named parameters for passing parameters to an SQL Statement or a stored procedure called by an OleDbCommand when CommandType is set to Text. In this case, the question mark (?) placeholder must be used. For example:

SELECT * FROM Customers WHERE CustomerID = ?

Therefore, the order in which OleDbParameter objects are added to the OleDbParameterCollection must directly correspond to the position of the question mark placeholder for the parameter.

For more information, see Using Stored Procedures with a Command.

The following example creates an OleDbCommand and sets some of its properties.

public void CreateMyOleDbCommand() 
{
   OleDbCommand command = new OleDbCommand();
   command.CommandText = "SELECT * FROM Categories ORDER BY CategoryID";
   command.CommandTimeout = 20;
}

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, 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
Show: