Share via

  • Article

StatusEventArgs Class

Represents status information returned by a replication agent when the Status event occurs.

Inheritance Hierarchy

System.Object
  System.EventArgs
    Microsoft.SqlServer.Replication.StatusEventArgs

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Replication (in Microsoft.SqlServer.Replication.dll)

Syntax

'Declaration
<ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)> _
<GuidAttribute("71B58976-D89C-41E3-8097-E9CA20A873E1")> _
<ComVisibleAttribute(True)> _
Public Class StatusEventArgs _
    Inherits EventArgs _
    Implements IStatusEventData
'Usage
Dim instance As StatusEventArgs

[ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)]
[GuidAttribute("71B58976-D89C-41E3-8097-E9CA20A873E1")]
[ComVisibleAttribute(true)]
public class StatusEventArgs : EventArgs, 
    IStatusEventData

[ClassInterfaceAttribute(ClassInterfaceType::AutoDispatch)]
[GuidAttribute(L"71B58976-D89C-41E3-8097-E9CA20A873E1")]
[ComVisibleAttribute(true)]
public ref class StatusEventArgs : public EventArgs, 
    IStatusEventData

[<ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)>]
[<GuidAttribute("71B58976-D89C-41E3-8097-E9CA20A873E1")>]
[<ComVisibleAttribute(true)>]
type StatusEventArgs =  
    class
        inherit EventArgs
        interface IStatusEventData
    end

public class StatusEventArgs extends EventArgs implements IStatusEventData

The StatusEventArgs type exposes the following members.

Constructors

  Name Description
Public method StatusEventArgs() Creates a new instance of the StatusEventArgs class.
Public method StatusEventArgs(String, Byte, MessageStatus) Creates a new instance of the StatusEventArgs class with the provided replication agent status information.

Top

Properties

  Name Description
Public property Message The status message returned by the replication agent.
Public property MessageStatus The current operational status of the replication agent.
Public property PercentCompleted The estimated amount of the overall synchronization that has completed.

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

The Status event returns a status message, status code, and percentage complete information from the replication agent during synchronization. The AgentCore.StatusEventHandler returns a StatusEventArgs object when the Status event occurs during agent execution.

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.