SqlRowUpdatedEventArgs Class

Definition

Namespace:

System.Data.SqlClient

Assembly:

System.Data.SqlClient.dll

Package:

System.Data.SqlClient v4.9.0

Source:

System.Data.SqlClient.notsupported.cs

Caution

Use the Microsoft.Data.SqlClient package instead.

Provides data for the RowUpdated event.

public ref class SqlRowUpdatedEventArgs sealed : System::Data::Common::RowUpdatedEventArgs

[System.Obsolete("Use the Microsoft.Data.SqlClient package instead.")]
public sealed class SqlRowUpdatedEventArgs : System.Data.Common.RowUpdatedEventArgs

[<System.Obsolete("Use the Microsoft.Data.SqlClient package instead.")>]
type SqlRowUpdatedEventArgs = class
    inherit RowUpdatedEventArgs

Public NotInheritable Class SqlRowUpdatedEventArgs
Inherits RowUpdatedEventArgs

Inheritance

Object

EventArgs

RowUpdatedEventArgs

SqlRowUpdatedEventArgs

Attributes

ObsoleteAttribute

Examples

The following example shows how to use both the RowUpdating and RowUpdated events.

The RowUpdating event returns this output:

Event Arguments: (command=System.Data.SqlClient.SqlCommand commandType=2 status=0)

The RowUpdated event returns this output:

Event Arguments: (command=System.Data.SqlClient.SqlCommand commandType=2 recordsAffected=1 row=System.Data.DataRow[37] status=0)

// handler for RowUpdating event
private static void OnRowUpdating(object sender, SqlRowUpdatingEventArgs e)
{
    PrintEventArgs(e);
}

// handler for RowUpdated event
private static void OnRowUpdated(object sender, SqlRowUpdatedEventArgs e)
{
    PrintEventArgs(e);
}

public static int Main()
{
    const string connectionString =
              "Integrated Security=SSPI;database=Northwind;server=MSSQL1";
    const string queryString = "SELECT * FROM Products";

    // create DataAdapter
    SqlDataAdapter adapter = new SqlDataAdapter(queryString, connectionString);
    SqlCommandBuilder builder = new SqlCommandBuilder(adapter);

    // Create and fill DataSet (select only first 5 rows)
    DataSet dataSet = new DataSet();
    adapter.Fill(dataSet, 0, 5, "Table");

    // Modify DataSet
    DataTable table = dataSet.Tables["Table"];
    table.Rows[0][1] = "new product";

    // add handlers
    adapter.RowUpdating += new SqlRowUpdatingEventHandler( OnRowUpdating );
    adapter.RowUpdated += new SqlRowUpdatedEventHandler( OnRowUpdated );

    // update, this operation fires two events
    // (RowUpdating/RowUpdated) per changed row
    adapter.Update(dataSet, "Table");

    // remove handlers
    adapter.RowUpdating -= new SqlRowUpdatingEventHandler( OnRowUpdating );
    adapter.RowUpdated -= new SqlRowUpdatedEventHandler( OnRowUpdated );
    return 0;
}

private static void PrintEventArgs(SqlRowUpdatingEventArgs args)
{
    Console.WriteLine("OnRowUpdating");
    Console.WriteLine("  event args: ("+
        " command=" + args.Command +
        " commandType=" + args.StatementType +
        " status=" + args.Status + ")");
}

