CustomAction Element
- Description
-
Specifies a custom action to be added to the MSI CustomAction table. Various combinations of the attributes for this element correspond to different custom action types. For more information about custom actions see the MSDN documentation http://msdn.microsoft.com/library/en-us/msi/setup/summary_list_of_all_custom_action_types.asp for a "Summary List of All Custom Action Types".
- Windows Installer references
- CustomAction Table
- Parents
- Fragment, Include, Module, Product
- Inner Text (xs:string)
- The text node is only valid if the Script attribute is specified. In that case, the text node contains the script to embed.
- Children
- None
- Attributes
-
Name Type Description Required BinaryKey String This attribute is a reference to a Binary element with matching Id attribute. That binary stream contains the custom action for use during install. The custom action will not be installed into a target directory. This attribute is typically used with the DllEntry attribute to specify the custom action DLL to use for a type 1 custom action, with the ExeCommand attribute to specify a type 17 custom action that runs an embedded executable, or with the VBScriptCall or JScriptCall attributes to specify a type 5 or 6 custom action. Directory String This attribute specifies a reference to a Directory element with matching Id attribute containing a directory path. This attribute is typically used with the ExeCommand attribute to specify the source executable for a type 34 custom action, or with the Value attribute to specify a formatted string to place in the specified Directory table entry in a type 35 custom action. DllEntry String This attribute specifies the name of a function in a custom action to execute. This attribute is used with the BinaryKey attribute to create a type 1 custom action, or with the FileKey attribute to create a type 17 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. ExeCommand String This attribute specifies the command line parameters to supply to an externally run executable. This attribute is typically used with the BinaryKey attribute for a type 2 custom action, the FileKey attribute for a type 18 custom action, the Property attribute for a type 50 custom action, or the Directory attribute for a type 34 custom action that specify the executable to run. Execute Enumeration This attribute indicates the scheduling of the custom action. This attribute's value should be one of the following: - commit
- Indicates that the custom action will run after successful completion of the installation script (at the end of the installation).
- deferred
- Indicates that the custom action runs in-script (possibly with elevated privileges).
- firstSequence
- Indicates that the custom action will only run in the first sequence that runs it.
- immediate
- Indicates that the custom action will run during normal processing time with user privileges. This is the default.
- oncePerProcess
- Indicates that the custom action will only run in the first sequence that runs it in the same process.
- rollback
- Indicates that a custom action will run in the rollback sequence when a failure occurs during installation, usually to undo changes made by a deferred custom action.
- secondSequence
- Indicates that a custom action should be run a second time if it was previously run in an earlier sequence.
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. This attribute is typically used with the ExeCommand attribute to specify a type 18 custom action that runs an installed executable, with the DllEntry attribute to specify an installed custom action DLL to use for a type 17 custom action, or with the VBScriptCall or JScriptCall attributes to specify a type 21 or 22 custom action. HideTarget YesNoType Ensures the installer does not log the CustomActionData for the deferred custom action. Id String The identifier 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. Typically the value should be 'yes', except when the custom action needs elevated privileges to apply changes to the machine. JScriptCall String This attribute specifies the name of the JScript function to execute in a script. The script must be provided in a Binary element identified by the BinaryKey attribute described above. In other words, this attribute must be specified in conjunction with the BinaryKey attribute. 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. This attribute is typically used with the Value attribute to create a type 51 custom action that parses the text in Value and places it into the specified Property. This attribute is also used with the ExeCommand attribute to create a type 50 custom action that uses the value of the given property to specify the path to the executable. Type 51 custom actions are often useful to pass values to a deferred custom action. See http://msdn.microsoft.com/library/en-us/msi/setup/obtaining_context_information_for_deferred_execution_custom_actions.asp for more information. Return Enumeration Set this attribute to set the return behavior of the custom action. This attribute's value should be one of the following: - asyncNoWait
- Indicates that the custom action will run asyncronously and execution may continue after the installer terminates.
- asyncWait
- Indicates that the custom action will run asynchronously but the installer will wait for the return code at sequence end.
- check
- Indicates that the custom action will run synchronously and the return code will be checked for success. This is the default.
- ignore
- Indicates that the custom action will run synchronously and the return code will not be checked.
Script Enumeration Creates a type 37 or 38 custom action. The text of the element should contain the script to be embedded in the package. This attribute's value should be one of the following: - jscript
- vbscript
TerminalServerAware YesNoType This attribute specifies controls whether the custom action will impersonate the installing user during per-machine installs on Terminal Server machines. Deferred execution custom actions that do not specify this attribute, or explicitly set it 'no', will run with no user impersonation on Terminal Server machines during per-machine installations. This attribute is only applicable when installing on the Windows Server 2003 family. Value String This attribute specifies a string value to use in the custom action. This attribute must be used with the Property attribute to set the property as part of a type 51 custom action or with the Directory attribute to set a directory path in that table in a type 35 custom action. The value can be a literal value or derived from a Property element using the Formatted syntax. VBScriptCall String This attribute specifies the name of the VBScript Subroutine to execute in a script. The script must be provided in a Binary element identified by the BinaryKey attribute described above. In other words, this attribute must be specified in conjunction with the BinaryKey attribute. Win64 YesNoType Specifies that a script custom action targets a 64-bit platform. Valid only when used with the Script, VBScriptCall, and JScriptCall attributes. - See Also
- Wix Schema, Custom, CustomActionRef