GetCurrentDialogName

InstallShield 2014 » InstallScript Language Reference

Project: This information applies to InstallScript projects.

The GetCurrentDialogName function retrieves the name of the currently displayed dialog as it was specified in the call to EzDefineDialog when the dialog was defined.

This information can be used to close the dialog by calling EndDialog.

Syntax

GetCurrentDialogName ( svDialogName );

Parameters

GetCurrentDialogName Parameters

Parameter

Description

svDialogName

Returns the name of the currently displayed dialog, or a null string ("") if no dialog is currently displayed.

Return Values

GetCurrentDialogName Return Values

Return Value

Description

>= ISERR_SUCCESS

GetCurrentDialogName successfully retrieved the name of the currently displayed dialog.

< ISERR_SUCCESS

No dialog is currently displayed.

You can obtain the error message text associated with a large negative return value—for example, -2147024891 (0x80070005)—by calling FormatMessage.