private static void PrintEventArgs(SqlRowUpdatedEventArgs args)
{
    Console.WriteLine("OnRowUpdated");
    Console.WriteLine( "  event args: ("+
        " command=" + args.Command +
        " commandType=" + args.StatementType +
        " recordsAffected=" + args.RecordsAffected +
        " status=" + args.Status + ")");
}

    ' handler for RowUpdating event
    Private Shared Sub OnRowUpdating(sender As Object, e As SqlRowUpdatingEventArgs)
        PrintEventArgs(e)
    End Sub 

    ' handler for RowUpdated event
    Private Shared Sub OnRowUpdated(sender As Object, e As SqlRowUpdatedEventArgs)
        PrintEventArgs(e)
    End Sub 
    
    'Entry point which delegates to C-style main Private Function
    Public Overloads Shared Sub Main()
        System.Environment.ExitCode = Main(System.Environment.GetCommandLineArgs())
    End Sub
    
    Overloads Public Shared Function Main(args() As String) As Integer
        Const connectionString As String = _
            "Integrated Security=SSPI;database=Northwind;server=MSSQL1"
        Const queryString As String = "SELECT * FROM Products"
        
        ' create DataAdapter
        Dim adapter As New SqlDataAdapter(queryString, connectionString)
        Dim builder As New SqlCommandBuilder(adapter)
        
        ' Create and fill DataSet (select only first 5 rows)
        Dim dataSet As New DataSet()
        adapter.Fill(dataSet, 0, 5, "Table")
        
        ' Modify DataSet
        Dim table As DataTable = dataSet.Tables("Table")
        table.Rows(0)(1) = "new product"
        
        ' add handlers
        AddHandler adapter.RowUpdating, AddressOf OnRowUpdating
        AddHandler adapter.RowUpdated, AddressOf OnRowUpdated
        
        ' update, this operation fires two events 
        '(RowUpdating/RowUpdated) per changed row 
        adapter.Update(dataSet, "Table")
        
        ' remove handlers
        RemoveHandler adapter.RowUpdating, AddressOf OnRowUpdating
        RemoveHandler adapter.RowUpdated, AddressOf OnRowUpdated
        Return 0
    End Function 
    
    
    Overloads Private Shared Sub PrintEventArgs(args As SqlRowUpdatingEventArgs)
        Console.WriteLine("OnRowUpdating")
        Console.WriteLine("  event args: (" & " command=" & args.Command.CommandText & _
           " commandType=" & args.StatementType & " status=" & args.Status & ")")
    End Sub 
    
    
    Overloads Private Shared Sub PrintEventArgs(args As SqlRowUpdatedEventArgs)
        Console.WriteLine("OnRowUpdated")
        Console.WriteLine("  event args: (" & " command=" & args.Command.CommandText & _
           " commandType=" & args.StatementType & " recordsAffected=" & _
           args.RecordsAffected & " status=" & args.Status & ")")
    End Sub 
End Class

Remarks

The RowUpdated event is raised when an Update to a row is completed.

When using Update, there are two events that occur for each data row updated. The order of execution is as follows:

1. The values in the DataRow are moved to the parameter values.

2. The OnRowUpdating event is raised.

3. The command executes.

4. If the command is set to FirstReturnedRecord, and the first returned result is placed in the DataRow.

5. If there are output parameters, they are placed in the DataRow.

6. The OnRowUpdated event is raised.

7. AcceptChanges is called.

Constructors

SqlRowUpdatedEventArgs(DataRow, IDbCommand, StatementType, DataTableMapping)

Initializes a new instance of the SqlRowUpdatedEventArgs class.

Properties

Command	Gets or sets the SqlCommand executed when Update(DataSet) is called.
Errors	Gets any errors generated by the .NET data provider when the Command was executed. (Inherited from RowUpdatedEventArgs)
RecordsAffected	Gets the number of rows changed, inserted, or deleted by execution of the SQL statement. (Inherited from RowUpdatedEventArgs)
Row	Gets the DataRow sent through an Update(DataSet). (Inherited from RowUpdatedEventArgs)
RowCount	Gets the number of rows processed in a batch of updated records. (Inherited from RowUpdatedEventArgs)
StatementType	Gets the type of SQL statement executed. (Inherited from RowUpdatedEventArgs)
Status	Gets the UpdateStatus of the Command property. (Inherited from RowUpdatedEventArgs)
TableMapping	Gets the DataTableMapping sent through an Update(DataSet). (Inherited from RowUpdatedEventArgs)

Methods

CopyToRows(DataRow[], Int32)	Copies references to the modified rows into the provided array. (Inherited from RowUpdatedEventArgs)
CopyToRows(DataRow[])	Copies references to the modified rows into the provided array. (Inherited from RowUpdatedEventArgs)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• ADO.NET Overview