desktop6:CustomInstall

Article
03/21/2023

Enables your desktop application to specify one or more additional installer files (.exe or .msi) that are installed with your desktop application. For example, this is useful for apps that bundle a 3rd party redistributable component.

Note

This element is currently intended to be used only by certain types of desktop PC games that are published by Microsoft and our partners. It requires the customInstallActions restricted capability.

Element hierarchy

<desktop6:Extension>

<desktop6:CustomInstall>

Syntax

<desktop6:CustomInstall
  Folder = 'A string with a value between 1 and 256 characters in length that cannot contain these characters: <, >, :, ", |, ?, or *.' 
  desktop8:RunAsUser = 'An optional boolean value.'>

  <!-- Child elements -->
  desktop6:InstallActions
  desktop6:RepairActions
  desktop6:UninstallActions?

</desktop6:CustomInstall>

Key

? optional (zero or one)

Attributes and elements

Attributes

Attribute	Description	Data type	Required	Default value
Folder	The name of the package folder that contains all the files requires for all custom actions. This folder may contain subfolders.	A string with a value between 1 and 256 characters in length that cannot contain these characters: `<`, `>`, `:`, `"`, `\|`, `?`, or `*`.	Yes

Child elements

Child element	Description
InstallActions	Specifies installer files that are run before the first launch of your desktop application.
RepairActions	Specifies installer files that are run when the user selects the repair or reset options in the Settings page for your desktop application.
UninstallActions	Specifies installer files that are run when the user uninstalls your desktop application.

Parent elements

Parent element	Description
desktop6:Extension	Declares an extensibility point for the desktop application.
desktop8:RunAsUser	Indicates whether the task should be run as the current user.

Remarks

This element requires the customInstallActions restricted capability.

The OS uses the Name attribute of the desktop6:InstallAction, desktop6:RepairAction, and desktop6:UninstallAction elements to identify a related set of install, repair, and uninstall actions. To specify a related set of actions that should be executed in conjunction with each other, make sure they have the same value for the Name attribute. The OS will run an uninstall action only if the corresponding install or repair action has been run.

Examples

<Package
  xmlns:desktop6="http://schemas.microsoft.com/appx/manifest/desktop/windows10/6"
  xmlns:rescap="http://schemas.microsoft.com/appx/manifest/foundation/windows10/restrictedcapabilities"
  IgnorableNamespaces="rescap desktop6">

  <!-- ... -->
  <!-- Other entries omitted for brevity. -->
  <!-- ... -->

  <Extensions>
    <desktop6:Extension Category="windows.customInstall">
      <desktop6:CustomInstall Folder="MyInstallers">
        <desktop6:InstallActions>
          <desktop6:InstallAction File="Setup_AntiCheat.exe" Name="AC_1" Arguments="/add /silent" />
        </desktop6:InstallActions>
        <desktop6:RepairActions>
          <desktop6:RepairAction File="Setup_AntiCheat.exe" Name="AC_1" Arguments="/add /silent /force" />
        </desktop6:RepairActions>
        <desktop6:UninstallActions>
          <desktop6:UninstallAction File="Setup_AntiCheat.exe" Name="AC_1" Arguments="/remove /silent" />
        </desktop6:UninstallActions>
      </desktop6:CustomInstall>
    </desktop6:Extension>
  </Extensions>

  <Capabilities>
    <rescap:Capability Name="customInstallActions"/>
  </Capabilities>
</Package>

Requirements

Item	Value
Namespace	`http://schemas.microsoft.com/appx/manifest/desktop/windows10/6`
Minimum OS Version	Windows 10 version 1903 (Build 18362)

Share via