• Article

PercentCompleteEventArgs Class

The PercentCompleteEventArgs object represents the arguments passed by the event raised when a process reaches a percent complete marker.

Inheritance Hierarchy

System.Object
  System.EventArgs
    Microsoft.SqlServer.Management.Common.ServerMessageEventArgs
      Microsoft.SqlServer.Management.Smo.PercentCompleteEventArgs

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

Syntax

'Declaration
Public NotInheritable Class PercentCompleteEventArgs _
    Inherits ServerMessageEventArgs
'Usage
Dim instance As PercentCompleteEventArgs

public sealed class PercentCompleteEventArgs : ServerMessageEventArgs

public ref class PercentCompleteEventArgs sealed : public ServerMessageEventArgs

[<SealedAttribute>]
type PercentCompleteEventArgs =  
    class
        inherit ServerMessageEventArgs
    end

public final class PercentCompleteEventArgs extends ServerMessageEventArgs

The PercentCompleteEventArgs type exposes the following members.

Properties

  Name Description
Public property Error Gets the error associated with the server message event. (Inherited from ServerMessageEventArgs.)
Public property Percent Gets the percentage value amount that when used in integer multiples, and marks the point at which to report progress.

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 Returns a String that represents the ServerMessageEventArgs object. (Inherited from ServerMessageEventArgs.)

Top

Remarks

The PercentCompleteEventArgs object is used by the Backup class and the Restore class to report progress.

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.

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.