Share via

  • Article

SqlStudioMessageBox.Show Method (IWin32Window, Exception, String, MessageBoxIcon, MessageBoxDefaultButton)

Displays a message box in front of the specified object with the exception that is thrown when an error occurs during application execution. The message box has the specified text, icon, and default button.

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

Syntax

'Declaration
Public Shared Function Show ( _
    owner As IWin32Window, _
    error As Exception, _
    caption As String, _
    icon As MessageBoxIcon, _
    defaultButton As MessageBoxDefaultButton _
) As DialogResult
'Usage
Dim owner As IWin32Window
Dim error As Exception
Dim caption As String
Dim icon As MessageBoxIcon
Dim defaultButton As MessageBoxDefaultButton
Dim returnValue As DialogResult

returnValue = SqlStudioMessageBox.Show(owner, error, _
    caption, icon, defaultButton)

public static DialogResult Show(
    IWin32Window owner,
    Exception error,
    string caption,
    MessageBoxIcon icon,
    MessageBoxDefaultButton defaultButton
)

public:
static DialogResult Show(
    IWin32Window^ owner, 
    Exception^ error, 
    String^ caption, 
    MessageBoxIcon icon, 
    MessageBoxDefaultButton defaultButton
)

static member Show : 
        owner:IWin32Window * 
        error:Exception * 
        caption:string * 
        icon:MessageBoxIcon * 
        defaultButton:MessageBoxDefaultButton -> DialogResult 

public static function Show(
    owner : IWin32Window, 
    error : Exception, 
    caption : String, 
    icon : MessageBoxIcon, 
    defaultButton : MessageBoxDefaultButton
) : DialogResult

Parameters

  • error
    Type: System.Exception
    Represents errors that occur during application execution.
  • caption
    Type: System.String
    The text to display in the title bar of the message box.

Return Value

Type: System.Windows.Forms.DialogResult
One of the DialogResult values.