ProgressReportEventArgs Class

The ProgressReportEventArgs object provides programmatic access to the arguments used to report the progress of an operation that works through an object hierarchy, such as discovering dependencies in scripting operations.

Inheritance Hierarchy

System.Object
  System.EventArgs
    Microsoft.SqlServer.Management.Smo.ProgressReportEventArgs

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public Class ProgressReportEventArgs _
    Inherits EventArgs
'Usage
Dim instance As ProgressReportEventArgs
public class ProgressReportEventArgs : EventArgs
public ref class ProgressReportEventArgs : public EventArgs
type ProgressReportEventArgs =  
    class 
        inherit EventArgs 
    end
public class ProgressReportEventArgs extends EventArgs

The ProgressReportEventArgs type exposes the following members.

Constructors

  Name Description
Public method ProgressReportEventArgs(Urn, Urn, Int32, Int32, Int32, Int32) Creates a new instance of the ProgressReportEventArgs class with the specified options.
Public method ProgressReportEventArgs(Urn, Urn, Boolean, Int32, Int32, Int32, Int32) Creates a new instance of the ProgressReportEventArgs class with the specified options.

Top

Properties

  Name Description
Public property Current Gets the Urn object value that specifies the object that the operation is currently processing.
Public property IsSchemaBound Gets a Boolean indicating whether the Progress Report is bound to a schema.
Public property Parent Gets the Urn object that is the parent of the ProgressReportEventArgs object.
Public property SubTotal Gets the total number of objects within the current branch of the object hierarchy.
Public property SubTotalCount Gets the current count of objects processed by the operation within the current branch of the object hierarchy.
Public property Total Gets the total number of object in the entire object hierarchy.
Public property TotalCount Gets the total current count of objects processed by the operation within the entire object hierarchy.

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)

Top

Remarks

Thread Safety

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

Examples

Handling SMO Events

Thread Safety

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

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace