OleDbCommand.CommandText OleDbCommand.CommandText OleDbCommand.CommandText OleDbCommand.CommandText Property

Definition

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

public:
 virtual property System::String ^ CommandText { System::String ^ get(); void set(System::String ^ value); };
[System.Data.DataSysDescription("DbCommand_CommandText")]
public override string CommandText { get; set; }
member this.CommandText : string with get, set
Public Overrides Property CommandText As String

Property Value

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

Implements

Examples

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;
}
Public Sub CreateMyOleDbCommand()
    Dim command As New OleDbCommand()
    command.CommandText = "SELECT * FROM Categories ORDER BY CategoryID"
    command.CommandTimeout = 20
End Sub

Remarks

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 Configuring Parameters and Parameter Data Types.

Applies to

See also