ServiceInstall Element

Description

Adds services for parent Component. Use the ServiceControl element to remove services.

Windows Installer references

ServiceInstall Table

Parents

Component

Inner Text

None

Children

Choice of elements (min: 0, max: unbounded)

• PermissionEx (min: 0, max: unbounded): Configures the ACLs for this service.
• ServiceConfig (min: 0, max: unbounded)
• ServiceConfigFailureActions (min: 0, max: unbounded)
• ServiceDependency (min: 0, max: unbounded): Ordered list of dependencies when installing services.
• Any Element (namespace='##other' processContents='Lax') Extensibility point in the WiX XML Schema. Schema extensions can register additional elements at this point in the schema.
  • ServiceConfig
  • UrlReservation

Attributes

Name	Type	Description	Required
Account	String	Fully qualified names must be used even for local accounts, e.g.: ".\LOCAL_ACCOUNT". 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 must be one of the following: ignore Logs the error and continues with the startup operation. normal Logs the error, displays a message box and continues the startup operation. critical Logs the error if it is possible and the system is restarted with the last configuration known to be good. If the last-known-good configuration is being started, the startup operation fails.	Yes
Id	String	Unique identifier for this service configuration. This value will default to the Name attribute if not specified.
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 must be one of the following: auto The service will start during startup of the system. demand The service will start when the service control manager calls the StartService function. disabled The service can no longer be started. boot The service is a device driver that will be started by the operating system boot loader. This value is not currently supported by the Windows Installer. system The service is a device driver that will be started by the IoInitSystem function. This value is not currently supported by the Windows Installer.	Yes
Type	Enumeration	The Windows Installer does not currently support kernelDriver or systemDriver. This attribute's value must be one of the following: ownProcess A Win32 service that runs its own process. shareProcess A Win32 service that shares a process. kernelDriver A kernel driver service. This value is not currently supported by the Windows Installer. systemDriver A file system driver service. This value is not currently supported by the Windows Installer.	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