Share via


ServerMessageEventArgs Class

Provides information about a server message event.

Inheritance Hierarchy

System.Object
  System.EventArgs
    Microsoft.SqlServer.Management.MultiServerConnection.ServerMessageEventArgs

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

Syntax

'Declaration
Public Class ServerMessageEventArgs _
    Inherits EventArgs _
    Implements IResultInfo
'Usage
Dim instance As ServerMessageEventArgs
public class ServerMessageEventArgs : EventArgs, 
    IResultInfo
public ref class ServerMessageEventArgs : public EventArgs, 
    IResultInfo
type ServerMessageEventArgs =  
    class
        inherit EventArgs
        interface IResultInfo
    end
public class ServerMessageEventArgs extends EventArgs implements IResultInfo

The ServerMessageEventArgs type exposes the following members.

Constructors

  Name Description
Public method ServerMessageEventArgs Initializes a new instance of the ServerMessageEventArgs class.

Top

Properties

  Name Description
Public property BatchStartingLine Gets the starting line of the batch in the editor.
Public property BatchText Gets the text of the Transact-SQL batch that was executed.
Public property CompletedSuccessfully Gets true if execution was successful, false if there was an exception.
Public property ConnectionInfo Gets the connection info of the connection producing the result.
Public property Errors Gets the messages that were returned by the server.
Public property Exception Gets the exception that was thrown while executing the Transact-SQL batch.
Public property ExecutionTime Gets the amount of client wall-time it took to get the result back from the server.
Public property LoginName Gets the name of the login executing the batch.
Public property ServerDisplayName Gets the display name of the server where the batch was executed.
Public property ServerName Gets the name of the server where the batch was executed.
Public property StartTime Gets the time when the batch was submitted.

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

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.