AdminAskPath

InstallShield 2014 ยป InstallScript Language Reference

Project: This information applies to InstallScript MSI projects.

The AdminAskPath function displays a dialog that prompts the end user to enter the path to a destination location for an administrative installation (when the end user runs an InstallScript MSI project Setup.exe with the /a argument).

Syntax

AdminAskPath ( szMsg, szDefaultPath, svResultPath );

Parameters

AdminAskPath Parameters

Parameter

Description

szMsg

Specifies the message to display in this dialog. To display the default instructions for this dialog, pass a null string ("") in this parameter.

szDefaultPath

Specifies the default path to display in the edit field. The end user can modify this string. The default implementation of OnAdminInstallUIBefore passes INSTALLDIR in this parameter.

svResultPath

Returns the resulting path, regardless of whether the user accepts the default path, modifies it, or selects an alternate path from the Choose Folder dialog. The default implementation of OnAdminInstallUIBefore passes INSTALLDIR in this parameter.

Return Values

AdminAskPath Return Values

Return Value

Description

NEXT (1)

Indicates that the user clicked the Next button.

BACK (12)

Indicates that the user clicked the Back button.

Additional Information

AdminAskPath uses the AskPath dialog, and it uses the same dialog resources as AskPath. Therefore, any changes you make to the layout of AskPath in the Dialog Editor are reflected in AdminAskPath.

To view an example of this or other dialogs for your installation, use the Dialog Sampler. In InstallShield, on the Tools menu, point to InstallScript, then click Standard Dialog Sampler or Skinned Dialog Sampler.

See Also