dotConnect for DB2 Documentation
Devart.Common Namespace / DbScript Class / Progress Event
Example

In This Topic
    Progress Event
    In This Topic
    Occurs when a SQL statement within script has successfully executed.
    Syntax
    'Declaration
     
    Public Event Progress As ScriptProgressEventHandler
    public event ScriptProgressEventHandler Progress
    Event Data

    The event handler receives an argument of type ScriptProgressEventArgs containing data related to this event. The following ScriptProgressEventArgs properties provide information specific to this event.

    PropertyDescription
    Gets length of the statement in symbols.  
    Gets number of line in the whole script where the statement can be located.  
    Gets position of the statement in its line.  
    Gets offset of the statement in the whole script text.  
    Gets type of the statement that is executed.  
    Gets SQL statement that has been executed.  
    Remarks

    This event can be generated by Execute and ExecuteNext methods in case of successfull execution of a statement in a script.

    If you want to stop script execution from the event handler, you can raise an exception.

    Example
    This sample demonstrates how to execute script and retrieve information about execution flow using Progress and Error events.
    [STAThread]
    static void Main(string[] args)
    {
    string script =
    
      "INSERT INTO DEPT VALUES (10,'ACCOUNTING','NEW YORK');"+
      "INSERT INTO DEPT VALUES (20,'RESEARCH','DALLAS');"+
      "INSERT INTO DEPT VALUES (30,'SALES','CHICAGO');"+
      "INSERT INTO DEPT VALUES (40,'OPERATIONS','BOSTON');"+
      "SELECT * FROM DEPT";
          DB2Connection db2Conn = new DB2Connection(
              "user id=db2admin;server=db2;database=SAMPLE;");
          DB2Script db2Script = new DB2Script(script,db2Conn);
          db2Script.Progress += new Devart.Common.ScriptProgressEventHandler(OnProgress);
          db2Script.Error += new Devart.Common.ScriptErrorEventHandler(OnError);
          db2Conn.Open();
          db2Script.Execute();
          db2Conn.Close();
        }
    
    static void OnProgress(object sender, Devart.Common.ScriptProgressEventArgs e)
    {
      Console.WriteLine(e.Text);
      Console.WriteLine("  Successfully executed.");
    }
    
    static void OnError(object sender, Devart.Common.ScriptErrorEventArgs e)
    {
      e.Ignore = true;
      Console.WriteLine(e.Text);
      Console.WriteLine("  Failed.");
    }
    Module Module1
    
      Friend WithEvents db2Script As Devart.Data.DB2.DB2Script
    
      Sub Main()
        Dim script As String = _
    
      "INSERT INTO DEPT VALUES (10,'ACCOUNTING','NEW YORK');" & _
      "INSERT INTO DEPT VALUES (20,'RESEARCH','DALLAS');" & _
      "INSERT INTO DEPT VALUES (30,'SALES','CHICAGO');" & _
      "INSERT INTO DEPT VALUES (40,'OPERATIONS','BOSTON');" & _
      "SELECT * FROM DEPT"
        Dim db2Conn As DB2Connection = New DB2Connection( _
            "user id=db2admin;server=db2;database=SAMPLE;")
        db2Script = New DB2Script(script, db2Conn)
        db2Conn.Open()
        db2Script.Execute()
        db2Conn.Close()
        Console.ReadLine()
      End Sub
    
      Sub OnProgress(ByVal sender As Object, ByVal e As Devart.Common.ScriptProgressEventArgs) Handles db2Script.Progress
        Console.WriteLine(e.Text)
        Console.WriteLine("  Successfully executed.")
      End Sub
    
      Sub OnError(ByVal sender As Object, ByVal e As Devart.Common.ScriptErrorEventArgs) Handles db2Script.Error
        e.Ignore = True
        Console.WriteLine(e.Text)
        Console.WriteLine("  Failed.")
      End Sub
    
    End Module
    Requirements

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

    See Also