FeatureFilterLanguage

InstallShield 2014 » InstallScript Language Reference

Project: This information applies to the following project types:

InstallScript
InstallScript MSI

The FeatureFilterLanguage function filters (excludes) files from file transfer based on language. By default, all languages included in the media build are unfiltered (included). You must call FeatureFilterLanguage for each language you wish to filter or unfilter.

Note: This function cannot be used with script-created feature sets.

Filtering Language-Specific Components

To filter language-specific components during the installation:

1. Filter (exclude) all languages by calling FeatureFilterLanguage with ISLANG_ALL in the parameter nLangID and bFiltered set to TRUE.
2. For each language that you want to install, call FeatureFilterLanguage with the appropriate language constant in nLangID and with the parameter bFiltered parameter set to FALSE. Each call unfilters (includes) components for the language specified in nLangID.

Note: You cannot specify multiple language constants in the nLangID parameter by using the OR operator ( | ). Specifying multiple language constants causes the function to perform incorrectly.

Supporting Different Languages

InstallShield allows you to designate components for any language or language subgroup that is supported by Windows. However, in order for the Release Wizard to build a language-specific component, you must have support for the language of that component. Your setup must also support the language of the component.

If your setup includes language-specific components that are designated as specific to a language not supported by InstallShield or by your setup, the components are filtered (not included) by the Release Wizard.

Using FeatureFilterLanguage With GetSystemInfo

When using FeatureFilterLanguage in conjunction with the GetSystemInfo function, you must consider the following: The language constants that can be used to designate language-specific components are a small subset of the language constants that can be returned by GetSystemInfo.

If your setup includes language filtering based on these return values, you must use a switch statement to convert constants returned by this function into one of the constants supported for language filtering.

Syntax

FeatureFilterLanguage ( szFeatureSource, nLangID, bFiltered );

Parameters

FeatureFilterLanguage Parameters

Parameter

Description

szFeatureSource

Specifies the media name of the file media.

nLangID

Specifies the ID of the language to filter or unfilter. Only one language constant can be specified for each function call. To filter all languages, pass ISLANG_ALL in this parameter. See Language IDs to learn more.

bFiltered

Indicates whether to filter (exclude) or unfilter (include) the language specified in nLangID. Pass one of the following predefined constants in this parameter:

TRUE—Filter the language specified in nLangID—do not include it in the file transfer.
FALSE—Do not filter the language specified in nLangID—include it in the file transfer.

Return Values

FeatureFilterLanguage Return Values

Return Value

Description

0

FeatureFilterLanguage was successful.

< 0

FeatureFilterLanguage failed.

See Also