TextSubSetValue

InstallShield 2016 » InstallScript Language Reference

The TextSubSetValue function creates a text substitution association between szTextSub and szValue. The bGlobal parameter specifies whether the association is global or local.

Syntax

TextSubSetValue ( szTextSub, szValue, bGlobal );

Parameters

TextSubSetValue Parameters

Parameter

Description

szTextSub

Specifies the string that is replaced by szValue when text substitution is performed. You can optionally enclose the string value in angle brackets, for example, "<MYTEXTSUB>". If you enclose the string value in angle brackets, you can include additional text in the string outside the angle brackets (for example, "additional<MYTEXTSUB>text") that is automatically removed before text substitution is performed.

Note • In order to avoid conflicts with existing text substitutions that are created internally or by objects used by the installation, it is recommended that any values of szTextSub that you specify in TextSubSetValue use a prefix that is specific to the installation.

szValue

Specifies the string that replaces occurrences of szTextSub when text substitution is performed. This string value can itself contain embedded text substitutions. For more information, see Text Substitutions.

bGlobal

Specifies whether the association between szTextSub and szValue is global or local; for more information, see Text Substitutions.

Return Values

TextSubSetValue Return Values

Return Value

Description

ISERR_SUCCESS

TextSubSetValue successfully associated the specified strings.

< ISERR_SUCCESS

TextSubSetValue failed to associate the specified strings.

See Also