DisplayMessageBox Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.DisplayMessageBox ( dlgTitle, messageText, msgBoxType = MsgBox_Information, dlgOptions = 0, win32Flags = 0)

Return Value

Long

Returns the user response. This is the same as the return value from the Microsoft Windows Software Development Kit MessageBox function. The following are typical values: IDOK (1), IDCANCEL (2), IDYES (6), IDNO (7).

Purpose

Launches a message dialog box.

Remarks

Calling this method on a remote instance of the engine displays the message on the local computer.

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.

messageText As String

[In] Specifies the text to display in the message box.

msgBoxType As MsgBoxTypes

[In] Specifies the type of message box. This tells the message box which icon to display.

This parameter has a default value of MsgBox_Information.

dlgOptions As Long

[In] Specify CommonDlgOption_NoOptions or CommonDlgOption_ModalToAppMainWnd.

This parameter has a default value of 0.

win32Flags As Long

[In] Specifies any additional flags the Windows SDK MessageBox function allows.

This parameter has a default value of 0.


See Also

CommonDialogOptions

MsgBoxTypes

WAS THIS ARTICLE HELPFUL?

Not Helpful