This custom action is written in VBScript. See also Scripts.

Source

The script is installed with the application during the current session. The Source field of the CustomAction table contains a key to the File table. The location of the custom action code is determined by the resolution of the target path for this file; therefore this custom action must be called after the file has been installed and before it is removed.

Type Value

Include the following value in the Type column of the CustomAction table to specify the basic numeric type of a 32-bit custom action.

Windows Installer may use 64-bit custom actions on 64-bit operating systems. A 64-bit custom action based on scripts must include the msidbCustomActionType64BitScript bit in its numeric type. For information see 64-bit Custom Actions. Include the following value in the Type column of the CustomAction table to specify the basic numeric type of a 64-bit custom action.

Target

The Target field of the CustomAction table contains an optional script function. Processing first sends the script for parsing and then calls the optional script function.

Return Processing Options

Include optional flag bits in the Type column of the CustomAction table to specify return processing options. For a description of the options and the values, see Custom Action Return Processing Options.

Execution Scheduling Options

Include optional flag bits in the Type column of the CustomAction table to specify execution scheduling options. These options control the multiple execution of custom actions. For a description of the options, see Custom Action Execution Scheduling Options.

In-Script Execution Options

Include optional flag bits in the Type column of the CustomAction table to specify an in-script execution option. These options copy the action code into the execution, rollback, or commit script. For a description of the options, see Custom Action In-Script Execution Options.

Return Values

Optional functions written in script must return one of the values described in Return Values of JScript and VBScript Custom Actions.

Remarks

A custom action that is written in JScript or VBScript requires the install Session Object. This is of the type Session Object and the installer attaches it to the script with the name "Session". Because the Session object may not exist during an installation rollback, a deferred custom action written in script must use one of the methods or properties of the Session object described in the section Obtaining Context Information for Deferred Execution Custom Actions to retrieve its context.

Custom actions that reference an installed file as their source, such as Custom Action Type 22 (VBcript), must adhere to the following sequencing restrictions:

• The custom action must be sequenced after the CostFinalize action. This is so that the custom action can resolve the path needed to locate the source file containing the VBScript.
• If the source file is not already installed on the computer, deferred (in-script) custom actions of this type must be sequenced after the InstallFiles action.
• If the source file is not already installed on the computer, non-deferred custom actions of this type must be sequenced after the InstallFinalize action.

See Also

Custom_Actions

Send comments about this topic to Microsoft

Build date: 8/13/2009