Wix::Extensions::SystemTools::ScheduleExecute Class Reference

Public Attributes
string	Id
string	Directory
string	CommandLine
string	ErrorMessage
integer	ReturnCode
YesNoType	ContinueOnError
YesNoType	ExecuteOnInstall
YesNoType	ExecuteOnUnInstall
YesNoType	ExecuteOnRollback

Detailed Description

May be nested under Component. To manually schedule an Execute action, use ScheduleExecute. This creates a custom action invoking Win32_Execute_Deferred with the ID of the ScheduleExecute declaration. Explicit options, including ExecuteOnInstall and ExecuteOnUnInstall still apply and ScheduleExecute may also be nested under a component to inherit the component's condition.

Example:

<AppSecInc:ScheduleExecute Id="Scheduled_copy" CommandLine="cmd.exe /C copy Source.txt Target.txt" ExecuteOnInstall="yes" />
<AppSecInc:ScheduleExecute Id="Scheduled_delete" CommandLine="cmd.exe /C del Target.txt" ExecuteOnUnInstall="yes" />
<AppSecInc:ScheduleExecute Id="Scheduled_rollback" CommandLine="cmd.exe /C del Target.txt" ExecuteOnRollback="yes" />
...
<InstallExecuteSequence>
<Custom Action="Scheduled_copy" After="InstallFiles">NOT Installed</Custom>
<Custom Action="Scheduled_delete" After="InstallFiles">Installed</Custom>
<Custom Action="Scheduled_rollback" After="InstallFiles">NOT Installed</Custom>
</InstallExecuteSequence>

Member Data Documentation

string Wix::Extensions::SystemTools::ScheduleExecute::CommandLine

Command-line to execute.

YesNoType Wix::Extensions::SystemTools::ScheduleExecute::ContinueOnError

Continue on error.

string Wix::Extensions::SystemTools::ScheduleExecute::Directory

Optional directory in which to execute the command.

string Wix::Extensions::SystemTools::ScheduleExecute::ErrorMessage

Optional error message to display instead of a raw error.

YesNoType Wix::Extensions::SystemTools::ScheduleExecute::ExecuteOnInstall

Execute command at install time.

YesNoType Wix::Extensions::SystemTools::ScheduleExecute::ExecuteOnRollback

Execute command at rollback time.

YesNoType Wix::Extensions::SystemTools::ScheduleExecute::ExecuteOnUnInstall

Execute command at uninstall time.

string Wix::Extensions::SystemTools::ScheduleExecute::Id

Identifier for the execute statement (primary key).

integer Wix::Extensions::SystemTools::ScheduleExecute::ReturnCode

Optional return code that indicates success of the process, defaults to zero.

---

The documentation for this class was generated from the following file:

• src/WixExtensions/SystemToolsExtension/wixext/Xsd/SystemTools.xsd