Export (0) Print
Expand All

IDbDataAdapter.UpdateCommand Property

Gets or sets an SQL statement used to update records in the data source.

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

'Declaration
Property UpdateCommand As IDbCommand
'Usage
Dim instance As IDbDataAdapter
Dim value As IDbCommand

value = instance.UpdateCommand

instance.UpdateCommand = value
/** @property */
IDbCommand get_UpdateCommand ()

/** @property */
void set_UpdateCommand (IDbCommand value)

function get UpdateCommand () : IDbCommand

function set UpdateCommand (value : IDbCommand)

Property Value

An IDbCommand used during Update to update records in the data source for modified rows in the data set.

During Update, if this property is not set and primary key information is present in the DataSet, the UpdateCommand can be generated automatically if you set the SelectCommand property of a .NET Framework data provider. Then, any additional commands that you do not set are generated by the CommandBuilder. This generation logic requires key column information to be present in the DataSet. For more information see Automatically Generating Commands.

When UpdateCommand is assigned to a previously created IDbCommand, the IDbCommand is not cloned. The UpdateCommand maintains a reference to the previously created IDbCommand object.

NoteNote

If execution of this command returns rows, these rows are added to the DataSet.

The following example creates an instance of the inherited OleDbDataAdapter class, and sets the SelectCommand and UpdateCommand properties. It assumes you have already created an OleDbConnection object.

Private Function CreateCustomerAdapter( _
    ByVal connection As OleDbConnection) As OleDbDataAdapter

    Dim dataAdapter As OleDbDataAdapter = New OleDbDataAdapter()
    Dim command As OleDbCommand
    Dim parameter As OleDbParameter

    ' Create the SelectCommand.
    command = New OleDbCommand("SELECT * FROM dbo.Customers " & _
        "WHERE Country = ? AND City = ?", connection)

    command.Parameters.Add("Country", OleDbType.VarChar, 15)
    command.Parameters.Add("City", OleDbType.VarChar, 15)

    dataAdapter.SelectCommand = command

    ' Create the UpdateCommand.
    command = New OleDbCommand("UPDATE dbo.Customers " & _
        "SET CustomerID = ?, CompanyName = ? " & _
        "WHERE CustomerID = ?", connection)

    command.Parameters.Add( _
        "CustomerID", OleDbType.Char, 5, "CustomerID")
    command.Parameters.Add( _
        "CompanyName", OleDbType.VarChar, 40, "CompanyName")

    parameter = command.Parameters.Add( _
        "oldCustomerID", OleDbType.Char, 5, "CustomerID")
    parameter.SourceVersion = DataRowVersion.Original

    dataAdapter.UpdateCommand = command

    Return dataAdapter
End Function

Windows 98, Windows 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 .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft