CloseApplication Element (Util Extension)

WiX Toolset

CloseApplication Element (Util Extension)

Description
Closes applications or schedules a reboot if application cannot be closed.
Windows Installer references
None
Parents
Fragment, Module, Product
Inner Text (xs:string)
Condition that determines if the application should be closed. Must be blank or evaluate to true for the application to be scheduled for closing.
Children
None
Attributes
Name Type Description Required
CloseMessage YesNoType Optionally sends a close message to the application. Default is no.  
Description String Description to show if application is running and needs to be closed.  
ElevatedCloseMessage YesNoType Optionally sends a close message to the application from deffered action without impersonation. Default is no.  
ElevatedEndSessionMessage YesNoType Sends WM_QUERYENDSESSION then WM_ENDSESSION messages to the application from a deffered action without impersonation. Default is "no".  
EndSessionMessage YesNoType Sends WM_QUERYENDSESSION then WM_ENDSESSION messages to the application. Default is "no".  
Id String Identifier for the close application (primary key). If the Id is not specified, one will be generated.  
PromptToContinue YesNoType When this attribute is set to "yes", the user will be prompted when the application is still running. The Description attribute must contain the message to display in the prompt. The prompt occurs before executing any of the other options and gives the options to "Abort", "Retry", or "Ignore". Abort will cancel the install. Retry will attempt the check again and if the application is still running, prompt again. "Ignore" will continue and execute any other options set on the CloseApplication element. The default is "no".  
Property String Property to be set if application is still running. Useful for launch conditions or to conditionalize custom UI to ask user to shut down apps.  
RebootPrompt YesNoType Optionally prompts for reboot if application is still running. The default is "yes". The TerminateProcess attribute must be "no" or not specified if this attribute is "yes".  
Sequence Integer Optionally orders the applications to be closed.  
Target String Name of the exectuable to be closed. This should only be the file name. Yes
TerminateProcess Integer Attempts to terminates process and return the specified exit code if application is still running after sending any requested close and/or end session messages. If this attribute is specified, the RebootPrompt attribute must be "no". The default is "no".  
Timeout Integer Optional time in seconds to wait for the application to exit after the close and/or end session messages. If the application is still running after the timeout then the RebootPrompt or TerminateProcess attributes will be considered. The default value is "5" seconds.  
See Also
Util Schema