OleDbCommand Class

 

Represents an SQL statement or stored procedure to execute against a data source.

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

System::Object
  System::MarshalByRefObject
    System.ComponentModel::Component
      System.Data.Common::DbCommand
        System.Data.OleDb::OleDbCommand

public ref class OleDbCommand sealed : DbCommand, ICloneable, 
	IDbCommand, IDisposable

NameDescription
System_CAPS_pubmethodOleDbCommand()

Initializes a new instance of the OleDbCommand class.

System_CAPS_pubmethodOleDbCommand(String^)

Initializes a new instance of the OleDbCommand class with the text of the query.

System_CAPS_pubmethodOleDbCommand(String^, OleDbConnection^)

Initializes a new instance of the OleDbCommand class with the text of the query and an OleDbConnection.

System_CAPS_pubmethodOleDbCommand(String^, OleDbConnection^, OleDbTransaction^)

Initializes a new instance of the OleDbCommand class with the text of the query, an OleDbConnection, and the Transaction.

NameDescription
System_CAPS_pubpropertyCommandText

Gets or sets the SQL statement or stored procedure to execute at the data source.(Overrides DbCommand::CommandText.)

System_CAPS_pubpropertyCommandTimeout

Gets or sets the wait time before terminating an attempt to execute a command and generating an error.(Overrides DbCommand::CommandTimeout.)

System_CAPS_pubpropertyCommandType

Gets or sets a value that indicates how the CommandText property is interpreted.(Overrides DbCommand::CommandType.)

System_CAPS_pubpropertyConnection

Gets or sets the OleDbConnection used by this instance of the OleDbCommand.

System_CAPS_pubpropertyContainer

Gets the IContainer that contains the Component.(Inherited from Component.)

System_CAPS_pubpropertyDesignTimeVisible

Gets or sets a value that indicates whether the command object should be visible in a customized Windows Forms Designer control.(Overrides DbCommand::DesignTimeVisible.)

System_CAPS_pubpropertyParameters
System_CAPS_pubpropertySite

Gets or sets the ISite of the Component.(Inherited from Component.)

System_CAPS_pubpropertyTransaction

Gets or sets the OleDbTransaction within which the OleDbCommand executes.

System_CAPS_pubpropertyUpdatedRowSource

Gets or sets how command results are applied to the DataRow when used by the Update method of the OleDbDataAdapter.(Overrides DbCommand::UpdatedRowSource.)

NameDescription
System_CAPS_pubmethodCancel()

Tries to cancel the execution of an OleDbCommand.(Overrides DbCommand::Cancel().)

System_CAPS_pubmethodClone()

Creates a new OleDbCommand object that is a copy of the current instance.

System_CAPS_pubmethodCreateObjRef(Type^)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodCreateParameter()

Creates a new instance of an OleDbParameter object.

System_CAPS_pubmethodDispose()

Releases all resources used by the Component.(Inherited from Component.)

System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodExecuteNonQuery()

Executes an SQL statement against the Connection and returns the number of rows affected.(Overrides DbCommand::ExecuteNonQuery().)

System_CAPS_pubmethodExecuteNonQueryAsync()

An asynchronous version of ExecuteNonQuery, which executes a SQL statement against a connection object.

Invokes ExecuteNonQueryAsync with CancellationToken.None.(Inherited from DbCommand.)

System_CAPS_pubmethodExecuteNonQueryAsync(CancellationToken)

This is the asynchronous version of ExecuteNonQuery. Providers should override with an appropriate implementation. The cancellation token may optionally be ignored.

The default implementation invokes the synchronous ExecuteNonQuery method and returns a completed task, blocking the calling thread. The default implementation will return a cancelled task if passed an already cancelled cancellation token. Exceptions thrown by ExecuteNonQuery will be communicated via the returned Task Exception property.

Do not invoke other methods and properties of the DbCommand object until the returned Task is complete.(Inherited from DbCommand.)

System_CAPS_pubmethodExecuteReader()

Sends the CommandText to the Connection and builds an OleDbDataReader.

System_CAPS_pubmethodExecuteReader(CommandBehavior)

Sends the CommandText to the Connection, and builds an OleDbDataReader using one of the CommandBehavior values.

System_CAPS_pubmethodExecuteReaderAsync()

An asynchronous version of ExecuteReader, which executes the CommandText against the Connection and returns a DbDataReader.

