FeatureSetupTypeGetData

InstallShield 2014 » InstallScript Language Reference

Project: This information applies to the following project types:

•

InstallScript

•

InstallScript MSI

The FeatureSetupTypeGetData function retrieves data associated with a specified setup type. You can then use this data for any purpose.

A typical application of FeatureSetupTypeGetData might be to display setup type information in a custom setup type-related dialog. You would call FeatureSetupTypeGetData inside the switch-case statement following the call to WaitOnDialog that displays the custom dialog.

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

Syntax

FeatureSetupTypeGetData ( szFeatureSource, szSetupType, nInfo, nvResult, svResult );

Parameters

FeatureSetupTypeGetData Parameters

Parameter

Description

szFeatureSource

Specifies the media name of the file media from which data associated with a setup type is to be retrieved.

szSetupType

Specifies the setup type name. This name must be specified exactly as it appears in the InstallShield interface—for example, “Typical”.

nInfo

Specifies the information to retrieve. Pass one of the following predefined constants in this parameter:

•

SETUPTYPE_INFO_DESCRIPTION—Retrieves the description of the specified setup type. The description is returned in svResult.

•

SETUPTYPE_INFO_DISPLAYNAME—Retrieves the display name of the setup type. The name is returned in svResult.

nvResult

Returns a NUMBER or LONG value when nInfo specifies information of that type.

svResult

Returns a STRING value when nInfo specifies information of that type.

Return Values

FeatureSetupTypeGetData Return Values
Return Value	Description
0	FeatureSetupTypeGetData was successful.
< 0	FeatureSetupTypeGetData failed. Call FeatureError for additional information.

FeatureSetupTypeGetData

InstallShield 2014 Help Library

May 2014