FeatureStandardSetupTypeSet

InstallShield 2024 » InstallScript Language Reference

Project: This information applies to the following project types:

•

InstallScript

•

InstallScript MSI

The FeatureStandardSetupTypeSet function sets the current setup type to the standard setup type specified by nSetupType. This function attempts to set the setup type by calling the FeatureSetupTypeSet function with the appropriate string to set the setup type.

Syntax

FeatureStandardSetupTypeSet ( szFeatureSource, nSetupType );

Parameters

FeatureStandardSetupTypeSet Parameters

Parameter

Description

szFeatureSource

Specifies the media name of the file media whose setup type is to be set.

nSetupType

Specifies which setup type to set. Pass one of the following predefined constants in this parameter:

•

TYPICAL

•

COMPLETE

•

COMPACT

•

CUSTOM

You can customize the string setup type value associated with each numeric constant by customizing the global predefined script variables listed below. The function sets the setup or installation type by trying the appropriate script variable, then tries the setup type name in English and Japanese (see below). Also, when the COMPLETE setup type is specified, the function tries all TYPICAL values after checking the values for COMPLETE. If the setup type cannot be set to any of these values, the function returns failure. The following global predefined script variables can be customized:

•

SETUPTYPE_STR_TYPICAL—Defines the setup type that will be set by default if TYPICAL is specified.

•

SETUPTYPE_STR_COMPLETE—Defines the setup type that will be set by default if COMPLETE is specified.

•

SETUPTYPE_STR_COMPACT—Defines the setup type that will be set by default if COMPACT is specified.

•

SETUPTYPE_STR_CUSTOM—Defines the setup type that will be set by default if CUSTOM is specified.

The following table shows the values the FeatureStandardSetupTypeSet function uses when each constant is specified in the nSetupType parameter.

nSetupType Constants
Constant	Strings Used
TYPICAL	SETUPTYPE_STR_TYPICAL Typical
COMPLETE	SETUPTYPE_STR_COMPLETE Complete
COMPACT	SETUPTYPE_STR_COMPACT Compact
CUSTOM	SETUPTYPE_STR_CUSTOM Custom

Return Values

FeatureStandardSetupTypeSet Return Values
Return Value	Description
>= ISERR_SUCCESS	FeatureStandardSetupTypeSet was able to set the specified setup type.
< ISERR_SUCCESS	FeatureStandardSetupTypeSet was unable to set the specified setup type.