WindowsInstaller Schema

Applies To: Windows Server Update Services

Types

The WindowsInstaller Schema defines the following types in the https://schemas.microsoft.com/msus/2002/12/UpdateHandlers/WindowsInstaller target namespace. It references types from the BaseTypes Schema , CSAPI Update Schema and the PatchApplicability Schema.

WindowsInstallerApp

Handler-specific data for updates that are Windows Installer Applications.

<complexType name="WindowsInstallerApp">  
    <complexContent>  
      <extension base="upd:HandlerSpecificData">  
        <sequence>  
          <element name="MsiData">  
            <annotation>  
              <documentation>Handler-specific data for Windows Installer application installs.</documentation>  
            </annotation>  
            <complexType>  
              <sequence>  
                <element name="RepairPath" type="msiar:WindowsInstallerRepairPath" minOccurs="0" maxOccurs="unbounded" />  
              </sequence>  
  
              <attribute name="CommandLine" type="msiar:WindowsInstallerCommandLine" use="optional">  
  
                <annotation>  
                  <documentation>  
                    Optional "command line" that is passed to the Windows Installer APIs when installing the product. This will typically contain extra properties as name-value pairs separated by spaces.  
                  </documentation>  
                </annotation>  
              </attribute>  
  
              <attribute name="UninstallCommandLine" type="msiar:WindowsInstallerCommandLine" use="optional">  
  
                <annotation>  
                  <documentation>  
                    Optional uninstall "command line" that is passed to the Windows Installer APIs when uninstalling the product.  This will typically contain extra properties as name-value pairs separated by spaces.  
                  </documentation>  
                </annotation>  
              </attribute>  
  
              <attribute name="MsiFile" type="bt:FilePath" use="required">  
                <annotation>  
                  <documentation>  
                    The file name of the Windows Installer file (contained in the CAB) to use when installing the application.  
                  </documentation>  
                </annotation>  
              </attribute>  
  
              <attribute name="ProductCode" type="mspblob:GUID" use="required">  
                <annotation>  
                  <documentation>  
                    ProductCode of the Windows Installer to be applied.  
                  </documentation>  
                </annotation>  
              </attribute>  
  
              <attribute name="MediaPackagePath" type="string" use="optional">  
                <annotation>  
                  <documentation>  
                    Relative path to the Windows Installer file on repair media.  
                  </documentation>  
                </annotation>  
              </attribute>  
            </complexType>  
          </element>  
        </sequence>  
      </extension>  
    </complexContent>  
  </complexType>  

WindowsInstaller

Handler-specific data for updates that are Windows Installer Patches.

<complexType name="WindowsInstaller">  
  <complexContent>  
    <extension base="upd:HandlerSpecificData">  
      <sequence>  
        <element name="MspData">  
          <annotation>  
            <documentation>Handler-specific data for MSP application patch installs.</documentation>  
          </annotation>  
          <complexType>  
            <sequence>  
              <element name="RepairPath" type="msiar:WindowsInstallerRepairPath" minOccurs="0" maxOccurs="unbounded" />  
            </sequence>  
            <attribute name="PatchCode" type="mspblob:GUID" use="optional">  
              <annotation>  
                <documentation>Patch code for the MSP to be applied.</documentation>  
              </annotation>  
            </attribute>  
            <attribute name="FullFilePatchCode" type="mspblob:GUID" use="optional">  
              <annotation>  
                <documentation>Patch code for the companion full-file MSP when the update contains both full-file and binary-delta payloads. To accomidate both payloads in the same update we assume that the binary delta-patch's applicability is more restrictive. In that case, the applicability meta-data element is that of the delta-patch and this attribute allows the full file patch GUID to also be specified.</documentation>  
              </annotation>  
            </attribute>  
            <attribute name="CommandLine" type="msiar:WindowsInstallerCommandLine" use="optional">  
              <annotation>  
                <documentation>Optional "command line" that is passed to the Windows Installer APIs when installing the product.  This will typically contain extra properties as name-value pairs separated by spaces.</documentation>  
              </annotation>  
            </attribute>  
            <attribute name="UninstallCommandLine" type="msiar:WindowsInstallerCommandLine" use="optional">  
              <annotation>  
                <documentation>Optional uninstall "command line" that is passed to the Windows Installer APIs when uninstalling the product.  This will typically contain extra properties as name-value pairs separated by spaces.</documentation>  
              </annotation>  
            </attribute>  
            <attribute name="TargetsSystemMsi" type="boolean" use="optional">  
              <annotation>  
                <documentation>Indicates whether the MSP targets a System Windows Installer product.</documentation>  
              </annotation>  
            </attribute>  
          </complexType>  
        </element>  
      </sequence>  
    </extension>  
  </complexContent>  
</complexType>  

ExplicitWindowsInstallerRepairPath

Representation of a Windows Installer repair path for an arbitrary GUID and type.

<complexType name="ExplicitWindowsInstallerRepairPath">  
  <complexContent>  
    <extension base="msiar:WindowsInstallerRepairPath">  
      <attribute  
        name="TargetId"  
        type="mspblob:GUID"  
        use="required">  
        <annotation>  
          <documentation>Indicates the target ProductCode or PatchCode of the repair path.</documentation>  
        </annotation>  
      </attribute>  
  
      <attribute   
        name="TargetType"  
        type="msiar:MsiType"  
        use="required">  
  
        <annotation>  
          <documentation>Indicates whether the GUID referenced by TargetID is for a Windows Installer Product or MSP Patch.</documentation>  
        </annotation>  
  
      </attribute>  
    </extension>  
  </complexContent>  
</complexType>  

WindowsInstallerRepairPath

Representation of a Windows Installer repair path.

<complexType name="WindowsInstallerRepairPath">  
  <attribute name="RelativeToServer" type="boolean" use="required">  
    <annotation>  
      <documentation>Indicates whether the path is relative to the server root or absolute.</documentation>  
    </annotation>  
  </attribute>  
  <attribute name="Path" type="bt:FilePath" use="required">  
    <annotation>  
      <documentation>Specifies the repair path.</documentation>  
    </annotation>  
  </attribute>  
</complexType>  

MsiType

An enumeration defining the target type of an Windows Installer operation.

<simpleType name="MsiType">  
  <annotation>  
    <documentation>An enumeration defining the target type of an Windows Installer operation.</documentation>  
  </annotation>  
  <restriction base="token">  
    <enumeration value="MsiProduct" />  
    <enumeration value="MsiPatch" />  
  </restriction>  
</simpleType>  

WindowsInstallerCommandLine

An optional command line to be passed to update.exe when installing or preparing to download the update.

<simpleType name="WindowsInstallerCommandLine">  
  <restriction base="string">  
    <maxLength value="32768" />  
    <minLength value="1" />  
  </restriction>  
</simpleType>