Autodesk Vault ProfessionalVault API

ShowError(String,String,String,Action) Method

Autodesk.DataManagement.Client.Framework.FormsLibrary

Displays an error dialog box with the specified message and optionally, a link to launch help.

Syntax

public static System.Windows.Forms.DialogResult ShowError(
   System.string message,
   System.string title,
   System.string helpTopic,
   System.Action helpAction
)
Public Overloads Shared Function ShowError( _
   ByVal message As System.String, _
   ByVal title As System.String, _
   ByVal helpTopic As System.String, _
   ByVal helpAction As System.Action _
) As System.Windows.Forms.DialogResult

Parameters

NameDescription
messageThe error text to display in the dialog box.
titleThe Caption of the dialog box.
helpTopicHelp topic to be displayed as link text
helpActionA delegate that takes care of launching help

Remarks

The error dialog box will display the System Error Icon and have an OK button. If valid values are supplied supplied for helpTopic, helpTopicId, and a valid callback is supplied for helpAction, a help link is also displayed, which can launch help.

See Also