ServiceInstall Element

WiX Help

ServiceInstall Element

Description

Adds and removes services for parent Component.

Windows Installer references
ServiceInstall Table
Parents
Component, Include
Inner Text
None
Children
Sequence (min: 1, max: 1)
  1. Permission (min: 0, max: unbounded): Permissions for this service.
  2. ServiceConfig (min: 0, max: 1): Service Config: failure actions for service
  3. ServiceDependency (min: 0, max: unbounded): ordered list of dependencies when installing services
Attributes
Name Type Description Required
Id String Unique identifier for this service. Yes
Account String The acount under which to start the service. Valid only when ServiceType is ownProcess.  
Arguments String Contains any command line arguments or properties required to run the service.  
Description String Sets the description of the service.  
DisplayName String This column is the localizable string that user interface programs use to identify the service.  
EraseDescription YesNoType Determines whether the existing service description will be ignored. If 'yes', the service description will be null, even if the Description attribute is set.  
ErrorControl Enumeration Determines what action should be taken on an error. This attribute's value should be one of the following:
ignore
normal
critical
Yes
Interactive YesNoType Whether or not the service interacts with the desktop.  
LoadOrderGroup String The load ordering group that this service should be a part of.  
Name String This column is the string that gives the service name to install. Yes
Password String The password for the account. Valid only when the account has a password.  
Start Enumeration Determines when the service should be started. The Windows Installer does not support boot or system. This attribute's value should be one of the following:
auto
demand
disabled
boot
system
Yes
Type Enumeration The Windows Installer does not currently support kernelDriver or systemDriver This attribute's value should be one of the following:
ownProcess
shareProcess
kernelDriver
systemDriver
Yes
Vital YesNoType The overall install should fail if this service fails to install.  
Remarks
The service executable installed will point to the KeyPath for the Component. Therefore, you must ensure that the correct executable is either the first child File element under this Component or explicitly mark the appropriate File element as KeyPath='yes'.
See Also
Wix Schema