Invokes ExecuteDbDataReaderAsync with CancellationToken.None.(Inherited from DbCommand.)

System_CAPS_pubmethodExecuteReaderAsync(CancellationToken)

An asynchronous version of ExecuteReader, which executes the CommandText against the Connection and returns a DbDataReader. This method propagates a notification that operations should be canceled.

Invokes ExecuteDbDataReaderAsync.(Inherited from DbCommand.)

System_CAPS_pubmethodExecuteReaderAsync(CommandBehavior)

An asynchronous version of ExecuteReader, which executes the CommandText against the Connection and returns a DbDataReader.

Invokes ExecuteDbDataReaderAsync.(Inherited from DbCommand.)

System_CAPS_pubmethodExecuteReaderAsync(CommandBehavior, CancellationToken)

Invokes ExecuteDbDataReaderAsync.(Inherited from DbCommand.)

System_CAPS_pubmethodExecuteScalar()

Executes the query, and returns the first column of the first row in the result set returned by the query. Additional columns or rows are ignored.(Overrides DbCommand::ExecuteScalar().)

System_CAPS_pubmethodExecuteScalarAsync()

An asynchronous version of ExecuteScalar, which executes the query and returns the first column of the first row in the result set returned by the query. All other columns and rows are ignored.

Invokes ExecuteScalarAsync with CancellationToken.None.(Inherited from DbCommand.)

System_CAPS_pubmethodExecuteScalarAsync(CancellationToken)

This is the asynchronous version of ExecuteScalar. Providers should override with an appropriate implementation. The cancellation token may optionally be ignored.

The default implementation invokes the synchronous ExecuteScalar method and returns a completed task, blocking the calling thread. The default implementation will return a cancelled task if passed an already cancelled cancellation token. Exceptions thrown by ExecuteScalar will be communicated via the returned Task Exception property.

Do not invoke other methods and properties of the DbCommand object until the returned Task is complete.(Inherited from DbCommand.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodPrepare()

Creates a prepared (or compiled) version of the command on the data source.(Overrides DbCommand::Prepare().)

System_CAPS_pubmethodResetCommandTimeout()

Resets the CommandTimeout property to the default value.

System_CAPS_pubmethodToString()

Returns a String containing the name of the Component, if any. This method should not be overridden.(Inherited from Component.)

NameDescription
System_CAPS_pubeventDisposed

Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIDbCommand::CreateParameter()

Creates a new instance of an IDbDataParameter object.(Inherited from DbCommand.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIDbCommand::ExecuteReader()

For a description of this member, see IDbCommand::ExecuteReader.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIDbCommand::ExecuteReader(CommandBehavior)

Executes the CommandText against the Connection, and builds an IDataReader using one of the CommandBehavior values.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICloneable::Clone()

For a description of this member, see ICloneable::Clone.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDbCommand::Connection

Gets or sets the IDbConnection used by this instance of the IDbCommand.(Inherited from DbCommand.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDbCommand::Parameters

Gets the IDataParameterCollection.(Inherited from DbCommand.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDbCommand::Transaction

Gets or sets the DbTransaction within which this DbCommand object executes.(Inherited from DbCommand.)

When an instance of OleDbCommand is created, the read/write properties are set to their initial values. For a list of these values, see the OleDbCommand constructor.

OleDbCommand features the following methods executing commands at a data source:

Item

Description

ExecuteReader

Executes commands that return rows. ExecuteReader may not have the effect that you want if used to execute commands such as SQL SET statements.

ExecuteNonQuery

Executes commands such as SQL INSERT, DELETE, UPDATE, and SET statements.

ExecuteScalar

Retrieves a single value, for example, an aggregate value from a database.

You can reset the CommandText property and reuse the OleDbCommand object. However, you must close the OleDbDataReader before you can execute a new or previous command.

If a fatal OleDbException (for example, a SQL Server severity level of 20 or greater) is generated by the method executing an OleDbCommand, the OleDbConnection, the connection may be closed. However, the user can reopen the connection and continue.

The following example uses the OleDbCommand, along OleDbDataAdapter and OleDbConnection, to select rows from an Access database. The filled DataSet is then returned. The example is passed an initialized DataSet, a connection string, a query string that is an SQL SELECT statement, and a string that is the name of the source database table.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: