Syntax

Engine.DisplayRunTimeErrorDialog( dlgTitle, errorMessage, inCleanupStepGroup, modalToAppMainWind, displayOnNextError, suspendExecution, runTimeErrorAction)

Purpose

Remarks

Launches the Run-Time Error dialog box. The sequence editor and user interface typically call this function in response to a UIMsg_BreakOnRunTimeError event. The Run-Time Error dialog box allows the user to specify how the execution is to proceed.

Parameters

dlgTitle As String

[In] Specifies the title of the dialog box. Pass an empty string to use the default title for the dialog box.

errorMessage As String

[In] Specifies the error message to display in the dialog box.

inCleanupStepGroup As Boolean

[In] Pass True if the run-time error occurred in the Cleanup step group of the sequence. This information affects the list of options the dialog box displays to the user.

modalToAppMainWind As Boolean

[In] By default, the dialog box is modal to the last active window of the calling thread, or if there is none, to the last active window from AppMainHwnd. If you set this option, the dialog box is modal with respect to the window handle of the Engine.AppMainHwnd property. Typically, you do not need to set this option.

displayOnNextError As Boolean

[Out] Returns a value that indicates whether the user wants this dialog box to launch again if another run-time error occurs in the current execution.

suspendExecution As Boolean

[Out] Returns a value that indicates whether the user wants the current execution to suspend at the location of the run-time error.

runTimeErrorAction As RTEOptions

[Out] Returns the option the user selects in the dialog box to specify how the execution should proceed.

See Also

Engine.AppMainHwnd

Engine.DisplayRunTimeErrorDialogEx

RTEOptions

Run-Time Error dialog box

UIMessage.Event

UIMessageCodes