Export (0) Print
Expand All

OdbcCommand Class

Represents an SQL statement or stored procedure to execute against a data source. This class cannot be inherited.

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

[<Sealed>]
type OdbcCommand =  
    class
        inherit DbCommand
        interface ICloneable
    end

The OdbcCommand type exposes the following members.

  NameDescription
Public methodOdbcCommand()Initializes a new instance of the OdbcCommand class.
Public methodOdbcCommand(String)Initializes a new instance of the OdbcCommand class with the text of the query.
Public methodOdbcCommand(String, OdbcConnection)Initializes a new instance of the OdbcCommand class with the text of the query and an OdbcConnection object.
Public methodOdbcCommand(String, OdbcConnection, OdbcTransaction)Initializes a new instance of the OdbcCommand class with the text of the query, an OdbcConnection object, and the Transaction.
Top

  NameDescription
Protected propertyCanRaiseEventsGets a value indicating whether the component can raise an event. (Inherited from Component.)
Public propertyCommandTextGets or sets the SQL statement or stored procedure to execute against the data source. (Overrides DbCommand.CommandText.)
Public propertyCommandTimeoutGets or sets the wait time before terminating an attempt to execute a command and generating an error. (Overrides DbCommand.CommandTimeout.)
Public propertyCommandTypeGets or sets a value that indicates how the CommandText property is interpreted. (Overrides DbCommand.CommandType.)
Public propertyConnectionGets or sets the OdbcConnection used by this instance of the OdbcCommand.
Public propertyContainerGets the IContainer that contains the Component. (Inherited from Component.)
Protected propertyDbConnectionGets or sets the DbConnection used by this DbCommand. (Inherited from DbCommand.)
Protected propertyDbParameterCollectionGets the collection of DbParameter objects. (Inherited from DbCommand.)
Protected propertyDbTransactionGets or sets the DbTransaction within which this DbCommand object executes. (Inherited from DbCommand.)
Protected propertyDesignModeGets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Public propertyDesignTimeVisibleGets or sets a value that indicates whether the command object should be visible in a customized interface control. (Overrides DbCommand.DesignTimeVisible.)
Protected propertyEventsGets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public propertyParametersGets the OdbcParameterCollection.
Public propertySiteGets or sets the ISite of the Component. (Inherited from Component.)
Public propertyTransactionGets or sets the OdbcTransaction within which the OdbcCommand executes.
Public propertyUpdatedRowSourceGets or sets a value that specifies how the Update method should apply command results to the DataRow. (Overrides DbCommand.UpdatedRowSource.)
Top

  NameDescription
Public methodCancelTries to cancel the execution of an OdbcCommand. (Overrides DbCommand.Cancel().)
Protected methodCreateDbParameterCreates a new instance of a DbParameter object. (Inherited from DbCommand.)
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodCreateParameterCreates a new instance of an OdbcParameter object.
Public methodDispose()Releases all resources used by the Component. (Inherited from Component.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodExecuteDbDataReaderExecutes the command text against the connection. (Inherited from DbCommand.)
Public methodExecuteNonQueryExecutes an SQL statement against the Connection and returns the number of rows affected. (Overrides DbCommand.ExecuteNonQuery().)
Public methodExecuteReader()Sends the CommandText to the Connection and builds an OdbcDataReader.
Public methodExecuteReader(CommandBehavior)Sends the CommandText to the Connection, and builds an OdbcDataReader using one of the CommandBehavior values.
Public methodExecuteScalarExecutes 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().)
Protected methodFinalizeReleases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodGetServiceReturns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodMemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public methodPrepareCreates a prepared or compiled version of the command at the data source. (Overrides DbCommand.Prepare().)
Public methodResetCommandTimeoutResets the CommandTimeout property to the default value.
Public methodToStringReturns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)
Top

  NameDescription
Public eventDisposedOccurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICloneable.CloneFor a description of this member, see ICloneable.Clone.
Explicit interface implemetationPrivate propertyIDbCommand.ConnectionGets or sets the IDbConnection used by this instance of the IDbCommand. (Inherited from DbCommand.)
Explicit interface implemetationPrivate methodIDbCommand.CreateParameterCreates a new instance of an IDbDataParameter object. (Inherited from DbCommand.)
Explicit interface implemetationPrivate methodIDbCommand.ExecuteReader()Executes the CommandText against the Connection and builds an IDataReader. (Inherited from DbCommand.)
Explicit interface implemetationPrivate methodIDbCommand.ExecuteReader(CommandBehavior)Executes the CommandText against the Connection, and builds an IDataReader using one of the CommandBehavior values. (Inherited from DbCommand.)
Explicit interface implemetationPrivate propertyIDbCommand.ParametersGets the IDataParameterCollection. (Inherited from DbCommand.)
Explicit interface implemetationPrivate propertyIDbCommand.TransactionGets or sets the DbTransaction within which this DbCommand object executes. (Inherited from DbCommand.)
Top

The OdbcCommand class provides the following methods for executing commands against a data source:

Item

Description

ExecuteReader

Executes commands that return rows.

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 OdbcCommand object. However, you must close the OdbcDataReader before you can execute a new or previous command.

If execution of the command causes a fatal OdbcException such as a SQL Server severity level of 20 or more, OdbcConnection may close. However, the user can reopen the connection and continue.

The following example uses the ExecuteReader method of the OdbcCommand class, together with the OdbcDataReader and OdbcConnection classes, to select rows from a table.

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

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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

Community Additions

ADD
Show:
© 2014 Microsoft