Do

InstallShield 2019 » InstallScript Language Reference

The Do function executes the currently defined EXIT and HELP handlers, giving you greater control over these handlers, which are normally executed only when the user presses the F1 key (HELP) or the Cancel button (EXIT). Using the Do function, you can execute EXIT or HELP handlers in response to custom dialog events or to any user input from built-in dialogs. You can also use the Do function during script development to test your EXIT and HELP handlers.

The Do function can also register queued self-registering files. Files are queued for registration using the “batch method” for installing self-registering files. When you call Do(SELFREGISTRATIONPROCESS), the installation carries out self-registration of all queued files, even if one of them fails. (Note that when you call FeatureTransferData, Do(SELFREGISTRATIONPROCESS) is called automatically after the files are installed but before the FeatureTransferData call returns. If you use an event-based script, the FeatureTransferData function is called by the default code for the OnMoveData event handler function.)

Syntax

Do (nOperation);

Parameters

Do Parameters

Parameter

Description

nOperation

Specifies the type of operation to perform. Pass one of the following predefined constants in this parameter:

•

EXIT—Initiates the Exit operation. If no EXIT handler is defined, the default Exit dialog is displayed.

•

HELP—Initiates the Help operation. If no HELP handler is defined, the function takes no action.

•

SELFREGISTRATIONPROCESS—Registers all self-registering files that have been queued for registration.

Return Values

Do Return Values
Return Value	Description
0	The Do function successfully initiated the specified operation.
< 0	The Do function was unable to initiate the specified operation.

Additional Information

•

The Do function allows the currently defined HELP and EXIT handlers to execute without the end user pressing F1. The Do function also provides more versatility than the goto statement, which can be used to call HELP and EXIT handler labels. The goto statement cannot be used in all circumstances, but the Do function can be called virtually anytime. For more information on default and custom HELP and EXIT handlers, see HandlerEx.

•

If Do fails for any reason, it returns -1. The names of the files that failed to self-register are stored in the InstallScript system variable ERRORFILENAME, and each is separated by a semicolon (;).

Do

InstallShield 2019 Help Library

April 2019