Description
Specifies a custom action to be added to the MSI CustomAction table.
Derived By
Extending string
Attributes
| Name |
Type |
Description |
| Id |
string |
The identifier of the custom action.
|
| BinaryKey |
string |
This attribute is a reference to a Binary element with matching Id attribute.
|
| FileKey |
string |
This attribute specifies a reference to a File element with matching Id attribute that will execute the custom action code in the file after the file is installed.
|
| Property |
string |
This attribute specifies a reference to a Property element with matching Id attribute that specifies the Property to be used or updated on execution of this custom action.
|
| Directory |
string |
This attribute specifies a reference to a Directory element with matching Id attribute containing a directory path.
|
| DllEntry |
string |
This attribute specifies the name of a function in a custom action to execute.
|
| ExeCommand |
string |
This attribute specifies the command line parameters to supply to an externally run executable.
|
| JScriptCall |
string |
This attribute specifies the name of the JScript function to execute in a script.
|
| VBScriptCall |
string |
This attribute specifies the name of the VBScript Subroutine to execute in a script.
|
| Script |
NMTOKEN (restriction) |
Creates a type 37 or 38 custom action.
|
| SuppressModularization |
YesNoType |
Use to suppress modularization of this custom action name in merge modules.
|
| Value |
string |
This attribute specifies a string value to use in the custom action.
|
| Error |
string |
This attribute specifies an index in the MSI Error table to use as an error message for a type 19 custom action that displays the error message and aborts a product's installation.
|
| Return |
NMTOKEN (restriction) |
Set this attribute to set the return behavior of the custom action.
|
| Execute |
NMTOKEN (restriction) |
This attribute indicates the scheduling of the custom action.
|
| Impersonate |
YesNoType |
This attribute specifies whether the Windows Installer, which executes as LocalSystem, should impersonate the user context of the installing user when executing this custom action.
|
| PatchUninstall |
YesNoType |
This attribute specifies that the Windows Installer, execute the custom action only when a patch is being uninstalled.
|
| Win64 |
YesNoType |
Specifies that a script custom action targets a 64-bit platform.
|
| TerminalServerAware |
YesNoType |
This attribute specifies controls whether the custom action will impersonate the installing user during per-machine installs on Terminal Server machines.
|
| HideTarget |
YesNoType |
Ensures the installer does not log the CustomActionData for the deferred custom action.
|
Content Model
Contains text only.
Remarks
Various combinations of the attributes for this element correspond to different custom action types. For more information about custom actions see the Custom Action Types topic on MSDN.