CtrlGetUrlForLinkClicked

InstallShield 2014 » InstallScript Language Reference

Project: This information applies to the following project types:

InstallScript
InstallScript MSI

The CtrlGetUrlForLinkClicked function retrieves the URL for a link that an end user clicked.

Tip: To learn how to add links to dialogs in InstallScript and InstallScript MSI projects, see Using an HTML Control on a Dialog.

Syntax

CtrlGetUrlForLinkClicked (byval string szDialogName, byval number nControlID, byref string svText);

Parameters

CtrlGetUrlForLinkClicked Parameters

Parameter

Description

szDialogName

Specify the name of the dialog that contains the HTML control.

nControlID

Specify the control ID of the HTML control. This ID is the same as the ID of the static control that was converted into an HTML control.

svText

Specify the string variable to return the link URL text.

Return Values

CtrlGetUrlForLinkClicked Return Values

Return Value

Description

0

CtrlGetUrlForLinkClicked was able to determine the link that the end user clicked.

ISERR_GEN_FAILURE

CtrlGetUrlForLinkClicked was unable to determine the link that an end user clicked. This function returns this value if the specified control ID is not for an HTML control.

See Also