WiX Database XML Schema

Table of Contents

WiX Database XML Schema

Description

Namespace

http://schemas.microsoft.com/wix/2006/wi

Remarks

Copyright (c) Microsoft Corporation. All rights reserved.

The use and distribution terms for this software are covered by the Common Public License 1.0 (https://opensource.org/licenses/cpl1.0.php) which can be found in the file CPL.TXT at the root of this distribution. By using this software in any fashion, you are agreeing to be bound by the terms of this license.

Attributes

Set this value to 'yes' in order to create a normal AppId table row. Set this value to 'no' in order to generate Registry rows that perform similar registration (without the often problematic Windows Installer advertising behavior).

Set this value to the name of the remote server to configure the client to request the object be run at a particular machine whenever an activation function is called for which a COSERVERINFO structure is not specified.

Set this value to 'yes' to configure a class to run under the identity of the user currently logged on and connected to the interactive desktop when activated by a remote client without being written as a Win32 service.

Referenced By

Remarks

If this element is nested under a Fragment, Module, or Product element, it must be advertised.

Definition

<xs:element name="AppId"> <xs:annotation> <xs:documentation> Application ID containing DCOM information for the associated application GUID. If this element is nested under a Fragment, Module, or Product element, it must be advertised. </xs:documentation> <xs:appinfo> <xse:msiRef table="AppId" href="http://msdn.microsoft.com/library/aa367566.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="Registry" href="http://msdn.microsoft.com/library/aa371168.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:remarks xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"> When being used in unadvertised mode, the attributes in the AppId element correspond to registry keys as follows (values that can be specified in authoring are in bold): <html:dl xmlns:html="http://www.w3.org/1999/xhtml"><html:dt>Id</html:dt><html:dd><html:dl><html:dt>In General</html:dt><html:dd> [HKCR\AppID\{<html:b>Id</html:b>}]<html:br /></html:dd><html:dt>Specific Example</html:dt><html:dd> [HKCR\AppID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}]<html:br /></html:dd></html:dl></html:dd><html:dt>ActivateAtStorage</html:dt><html:dd><html:dl><html:dt>In General</html:dt><html:dd> [HKCR\AppID\{<html:b>Id</html:b>}]<html:br /> ActivateAtStorage="<html:b>ActivateAtStorage</html:b>" </html:dd><html:dt>Specific Example</html:dt><html:dd> [HKCR\AppID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}]<html:br /> ActivateAtStorage="<html:b>Y</html:b>" </html:dd></html:dl></html:dd><html:dt>Description</html:dt><html:dd><html:dl><html:dt>In General</html:dt><html:dd> [HKCR\AppID\{<html:b>Id</html:b>}]<html:br /> @="<html:b>Description</html:b>" </html:dd><html:dt>Specific Example</html:dt><html:dd> [HKCR\AppID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}]<html:br /> @="<html:b>My AppId Description</html:b>" </html:dd></html:dl></html:dd><html:dt>DllSurrogate</html:dt><html:dd><html:dl><html:dt>In General</html:dt><html:dd> [HKCR\AppID\{<html:b>Id</html:b>}]<html:br /> DllSurrogate="<html:b>DllSurrogate</html:b>" </html:dd><html:dt>Specific Example</html:dt><html:dd> [HKCR\AppID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}]<html:br /> DllSurrogate="<html:b>C:\surrogate.exe</html:b>" </html:dd></html:dl></html:dd><html:dt>LocalService</html:dt><html:dd><html:dl><html:dt>In General</html:dt><html:dd> [HKCR\AppID\{<html:b>Id</html:b>}]<html:br /> LocalService="<html:b>LocalService</html:b>" </html:dd><html:dt>Specific Example</html:dt><html:dd> [HKCR\AppID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}]<html:br /> LocalService="<html:b>MyServiceName</html:b>" </html:dd></html:dl></html:dd><html:dt>RemoteServerName</html:dt><html:dd><html:dl><html:dt>In General</html:dt><html:dd> [HKCR\AppID\{<html:b>Id</html:b>}]<html:br /> RemoteServerName="<html:b>RemoteServerName</html:b>" </html:dd><html:dt>Specific Example</html:dt><html:dd> [HKCR\AppID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}]<html:br /> RemoteServerName="<html:b>MyRemoteServer</html:b>" </html:dd></html:dl></html:dd><html:dt>RunAsInteractiveUser</html:dt><html:dd><html:dl><html:dt>In General</html:dt><html:dd> [HKCR\AppID\{<html:b>Id</html:b>}]<html:br /> RunAs="<html:b>RunAsInteractiveUser</html:b>" </html:dd><html:dt>Specific Example</html:dt><html:dd> [HKCR\AppID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}]<html:br /> RunAs="<html:b>Interactive User</html:b>" </html:dd></html:dl></html:dd><html:dt>ServiceParameters</html:dt><html:dd><html:dl><html:dt>In General</html:dt><html:dd> [HKCR\AppID\{<html:b>Id</html:b>}]<html:br /> ServiceParameters="<html:b>ServiceParameters</html:b>" </html:dd><html:dt>Specific Example</html:dt><html:dd> [HKCR\AppID\{<html:b>01234567-89AB-CDEF-0123-456789ABCDEF</html:b>}]<html:br /> ServiceParameters="<html:b>-param</html:b>" </html:dd></html:dl></html:dd></html:dl></xse:remarks> </xs:appinfo> </xs:annotation> <xs:complexType> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element ref="Class" /> </xs:choice> <xs:attribute name="ActivateAtStorage" type="YesNoType"> <xs:annotation> <xs:documentation> Set this value to 'yes' to configure the client to activate on the same system as persistent storage. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Advertise" type="YesNoType"> <xs:annotation> <xs:documentation> Set this value to 'yes' in order to create a normal AppId table row. Set this value to 'no' in order to generate Registry rows that perform similar registration (without the often problematic Windows Installer advertising behavior). </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Description" type="xs:string"> <xs:annotation> <xs:documentation> Set this value to the description of the AppId. It can only be specified when the AppId is not being advertised. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="DllSurrogate" type="xs:string"> <xs:annotation> <xs:documentation> Set this value to specify that the class is a DLL that is to be activated in a surrogate EXE process, and the surrogate process to be used is the path of a surrogate EXE file specified by the value. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Id" type="Guid" use="required"> <xs:annotation> <xs:documentation> Set this value to the AppID GUID that corresponds to the named executable. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="LocalService" type="xs:string"> <xs:annotation> <xs:documentation> Set this value to the name of a service to allow the object to be installed as a Win32 service. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="RemoteServerName" type="xs:string"> <xs:annotation> <xs:documentation> Set this value to the name of the remote server to configure the client to request the object be run at a particular machine whenever an activation function is called for which a COSERVERINFO structure is not specified. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="RunAsInteractiveUser" type="YesNoType"> <xs:annotation> <xs:documentation> Set this value to 'yes' to configure a class to run under the identity of the user currently logged on and connected to the interactive desktop when activated by a remote client without being written as a Win32 service. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ServiceParameters" type="xs:string"> <xs:annotation> <xs:documentation> Set this value to the parameters to be passed to a LocalService on invocation. </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType></xs:element>

Content Model

Referenced By

Remarks

The AppSearch action may use this information to determine where upgrades are to be installed. The AppSearch action can also be used to set a property to the existing value of an registry or .ini file entry. AppSearch should be authored into the InstallUISequence table and InstallExecuteSequence table. The installer prevents The AppSearch action from running in the InstallExecuteSequence sequence if the action has already run in InstallUISequence sequence. The AppSearch action searches for file signatures using the CompLocator table first, the RegLocator table next, then the IniLocator table, and finally the DrLocator table. The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="AppSearch" type="ActionModuleSequenceType"> <xs:annotation> <xs:appinfo> <xse:seeAlso ref="ComponentSearch" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:seeAlso ref="FileSearch" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:seeAlso ref="IniFileSearch" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:seeAlso ref="RegistrySearch" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="AppSearch" href="http://msdn.microsoft.com/library/aa367579.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef action="AppSearch" href="http://msdn.microsoft.com/library/aa367578.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Uses file signatures to search for existing versions of products. The AppSearch action may use this information to determine where upgrades are to be installed. The AppSearch action can also be used to set a property to the existing value of an registry or .ini file entry. AppSearch should be authored into the InstallUISequence table and InstallExecuteSequence table. The installer prevents The AppSearch action from running in the InstallExecuteSequence sequence if the action has already run in InstallUISequence sequence. The AppSearch action searches for file signatures using the CompLocator table first, the RegLocator table next, then the IniLocator table, and finally the DrLocator table. The condition for this action may be specified in the element's inner text.</xs:documentation> </xs:annotation></xs:element>

Element: AssemblyName

Description

The MsiAssemblyName table specifies the schema for the elements of a strong assembly cache name for a .NET Framework or Win32 assembly.

Content Model

Referenced By

Remarks

Consider using the Assembly attribute on File element to have the toolset populate these entries automatically.

Definition

<xs:element name="AssemblyName"> <xs:annotation> <xs:documentation> The MsiAssemblyName table specifies the schema for the elements of a strong assembly cache name for a .NET Framework or Win32 assembly. Consider using the Assembly attribute on File element to have the toolset populate these entries automatically. </xs:documentation> <xs:appinfo> <xse:msiRef table="MsiAssemblyName" href="http://msdn.microsoft.com/library/aa370062.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> </xs:annotation> <xs:complexType> <xs:attribute name="Id" use="required" type="xs:string"> <xs:annotation> <xs:documentation>Name of the attribute associated with the value specified in the Value column.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Value" type="xs:string"> <xs:annotation> <xs:documentation>Value associated with the name specified in the Name column.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType></xs:element>

Derived By

Attributes

Content Model

Always empty.

Definition

<xs:element name="BinaryRef"> <xs:annotation> <xs:documentation>Used only for PatchFamilies to include only a binary table entry in a patch.</xs:documentation> </xs:annotation> <xs:complexType> <xs:attribute name="Id" type="xs:string" use="required"> <xs:annotation> <xs:documentation>The identifier of the Binary element to reference.</xs:documentation> </xs:annotation> </xs:attribute> <xs:anyAttribute namespace="##other" processContents="lax"> <xs:annotation> <xs:documentation> Extensibility point in the WiX XML Schema. Schema extensions can register additional attributes at this point in the schema. </xs:documentation> </xs:annotation> </xs:anyAttribute> </xs:complexType></xs:element>

Element: BindImage

Description

Binds each executable or DLL that must be bound to the DLLs imported by it.

Content Model

Referenced By

Remarks

The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="BindImage" type="ActionSequenceType"> <xs:annotation> <xs:appinfo> <xse:msiRef table="BindImage" href="http://msdn.microsoft.com/library/aa367828.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef action="BindImage" href="http://msdn.microsoft.com/library/aa367827.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Binds each executable or DLL that must be bound to the DLLs imported by it. The condition for this action may be specified in the element's inner text.</xs:documentation> </xs:annotation></xs:element>

Content Model

Referenced By

Remarks

The CCPSearch action should be authored into the InstallUISequence table and InstallExecuteSequence table. The installer prevents the CCPSearch action from running in the InstallExecuteSequence sequence if the action has already run in InstallUISequence sequence. The CCPSearch action must come before the RMCCPSearch action. The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="CCPSearch" type="ActionModuleSequenceType"> <xs:annotation> <xs:appinfo> <xse:seeAlso ref="RMCCPSearch" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:seeAlso ref="ComplianceCheck" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef action="CCPSearch" href="http://msdn.microsoft.com/library/aa367845.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Uses file signatures to validate that qualifying products are installed on a system before an upgrade installation is performed. The CCPSearch action should be authored into the InstallUISequence table and InstallExecuteSequence table. The installer prevents the CCPSearch action from running in the InstallExecuteSequence sequence if the action has already run in InstallUISequence sequence. The CCPSearch action must come before the RMCCPSearch action. The condition for this action may be specified in the element's inner text.</xs:documentation> </xs:annotation></xs:element>

Set this value to "yes" in order to create a normal Class table row. Set this value to "no" in order to generate Registry rows that perform similar registration (without the often problematic Windows Installer advertising behavior).

Referenced By

Definition

<xs:element name="Component"> <xs:annotation> <xs:documentation>Component for parent Directory</xs:documentation> <xs:appinfo> <xse:seeAlso ref="ComponentRef" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:seeAlso ref="Media" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="Component" href="http://msdn.microsoft.com/library/aa368007.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="Condition" href="http://msdn.microsoft.com/library/aa368014.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="Directory" href="http://msdn.microsoft.com/library/aa368295.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:howtoRef href="add_a_file.htm" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Add a file to your installer</xse:howtoRef> </xs:appinfo> </xs:annotation> <xs:complexType> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element ref="AppId" /> <xs:element ref="Category" /> <xs:element ref="Class" /> <xs:element ref="Condition" /> <xs:element ref="CopyFile" /> <xs:element ref="CreateFolder" /> <xs:element ref="Environment" /> <xs:element ref="Extension" /> <xs:element ref="File" /> <xs:element ref="IniFile" /> <xs:element ref="Interface" /> <xs:element ref="IsolateComponent" /> <xs:element ref="ODBCDataSource" /> <xs:element ref="ODBCDriver" /> <xs:element ref="ODBCTranslator" /> <xs:element ref="ProgId" /> <xs:element ref="Registry" /> <xs:element ref="RegistryKey" /> <xs:element ref="RegistryValue" /> <xs:element ref="RemoveFile" /> <xs:element ref="RemoveFolder" /> <xs:element ref="RemoveRegistryKey" /> <xs:element ref="RemoveRegistryValue" /> <xs:element ref="ReserveCost" /> <xs:element ref="ServiceControl" /> <xs:element ref="ServiceInstall" /> <xs:element ref="Shortcut" /> <xs:element ref="SymbolPath" /> <xs:element ref="TypeLib" /> <xs:any namespace="##other" processContents="lax"> <xs:annotation> <xs:documentation> Extensibility point in the WiX XML Schema. Schema extensions can register additional elements at this point in the schema. </xs:documentation> </xs:annotation> </xs:any> </xs:choice> <xs:attribute name="Id" type="xs:string" use="required"> <xs:annotation> <xs:documentation>Component identifier; this is the primary key for identifying components.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ComPlusFlags" type="xs:integer"> <xs:annotation> <xs:documentation> Set this attribute to create a ComPlus entry. The value should be the export flags used during the generation of the .msi file. For more information see the COM+ documentation in the Platform SDK. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="DisableRegistryReflection" type="YesNoType"> <xs:annotation> <xs:documentation> Set this attribute to 'yes' in order to disable registry reflection on all existing and new registry keys affected by this component. When set to 'yes', the Windows Installer calls the RegDisableReflectionKey on each key being accessed by the component. This bit is available with Windows Installer version 4.0 and is ignored on 32-bit systems. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Directory" type="xs:string"> <xs:annotation> <xs:documentation> Sets the Directory of the Component. If this element is nested under a Directory element, this value defaults to the value of the parent Directory/@Id. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="DiskId" type="xs:integer"> <xs:annotation> <xs:documentation> This attribute must be set either on a Component element or all of its children File elements. The value of this attribute should correspond to the Id attribute of a Media element authored elsewhere. By creating this connection between a component (or particular files), you set the packaging options to the values specified in the Media element (values such as compression level, cab embedding, etc...). </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Feature" type="xs:string"> <xs:annotation> <xs:documentation> Identifies a feature to which this component belongs, as a shorthand for a child ComponentRef element of the Feature element. The value of this attribute should correspond to the Id attribute of a Feature element authored elsewhere. Note that a single component can belong to multiple features but this attribute allows you to specify only a single feature. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Guid" type="ComponentGuid" use="required"> <xs:annotation> <xs:documentation> This value should be a guid that uniquely identifies this component's contents, language, platform, and version. It's also possible to set the value to an empty string to specify an unmanaged component. Unmanaged components are a security vulnerability because the component cannot be removed or repaired by Windows Installer (it is essentially an unpatchable, permanent component). Therefore, a guid should always be specified for any component which contains resources that may need to be patched in the future. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="KeyPath" type="YesNoType"> <xs:annotation> <xs:documentation> If this attribute's value is set to 'yes', then the Directory of this Component is used as the KeyPath. To set a Registry key or File as the KeyPath of a component, set the KeyPath attribute to 'yes' on one of those child elements. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Location"> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="local"> <xs:annotation> <xs:documentation> Prevents the component from running from the source or the network (this is the default behavior if this attribute is not set). </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="source"> <xs:annotation> <xs:documentation> Enforces that the component can only be run from the source (it cannot be run from the user's computer). </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="either"> <xs:annotation> <xs:documentation> Allows the component to run from source or locally. </xs:documentation> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute name="NeverOverwrite" type="YesNoType"> <xs:annotation> <xs:documentation> If this attribute is set to 'yes', the installer does not install or reinstall the component if a key path file or a key path registry entry for the component already exists. The application does register itself as a client of the component. Use this flag only for components that are being registered by the Registry table. Do not use this flag for components registered by the AppId, Class, Extension, ProgId, MIME, and Verb tables. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Permanent" type="YesNoType"> <xs:annotation> <xs:documentation> If this attribute is set to 'yes', the installer does not remove the component during an uninstall. The installer registers an extra system client for the component in the Windows Installer registry settings (which basically just means that at least one product is always referencing this component). Note that this option differs from the behavior of not setting a guid because although the component is permanent, it is still patchable (because Windows Installer still tracks it), it's just not uninstallable. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Shared" type="YesNoType"> <xs:annotation> <xs:documentation> If this attribute's value is set to 'yes', enables advanced patching semantics for Components that are shared across multiple Products. Specifically, the Windows Installer will cache the shared files to improve patch uninstall. This functionality is available in Windows Installer 4.5 and later. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="SharedDllRefCount" type="YesNoType"> <xs:annotation> <xs:documentation> If this attribute's value is set to 'yes', the installer increments the reference count in the shared DLL registry of the component's key file. If this bit is not set, the installer increments the reference count only if the reference count already exists. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Transitive" type="YesNoType"> <xs:annotation> <xs:documentation> If this attribute is set to 'yes', the installer reevaluates the value of the statement in the Condition upon a reinstall. If the value was previously False and has changed to True, the installer installs the component. If the value was previously True and has changed to False, the installer removes the component even if the component has other products as clients. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="UninstallWhenSuperseded" type="YesNoType"> <xs:annotation> <xs:documentation> If this attribute is set to 'yes', the installer will uninstall the Component's files and registry keys when it is superseded by a patch. This functionality is available in Windows Installer 4.5 and later. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Win64" type="YesNoType"> <xs:annotation> <xs:documentation> Set this attribute to 'yes' to mark this as a 64-bit component. This attribute facilitates the installation of packages that include both 32-bit and 64-bit components. If this bit is not set, the component is registered as a 32-bit component. If this is a 64-bit component replacing a 32-bit component, set this bit and assign a new GUID in the Guid attribute. </xs:documentation> </xs:annotation> </xs:attribute> <xs:anyAttribute namespace="##other" processContents="lax"> <xs:annotation> <xs:documentation> Extensibility point in the WiX XML Schema. Schema extensions can register additional attributes at this point in the schema. </xs:documentation> </xs:annotation> </xs:anyAttribute> </xs:complexType></xs:element>

Content Model

Referenced By

Definition

<xs:element name="ComponentGroupRef"> <xs:annotation> <xs:documentation>Create a reference to a ComponentGroup in another Fragment.</xs:documentation> <xs:appinfo> <xse:seeAlso ref="ComponentGroup" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> </xs:annotation> <xs:complexType> <xs:attribute name="Id" type="xs:string" use="required"> <xs:annotation> <xs:documentation>The identifier of the ComponentGroup to reference.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Primary" type="YesNoType"> <xs:annotation> <xs:documentation> Set this attribute to 'yes' in order to make the parent feature of this component the primary feature for this component. Components may belong to multiple features. By designating a feature as the primary feature of a component, you ensure that whenever a component is selected for install-on-demand (IOD), the primary feature will be the one to install it. This attribute should only be set if a component actually nests under multiple features. If a component nests under only one feature, that feature is the primary feature for the component. You cannot set more than one feature as the primary feature of a given component. </xs:documentation> </xs:annotation> </xs:attribute> <xs:anyAttribute namespace="##other" processContents="lax"> <xs:annotation> <xs:documentation> Extensibility point in the WiX XML Schema. Schema extensions can register additional attributes at this point in the schema. </xs:documentation> </xs:annotation> </xs:anyAttribute> </xs:complexType></xs:element>

Content Model

Referenced By

Definition

<xs:element name="ComponentRef"> <xs:annotation> <xs:documentation>Create a reference to a Feature element in another Fragment.</xs:documentation> <xs:appinfo> <xse:seeAlso ref="Component" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:howtoRef href="add_a_file.htm" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Add a file to your installer</xse:howtoRef> </xs:appinfo> </xs:annotation> <xs:complexType> <xs:attribute name="Id" type="xs:string" use="required"> <xs:annotation> <xs:documentation>The identifier of the Component element to reference.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Primary" type="YesNoType"> <xs:annotation> <xs:documentation> Set this attribute to 'yes' in order to make the parent feature of this component the primary feature for this component. Components may belong to multiple features. By designating a feature as the primary feature of a component, you ensure that whenever a component is selected for install-on-demand (IOD), the primary feature will be the one to install it. This attribute should only be set if a component actually nests under multiple features. If a component nests under only one feature, that feature is the primary feature for the component. You cannot set more than one feature as the primary feature of a given component. </xs:documentation> </xs:annotation> </xs:attribute> <xs:anyAttribute namespace="##other" processContents="lax"> <xs:annotation> <xs:documentation> Extensibility point in the WiX XML Schema. Schema extensions can register additional attributes at this point in the schema. </xs:documentation> </xs:annotation> </xs:anyAttribute> </xs:complexType></xs:element>

Element: ComponentSearch

Description

Searches for file or directory and assigns to value of parent Property.

Content Model

Referenced By

Remarks

The condition is specified in the inner text of the element.

Definition

<xs:element name="Condition"> <xs:annotation> <xs:documentation> Conditions for components, controls, features, and products. The condition is specified in the inner text of the element. </xs:documentation> <xs:appinfo> <xse:msiRef table="Component" href="http://msdn.microsoft.com/library/aa368007.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="ControlCondition" href="http://msdn.microsoft.com/library/aa368035.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="Condition" href="http://msdn.microsoft.com/library/aa368014.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="LaunchCondition" href="http://msdn.microsoft.com/library/aa369752.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:howtoRef href="block_install_on_os.htm" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Block installation based on OS version</xse:howtoRef> <xse:howtoRef href="check_the_version_number.htm" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Check the version number of a file during installation</xse:howtoRef> </xs:appinfo> </xs:annotation> <xs:complexType> <xs:simpleContent> <xs:extension base="xs:string"> <xs:annotation> <xs:documentation> Under a Component element, the condition becomes the condition of the component. Under a Control element, the condition becomes a ControlCondition entry. Under a Feature element, the condition becomes a Condition entry. Under a Fragment or Product element, the condition becomes a LaunchCondition entry. </xs:documentation> </xs:annotation> <xs:attribute name="Action"> <xs:annotation> <xs:documentation> Used only under Control elements and is required. Allows specific actions to be applied to a control based on the result of this condition. </xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="default"> <xs:annotation> <xs:documentation> Set the Control as the default. Only used under Control elements. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="enable"> <xs:annotation> <xs:documentation> Enable the Control. Only used under Control elements. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="disable"> <xs:annotation> <xs:documentation> Disable the Control. Only used under Control elements. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="hide"> <xs:annotation> <xs:documentation> Hide the Control. Only used under Control elements. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="show"> <xs:annotation> <xs:documentation> Display the Control. Only used under Control elements. </xs:documentation> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute name="Level" type="xs:integer"> <xs:annotation> <xs:documentation> Used only under Feature elements and is required. Allows modifying the level of a Feature based on the result of this condition. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Message" type="xs:string"> <xs:annotation> <xs:documentation> Used only under Fragment or Product elements and is required. Set the value to the text to display when the condition fails and the installation must be terminated. </xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:simpleContent> </xs:complexType></xs:element>

Referenced By

Definition

<xs:element name="Control"> <xs:annotation> <xs:appinfo> <xse:msiRef table="Control" href="http://msdn.microsoft.com/library/aa368044.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="ComboBox" href="http://msdn.microsoft.com/library/aa367872.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="Dialog" href="http://msdn.microsoft.com/library/aa368286.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="ListBox" href="http://msdn.microsoft.com/library/aa369762.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="ListView" href="http://msdn.microsoft.com/library/aa369764.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="RadioButton" href="http://msdn.microsoft.com/library/aa370962.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Contains the controls that appear on each dialog.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element ref="Text" minOccurs="0"> <xs:annotation> <xs:documentation>alternative to Text attribute when CDATA is needed to escape XML delimiters</xs:documentation> </xs:annotation> </xs:element> <xs:element ref="ComboBox" minOccurs="0"> <xs:annotation> <xs:documentation>ComboBox table with ListItem children</xs:documentation> </xs:annotation> </xs:element> <xs:element ref="ListBox" minOccurs="0"> <xs:annotation> <xs:documentation>ListBox table with ListItem children</xs:documentation> </xs:annotation> </xs:element> <xs:element ref="ListView" minOccurs="0"> <xs:annotation> <xs:documentation>ListView table with ListItem children</xs:documentation> </xs:annotation> </xs:element> <xs:element ref="RadioButtonGroup" minOccurs="0"> <xs:annotation> <xs:documentation>RadioButton table with RadioButton children</xs:documentation> </xs:annotation> </xs:element> <xs:element ref="Property" minOccurs="0"> <xs:annotation> <xs:documentation>Property table entry for the Property table column associated with this control</xs:documentation> </xs:annotation> </xs:element> <xs:element ref="Binary" minOccurs="0"> <xs:annotation> <xs:documentation>Icon referenced in icon column of row</xs:documentation> </xs:annotation> </xs:element> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>child elements affecting operation of this control</xs:documentation> </xs:annotation> <xs:element ref="Condition"> <xs:annotation> <xs:documentation>Condition to specify actions for this control based on the outcome of the condition.</xs:documentation> </xs:annotation> </xs:element> <xs:element ref="Publish" /> <xs:element ref="Subscribe" /> </xs:choice> </xs:sequence> <xs:attribute name="Id" use="required" type="xs:string"> <xs:annotation> <xs:documentation>Combined with the Dialog Id to make up the primary key of the Control table.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Type" use="required" type="xs:string"> <xs:annotation> <xs:documentation>The type of the control. Could be one of the following: Billboard, Bitmap, CheckBox, ComboBox, DirectoryCombo, DirectoryList, Edit, GroupBox, Icon, Line, ListBox, ListView, MaskedEdit, PathEdit, ProgressBar, PushButton, RadioButtonGroup, ScrollableText, SelectionTree, Text, VolumeCostList, VolumeSelectCombo</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="X" use="required" type="LocalizableInteger"> <xs:annotation> <xs:documentation>Horizontal coordinate of the upper-left corner of the rectangular boundary of the control. This must be a non-negative number.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Y" use="required" type="LocalizableInteger"> <xs:annotation> <xs:documentation>Vertical coordinate of the upper-left corner of the rectangular boundary of the control. This must be a non-negative number.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Width" use="required" type="LocalizableInteger"> <xs:annotation> <xs:documentation>Width of the rectangular boundary of the control. This must be a non-negative number.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Height" use="required" type="LocalizableInteger"> <xs:annotation> <xs:documentation>Height of the rectangular boundary of the control. This must be a non-negative number.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Property" type="xs:string"> <xs:annotation> <xs:documentation>The name of a defined property to be linked to this control. This column is required for active controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Text" type="xs:string"> <xs:annotation> <xs:documentation>A localizable string used to set the initial text contained in a control. This attribute can contain a formatted string that is processed at install time to insert the values of properties using [PropertyName] syntax. Also supported are environment variables, file installation paths, and component installation directories; see <a href="http://msdn2.microsoft.com/library/aa368609.aspx" target="_blank" xmlns="http://schemas.microsoft.com/wix/2006/wi">Formatted</a> for details.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Help" type="xs:string"> <xs:annotation> <xs:documentation>This attribute is reserved for future use. There is no need to use this until Windows Installer uses it for something.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ToolTip" type="xs:string"> <xs:annotation> <xs:documentation>The string used for the Tooltip.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="CheckBoxValue" type="xs:string"> <xs:annotation> <xs:documentation>This attribute is only valid for CheckBox Controls. When set, the linked Property will be set to this value when the check box is checked.</xs:documentation> </xs:annotation> </xs:attribute> <!-- Control ordering - order of declaration in Dialog determines tab ordering --> <xs:attribute name="TabSkip" type="YesNoType"> <xs:annotation> <xs:documentation>Set this attribute to "yes" to cause this Control to be skipped in the tab sequence.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Default" type="YesNoType"> <xs:annotation> <xs:documentation>Set this attribute to "yes" to cause this Control to be invoked by the return key.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Cancel" type="YesNoType"> <xs:annotation> <xs:documentation>Set this attribute to "yes" to cause this Control to be invoked by the escape key.</xs:documentation> </xs:annotation> </xs:attribute> <!-- common Control attributes --> <xs:attribute name="Hidden" type="YesNoType"> <xs:annotation> <xs:documentation>Set this attribute to "yes" to cause the Control to be hidden.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Disabled" type="YesNoType"> <xs:annotation> <xs:documentation>Set this attribute to "yes" to cause the Control to be disabled.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Sunken" type="YesNoType"> <xs:annotation> <xs:documentation>Set this attribute to "yes" to cause the Control to be sunken.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Indirect" type="YesNoType"> <xs:annotation> <xs:documentation>Specifies whether the value displayed or changed by this control is referenced indirectly. If this bit is set, the control displays or changes the value of the property that has the identifier listed in the Property column of the Control table.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Integer" type="YesNoType"> <xs:annotation> <xs:documentation>Set this attribute to "yes" to cause the linked Property value for the Control to be treated as an integer. Otherwise, the Property will be treated as a string.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="RightToLeft" type="YesNoType"> <xs:annotation> <xs:documentation>Set this attribute to "yes" to cause the Control to display from right to left.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="RightAligned" type="YesNoType"> <xs:annotation> <xs:documentation>Set this attribute to "yes" to cause the Control to be right aligned.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="LeftScroll" type="YesNoType"> <xs:annotation> <xs:documentation>Set this attribute to "yes" to cause the scroll bar to display on the left side of the Control.</xs:documentation> </xs:annotation> </xs:attribute> <!-- attributes applied to specific Controls --> <xs:attribute name="Transparent" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for Text Controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="NoPrefix" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for Text Controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="NoWrap" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for Text Controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="FormatSize" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for Text Controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="UserLanguage" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for Text Controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Multiline" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for Edit Controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Password" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for Edit Controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ProgressBlocks" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for ProgressBar Controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Removable" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for Volume and Directory Controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Fixed" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for Volume and Directory Controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Remote" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for Volume and Directory Controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="CDROM" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for Volume and Directory Controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="RAMDisk" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for Volume and Directory Controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Floppy" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for Volume and Directory Controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ShowRollbackCost" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for VolumeCostList Controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Sorted" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for Listbox, ListView, and ComboBox Controls. Set the value of this attribute to "yes" to have entries appear in the order specified under the Control. If the attribute value is "no" or absent the entries in the control will appear in alphabetical order. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ComboList" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for ComboBox Controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Image" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for RadioButton, PushButton, and Icon Controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="IconSize"> <xs:annotation> <xs:documentation>This attribute is only valid for RadioButton, PushButton, and Icon Controls.</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="16" /> <xs:enumeration value="32" /> <xs:enumeration value="48" /> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute name="FixedSize" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for RadioButton, PushButton, and Icon Controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Icon" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for RadioButton and PushButton Controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Bitmap" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for RadioButton and PushButton Controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="PushLike" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for RadioButton and Checkbox Controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="HasBorder" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute is only valid for RadioButton Controls.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ElevationShield" type="YesNoType"> <xs:annotation> <xs:documentation> This attribute is only valid for PushButton controls. Set this attribute to "yes" to add the User Account Control (UAC) elevation icon (shield icon) to the PushButton control. If this attribute's value is "yes" and the installation is not yet running with elevated privileges, the pushbutton control is created using the User Account Control (UAC) elevation icon (shield icon). If this attribute's value is "yes" and the installation is already running with elevated privileges, the pushbutton control is created using the other icon attributes. Otherwise, the pushbutton control is created using the other icon attributes. </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType></xs:element>

Element: CopyFile

Description

Copy or move an existing file on the target machine, or copy a file that is being installed, to another destination.

Content Model

Referenced By

Remarks

When this element is nested under a File element, the parent file will be installed, then copied to the specified destination if the parent component of the file is selected for installation or removal. When this element is nested under a Component element and no FileId attribute is specified, the file to copy or move must already be on the target machine.

When this element is nested under a Component element and the FileId attribute is specified, the specified file is installed, then copied to the specified destination if the parent component is selected for installation or removal (use this option to control the copy of a file in a different component by the parent component's installation state). If the specified destination directory is the same as the directory containing the original file and the name for the proposed source file is the same as the original, then no action takes place.

Definition

<xs:element name="CopyFile"> <xs:annotation> <xs:appinfo> <xse:seeAlso ref="RemoveFile" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="DuplicateFile" href="http://msdn.microsoft.com/library/aa368335.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="MoveFile" href="http://msdn.microsoft.com/library/aa370055.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation> Copy or move an existing file on the target machine, or copy a file that is being installed, to another destination. When this element is nested under a File element, the parent file will be installed, then copied to the specified destination if the parent component of the file is selected for installation or removal. When this element is nested under a Component element and no FileId attribute is specified, the file to copy or move must already be on the target machine. When this element is nested under a Component element and the FileId attribute is specified, the specified file is installed, then copied to the specified destination if the parent component is selected for installation or removal (use this option to control the copy of a file in a different component by the parent component's installation state). If the specified destination directory is the same as the directory containing the original file and the name for the proposed source file is the same as the original, then no action takes place. </xs:documentation> </xs:annotation> <xs:complexType> <xs:attribute name="Id" type="xs:string" use="required"> <xs:annotation> <xs:documentation>Primary key used to identify this particular entry.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="FileId" type="xs:string"> <xs:annotation> <xs:documentation> This attribute cannot be specified if the element is nested under a File element. Set this attribute's value to the identifier of a file from a different component to copy it based on the install state of the parent component. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="SourceDirectory" type="xs:string"> <xs:annotation> <xs:documentation> This attribute cannot be specified if the element is nested under a File element or the FileId attribute is specified. Set this value to the source directory from which to copy or move an existing file on the target machine. This Directory must exist in the installer database at creation time. This attribute cannot be specified in conjunction with SourceProperty. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="SourceProperty" type="xs:string"> <xs:annotation> <xs:documentation> This attribute cannot be specified if the element is nested under a File element or the FileId attribute is specified. Set this value to a property that will have a value that resolves to the full path of the source directory (or full path including file name if SourceName is not specified). The property does not have to exist in the installer database at creation time; it could be created at installation time by a custom action, on the command line, etc. This attribute cannot be specified in conjunction with SourceDirectory. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="SourceName" type="WildCardLongFileNameType"> <xs:annotation> <xs:documentation> This attribute cannot be specified if the element is nested under a File element or the FileId attribute is specified. Set this value to the localizable name of the file(s) to be copied or moved. All of the files that match the wild card will be removed from the specified directory. The value is a filename that may also contain the wild card characters "?" for any single character or "*" for zero or more occurrences of any character. If this attribute is not specified (and this element is not nested under a File element or specify a FileId attribute) then the SourceProperty attribute should be set to the name of a property that will resolve to the full path of the source filename. If the value of this attribute contains a "*" wildcard and the DestinationName attribute is specified, all moved or copied files retain the file names from their sources. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="DestinationDirectory" type="xs:string"> <xs:annotation> <xs:documentation> Set this value to the destination directory where an existing file on the target machine should be moved or copied to. This Directory must exist in the installer database at creation time. This attribute cannot be specified in conjunction with DestinationProperty. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="DestinationProperty" type="xs:string"> <xs:annotation> <xs:documentation> Set this value to a property that will have a value that resolves to the full path of the destination directory. The property does not have to exist in the installer database at creation time; it could be created at installation time by a custom action, on the command line, etc. This attribute cannot be specified in conjunction with DestinationDirectory. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="DestinationName" type="LongFileNameType"> <xs:annotation> <xs:documentation> In prior versions of the WiX toolset, this attribute specified the short file name. Now set this value to the localizable name to be given to the original file after it is moved or copied. If this attribute is not specified, then the destination file is given the same name as the source file. If a short file name is specified, the DestinationShortName attribute may not be specified. If a long file name is specified, the DestinationLongName attribute may not be specified. Also, if this value is a long file name, the DestinationShortName attribute may be omitted to allow WiX to attempt to generate a unique short file name. However, if this name collides with another file or you wish to manually specify the short file name, then the DestinationShortName attribute may be specified. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="DestinationLongName" type="LongFileNameType"> <xs:annotation> <xs:appinfo> <xse:deprecated ref="DestinationName" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> </xs:annotation> </xs:attribute> <xs:attribute name="DestinationShortName" type="ShortFileNameType"> <xs:annotation> <xs:documentation> The short file name of the file in 8.3 format. This attribute should only be set if there is a conflict between generated short file names or you wish to manually specify the short file name. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Delete" type="YesNoType"> <xs:annotation> <xs:documentation> This attribute cannot be specified if the element is nested under a File element or the FileId attribute is specified. In other cases, if the attribute is not specified, the default value is "no" and the file is copied, not moved. Set the value to "yes" in order to move the file (thus deleting the source file) instead of copying it. </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType></xs:element>

Content Model

Referenced By

Remarks

Any standard or custom actions that affect costing should be sequenced before the CostInitialize action. Call the FileCost action immediately following the CostInitialize action and then call the CostFinalize action to make all final cost calculations available to the installer through the Component table. The CostFinalize action must be executed before starting any user interface sequence which allows the user to view or modify Feature table selections or directories. The CostFinalize action queries the Condition table to determine which features are scheduled to be installed. Costing is done for each component in the Component table. The CostFinalize action also verifies that all the target directories are writable before allowing the installation to continue. The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="CostFinalize" type="ActionSequenceType"> <xs:annotation> <xs:appinfo> <xse:seeAlso ref="CostInitialize" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:seeAlso ref="FileCost" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef action="CostFinalize" href="http://msdn.microsoft.com/library/aa368048.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Ends the internal installation costing process begun by the CostInitialize action. Any standard or custom actions that affect costing should be sequenced before the CostInitialize action. Call the FileCost action immediately following the CostInitialize action and then call the CostFinalize action to make all final cost calculations available to the installer through the Component table. The CostFinalize action must be executed before starting any user interface sequence which allows the user to view or modify Feature table selections or directories. The CostFinalize action queries the Condition table to determine which features are scheduled to be installed. Costing is done for each component in the Component table. The CostFinalize action also verifies that all the target directories are writable before allowing the installation to continue. The condition for this action may be specified in the element's inner text.</xs:documentation> </xs:annotation></xs:element>

Content Model

Referenced By

Remarks

Any standard or custom actions that affect costing should be sequenced before the CostInitialize action. Call the FileCost action immediately following the CostInitialize action. Then call the CostFinalize action following the CostInitialize action to make all final cost calculations available to the installer through the Component table. The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="CostInitialize" type="ActionSequenceType"> <xs:annotation> <xs:appinfo> <xse:seeAlso ref="FileCost" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:seeAlso ref="CostFinalize" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef action="CostInitialize" href="http://msdn.microsoft.com/library/aa368048.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Initiates the internal installation costing process. Any standard or custom actions that affect costing should be sequenced before the CostInitialize action. Call the FileCost action immediately following the CostInitialize action. Then call the CostFinalize action following the CostInitialize action to make all final cost calculations available to the installer through the Component table. The condition for this action may be specified in the element's inner text.</xs:documentation> </xs:annotation></xs:element>

Content Model

Referenced By

Remarks

The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="CreateFolders" type="ActionSequenceType"> <xs:annotation> <xs:appinfo> <xse:msiRef action="CreateFolders" href="http://msdn.microsoft.com/library/aa368052.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Creates empty folders for components that are set to be installed. The condition for this action may be specified in the element's inner text.</xs:documentation> </xs:annotation></xs:element>

Content Model

Referenced By

Remarks

Various combinations of the attributes for this element correspond to different custom action types. For more information about custom actions see the Custom Action Types topic on MSDN.

Definition

<xs:element name="CustomAction"> <xs:annotation> <xs:appinfo> <xse:seeAlso ref="Custom" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:seeAlso ref="CustomActionRef" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="CustomAction" href="http://msdn.microsoft.com/library/aa368062.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation> Specifies a custom action to be added to the MSI CustomAction table. Various combinations of the attributes for this element correspond to different custom action types. For more information about custom actions see the <html:a href="http://msdn.microsoft.com/library/aa372048.aspx" target="_blank" xmlns:html="http://www.w3.org/1999/xhtml"> Custom Action Types</html:a> topic on MSDN. </xs:documentation> </xs:annotation> <xs:complexType> <xs:simpleContent> <xs:extension base="xs:string"> <xs:annotation> <xs:documentation> The text node is only valid if the Script attribute is specified. In that case, the text node contains the script to embed. </xs:documentation> </xs:annotation> <xs:attribute name="Id" type="xs:string"> <xs:annotation> <xs:documentation> The identifier of the custom action. </xs:documentation> </xs:annotation> </xs:attribute> <!-- CustomAction Source specification, sets source Attribute bits --> <xs:attribute name="BinaryKey" type="xs:string"> <xs:annotation> <xs:documentation> This attribute is a reference to a Binary element with matching Id attribute. That binary stream contains the custom action for use during install. The custom action will not be installed into a target directory. This attribute is typically used with the DllEntry attribute to specify the custom action DLL to use for a type 1 custom action, with the ExeCommand attribute to specify a type 17 custom action that runs an embedded executable, or with the VBScriptCall or JScriptCall attributes to specify a type 5 or 6 custom action. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="FileKey" type="xs:string"> <xs:annotation> <xs:documentation> This attribute specifies a reference to a File element with matching Id attribute that will execute the custom action code in the file after the file is installed. This attribute is typically used with the ExeCommand attribute to specify a type 18 custom action that runs an installed executable, with the DllEntry attribute to specify an installed custom action DLL to use for a type 17 custom action, or with the VBScriptCall or JScriptCall attributes to specify a type 21 or 22 custom action. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Property" type="xs:string"> <xs:annotation> <xs:documentation> This attribute specifies a reference to a Property element with matching Id attribute that specifies the Property to be used or updated on execution of this custom action. This attribute is typically used with the Value attribute to create a type 51 custom action that parses the text in Value and places it into the specified Property. This attribute is also used with the ExeCommand attribute to create a type 50 custom action that uses the value of the given property to specify the path to the executable. Type 51 custom actions are often useful to pass values to a deferred custom action. See <html:a href="http://msdn.microsoft.com/library/aa370543.aspx" target="_blank" xmlns:html="http://www.w3.org/1999/xhtml"> http://msdn.microsoft.com/library/aa370543.aspx</html:a> for more information. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Directory" type="xs:string"> <xs:annotation> <xs:documentation> This attribute specifies a reference to a Directory element with matching Id attribute containing a directory path. This attribute is typically used with the ExeCommand attribute to specify the source executable for a type 34 custom action, or with the Value attribute to specify a formatted string to place in the specified Directory table entry in a type 35 custom action. </xs:documentation> </xs:annotation> </xs:attribute> <!-- CustomAction Target specification, sets target Attribute bits --> <xs:attribute name="DllEntry" type="xs:string"> <xs:annotation> <xs:documentation> This attribute specifies the name of a function in a custom action to execute. This attribute is used with the BinaryKey attribute to create a type 1 custom action, or with the FileKey attribute to create a type 17 custom action. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ExeCommand" type="xs:string"> <xs:annotation> <xs:documentation> This attribute specifies the command line parameters to supply to an externally run executable. This attribute is typically used with the BinaryKey attribute for a type 2 custom action, the FileKey attribute for a type 18 custom action, the Property attribute for a type 50 custom action, or the Directory attribute for a type 34 custom action that specify the executable to run. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="JScriptCall" type="xs:string"> <xs:annotation> <xs:documentation> This attribute specifies the name of the JScript function to execute in a script. The script must be provided in a Binary element identified by the BinaryKey attribute described above. In other words, this attribute must be specified in conjunction with the BinaryKey attribute. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="VBScriptCall" type="xs:string"> <xs:annotation> <xs:documentation> This attribute specifies the name of the VBScript Subroutine to execute in a script. The script must be provided in a Binary element identified by the BinaryKey attribute described above. In other words, this attribute must be specified in conjunction with the BinaryKey attribute. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Script"> <xs:annotation> <xs:documentation> Creates a type 37 or 38 custom action. The text of the element should contain the script to be embedded in the package. </xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="jscript" /> <xs:enumeration value="vbscript" /> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute name="SuppressModularization" type="YesNoType"> <xs:annotation> <xs:documentation> Use to suppress modularization of this custom action name in merge modules. This should only be necessary for table-driven custom actions because the table name which they interact with cannot be modularized, so there can only be one instance of the table. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Value" type="xs:string"> <xs:annotation> <xs:documentation> This attribute specifies a string value to use in the custom action. This attribute must be used with the Property attribute to set the property as part of a type 51 custom action or with the Directory attribute to set a directory path in that table in a type 35 custom action. The value can be a literal value or derived from a Property element using the <html:a href="http://msdn.microsoft.com/library/aa368609.aspx" target="_blank" xmlns:html="http://www.w3.org/1999/xhtml">Formatted</html:a> syntax. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Error" type="xs:string"> <xs:annotation> <xs:documentation> This attribute specifies an index in the MSI Error table to use as an error message for a type 19 custom action that displays the error message and aborts a product's installation. </xs:documentation> </xs:annotation> </xs:attribute> <!-- Other CustomAction type attributes --> <xs:attribute name="Return"> <xs:annotation> <xs:documentation> Set this attribute to set the return behavior of the custom action. </xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="asyncNoWait"> <xs:annotation> <xs:documentation> Indicates that the custom action will run asyncronously and execution may continue after the installer terminates. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="asyncWait"> <xs:annotation> <xs:documentation> Indicates that the custom action will run asynchronously but the installer will wait for the return code at sequence end. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="check"> <xs:annotation> <xs:documentation> Indicates that the custom action will run synchronously and the return code will be checked for success. This is the default. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="ignore"> <xs:annotation> <xs:documentation> Indicates that the custom action will run synchronously and the return code will not be checked. </xs:documentation> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute name="Execute"> <xs:annotation> <xs:documentation> This attribute indicates the scheduling of the custom action. </xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="commit"> <xs:annotation> <xs:documentation> Indicates that the custom action will run after successful completion of the installation script (at the end of the installation). </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="deferred"> <xs:annotation> <xs:documentation> Indicates that the custom action runs in-script (possibly with elevated privileges). </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="firstSequence"> <xs:annotation> <xs:documentation> Indicates that the custom action will only run in the first sequence that runs it. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="immediate"> <xs:annotation> <xs:documentation> Indicates that the custom action will run during normal processing time with user privileges. This is the default. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="oncePerProcess"> <xs:annotation> <xs:documentation> Indicates that the custom action will only run in the first sequence that runs it in the same process. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="rollback"> <xs:annotation> <xs:documentation> Indicates that a custom action will run in the rollback sequence when a failure occurs during installation, usually to undo changes made by a deferred custom action. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="secondSequence"> <xs:annotation> <xs:documentation> Indicates that a custom action should be run a second time if it was previously run in an earlier sequence. </xs:documentation> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute name="Impersonate" type="YesNoType"> <xs:annotation> <xs:documentation> This attribute specifies whether the Windows Installer, which executes as LocalSystem, should impersonate the user context of the installing user when executing this custom action. Typically the value should be 'yes', except when the custom action needs elevated privileges to apply changes to the machine. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="PatchUninstall" type="YesNoType"> <xs:annotation> <xs:documentation> This attribute specifies that the Windows Installer, execute the custom action only when a patch is being uninstalled. These custom actions should also be conditioned using the MSIPATCHREMOVE property to ensure proper down level (less than Windows Installer 4.5) behavior. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Win64" type="YesNoType"> <xs:annotation> <xs:documentation> Specifies that a script custom action targets a 64-bit platform. Valid only when used with the Script, VBScriptCall, and JScriptCall attributes. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="TerminalServerAware" type="YesNoType"> <xs:annotation> <xs:documentation> This attribute specifies controls whether the custom action will impersonate the installing user during per-machine installs on Terminal Server machines. Deferred execution custom actions that do not specify this attribute, or explicitly set it 'no', will run with no user impersonation on Terminal Server machines during per-machine installations. This attribute is only applicable when installing on the Windows Server 2003 family. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="HideTarget" type="YesNoType"> <xs:annotation> <xs:documentation>Ensures the installer does not log the CustomActionData for the deferred custom action.</xs:documentation> </xs:annotation> </xs:attribute> <xs:anyAttribute namespace="##other" processContents="lax"> <xs:annotation> <xs:documentation> Extensibility point in the WiX XML Schema. Schema extensions can register additional attributes at this point in the schema. </xs:documentation> </xs:annotation> </xs:anyAttribute> </xs:extension> </xs:simpleContent> </xs:complexType></xs:element>

Element: CustomActionRef

Description

This will cause the entire contents of the Fragment containing the referenced CustomAction to be included in the installer database.

Content Model

Referenced By

Remarks

The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="DeleteServices" type="ActionSequenceType"> <xs:annotation> <xs:appinfo> <xse:msiRef action="DeleteServices" href="http://msdn.microsoft.com/library/aa368270.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Stops a service and removes its registration from the system. The condition for this action may be specified in the element's inner text.</xs:documentation> </xs:annotation></xs:element>

Derived By

Attributes

The Component Guid Generation Seed is a guid that must be used when a Component with the generate guid directive ("*") is not rooted in a standard Windows Installer directory (for example, ProgramFilesFolder or CommonFilesFolder, etc).

Referenced By

Remarks

Also specifies the mappings between source and target directories.

Definition

<xs:element name="Directory"> <xs:annotation> <xs:documentation>Directory layout for the product. Also specifies the mappings between source and target directories.</xs:documentation> <xs:appinfo> <xse:seeAlso ref="DirectoryRef" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="Directory" href="http://msdn.microsoft.com/library/aa368295.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:howtoRef href="add_a_file.htm" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Add a file to your installer</xse:howtoRef> </xs:appinfo> </xs:annotation> <xs:complexType> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element ref="Component" /> <xs:element ref="Directory" /> <xs:element ref="Merge" /> <xs:element ref="SymbolPath" /> <xs:any namespace="##other" processContents="lax"> <xs:annotation> <xs:documentation> Extensibility point in the WiX XML Schema. Schema extensions can register additional elements at this point in the schema. </xs:documentation> </xs:annotation> </xs:any> </xs:choice> <xs:attribute name="Id" type="xs:string" use="required"> <xs:annotation> <xs:documentation>This value is the unique identifier of the directory entry.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ComponentGuidGenerationSeed" type="Guid"> <xs:annotation> <xs:documentation> The Component Guid Generation Seed is a guid that must be used when a Component with the generate guid directive ("*") is not rooted in a standard Windows Installer directory (for example, ProgramFilesFolder or CommonFilesFolder, etc). It is recommended that this attribute be avoided and that developers install their Components under standard directories with unique names instead (for example, "ProgramFilesFolder\Company Name Product Name Version"). It is important to note that once a directory is assigned a Component Guid Generation Seed the value must not change until the directory name changes. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="DiskId" type="xs:integer"> <xs:annotation> <xs:documentation> Sets the default disk identifier for the files contained in this directory. This attribute must be set on a Component, Directory, or DirectoryRef element or all of its children File elements, else the default disk identifier of 1 is assumed. The value of this attribute should correspond to the Id attribute of a Media element authored elsewhere. By creating this connection between a component (or particular files), you set the packaging options to the values specified in the Media element (values such as compression level, cab embedding, etc...). </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="FileSource" type="xs:string"> <xs:annotation> <xs:documentation>Used to set the file system source for this directory's child elements.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="LongName" type="LongFileNameType"> <xs:annotation> <xs:appinfo> <xse:deprecated ref="Name" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> </xs:annotation> </xs:attribute> <xs:attribute name="LongSource" type="LongFileNameType"> <xs:annotation> <xs:appinfo> <xse:deprecated ref="SourceName" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> </xs:annotation> </xs:attribute> <xs:attribute name="Name" type="LongFileNameType"> <xs:annotation> <xs:documentation> The name of the directory.

Do not specify this attribute (or the LongName attribute) if this directory represents the same directory as the parent (see the Windows Installer SDK's <html:a href="http://msdn2.microsoft.com/library/Aa368295.aspx" target="_blank" xmlns:html="http://www.w3.org/1999/xhtml">Directory table</html:a> topic for more information about the "." operator).

In prior versions of the WiX toolset, this attribute specified the short directory name. This attribute's value may now be either a short or long directory name. If a short directory name is specified, the ShortName attribute may not be specified. If a long directory name is specified, the LongName attribute may not be specified. Also, if this value is a long directory name, the ShortName attribute may be omitted to allow WiX to attempt to generate a unique short directory name. However, if this name collides with another directory or you wish to manually specify the short directory name, then the ShortName attribute may be specified. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ShortName" type="ShortFileNameType"> <xs:annotation> <xs:documentation> The short name of the directory in 8.3 format. This attribute should only be set if there is a conflict between generated short directory names or the user wants to manually specify the short directory name. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ShortSourceName" type="ShortFileNameType"> <xs:annotation> <xs:documentation> The short name of the directory on the source media in 8.3 format. This attribute should only be set if there is a conflict between generated short directory names or the user wants to manually specify the short source directory name. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="SourceName" type="LongFileNameType"> <xs:annotation> <xs:documentation> The name of the directory on the source media. If this attribute is note specified, the Windows Installer will default to the Name attribute.

In prior versions of the WiX toolset, this attribute specified the short source directory name. This attribute's value may now be either a short or long directory name. If a short directory name is specified, the ShortSourceName attribute may not be specified. If a long directory name is specified, the LongSource attribute may not be specified. Also, if this value is a long directory name, the ShortSourceName attribute may be omitted to allow WiX to attempt to generate a unique short directory name. However, if this name collides with another directory or you wish to manually specify the short directory name, then the ShortSourceName attribute may be specified. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="src" type="xs:string"> <xs:annotation> <xs:appinfo> <xse:deprecated ref="FileSource" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> </xs:annotation> </xs:attribute> </xs:complexType></xs:element>

Referenced By

Definition

<xs:element name="DirectorySearchRef"> <xs:annotation> <xs:appinfo> <xse:seeAlso ref="ComponentSearch" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:seeAlso ref="IniFileSearch" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:seeAlso ref="RegistrySearch" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:remarks xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"> <html:p xmlns:html="http://www.w3.org/1999/xhtml">If you intend to use a DirectorySearchRef to reference a DirectorySearch but they have different parent elements, you must use a DirectorySearch instead of a DirectorySearchRef. This is because the DrLocator table in an installer package is keyed on the Id, Parent, and Path. When a DirectorySearch and a DirectorySearchRef element are under different parent elements, the Parent will automatically be different so a DirectorySearchRef will not have a DirectorySearch to reference.</html:p> </xse:remarks> </xs:appinfo> <xs:documentation>References an existing DirectorySearch element.</xs:documentation> </xs:annotation> <xs:complexType> <xs:choice minOccurs="0"> <xs:element ref="DirectorySearch" /> <xs:element ref="DirectorySearchRef" /> <xs:element ref="FileSearch" /> <xs:element ref="FileSearchRef" /> </xs:choice> <xs:attribute name="Id" use="required" type="xs:string"> <xs:annotation> <xs:documentation>Id of the search being referred to.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Parent" type="xs:string"> <xs:annotation> <xs:documentation>This attribute is the signature of the parent directory of the file or directory in the Signature_ column. If this field is null, and the Path column does not expand to a full path, then all the fixed drives of the user's system are searched by using the Path. This field is a key into one of the following tables: the RegLocator, the IniLocator, the CompLocator, or the DrLocator tables.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Path" type="xs:string"> <xs:annotation> <xs:documentation>Path on the user's system. Either absolute, or relative to containing directories.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="AssignToProperty" type="YesNoType"> <xs:annotation> <xs:documentation>Set the result of this search to the value of the outer Property.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType></xs:element>

Content Model

Referenced By

Remarks

Special actions don't have a built-in sequence number and thus must appear relative to another action. The suggested way to do this is by using the Before or After attribute. InstallExecute and InstallExecuteAgain can optionally appear anywhere between InstallInitialize and InstallFinalize.

Definition

<xs:element name="DisableRollback" type="ActionModuleSequenceType"> <xs:annotation> <xs:appinfo> <xse:msiRef action="DisableRollback" href="http://msdn.microsoft.com/library/aa368308.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Disables rollback for the remainder of the installation. Special actions don't have a built-in sequence number and thus must appear relative to another action. The suggested way to do this is by using the Before or After attribute. InstallExecute and InstallExecuteAgain can optionally appear anywhere between InstallInitialize and InstallFinalize.</xs:documentation> </xs:annotation></xs:element>

The name for the embedded UI DLL when it is extracted from the Product and executed. (Windows Installer does not support the typical short filename and long filename combination for embedded UI files as it does for other kinds of files.)

Description

Derived By

Attributes

The name for the resource when it is extracted from the Product for use by the embedded UI DLL. (Windows Installer does not support the typical short filename and long filename combination for embedded UI files as it does for other kinds of files.)

Content Model

Referenced By

Definition

<xs:element name="EmbeddedUIResource"> <xs:annotation> <xs:documentation> Defines a resource for use by the embedded UI. </xs:documentation> <xs:appinfo> <xse:seeAlso ref="EmbeddedUI" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="MsiEmbeddedUI" href="http://msdn.microsoft.com/library/bb736317.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> </xs:annotation> <xs:complexType> <xs:attribute name="Id" type="xs:string" use="required"> <xs:annotation> <xs:documentation>Identifier for the embedded UI resource.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Name" type="LongFileNameType" use="required"> <xs:annotation> <xs:documentation> The name for the resource when it is extracted from the Product for use by the embedded UI DLL. (Windows Installer does not support the typical short filename and long filename combination for embedded UI files as it does for other kinds of files.) If this attribute is not specified the Id attribute will be used. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="SourceFile" type="xs:string" use="required"> <xs:annotation> <xs:documentation>Path to the binary file that is the embedded UI resource.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType></xs:element>

Element: EnsureTable

Description

Use this element to ensure that a table appears in the installer database, even if its empty.

Derived By

Restricting anyType

Attributes

Content Model

Referenced By

Definition

<xs:element name="EnsureTable"> <xs:annotation> <xs:documentation> Use this element to ensure that a table appears in the installer database, even if its empty. </xs:documentation> <xs:appinfo> <xse:remarks xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"> This element is particularly useful for two problems that may occur while merging merge modules: <html:ol xmlns:html="http://www.w3.org/1999/xhtml"><html:li> The first likely problem is that in order to properly merge you need to have certain tables present prior to merging. Using this element is one way to ensure those tables are present prior to the merging. </html:li><html:li> The other common problem is that a merge module has incorrect validation information about some tables. By ensuring these tables prior to merging, you can avoid this problem because the correct validation information will go into the installer database before the merge module has a chance to set it incorrectly. </html:li></html:ol></xse:remarks> </xs:appinfo> </xs:annotation> <xs:complexType> <xs:attribute name="Id" use="required" type="xs:string"> <xs:annotation> <xs:documentation>The name of the table.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType></xs:element>

Content Model

Referenced By

Definition

<xs:element name="Environment"> <xs:annotation> <xs:documentation> Environment variables added or removed for the parent component. </xs:documentation> <xs:appinfo> <xse:msiRef table="Environment" href="http://msdn.microsoft.com/library/aa368369.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> </xs:annotation> <xs:complexType> <xs:attribute name="Id" type="xs:string" use="required"> <xs:annotation> <xs:documentation>Unique identifier for environment entry.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Name" type="xs:string" use="required"> <xs:annotation> <xs:documentation>Name of the environment variable.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Value" type="xs:string"> <xs:annotation> <xs:documentation> The value to set into the environment variable. If this attribute is not set, the environment variable is removed during installation if it exists on the machine. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Separator" type="xs:string"> <xs:annotation> <xs:documentation>Optional attribute to change the separator used between values. By default a semicolon is used.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Action"> <xs:annotation> <xs:documentation>Specfies whether the environmental variable should be created, set or removed when the parent component is installed.</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="create"> <xs:annotation> <xs:documentation>Creates the environment variable if it does not exist, then set it during installation. This has no effect on the value of the environment variable if it already exists.</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="set"> <xs:annotation> <xs:documentation>Creates the environment variable if it does not exist, and then set it during installation. If the environment variable exists, set it during the installation.</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="remove"> <xs:annotation> <xs:documentation> Removes the environment variable during an installation. The installer only removes an environment variable during an installation if the name and value of the variable match the entries in the Name and Value attributes. If you want to remove an environment variable, regardless of its value, do not set the Value attribute. </xs:documentation> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute name="Part"> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="all"> <xs:annotation> <xs:documentation> This value is the entire environmental variable. This is the default. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="first"> <xs:annotation> <xs:documentation> This value is prefixed. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="last"> <xs:annotation> <xs:documentation> This value is appended. </xs:documentation> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute name="Permanent" type="YesNoType"> <xs:annotation> <xs:documentation>Specifies that the environment variable should not be removed on uninstall.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="System" type="YesNoType"> <xs:annotation> <xs:documentation> Specifies that the environment variable should be added to the system environment space. The default is 'no' which indicates the environment variable is added to the user environment space. </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType></xs:element>

Content Model

Always empty.

Definition

<xs:element name="Exclusion"> <xs:annotation> <xs:documentation>Declares a merge module with which this merge module is incompatible.</xs:documentation> </xs:annotation> <xs:complexType> <xs:attribute name="ExcludedId" type="xs:string" use="required"> <xs:annotation> <xs:documentation>Identifier of the merge module that is incompatible.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ExcludeExceptLanguage" type="xs:integer"> <xs:annotation> <xs:documentation>Numeric language ID of the merge module in ExcludedID. All except this language will be excluded. Only one of ExcludeExceptLanguage and ExcludeLanguage may be specified.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ExcludeLanguage" type="xs:integer"> <xs:annotation> <xs:documentation>Numeric language ID of the merge module in ExcludedID. The specified language will be excluded. Only one of ExcludeExceptLanguage and ExcludeLanguage may be specified.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ExcludedMinVersion" type="xs:string"> <xs:annotation> <xs:documentation>Minimum version excluded from a range. If not set, all versions before max are excluded. If neither max nor min, no exclusion based on version.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ExcludedMaxVersion" type="xs:string"> <xs:annotation> <xs:documentation>Maximum version excluded from a range. If not set, all versions after min are excluded. If neither max nor min, no exclusion based on version.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType></xs:element>

Referenced By

Remarks

Features are the smallest installable unit. See msi.chm for more detailed information on the myriad installation options for a feature.

Definition

<xs:element name="Feature"> <xs:annotation> <xs:documentation> A feature for the Feature table. Features are the smallest installable unit. See msi.chm for more detailed information on the myriad installation options for a feature. </xs:documentation> <xs:appinfo> <xse:seeAlso ref="FeatureRef" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="Feature" href="http://msdn.microsoft.com/library/aa368585.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:howtoRef href="add_a_file.htm" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Add a file to your installer</xse:howtoRef> </xs:appinfo> </xs:annotation> <xs:complexType> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element ref="Component" /> <xs:element ref="ComponentGroupRef" /> <xs:element ref="ComponentRef" /> <xs:element ref="Condition" /> <xs:element ref="Feature" /> <xs:element ref="FeatureGroupRef" /> <xs:element ref="FeatureRef" /> <xs:element ref="MergeRef" /> <xs:any namespace="##other" processContents="lax"> <xs:annotation> <xs:documentation> Extensibility point in the WiX XML Schema. Schema extensions can register additional elements at this point in the schema. </xs:documentation> </xs:annotation> </xs:any> </xs:choice> <xs:attribute name="Id" type="xs:string" use="required"> <xs:annotation> <xs:documentation>Unique identifier of the feature.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Absent"> <xs:annotation> <xs:documentation> This attribute determines if a user will have the option to set a feature to absent in the user interface. </xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="allow"> <xs:annotation> <xs:documentation> Allows the user interface to display an option to change the feature state to Absent. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="disallow"> <xs:annotation> <xs:documentation> Prevents the user interface from displaying an option to change the feature state to Absent by setting the msidbFeatureAttributesUIDisallowAbsent attribute. This will force the feature to the installation state, whether or not the feature is visible in the UI. </xs:documentation> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute name="AllowAdvertise"> <xs:annotation> <xs:documentation> This attribute determins the possible advertise states for this feature. </xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="no"> <xs:annotation> <xs:documentation> Prevents this feature from being advertised by settting the msidbFeatureAttributesDisallowAdvertise attribute. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="system"> <xs:annotation> <xs:documentation> Prevents advertising for this feature if the operating system shell does not support Windows Installer descriptors by setting the msidbFeatureAttributesNoUnsupportedAdvertise attribute. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="yes"> <xs:annotation> <xs:documentation> Allows the feature to be advertised. </xs:documentation> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute name="ConfigurableDirectory" type="xs:string"> <xs:annotation> <xs:documentation> Specify the Id of a Directory that can be configured by the user at installation time. This identifier must be a public property and therefore completely uppercase. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Description" type="xs:string"> <xs:annotation> <xs:documentation> Longer string of text describing the feature. This localizable string is displayed by the Text Control of the Selection Dialog. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Display" type="xs:string"> <xs:annotation> <xs:documentation> Determines the initial display of this feature in the feature tree. This attribute's value should be one of the following: <html:dl xmlns:html="http://www.w3.org/1999/xhtml"><html:dt class="enumerationValue"><html:dfn>collapse</html:dfn></html:dt><html:dd>Initially shows the feature collapsed. This is the default value.</html:dd><html:dt class="enumerationValue"><html:dfn>expand</html:dfn></html:dt><html:dd>Initially shows the feature expanded.</html:dd><html:dt class="enumerationValue"><html:dfn>hidden</html:dfn></html:dt><html:dd>Prevents the feature from displaying in the user interface.</html:dd><html:dt class="enumerationValue"><html:dfn>&lt;an explicit integer value&gt;</html:dfn></html:dt><html:dd> For advanced users only, it is possible to directly set the integer value of the display value that will appear in the Feature row. </html:dd></html:dl></xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="InstallDefault"> <xs:annotation> <xs:documentation> This attribute determines the default install/run location of a feature. This attribute cannot be specified if the value of the FollowParent attribute is 'yes' since that would ask the installer to force this feature to follow the parent installation state and simultaneously favor a particular installation state just for this feature. </xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="followParent"> <xs:annotation> <xs:documentation> Forces the feature to follow the same installation state as its parent feature. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="local"> <xs:annotation> <xs:documentation> Favors installing this feature locally by setting the msidbFeatureAttributesFavorLocal attribute. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="source"> <xs:annotation> <xs:documentation> Favors running this feature from source by setting the msidbFeatureAttributesFavorSource attribute. </xs:documentation> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute name="Level" type="xs:integer" use="required"> <xs:annotation> <xs:documentation> Sets the install level of this feature. A value of 0 will disable the feature. Processing the Condition Table can modify the level value (this is set via the Condition child element). </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Title" type="xs:string"> <xs:annotation> <xs:documentation> Short string of text identifying the feature. This string is listed as an item by the SelectionTree control of the Selection Dialog. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="TypicalDefault"> <xs:annotation> <xs:documentation> This attribute determines the default advertise state of the feature. </xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="advertise"> <xs:annotation> <xs:documentation> Sets the feature to be advertised by setting the msidbFeatureAttributesFavorAdvertise attribute. This value cannot be set if the value of the AllowAdvertise attribute is 'no' since that would ask the installer to disallow the advertised state for this feature while at the same time favoring it. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="install"> <xs:annotation> <xs:documentation> Sets the feature to the default non-advertised installation option. </xs:documentation> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:anyAttribute namespace="##other" processContents="lax"> <xs:annotation> <xs:documentation> Extensibility point in the WiX XML Schema. Schema extensions can register additional attributes at this point in the schema. </xs:documentation> </xs:annotation> </xs:anyAttribute> </xs:complexType></xs:element>

Element: FeatureGroup

Description

Groups together multiple components, features, and merges to be used in other locations.

Content Model

Referenced By

Definition

<xs:element name="FeatureGroupRef"> <xs:annotation> <xs:documentation>Create a reference to a FeatureGroup in another Fragment.</xs:documentation> <xs:appinfo> <xse:seeAlso ref="FeatureGroup" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> </xs:annotation> <xs:complexType> <xs:attribute name="Id" type="xs:string" use="required"> <xs:annotation> <xs:documentation>The identifier of the FeatureGroup to reference.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="IgnoreParent" type="YesNoType"> <xs:annotation> <xs:documentation> Normally feature group references that end up nested under a parent element create a connection to that parent. This behavior is undesirable when trying to simply reference to a FeatureGroup in a different Fragment. Specify 'yes' to have this feature group reference not create a connection to its parent. The default is 'no'. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Primary" type="YesNoType"> <xs:annotation> <xs:documentation> Set this attribute to 'yes' in order to make the parent feature of this group the primary feature for any components and merges contained in the group. Features may belong to multiple features. By designating a feature as the primary feature of a component or merge, you ensure that whenever a component is selected for install-on-demand (IOD), the primary feature will be the one to install it. This attribute should only be set if a component actually nests under multiple features. If a component nests under only one feature, that feature is the primary feature for the component. You cannot set more than one feature as the primary feature of a given component. </xs:documentation> </xs:annotation> </xs:attribute> <xs:anyAttribute namespace="##other" processContents="lax"> <xs:annotation> <xs:documentation> Extensibility point in the WiX XML Schema. Schema extensions can register additional attributes at this point in the schema. </xs:documentation> </xs:annotation> </xs:anyAttribute> </xs:complexType></xs:element>

Referenced By

Definition

<xs:element name="File"> <xs:annotation> <xs:documentation> File specification for File table, must be child node of Component. </xs:documentation> <xs:appinfo> <xse:msiRef table="File" href="http://msdn.microsoft.com/library/aa368596.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:howtoRef href="add_a_file.htm" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Add a file to your installer</xse:howtoRef> </xs:appinfo> </xs:annotation> <xs:complexType> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element ref="AssemblyName" /> <xs:element ref="Permission"> <xs:annotation> <xs:documentation>Used to configure the ACLs for this file.</xs:documentation> </xs:annotation> </xs:element> <xs:element ref="CopyFile"> <xs:annotation> <xs:documentation>Used to create a duplicate of this file elsewhere.</xs:documentation> </xs:annotation> </xs:element> <xs:element ref="Shortcut"> <xs:annotation> <xs:documentation>Target of the shortcut will be set to this file.</xs:documentation> </xs:annotation> </xs:element> <xs:element ref="ODBCDriver" /> <xs:element ref="ODBCTranslator" /> <xs:element ref="SymbolPath" /> <xs:element ref="Class" /> <xs:element ref="AppId" /> <xs:element ref="TypeLib" /> <xs:any namespace="##other" processContents="lax"> <xs:annotation> <xs:documentation> Extensibility point in the WiX XML Schema. Schema extensions can register additional elements at this point in the schema. </xs:documentation> </xs:annotation> </xs:any> </xs:choice> <xs:attribute name="Id" type="xs:string"> <xs:annotation> <xs:documentation> The unique identifier for this File element. If you omit Id, it defaults to the file name portion of the Source attribute, if specified. May be referenced as a Property by specifying [#value]. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="CompanionFile" type="xs:string"> <xs:annotation> <xs:documentation>Set this attribute to make this file a companion child of another file. The installation state of a companion file depends not on its own file versioning information, but on the versioning of its companion parent. A file that is the key path for its component can not be a companion file (that means this attribute cannot be set if KeyPath="yes" for this file). The Version attribute cannot be set along with this attribute since companion files are not installed based on their own version.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Name" type="LongFileNameType"> <xs:annotation> <xs:documentation> In prior versions of the WiX toolset, this attribute specified the short file name. This attribute's value may now be either a short or long file name. If a short file name is specified, the ShortName attribute may not be specified. If a long file name is specified, the LongName attribute may not be specified. Also, if this value is a long file name, the ShortName attribute may be omitted to allow WiX to attempt to generate a unique short file name. However, if this name collides with another file or you wish to manually specify the short file name, then the ShortName attribute may be specified. Finally, if this attribute is omitted then its default value is the file name portion of the Source attribute, if one is specified, or the value of the Id attribute, if the Source attribute is omitted or doesn't contain a file name. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="LongName" type="LongFileNameType"> <xs:annotation> <xs:appinfo> <xse:deprecated ref="Name" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> </xs:annotation> </xs:attribute> <xs:attribute name="KeyPath" type="YesNoType"> <xs:annotation> <xs:documentation>Set to yes in order to force this file to be the key path for the parent component.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ShortName" type="ShortFileNameType"> <xs:annotation> <xs:documentation> The short file name of the file in 8.3 format. This attribute should only be set if there is a conflict between generated short file names or the user wants to manually specify the short file name. </xs:documentation> </xs:annotation> </xs:attribute> <!-- 'Attributes' column integer value generated from XML attributes below --> <xs:attribute name="ReadOnly" type="YesNoType"> <xs:annotation> <xs:documentation>Set to yes in order to have the file's read-only attribute set when it is installed on the target machine.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Hidden" type="YesNoType"> <xs:annotation> <xs:documentation>Set to yes in order to have the file's hidden attribute set when it is installed on the target machine.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="System" type="YesNoType"> <xs:annotation> <xs:documentation>Set to yes in order to have the file's system attribute set when it is installed on the target machine.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Vital" type="YesNoType"> <xs:annotation> <xs:documentation>If a file is vital, then installation cannot proceed unless the file is successfully installed. The user will have no option to ignore an error installing this file. If an error occurs, they can merely retry to install the file or abort the installation. The default is "yes," unless the -sfdvital switch (candle.exe) or SuppressFileDefaultVital property (.wixproj) is used.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Checksum" type="YesNoType"> <xs:annotation> <xs:documentation>This attribute should be set to "yes" for every executable file in the installation that has a valid checksum stored in the Portable Executable (PE) file header. Only those files that have this attribute set will be verified for valid checksum during a reinstall.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Compressed" type="YesNoDefaultType"> <xs:annotation> <xs:documentation>Sets the file's source type compression. A setting of "yes" or "no" will override the setting in the Word Count Summary Property.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="BindPath" type="xs:string"> <xs:annotation> <xs:documentation>A list of paths, separated by semicolons, that represent the paths to be searched to find the imported DLLs. The list is usually a list of properties, with each property enclosed inside square brackets. The value may be set to an empty string. Including this attribute will cause an entry to be generated for the file in the BindImage table.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="SelfRegCost" type="xs:integer"> <xs:annotation> <xs:documentation>The cost of registering the file in bytes. This must be a non-negative number. Including this attribute will cause an entry to be generated for the file in the SelfReg table.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="TrueType" type="YesNoType"> <xs:annotation> <xs:documentation>Causes an entry to be generated for the file in the Font table with no FontTitle specified. This attribute is intended to be used to register the file as a TrueType font.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="FontTitle" type="xs:string"> <xs:annotation> <xs:documentation>Causes an entry to be generated for the file in the Font table with the specified FontTitle. This attribute is intended to be used to register the file as a non-TrueType font.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="DefaultLanguage" type="xs:string"> <xs:annotation> <xs:documentation>This is the default language of this file. The linker will replace this value from the value in the file if the suppress files option is not used.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="DefaultSize" type="xs:integer"> <xs:annotation> <xs:documentation>This is the default size of this file. The linker will replace this value from the value in the file if the suppress files option is not used.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="DefaultVersion" type="xs:string"> <xs:annotation> <xs:documentation>This is the default version of this file. The linker will replace this value from the value in the file if the suppress files option is not used.</xs:documentation> </xs:annotation> </xs:attribute> <!-- assembly information --> <xs:attribute name="Assembly"> <xs:annotation> <xs:documentation> Specifies if this File is a Win32 Assembly or .NET Assembly that needs to be installed into the Global Assembly Cache. If the value is '.net' or 'win32', this file must also be the key path of the Component. </xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value=".net"> <xs:annotation> <xs:documentation> The file is a .NET Framework assembly. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="no"> <xs:annotation> <xs:documentation> The file is not a .NET Framework or Win32 assembly. This is the default value. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="win32"> <xs:annotation> <xs:documentation> The file is a Win32 assembly. </xs:documentation> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute name="AssemblyManifest" type="xs:string"> <xs:annotation> <xs:documentation> Specifies the file identifier of the manifest file that describes this assembly. The manifest file should be in the same component as the assembly it describes. This attribute may only be specified if the Assembly attribute is set to '.net' or 'win32'. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="AssemblyApplication" type="xs:string"> <xs:annotation> <xs:documentation> Specifies the file identifier of the application file. This assembly will be isolated to the same directory as the application file. If this attribute is absent, the assembly will be installed to the Global Assembly Cache. This attribute may only be specified if the Assembly attribute is set to '.net' or 'win32'. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ProcessorArchitecture"> <xs:annotation> <xs:documentation>Specifies the architecture for this assembly. This attribute should only be used on .NET Framework 2.0 assemblies.</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="msil"> <xs:annotation> <xs:documentation> The file is a .NET Framework assembly that is processor-neutral. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="x86"> <xs:annotation> <xs:documentation> The file is a .NET Framework assembly for the x86 processor. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="x64"> <xs:annotation> <xs:documentation> The file is a .NET Framework assembly for the x64 processor. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="ia64"> <xs:annotation> <xs:documentation> The file is a .NET Framework assembly for the ia64 processor. </xs:documentation> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute name="DiskId" type="xs:integer"> <xs:annotation> <xs:documentation>Specifies the Media this File should be sourced on. This attribute overrides the default DiskId attribute from the parent Component element. If no DiskId attribute is specifed, the default is "1".</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Source" type="xs:string"> <xs:annotation> <xs:documentation>Specifies the path to the File in the build process. This attribute must be set if no source information can be gathered from parent directories.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="src" type="xs:string"> <xs:annotation> <xs:appinfo> <xse:deprecated ref="Source" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> </xs:annotation> </xs:attribute> <xs:attribute name="PatchGroup" type="xs:integer"> <xs:annotation> <xs:documentation> This attribute must be set for patch-added files. Each patch should be assigned a different patch group number. Patch groups numbers must be greater 0 and should be assigned consecutively. For example, the first patch should use PatchGroup='1', the second patch will have PatchGroup='2', etc... </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="PatchIgnore" type="YesNoType"> <xs:annotation> <xs:documentation>Prevents the updating of the file that is in fact changed in the upgraded image relative to the target images.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="PatchAllowIgnoreOnError" type="YesNoType"> <xs:annotation> <xs:documentation>Set to indicate that the patch is non-vital.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="PatchWholeFile" type="YesNoType"> <xs:annotation> <xs:documentation>Set if the entire file should be installed rather than creating a binary patch.</xs:documentation> </xs:annotation> </xs:attribute> <xs:anyAttribute namespace="##other" processContents="lax"> <xs:annotation> <xs:documentation> Extensibility point in the WiX XML Schema. Schema extensions can register additional attributes at this point in the schema. </xs:documentation> </xs:annotation> </xs:anyAttribute> </xs:complexType></xs:element>

Content Model

Referenced By

Remarks

Any standard or custom actions that affect costing should sequenced before the CostInitialize action. Call the FileCost action immediately following the CostInitialize action. Then call the CostFinalize action following the FileCost action to make all final cost calculations available to the installer through the Component table. The CostInitialize action must be executed before the FileCost action. The installer then determines the disk-space cost of every file in the File table, on a per-component basis, taking both volume clustering and the presence of existing files that may need to be overwritten into account. All actions that consume or release disk space are also considered. If an existing file is found, a file version check is performed to determine whether the new file actually needs to be installed or not. If the existing file is of an equal or greater version number, the existing file is not overwritten and no disk-space cost is incurred. In all cases, the installer uses the results of version number checking to set the installation state of each file. The FileCost action initializes cost calculation with the installer. Actual dynamic costing does not occur until the CostFinalize action is executed. The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="FileCost" type="ActionSequenceType"> <xs:annotation> <xs:appinfo> <xse:seeAlso ref="CostInitialize" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:seeAlso ref="CostFinalize" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef action="FileCost" href="http://msdn.microsoft.com/library/aa368589.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Initiates dynamic costing of standard installation actions. Any standard or custom actions that affect costing should sequenced before the CostInitialize action. Call the FileCost action immediately following the CostInitialize action. Then call the CostFinalize action following the FileCost action to make all final cost calculations available to the installer through the Component table. The CostInitialize action must be executed before the FileCost action. The installer then determines the disk-space cost of every file in the File table, on a per-component basis, taking both volume clustering and the presence of existing files that may need to be overwritten into account. All actions that consume or release disk space are also considered. If an existing file is found, a file version check is performed to determine whether the new file actually needs to be installed or not. If the existing file is of an equal or greater version number, the existing file is not overwritten and no disk-space cost is incurred. In all cases, the installer uses the results of version number checking to set the installation state of each file. The FileCost action initializes cost calculation with the installer. Actual dynamic costing does not occur until the CostFinalize action is executed. The condition for this action may be specified in the element's inner text.</xs:documentation> </xs:annotation></xs:element>

Content Model

Referenced By

Definition

<xs:element name="FileSearch"> <xs:annotation> <xs:appinfo> <xse:seeAlso ref="ComponentSearch" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:seeAlso ref="DirectorySearch" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:seeAlso ref="DirectorySearchRef" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:seeAlso ref="FileSearchRef" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:seeAlso ref="IniFileSearch" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:seeAlso ref="RegistrySearch" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="DrLocator" href="http://msdn.microsoft.com/library/aa368331.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="Signature" href="http://msdn.microsoft.com/library/aa371853.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:howtoRef href="check_the_version_number.htm" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension">How To: Check the version number of a file during installation</xse:howtoRef> </xs:appinfo> <xs:documentation>Searches for file and assigns to fullpath value of parent Property</xs:documentation> </xs:annotation> <xs:complexType> <xs:attribute name="Id" type="xs:string"> <xs:annotation> <xs:documentation>Unique identifier for the file search and external key into the Signature table. This attribute is required if FileSearch is nested under a DirectorySearch or DirectorySearchRef element.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Name" type="LongFileNameType"> <xs:annotation> <xs:documentation> In prior versions of the WiX toolset, this attribute specified the short file name. This attribute's value may now be either a short or long file name. If a short file name is specified, the ShortName attribute may not be specified. If a long file name is specified, the LongName attribute may not be specified. If you wish to manually specify the short file name, then the ShortName attribute may be specified. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="LongName" type="LongFileNameType"> <xs:annotation> <xs:appinfo> <xse:deprecated ref="Name" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> </xs:annotation> </xs:attribute> <xs:attribute name="ShortName" type="ShortFileNameType"> <xs:annotation> <xs:documentation> The short file name of the file in 8.3 format. There is a Windows Installer bug which prevents the FileSearch functionality from working if both a short and long file name are specified. Since the Name attribute allows either a short or long name to be specified, it is the only attribute related to file names which should be specified. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="MinSize" type="xs:int"> <xs:annotation> <xs:documentation>The minimum size of the file.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="MaxSize" type="xs:int"> <xs:annotation> <xs:documentation>The maximum size of the file.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="MinVersion" type="xs:string"> <xs:annotation> <xs:documentation>The minimum version of the file.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="MaxVersion" type="xs:string"> <xs:annotation> <xs:documentation>The maximum version of the file.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="MinDate" type="xs:dateTime"> <xs:annotation> <xs:documentation>The minimum modification date and time of the file. Formatted as YYYY-MM-DDTHH:mm:ss, where YYYY is the year, MM is month, DD is day, 'T' is literal, HH is hour, mm is minute and ss is second.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="MaxDate" type="xs:dateTime"> <xs:annotation> <xs:documentation>The maximum modification date and time of the file. Formatted as YYYY-MM-DDTHH:mm:ss, where YYYY is the year, MM is month, DD is day, 'T' is literal, HH is hour, mm is minute and ss is second.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Languages" type="xs:string"> <xs:annotation> <xs:documentation>The languages supported by the file.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType></xs:element>

Content Model

Referenced By

Definition

<xs:element name="FileSearchRef"> <xs:annotation> <xs:appinfo> <xse:seeAlso ref="FileSearch" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:remarks xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"> <html:p xmlns:html="http://www.w3.org/1999/xhtml">If you intend to use a FileSearchRef to reference a FileSearch but they have different parent elements, you must use a FileSearch instead of a FileSearchRef. This is because the DrLocator table in an installer package is keyed on the Id, Parent, and Path. A file is associated with its parent directory in the DrLocator table. When a FileSearch and a FileSearchRef element are under different parent elements, the Parent will automatically be different so a FileSearchRef will not have a FileSearch to reference.</html:p> </xse:remarks> </xs:appinfo> <xs:documentation>References an existing FileSearch element.</xs:documentation> </xs:annotation> <xs:complexType> <xs:attribute name="Id" use="required" type="xs:string"> <xs:annotation> <xs:documentation>Specify the Id to the FileSearch to reference.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType></xs:element>

Content Model

Referenced By

Definition

<xs:element name="FileTypeMask"> <xs:annotation> <xs:documentation>FileType data for class Id registration.</xs:documentation> </xs:annotation> <xs:complexType> <xs:attribute name="Offset" type="xs:integer" use="required"> <xs:annotation> <xs:documentation>Offset into file. If positive, offset is from the beginning; if negative, offset is from the end.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Mask" type="HexType" use="required"> <xs:annotation> <xs:documentation>Hex value that is AND'd against the bytes in the file at Offset.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Value" type="HexType" use="required"> <xs:annotation> <xs:documentation>If the result of the AND'ing of Mask with the bytes in the file is Value, the file is a match for this File Type.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType></xs:element>

Element: FindRelatedProducts

Description

Runs through each record of the Upgrade table in sequence and compares the upgrade code, product version, and language in each row to products installed on the system.

Content Model

Referenced By

Remarks

When FindRelatedProducts detects a correspondence between the upgrade information and an installed product, it appends the product code to the property specified in the ActionProperty column of the UpgradeTable. The FindRelatedProducts action only runs the first time the product is installed. The FindRelatedProducts action does not run during maintenance mode or uninstallation. FindRelatedProducts should be authored into the InstallUISequence table and InstallExecuteSequence tables. The installer prevents FindRelated Products from running in InstallExecuteSequence if the action has already run in InstallUISequence. The FindRelatedProducts action must come before the MigrateFeatureStates action and the RemoveExistingProducts action. The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="FindRelatedProducts" type="ActionModuleSequenceType"> <xs:annotation> <xs:appinfo> <xse:seeAlso ref="Upgrade" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef action="FindRelatedProducts" href="http://msdn.microsoft.com/library/aa368600.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Runs through each record of the Upgrade table in sequence and compares the upgrade code, product version, and language in each row to products installed on the system. When FindRelatedProducts detects a correspondence between the upgrade information and an installed product, it appends the product code to the property specified in the ActionProperty column of the UpgradeTable. The FindRelatedProducts action only runs the first time the product is installed. The FindRelatedProducts action does not run during maintenance mode or uninstallation. FindRelatedProducts should be authored into the InstallUISequence table and InstallExecuteSequence tables. The installer prevents FindRelated Products from running in InstallExecuteSequence if the action has already run in InstallUISequence. The FindRelatedProducts action must come before the MigrateFeatureStates action and the RemoveExistingProducts action. The condition for this action may be specified in the element's inner text.</xs:documentation> </xs:annotation></xs:element>

Content Model

Referenced By

Remarks

Special actions don't have a built-in sequence number and thus must appear relative to another action. The suggested way to do this is by using the Before or After attribute. InstallExecute and InstallExecuteAgain can optionally appear anywhere between InstallInitialize and InstallFinalize.

Definition

<xs:element name="ForceReboot" type="ActionModuleSequenceType"> <xs:annotation> <xs:appinfo> <xse:msiRef action="ForceReboot" href="http://msdn.microsoft.com/library/aa368607.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Prompts the user for a restart of the system during the installation. Special actions don't have a built-in sequence number and thus must appear relative to another action. The suggested way to do this is by using the Before or After attribute. InstallExecute and InstallExecuteAgain can optionally appear anywhere between InstallInitialize and InstallFinalize.</xs:documentation> </xs:annotation></xs:element>

Element: Fragment

Description

The Fragment element is the building block of creating an installer database in WiX.

Remarks

Once defined, the Fragment becomes an immutable, atomic unit which can either be completely included or excluded from a product. The contents of a Fragment element can be linked into a product by utilizing one of the many *Ref elements. When linking in a Fragment, it will be necessary to link in all of its individual units. For instance, if a given Fragment contains two Component elements, you must link both under features using ComponentRef for each linked Component. Otherwise, you will get a linker warning and have a floating Component that does not appear under any Feature.

Derived By

Attributes

Content Model

Always empty.

Definition

<xs:element name="IconRef"> <xs:annotation> <xs:documentation>Used only for PatchFamilies to include only a icon table entry in a patch.</xs:documentation> </xs:annotation> <xs:complexType> <xs:attribute name="Id" type="xs:string" use="required"> <xs:annotation> <xs:documentation>The identifier of the Icon element to reference.</xs:documentation> </xs:annotation> </xs:attribute> <xs:anyAttribute namespace="##other" processContents="lax"> <xs:annotation> <xs:documentation> Extensibility point in the WiX XML Schema. Schema extensions can register additional attributes at this point in the schema. </xs:documentation> </xs:annotation> </xs:anyAttribute> </xs:complexType></xs:element>

Derived By

Attributes

Content Model

Always empty.

Definition

<xs:element name="IgnoreRange"> <xs:annotation> <xs:documentation>Specifies part of a file that is to be ignored during patching.</xs:documentation> </xs:annotation> <xs:complexType> <xs:attribute name="Offset" type="xs:int" use="required"> <xs:annotation> <xs:documentation>Offset of the start of the range.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Length" type="xs:int" use="required"> <xs:annotation> <xs:documentation>Length of the range.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType></xs:element>

Element: IgnoreTable

Description

Specifies a table from the merge module that is not merged into an .msi file.

Derived By

Restricting anyType

Attributes

The name of the table in the merge module that is not to be merged into the .msi file.

Content Model

Always empty.

Remarks

If the table already exists in an .msi file, it is not modified by the merge. The specified table can therefore contain data that is unneeded after the merge. To minimize the size of the .msm file, it is recommended that developers remove unused tables from modules intended for redistribution rather than creating IgnoreTable elements for those tables.

Definition

<xs:element name="IgnoreTable"> <xs:annotation> <xs:documentation> Specifies a table from the merge module that is not merged into an .msi file. If the table already exists in an .msi file, it is not modified by the merge. The specified table can therefore contain data that is unneeded after the merge. To minimize the size of the .msm file, it is recommended that developers remove unused tables from modules intended for redistribution rather than creating IgnoreTable elements for those tables. </xs:documentation> </xs:annotation> <xs:complexType> <xs:attribute name="Id" type="xs:string" use="required"> <xs:annotation> <xs:documentation> The name of the table in the merge module that is not to be merged into the .msi file. </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType></xs:element>

Content Model

Referenced By

Definition

<xs:element name="IniFile"> <xs:annotation> <xs:documentation> Adds or removes .ini file entries. </xs:documentation> <xs:appinfo> <xse:msiRef table="IniFile" href="http://msdn.microsoft.com/library/aa369282.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="RemoveIniFile" href="http://msdn.microsoft.com/library/aa371204.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> </xs:annotation> <xs:complexType> <xs:attribute name="Id" use="required" type="xs:string"> <xs:annotation> <xs:documentation>Identifier for ini file.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Action" use="required"> <xs:annotation> <xs:documentation>The type of modification to be made.</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="addLine"> <xs:annotation> <xs:documentation>Creates or updates an .ini entry.</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="addTag"> <xs:annotation> <xs:documentation>Creates a new entry or appends a new comma-separated value to an existing entry.</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="createLine"> <xs:annotation> <xs:documentation>Creates an .ini entry only if the entry does no already exist.</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="removeLine"> <xs:annotation> <xs:documentation>Removes an .ini entry.</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="removeTag"> <xs:annotation> <xs:documentation>Removes a tag from an .ini entry.</xs:documentation> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute name="Directory" type="xs:string"> <xs:annotation> <xs:documentation>Name of a property, the value of which is the full path of the folder containing the .ini file. Can be name of a directory in the Directory table, a property set by the AppSearch table, or any other property representing a full path.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Key" use="required" type="xs:string"> <xs:annotation> <xs:documentation>The localizable .ini file key within the section.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="LongName" type="LongFileNameType"> <xs:annotation> <xs:appinfo> <xse:deprecated ref="Name" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> </xs:annotation> </xs:attribute> <xs:attribute name="Name" type="LongFileNameType" use="required"> <xs:annotation> <xs:documentation> In prior versions of the WiX toolset, this attribute specified the short name. This attribute's value may now be either a short or long name. If a short name is specified, the ShortName attribute may not be specified. If a long name is specified, the LongName attribute may not be specified. Also, if this value is a long name, the ShortName attribute may be omitted to allow WiX to attempt to generate a unique short name. However, if this name collides with another file or you wish to manually specify the short name, then the ShortName attribute may be specified. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Section" use="required" type="xs:string"> <xs:annotation> <xs:documentation>The localizable .ini file section.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ShortName" type="ShortFileNameType"> <xs:annotation> <xs:documentation> The short name of the in 8.3 format. This attribute should only be set if there is a conflict between generated short names or the user wants to manually specify the short name. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Value" type="xs:string"> <xs:annotation> <xs:documentation> The localizable value to be written or deleted. This attribute must be set if the Action attribute's value is "addLine", "addTag", or "createLine". </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType></xs:element>

Element: IniFileSearch

Description

Searches for file, directory or registry key and assigns to value of parent Property

Definition

<xs:element name="IniFileSearch"> <xs:annotation> <xs:appinfo> <xse:seeAlso ref="ComponentSearch" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:seeAlso ref="RegistrySearch" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="IniLocator" href="http://msdn.microsoft.com/library/aa369283.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef table="Signature" href="http://msdn.microsoft.com/library/aa371853.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Searches for file, directory or registry key and assigns to value of parent Property</xs:documentation> </xs:annotation> <xs:complexType> <xs:choice minOccurs="0"> <xs:element ref="DirectorySearch" /> <xs:element ref="DirectorySearchRef" /> <xs:element ref="FileSearch" /> <xs:element ref="FileSearchRef" /> </xs:choice> <xs:attribute name="Id" use="required" type="xs:string"> <xs:annotation> <xs:documentation>External key into the Signature table.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Field" type="xs:integer"> <xs:annotation> <xs:documentation>The field in the .ini line. If field is Null or 0, the entire line is read.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Key" use="required" type="xs:string"> <xs:annotation> <xs:documentation>The key value within the section.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="LongName" type="LongFileNameType"> <xs:annotation> <xs:appinfo> <xse:deprecated ref="Name" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> </xs:annotation> </xs:attribute> <xs:attribute name="Name" type="LongFileNameType" use="required"> <xs:annotation> <xs:documentation> In prior versions of the WiX toolset, this attribute specified the short name. This attribute's value may now be either a short or long name. If a short name is specified, the ShortName attribute may not be specified. If a long name is specified, the LongName attribute may not be specified. Also, if this value is a long name, the ShortName attribute may be omitted to allow WiX to attempt to generate a unique short name. However, if you wish to manually specify the short name, then the ShortName attribute may be specified. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Section" use="required" type="xs:string"> <xs:annotation> <xs:documentation>The localizable .ini file section.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ShortName" type="ShortFileNameType"> <xs:annotation> <xs:documentation> The short name of the file in 8.3 format. This attribute should only be set if the user wants to manually specify the short name. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Type"> <xs:annotation> <xs:documentation>Must be file if last child is FileSearch element and must be directory if last child is DirectorySearch element.</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="directory"> <xs:annotation> <xs:documentation>A directory location.</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="file"> <xs:annotation> <xs:documentation>A file location. This is the default value.</xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="raw"> <xs:annotation> <xs:documentation>A raw .ini value.</xs:documentation> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> </xs:attribute> </xs:complexType></xs:element>

Element: InstallAdminPackage

Description

Copies the product database to the administrative installation point. The condition for this action may be specified in the element's inner text.

Content Model

Referenced By

Remarks

Special actions don't have a built-in sequence number and thus must appear relative to another action. The suggested way to do this is by using the Before or After attribute. InstallExecute and InstallExecuteAgain can optionally appear anywhere between InstallInitialize and InstallFinalize.

Definition

<xs:element name="InstallExecute" type="ActionModuleSequenceType"> <xs:annotation> <xs:appinfo> <xse:msiRef action="InstallExecute" href="http://msdn.microsoft.com/library/aa369502.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Runs a script containing all operations spooled since either the start of the installation or the last InstallExecute action, or InstallExecuteAgain action. Special actions don't have a built-in sequence number and thus must appear relative to another action. The suggested way to do this is by using the Before or After attribute. InstallExecute and InstallExecuteAgain can optionally appear anywhere between InstallInitialize and InstallFinalize.</xs:documentation> </xs:annotation></xs:element>

Element: InstallExecuteAgain

Description

Runs a script containing all operations spooled since either the start of the installation or the last InstallExecute action, or InstallExecuteAgain action.

Content Model

Referenced By

Remarks

Should only be used after InstallExecute. Special actions don't have a built-in sequence number and thus must appear relative to another action. The suggested way to do this is by using the Before or After attribute. InstallExecute and InstallExecuteAgain can optionally appear anywhere between InstallInitialize and InstallFinalize.

Definition

<xs:element name="InstallExecuteAgain" type="ActionModuleSequenceType"> <xs:annotation> <xs:appinfo> <xse:msiRef action="InstallExecuteAgain" href="http://msdn.microsoft.com/library/aa369497.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Runs a script containing all operations spooled since either the start of the installation or the last InstallExecute action, or InstallExecuteAgain action. Should only be used after InstallExecute. Special actions don't have a built-in sequence number and thus must appear relative to another action. The suggested way to do this is by using the Before or After attribute. InstallExecute and InstallExecuteAgain can optionally appear anywhere between InstallInitialize and InstallFinalize.</xs:documentation> </xs:annotation></xs:element>

Content Model

Referenced By

Remarks

The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="InstallFiles" type="ActionSequenceType"> <xs:annotation> <xs:appinfo> <xse:msiRef action="InstallFiles" href="http://msdn.microsoft.com/library/aa369503.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Copies files specified in the File table from the source directory to the destination directory. The condition for this action may be specified in the element's inner text.</xs:documentation> </xs:annotation></xs:element>

Content Model

Referenced By

Remarks

The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="InstallFinalize" type="ActionSequenceType"> <xs:annotation> <xs:appinfo> <xse:seeAlso ref="InstallInitialize" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef action="InstallFinalize" href="http://msdn.microsoft.com/library/aa369505.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Marks the end of a sequence of actions that change the system. The condition for this action may be specified in the element's inner text.</xs:documentation> </xs:annotation></xs:element>

Content Model

Referenced By

Remarks

The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="InstallServices" type="ActionSequenceType"> <xs:annotation> <xs:appinfo> <xse:msiRef action="InstallServices" href="http://msdn.microsoft.com/library/aa369540.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Registers a service for the system. The condition for this action may be specified in the element's inner text.</xs:documentation> </xs:annotation></xs:element>

Content Model

Referenced By

Remarks

The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="InstallValidate" type="ActionSequenceType"> <xs:annotation> <xs:appinfo> <xse:msiRef action="InstallValidate" href="http://msdn.microsoft.com/library/aa369546.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Verifies that all costed volumes have enough space for the installation. The condition for this action may be specified in the element's inner text.</xs:documentation> </xs:annotation></xs:element>

Content Model

Referenced By

Definition

<xs:element name="Instance"> <xs:annotation> <xs:documentation> Defines an instance transform for your product. </xs:documentation> </xs:annotation> <xs:complexType> <xs:attribute name="Id" type="xs:string" use="required"> <xs:annotation> <xs:documentation> The identity of the instance transform. This value will define the name by which the instance should be referred to on the command line. In addition, the value of the this attribute will determine what the value of the property specified in Property attribute on InstanceTransforms will change to for each instance. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ProductCode" type="xs:string" use="required"> <xs:annotation> <xs:documentation>The ProductCode for this instance.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ProductName" type="xs:string"> <xs:annotation> <xs:documentation>The ProductName for this instance.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType></xs:element>

Content Model

Referenced By

Remarks

This isolates the application from other copies of the component that may be installed to a shared location on the computer. The action refers to each record of the IsolatedComponent table and associates the files of the component listed in the Component_Shared field with the component listed in the Component_Application field. The installer installs the files of Component_Shared into the same directory as Component_Application. The installer generates a file in this directory, zero bytes in length, having the short filename name of the key file for Component_Application (typically this is the same file name as the .exe) appended with .local. The IsolatedComponent action does not affect the installation of Component_Application. Uninstalling Component_Application also removes the Component_Shared files and the .local file from the directory. The IsolateComponents action can be used only in the InstallUISequence table and the InstallExecuteSequence table. This action must come after the CostInitialize action and before the CostFinalize action. The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="IsolateComponents" type="ActionSequenceType"> <xs:annotation> <xs:appinfo> <xse:seeAlso ref="IsolateComponent" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef action="IsolateComponents" href="http://msdn.microsoft.com/library/aa369561.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Installs a copy of a component (commonly a shared DLL) into a private location for use by a specific application (typically an .exe). This isolates the application from other copies of the component that may be installed to a shared location on the computer. The action refers to each record of the IsolatedComponent table and associates the files of the component listed in the Component_Shared field with the component listed in the Component_Application field. The installer installs the files of Component_Shared into the same directory as Component_Application. The installer generates a file in this directory, zero bytes in length, having the short filename name of the key file for Component_Application (typically this is the same file name as the .exe) appended with .local. The IsolatedComponent action does not affect the installation of Component_Application. Uninstalling Component_Application also removes the Component_Shared files and the .local file from the directory. The IsolateComponents action can be used only in the InstallUISequence table and the InstallExecuteSequence table. This action must come after the CostInitialize action and before the CostFinalize action. The condition for this action may be specified in the element's inner text.</xs:documentation> </xs:annotation></xs:element>

Element: LaunchConditions

Description

Queries the LaunchCondition table and evaluates each conditional statement recorded there.

Content Model

Referenced By

Remarks

If any of these conditional statements fail, an error message is displayed to the user and the installation is terminated. The LaunchConditions action is optional. This action is normally the first in the sequence, but the AppSearch Action may be sequenced before the LaunchConditions action. If there are launch conditions that do not apply to all installation modes, the appropriate installation mode property should be used in a conditional expression in the appropriate sequence table. The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="LaunchConditions" type="ActionModuleSequenceType"> <xs:annotation> <xs:appinfo> <xse:seeAlso ref="Condition" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef action="LaunchConditions" href="http://msdn.microsoft.com/library/aa369751.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Queries the LaunchCondition table and evaluates each conditional statement recorded there. If any of these conditional statements fail, an error message is displayed to the user and the installation is terminated. The LaunchConditions action is optional. This action is normally the first in the sequence, but the AppSearch Action may be sequenced before the LaunchConditions action. If there are launch conditions that do not apply to all installation modes, the appropriate installation mode property should be used in a conditional expression in the appropriate sequence table. The condition for this action may be specified in the element's inner text.</xs:documentation> </xs:annotation></xs:element>

Element: ListBox

Description

Set of items for a particular ListBox control tied to an install Property

Referenced By

Definition

<xs:element name="Media"> <xs:annotation> <xs:documentation>Media element describes a disk that makes up the source media for the installation.</xs:documentation> <xs:appinfo> <xse:msiRef table="Media" href="http://msdn.microsoft.com/library/aa369801.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> </xs:annotation> <xs:complexType> <xs:sequence> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element ref="DigitalSignature" minOccurs="0" /> <xs:element ref="PatchBaseline" minOccurs="0" maxOccurs="unbounded" /> <xs:element ref="SymbolPath" /> </xs:choice> </xs:sequence> <xs:attribute name="Id" type="xs:integer" use="required"> <xs:annotation> <xs:documentation>Disk identifier for Media table. This number must be equal to or greater than 1.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Cabinet" type="xs:string"> <xs:annotation> <xs:documentation>The name of the cabinet if some or all of the files stored on the media are in a cabinet file. If no cabinets are used, this attribute must not be set.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="CompressionLevel"> <xs:annotation> <xs:documentation> Indicates the compression level for the Media's cabinet. This attribute can only be used in conjunction with the Cabinet attribute. The default is 'mszip'. </xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="high" /> <xs:enumeration value="low" /> <xs:enumeration value="medium" /> <xs:enumeration value="mszip" /> <xs:enumeration value="none" /> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute name="DiskPrompt" type="xs:string"> <xs:annotation> <xs:documentation>The disk name, which is usually the visible text printed on the disk. This localizable text is used to prompt the user when this disk needs to be inserted. This value will be used in the "[1]" of the DiskPrompt Property. Using this attribute will require you to define a DiskPrompt Property.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="EmbedCab" type="YesNoType"> <xs:annotation> <xs:documentation>Instructs the binder to embed the cabinet in the product if 'yes'. This attribute can only be specified in conjunction with the Cabinet attribute.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Layout" type="xs:string"> <xs:annotation> <xs:documentation> This attribute specifies the root directory for the uncompressed files that are a part of this Media element. By default, the src will be the output directory for the final image. The default value ensures the binder generates an installable image. If a relative path is specified in the src attribute, the value will be appended to the image's output directory. If an absolute path is provided, that path will be used without modification. The latter two options are provided to ease the layout of an image onto multiple medias (CDs/DVDs). </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="src" type="xs:string"> <xs:annotation> <xs:appinfo> <xse:deprecated ref="Layout" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> </xs:annotation> </xs:attribute> <xs:attribute name="VolumeLabel" type="xs:string"> <xs:annotation> <xs:documentation> The label attributed to the volume. This is the volume label returned by the GetVolumeInformation function. If the SourceDir property refers to a removable (floppy or CD-ROM) volume, then this volume label is used to verify that the proper disk is in the drive before attempting to install files. The entry in this column must match the volume label of the physical media. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Source" type="xs:string"> <xs:annotation> <xs:documentation> Optional property that identifies the source of the embedded cabinet. If a cabinet is specified for a patch, this property should be defined and unique to each patch so that the embedded cabinet containing patched and new files can be located in the patch package. If the cabinet is not embedded - this is not typical - the cabinet can be found in the directory referenced in this column. If empty, the external cabinet must be located in the SourceDir directory. </xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType></xs:element>

Element: Merge

Description

Merge directive to bring in a merge module that will be redirected to the parent directory.

Content Model

Referenced By

Remarks

Reads feature states from existing application and sets these feature states for the pending installation. The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="MigrateFeatureStates" type="ActionSequenceType"> <xs:annotation> <xs:appinfo> <xse:msiRef action="MigrateFeatureStates" href="http://msdn.microsoft.com/library/aa370034.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Used for upgrading or installing over an existing application. Reads feature states from existing application and sets these feature states for the pending installation. The condition for this action may be specified in the element's inner text.</xs:documentation> </xs:annotation></xs:element>

Content Model

Referenced By

Definition

<xs:element name="MIME"> <xs:annotation> <xs:documentation> MIME content-type for an Extension </xs:documentation> <xs:appinfo> <xse:msiRef table="MIME" href="http://msdn.microsoft.com/library/aa370035.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> </xs:annotation> <xs:complexType> <xs:attribute name="Advertise" type="YesNoType"> <xs:annotation> <xs:documentation>Whether this MIME is to be advertised. The default is to match whatever the parent extension element uses. If the parent element is not advertised, then this element cannot be advertised either.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ContentType" type="xs:string" use="required"> <xs:annotation> <xs:documentation>This is the identifier for the MIME content. It is commonly written in the form of type/format.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Class" type="Guid"> <xs:annotation> <xs:documentation>Class ID for the COM server that is to be associated with the MIME content.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Default" type="YesNoType"> <xs:annotation> <xs:documentation>If 'yes', become the content type for the parent Extension. The default value is 'no'.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType></xs:element>

Content Model

Referenced By

Remarks

The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="MoveFiles" type="ActionSequenceType"> <xs:annotation> <xs:appinfo> <xse:msiRef table="MoveFile" href="http://msdn.microsoft.com/library/aa370055.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> <xse:msiRef action="MoveFiles" href="http://msdn.microsoft.com/library/aa370054.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Locates existing files on the system and moves or copies those files to a new location. The condition for this action may be specified in the element's inner text.</xs:documentation> </xs:annotation></xs:element>

Content Model

Referenced By

Remarks

The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="MsiUnpublishAssemblies" type="ActionSequenceType"> <xs:annotation> <xs:appinfo> <xse:msiRef action="MsiUnpublishAssemblies" href="http://msdn.microsoft.com/library/aa370500.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Manages the unadvertisement of CLR and Win32 assemblies that are being removed. The condition for this action may be specified in the element's inner text.</xs:documentation> </xs:annotation></xs:element>

Element: MultiStringValue

Description

Use several of these elements to specify each registry value in a multiString registry value.

Derived By

Content Model

Referenced By

Remarks

This element cannot be used if the Value attribute is specified unless the Type attribute is set to 'multiString'. The values should go in the text area of the MultiStringValue element.

Definition

<xs:element name="MultiStringValue"> <xs:annotation> <xs:documentation> Use several of these elements to specify each registry value in a multiString registry value. This element cannot be used if the Value attribute is specified unless the Type attribute is set to 'multiString'. The values should go in the text area of the MultiStringValue element. </xs:documentation> <xs:appinfo> <xse:msiRef table="Registry" href="http://msdn.microsoft.com/library/aa371168.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> </xs:annotation></xs:element>

Content Model

Referenced By

Remarks

These are visible from COM through the IStream interface, and these properties can be seen on the package in Explorer.

Definition

<xs:element name="Package"> <xs:annotation> <xs:documentation> Properties about the package to be placed in the Summary Information Stream. These are visible from COM through the IStream interface, and these properties can be seen on the package in Explorer. </xs:documentation> <xs:appinfo> <xse:remarks xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"> <html:p xmlns:html="http://www.w3.org/1999/xhtml">You can specify any valid Windows code by by integer like 1252, or by web name like Windows-1252. See <a href="/html/codepage.htm" xmlns="http://schemas.microsoft.com/wix/2006/wi">Code Pages</a> for more information.</html:p> </xse:remarks> </xs:appinfo> </xs:annotation> <xs:complexType> <xs:attribute name="Id" type="AutogenGuid"> <xs:annotation> <xs:documentation> The package code GUID for a product or merge module. When compiling a product, this attribute should not be set in order to allow the package code to be generated for each build. When compiling a merge module, this attribute must be set to the modularization guid. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="AdminImage" type="YesNoType"> <xs:annotation> <xs:documentation>Set to 'yes' if the source is an admin image.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Comments" type="xs:string"> <xs:annotation> <xs:documentation>Optional comments for browsing.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Compressed" type="YesNoType"> <xs:annotation> <xs:documentation> Set to 'yes' to have compressed files in the source. This attribute cannot be set for merge modules. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Description" type="xs:string"> <xs:annotation> <xs:documentation>The product full name or description.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="InstallPrivileges"> <xs:annotation> <xs:documentation>Use this attribute to specify the priviliges required to install the package on Windows Vista and above.</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="limited"> <xs:annotation> <xs:documentation> Set this value to declare that the package does not require elevated privileges to install. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="elevated"> <xs:annotation> <xs:documentation> Set this value to declare that the package requires elevated privileges to install. This is the default value. </xs:documentation> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute name="InstallScope"> <xs:annotation> <xs:documentation>Use this attribute to specify the installation scope of this package: per-machine or per-user.</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="perMachine"> <xs:annotation> <xs:documentation> Set this value to declare that the package is a per-machine installation and requires elevated privileges to install. Sets the ALLUSERS property to 1. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="perUser"> <xs:annotation> <xs:documentation> Set this value to declare that the package is a per-user installation and does not require elevated privileges to install. Sets the package's InstallPrivileges attribute to "limited." </xs:documentation> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute name="InstallerVersion" type="xs:integer"> <xs:annotation> <xs:documentation> The minimum version of the Windows Installer required to install this package. Take the major version of the required Windows Installer and multiply by a 100 then add the minor version of the Windows Installer. For example, "200" would represent Windows Installer 2.0 and "405" would represent Windows Installer 4.5. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Keywords" type="xs:string"> <xs:annotation> <xs:documentation>Optional keywords for browsing.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Languages" type="xs:string"> <xs:annotation> <xs:documentation>The list of language IDs (LCIDs) supported in the package.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Manufacturer" type="xs:string"> <xs:annotation> <xs:documentation>The vendor releasing the package.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Platforms" type="xs:string"> <xs:annotation> <xs:appinfo> <xse:deprecated ref="Platform" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> </xs:annotation> </xs:attribute> <xs:attribute name="Platform"> <xs:annotation> <xs:documentation>The platform supported by the package.</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:NMTOKEN"> <xs:enumeration value="x86"> <xs:annotation> <xs:documentation> Set this value to declare that the package is an x86 package. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="ia64"> <xs:annotation> <xs:documentation> Set this value to declare that the package is an ia64 package. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="x64"> <xs:annotation> <xs:documentation> Set this value to declare that the package is an x64 package. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="intel"> <xs:annotation> <xs:documentation> Deprecated. Use "x86" instead. </xs:documentation> </xs:annotation> </xs:enumeration> <xs:enumeration value="intel64"> <xs:annotation> <xs:documentation> Deprecated. Use "ia64" instead. </xs:documentation> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> </xs:attribute> <xs:attribute name="ReadOnly" type="YesNoDefaultType"> <xs:annotation> <xs:documentation> The value of this attribute conveys whether the package should be opened as read-only. A database editing tool should not modify a read-only enforced database and should issue a warning at attempts to modify a read-only recommended database. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ShortNames" type="YesNoType"> <xs:annotation> <xs:documentation>Set to 'yes' to have short filenames in the source.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="SummaryCodepage" type="xs:string"> <xs:annotation> <xs:documentation>The code page integer value or web name for summary info strings only. See remarks for more information.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType></xs:element>

Remarks

When linking, only one Patch section can be given to the linker to produce a successful result. Using this element creates an MSP file.

Definition

<xs:element name="Patch"> <xs:annotation> <xs:documentation> The Patch element is analogous to the main function in a C program. When linking, only one Patch section can be given to the linker to produce a successful result. Using this element creates an MSP file. </xs:documentation> <xs:appinfo> <xse:remarks xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"> <html:p xmlns:html="http://www.w3.org/1999/xhtml">You can specify any valid Windows code by by integer like 1252, or by web name like Windows-1252. See <a href="/html/codepage.htm" xmlns="http://schemas.microsoft.com/wix/2006/wi">Code Pages</a> for more information.</html:p> <html:p xmlns:html="http://www.w3.org/1999/xhtml">The ClientPatchId attribute allows you to specify an easily referenced identity that you can use in product authoring. This identity prefixes properties added by WiX to a patch transform, such as <html:i>ClientPatchId</html:i>.PatchCode and <html:i>ClientPatchId</html:i>.AllowRemoval. If the patch code GUID is auto-generated you could not reference any properties using this auto-generated prefix.</html:p> <html:p xmlns:html="http://www.w3.org/1999/xhtml">For example, if you were planning to ship a patch referred to as "QFE1" and needed to write your own registry values for Add/Remove Programs in product authoring such as the UninstallString for this patch, you could author a RegistryValue with the name UninstallString and the value <html:code><html:nobr>[SystemFolder]msiexec.exe</html:nobr> /package [ProductCode] /uninstall [QFE1.PatchCode]</html:code>. In your patch authoring you would then set ClientPatchId to "QFE1" and WiX will add the QFE1.PatchCode property to the patch transform when the patch is created. If the Id attribute specified the patch code to be generated automatically, you could not reference the <html:i>prefix</html:i>.PatchCode property as shown above.</html:p> </xse:remarks> </xs:appinfo> </xs:annotation> <xs:complexType> <xs:sequence> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element ref="Media" minOccurs="1" maxOccurs="unbounded" /> <xs:element ref="OptimizeCustomActions" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Indicates whether custom actions can be skipped when applying the patch.</xs:documentation> </xs:annotation> </xs:element> <xs:element ref="PatchFamily" minOccurs="1" maxOccurs="unbounded" /> <xs:element ref="PatchFamilyRef" minOccurs="0" maxOccurs="unbounded" /> <xs:element ref="PatchProperty" /> <xs:any namespace="##other" processContents="lax"> <xs:annotation> <xs:documentation> Extensibility point in the WiX XML Schema. Schema extensions can register additional elements at this point in the schema. </xs:documentation> </xs:annotation> </xs:any> </xs:choice> </xs:sequence> <xs:attribute name="Id" type="AutogenGuid"> <xs:annotation> <xs:documentation>Patch code for this patch.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Codepage" type="xs:string"> <xs:annotation> <xs:documentation>The code page integer value or web name for the resulting MSP. See remarks for more information.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="AllowRemoval" type="YesNoType"> <xs:annotation> <xs:documentation>Whether this is an uninstallable patch.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Classification" type="PatchClassificationType" use="required"> <xs:annotation> <xs:documentation>Category of updates.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ClientPatchId" type="xs:string"> <xs:annotation> <xs:documentation>An easily referenced identity unique to a patch that can be used in product authoring. See remarks for more information.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ApiPatchingSymbolNoImagehlpFlag" type="YesNoType"> <xs:annotation> <xs:documentation>Flag used when creating a binary file patch. Default is "no". Don't use imagehlp.dll.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ApiPatchingSymbolNoFailuresFlag" type="YesNoType"> <xs:annotation> <xs:documentation>Flag used when creating a binary file patch. Default is "no". Don't fail patch due to imagehlp failures.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ApiPatchingSymbolUndecoratedTooFlag" type="YesNoType"> <xs:annotation> <xs:documentation>Flag used when creating a binary file patch. Default is "no". After matching decorated symbols, try to match remaining by undecorated names.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Description" type="xs:string" use="required"> <xs:annotation> <xs:documentation>Description of the patch.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="DisplayName" type="xs:string" use="required"> <xs:annotation> <xs:documentation>A title for the patch that is suitable for public display. In Add/Remove Programs from XP SP2 on.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Manufacturer" type="xs:string"> <xs:annotation> <xs:documentation>Vendor releasing the package</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="MinorUpdateTargetRTM" type="YesNoType"> <xs:annotation> <xs:documentation> Indicates that the patch targets the RTM version of the product or the most recent major upgrade patch. Author this optional property in minor update patches that contain sequencing information to indicate that the patch removes all patches up to the RTM version of the product, or up to the most recent major upgrade patch. This property is available beginning with Windows Installer 3.1. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="MoreInfoURL" type="xs:string"> <xs:annotation> <xs:documentation>A URL that provides information specific to this patch. In Add/Remove Programs from XP SP2 on.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="OptimizedInstallMode" type="YesNoType"> <xs:annotation> <xs:documentation> If this attribute is set to 'yes' in all the patches to be applied in a transaction, the application of the patch is optimized if possible. Available beginning with Windows Installer 3.1. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="TargetProductName" type="xs:string"> <xs:annotation> <xs:documentation>Name of the application or target product suite.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="OptimizePatchSizeForLargeFiles" type="YesNoType"> <xs:annotation> <xs:documentation>When this attribute is set, patches for files greater than approximately 4 MB in size may be made smaller.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType></xs:element>

Referenced By

Remarks

When linking, only one PatchCreation section can be given to the linker to produce a successful result. Using this element creates a pcp file.

Definition

<xs:element name="PatchCreation"> <xs:annotation> <xs:documentation> The PatchCreation element is analogous to the main function in a C program. When linking, only one PatchCreation section can be given to the linker to produce a successful result. Using this element creates a pcp file. </xs:documentation> <xs:appinfo> <xse:remarks xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension"> <html:p xmlns:html="http://www.w3.org/1999/xhtml">You can specify any valid Windows code by by integer like 1252, or by web name like Windows-1252. See <a href="/html/codepage.htm" xmlns="http://schemas.microsoft.com/wix/2006/wi">Code Pages</a> for more information.</html:p> </xse:remarks> </xs:appinfo> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element ref="PatchInformation" /> <xs:element ref="PatchMetadata" minOccurs="0" /> <xs:element ref="Family" maxOccurs="unbounded" /> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element ref="PatchProperty" /> <xs:element ref="PatchSequence" /> <xs:element ref="ReplacePatch" /> <xs:element ref="TargetProductCode" /> </xs:choice> </xs:sequence> <xs:attribute name="Id" type="Guid" use="required"> <xs:annotation> <xs:documentation>PatchCreation identifier; this is the primary key for identifying patches.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="AllowMajorVersionMismatches" type="YesNoType"> <xs:annotation> <xs:documentation>Use this to set whether the major versions between the upgrade and target images match. See <a href="http://msdn2.microsoft.com/library/aa370890.aspx" target="_blank" xmlns="http://schemas.microsoft.com/wix/2006/wi">AllowProductVersionMajorMismatches</a> for more information.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="AllowProductCodeMismatches" type="YesNoType"> <xs:annotation> <xs:documentation>Use this to set whether the product code between the upgrade and target images match. See <a href="http://msdn2.microsoft.com/library/aa370890.aspx" target="_blank" xmlns="http://schemas.microsoft.com/wix/2006/wi">AllowProductCodeMismatches</a> for more information.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="CleanWorkingFolder" type="YesNoType"> <xs:annotation> <xs:documentation>Use this to set whether Patchwiz should clean the temp folder when finished. See <a href="http://msdn2.microsoft.com/library/aa370890.aspx" target="_blank" xmlns="http://schemas.microsoft.com/wix/2006/wi">DontRemoveTempFolderWhenFinished</a> for more information. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Codepage" type="xs:string"> <xs:annotation> <xs:documentation>The code page integer value or web name for the resulting PCP. See remarks for more information.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="OutputPath" type="xs:string"> <xs:annotation> <xs:documentation>The full path, including file name, of the patch package file that is to be generated. See <a href="http://msdn2.microsoft.com/library/aa370890.aspx" target="_blank" xmlns="http://schemas.microsoft.com/wix/2006/wi">PatchOutputPath</a> for more information.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="SourceList" type="xs:string"> <xs:annotation> <xs:documentation>Used to locate the .msp file for the patch if the cached copy is unavailable. See <a href="http://msdn2.microsoft.com/library/aa370890.aspx" target="_blank" xmlns="http://schemas.microsoft.com/wix/2006/wi">PatchSourceList</a> for more information.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="SymbolFlags" type="xs:int"> <xs:annotation> <xs:documentation>An 8-digit hex integer representing the combination of patch symbol usage flags to use when creating a binary file patch. See <a href="http://msdn2.microsoft.com/library/aa370890.aspx" target="_blank" xmlns="http://schemas.microsoft.com/wix/2006/wi">ApiPatchingSymbolFlags</a> for more information.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="WholeFilesOnly" type="YesNoType"> <xs:annotation> <xs:documentation>Use this to set whether changing files should be included in their entirety. See <a href="http://msdn2.microsoft.com/library/aa370890.aspx" target="_blank" xmlns="http://schemas.microsoft.com/wix/2006/wi">IncludeWholeFilesOnly</a> for more information.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType></xs:element>

Element: PatchFamily

Description

Collection of items that should be kept from the differences between two products.

Derived By

Attributes

Content Model

Always empty.

Definition

<xs:element name="PatchFamilyRef"> <xs:annotation> <xs:appinfo> <xse:seeAlso ref="PatchFamily" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation> This will cause the entire contents of the Fragment containing the referenced PatchFamily to be used in the process of creating a patch. </xs:documentation> </xs:annotation> <xs:complexType> <xs:attribute name="Id" type="xs:string" use="required"> <xs:annotation> <xs:documentation>The identifier of the CustomAction to reference.</xs:documentation> </xs:annotation> </xs:attribute> <xs:anyAttribute namespace="##other" processContents="lax"> <xs:annotation> <xs:documentation> Extensibility point in the WiX XML Schema. Schema extensions can register additional attributes at this point in the schema. </xs:documentation> </xs:annotation> </xs:anyAttribute> </xs:complexType></xs:element>

Content Model

Referenced By

Remarks

The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="PatchFiles" type="ActionSequenceType"> <xs:annotation> <xs:appinfo> <xse:msiRef action="PatchFiles" href="http://msdn.microsoft.com/library/aa370577.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Queries the Patch table to determine which patches are to be applied. The condition for this action may be specified in the element's inner text.</xs:documentation> </xs:annotation></xs:element>

Element: PatchInformation

Description

Properties about the patch to be placed in the Summary Information Stream.

Content Model

Referenced By

Remarks

When under a Registry element, this cannot be used if the Action attribute's value is remove or removeKeyOnInstall. This element has no Id attribute. The table and key are taken from the parent element.

Content Model

Referenced By

Definition

<xs:element name="Publish"> <xs:annotation> <xs:appinfo> <xse:msiRef table="ControlEvent" href="http://msdn.microsoft.com/library/aa368037.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> </xs:annotation> <xs:complexType> <xs:simpleContent> <xs:extension base="xs:string"> <xs:annotation> <xs:documentation>The element value is the optional Condition expression.</xs:documentation> </xs:annotation> <xs:attribute name="Control" type="xs:string"> <xs:annotation> <xs:documentation> The parent Control for this Publish element, should only be specified when this element is a child of the UI element. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Dialog" type="xs:string"> <xs:annotation> <xs:documentation> The parent Dialog for this Publish element, should only be specified when this element is a child of the UI element. This attribute will create a reference to the specified Dialog, so an additional DialogRef is not necessary. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Event" type="xs:string"> <xs:annotation> <xs:documentation> Set this attribute's value to one of the standard control events to trigger that event. Either this attribute or the Property attribute must be set, but not both at the same time. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Order" type="xs:string"> <xs:annotation> <xs:documentation> This attribute should only need to be set if this element is nested under a UI element in order to control the order in which this publish event will be started. If this element is nested under a Control element, the default value will be one greater than any previous Publish element's order (the first element's default value is 1). If this element is nested under a UI element, the default value is always 1 (it does not get a default value based on any previous Publish elements). </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Property" type="xs:string"> <xs:annotation> <xs:documentation> Set this attribute's value to a property name to set that property. Either this attribute or the Event attribute must be set, but not both at the same time. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="Value" type="xs:string"> <xs:annotation> <xs:documentation> If the Property attribute is specified, set the value of this attribute to the new value for the property. To set a property to null, do not set this attribute (the ControlEvent Argument column will be set to '{}'). Otherwise, this attribute's value should be the argument for the event specified in the Event attribute. </xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:simpleContent> </xs:complexType></xs:element>

Element: PublishComponents

Description

Manages the advertisement of the components from the PublishComponent table.

Content Model

Referenced By

Remarks

The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="PublishComponents" type="ActionSequenceType"> <xs:annotation> <xs:appinfo> <xse:msiRef action="PublishComponents" href="http://msdn.microsoft.com/library/aa370918.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Manages the advertisement of the components from the PublishComponent table. The condition for this action may be specified in the element's inner text.</xs:documentation> </xs:annotation></xs:element>

Content Model

Referenced By

Remarks

The condition for this action may be specified in the element's inner text.

Definition

<xs:element name="PublishFeatures" type="ActionSequenceType"> <xs:annotation> <xs:appinfo> <xse:msiRef action="PublishFeatures" href="http://msdn.microsoft.com/library/aa370923.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" /> </xs:appinfo> <xs:documentation>Writes each feature's state into the system registry. The condition for this action may be specified in the element's inner text.</xs:documentation> </xs:annotation></xs:element>