• Article

ExceptionMessageBox.GetMessageText Method

Returns the string that a user can copy to the clipboard when the exception is displayed in an exception message box.

Namespace:  Microsoft.SqlServer.MessageBox
Assembly:  Microsoft.ExceptionMessageBox (in Microsoft.ExceptionMessageBox.dll)

Syntax

'Declaration
Public Shared Function GetMessageText ( _
    exception As Exception _
) As String
'Usage
Dim exception As Exception
Dim returnValue As String

returnValue = ExceptionMessageBox.GetMessageText(exception)

public static string GetMessageText(
    Exception exception
)

public:
static String^ GetMessageText(
    Exception^ exception
)

static member GetMessageText : 
        exception:Exception -> string 

public static function GetMessageText(
    exception : Exception
) : String

Parameters

Return Value

Type: System.String
String that contains the full content of the message.

Remarks

The returned String includes the message text, the caption, and help links from all message parts. This is the same text that is placed on the clipboard when the Copy Message button is clicked.