powershell-wix

1.0.8

en-US/powershell-wix-help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<helpItems xmlns="http://msh" schema="maml">

<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

<command:details><command:name>Get-WixLocalConfig</command:name>

<command:verb>Get</command:verb>

<command:noun>WixLocalConfig</command:noun>

<maml:description><maml:para>Returns the local WiX configuration.

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>This function returns an object representing the local WiX configuration. Configuration is returned from a JSON formatted config file (default location: '..wix.json'). Sensible default values are returned if they are not contained in this file. Upgrade codes are generated and stored if they do not exist.

</maml:para>

<maml:para>Individual configuration values can also be selected. If no configuration values are selected, all values are returned.

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>Get-WixLocalConfig</maml:name>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>Path</maml:name>

<maml:Description><maml:para>Folder to look for a '.wix' file.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-Location).Path</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AboutLink</maml:name>

<maml:Description><maml:para>Include "AboutLink" in returned object.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HelpLink</maml:name>

<maml:Description><maml:para>Include "HelpLink" in returned object.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Manufacturer</maml:name>

<maml:Description><maml:para>Include "Manufacturer" in returned object.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ProductName</maml:name>

<maml:Description><maml:para>Include "ProductName" in returned object.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ProductShortName</maml:name>

<maml:Description><maml:para>Include "ProductShortName" in returned object.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ProductVersion</maml:name>

<maml:Description><maml:para>Include "ProductVersion" in returned object.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>UpgradeCodeX64</maml:name>

<maml:Description><maml:para>Include "UpgradeCodeX64" in returned object.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>UpgradeCodeX86</maml:name>

<maml:Description><maml:para>Include "UpgradeCodeX86" in returned object.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:syntaxItem>

</command:syntax>

<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AboutLink</maml:name>

<maml:Description><maml:para>Include "AboutLink" in returned object.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HelpLink</maml:name>

<maml:Description><maml:para>Include "HelpLink" in returned object.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Manufacturer</maml:name>

<maml:Description><maml:para>Include "Manufacturer" in returned object.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>Path</maml:name>

<maml:Description><maml:para>Folder to look for a '.wix' file.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-Location).Path</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ProductName</maml:name>

<maml:Description><maml:para>Include "ProductName" in returned object.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ProductShortName</maml:name>

<maml:Description><maml:para>Include "ProductShortName" in returned object.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ProductVersion</maml:name>

<maml:Description><maml:para>Include "ProductVersion" in returned object.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>UpgradeCodeX64</maml:name>

<maml:Description><maml:para>Include "UpgradeCodeX64" in returned object.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>UpgradeCodeX86</maml:name>

<maml:Description><maml:para>Include "UpgradeCodeX86" in returned object.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:parameters>

<command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name>

</dev:type>

<maml:description><maml:para>

</maml:para>

</maml:description>

</command:inputType>

</command:inputTypes>

<command:returnValues><command:returnValue><dev:type><maml:name>System.Management.Automation.PSCustomObject</maml:name>

</dev:type>

<maml:description><maml:para>A custom object representing the local WiX configuration.

</maml:para>

</maml:description>

</command:returnValue>

</command:returnValues>

<maml:alertSet><maml:alert><maml:para>NAME: Get-WixLocalConfig

</maml:para>

<maml:para>AUTHOR: Richard Grainger grainger@gmail.com

</maml:para>

</maml:alert>

</maml:alertSet>

<command:examples><command:example><maml:title>Example 1</maml:title>

<dev:code>PS C:\&gt; Get-WixLocalConfig</dev:code>

<dev:remarks><maml:para>Get local WiX configuration from '.wix.json'.

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>Example 2</maml:title>

<dev:code>PS C:\&gt; (Get-WixLocalConfig -ProductName).ProductName</dev:code>

<dev:remarks><maml:para>Get 'ProductName' as a string from '.wix.json'.

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText>

<maml:uri>https://gitlab.com/harbottle/powershell-wix/blob/master/docs/Get-WixLocalConfig.md</maml:uri>

</maml:navigationLink>

</command:relatedLinks>

</command:command>

<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

<command:details><command:name>Set-WixLocalConfig</command:name>

<command:verb>Set</command:verb>

<command:noun>WixLocalConfig</command:noun>

<maml:description><maml:para>Sets local WiX configuration.

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>This function accepts an object representing configuration settings or individual configuration settings and writes them to a JSON formatted file (default location: '.wix.json'). It returns the new configuration.

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>Set-WixLocalConfig</maml:name>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AboutLink</maml:name>

<maml:Description><maml:para>Set "AboutLink" value.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HelpLink</maml:name>

<maml:Description><maml:para>Set "HelpLink" value.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Manufacturer</maml:name>

<maml:Description><maml:para>Set "Manufacturer" value.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Path</maml:name>

<maml:Description><maml:para>Folder to look for a '.wix' file.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-Location).Path</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ProductName</maml:name>

<maml:Description><maml:para>Set "ProductName" value.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ProductShortName</maml:name>

<maml:Description><maml:para>Set "ProductShortName" value.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ProductVersion</maml:name>

<maml:Description><maml:para>Set "ProductVersion" value.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Replace</maml:name>

<maml:Description><maml:para>Replace all existing configuration with new settings.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>UpgradeCodeX64</maml:name>

<maml:Description><maml:para>Set "UpgradeCodeX64" value.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>UpgradeCodeX86</maml:name>

<maml:Description><maml:para>Set "UpgradeCodeX86" value.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

</command:syntaxItem>

<command:syntaxItem><maml:name>Set-WixLocalConfig</maml:name>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Settings</maml:name>

<maml:Description><maml:para>Object containing all settings to be set.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

<dev:type><maml:name>Object</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Path</maml:name>

<maml:Description><maml:para>Folder to look for a '.wix' file.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-Location).Path</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Replace</maml:name>

<maml:Description><maml:para>Replace all existing configuration with new settings.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

</command:syntaxItem>

</command:syntax>

<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AboutLink</maml:name>

<maml:Description><maml:para>Set "AboutLink" value.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HelpLink</maml:name>

<maml:Description><maml:para>Set "HelpLink" value.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Manufacturer</maml:name>

<maml:Description><maml:para>Set "Manufacturer" value.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Path</maml:name>

<maml:Description><maml:para>Folder to look for a '.wix' file.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-Location).Path</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ProductName</maml:name>

<maml:Description><maml:para>Set "ProductName" value.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ProductShortName</maml:name>

<maml:Description><maml:para>Set "ProductShortName" value.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ProductVersion</maml:name>

<maml:Description><maml:para>Set "ProductVersion" value.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Replace</maml:name>

<maml:Description><maml:para>Replace all existing configuration with new settings.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"><maml:name>Settings</maml:name>

<maml:Description><maml:para>Object containing all settings to be set.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">Object</command:parameterValue>

<dev:type><maml:name>Object</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>UpgradeCodeX64</maml:name>

<maml:Description><maml:para>Set "UpgradeCodeX64" value.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>UpgradeCodeX86</maml:name>

<maml:Description><maml:para>Set "UpgradeCodeX86" value.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>None</dev:defaultValue>

</command:parameter>

</command:parameters>

<command:inputTypes><command:inputType><dev:type><maml:name>System.Management.Automation.PSCustomObject</maml:name>

</dev:type>

<maml:description><maml:para>A custom object representing the local WiX configuration. Use Get-WixLocalConfig to see an example of the object format.

</maml:para>

</maml:description>

</command:inputType>

</command:inputTypes>

<command:returnValues><command:returnValue><dev:type><maml:name>System.Management.Automation.PSCustomObject</maml:name>

</dev:type>

<maml:description><maml:para>A custom object representing the new local WiX configuration.

</maml:para>

</maml:description>

</command:returnValue>

</command:returnValues>

<maml:alertSet><maml:alert><maml:para>NAME: Set-WixLocalConfig

</maml:para>

<maml:para>AUTHOR: Richard Grainger grainger@gmail.com

</maml:para>

</maml:alert>

</maml:alertSet>

<command:examples><command:example><maml:title>Example 1</maml:title>

<dev:code>PS C:\&gt; Set-WixLocalConfig -ProductName "My Awesome PowerShell Module"</dev:code>

<dev:remarks><maml:para>Sets the 'ProductName' setting in default config file '.wix.json'.

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText>

<maml:uri>https://gitlab.com/harbottle/powershell-wix/blob/master/docs/Set-WixLocalConfig.md</maml:uri>

</maml:navigationLink>

</command:relatedLinks>

</command:command>

<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

<command:details><command:name>Start-WixBuild</command:name>

<command:verb>Start</command:verb>

<command:noun>WixBuild</command:noun>

<maml:description><maml:para>Converts a PowerShell module folder to installable MSI package files.

</maml:para>

</maml:description>

</command:details>

<maml:description><maml:para>This function uses the WiX Toolset to convert a directory containing a PowerShell module to an installable Microsoft Installer package file (MSI). By default 32bit and 64bit MSI files are generated. The target install directories for the MSI files are set to:

</maml:para>

<maml:para>- C:\Program Files\WindowsPowerShell\Modules (64bit MSI on 64bit Windows and 32bit MSI on 32bit Windows).

</maml:para>

<maml:para>- C:\Program Files (x86)\WindowsPowerShell\Modules (32bit MSI on 64bit Windows).

</maml:para>

<maml:para>

</maml:para>

<maml:para>See the each function parameter for options.

</maml:para>

</maml:description>

<command:syntax><command:syntaxItem><maml:name>Start-WixBuild</maml:name>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>Path</maml:name>

<maml:Description><maml:para>The path to the folder containing the PowerShell module to be converted. Defaults to current directory.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-Location).Path</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AboutLink</maml:name>

<maml:Description><maml:para>URL for more information.  The URL will be displayed in 'Add/Remove Programs' for your package.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-WiXLocalConfig -AboutLink -Path $Path).AboutLink</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>BannerFile</maml:name>

<maml:Description><maml:para>The path to a bitmap file (.bmp). The image will be displayed at the top of dialogue screens for your package. Defaults to 'dialog.bmp' in the current directory. If this can't be found an included PowerShell dialog image is used.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>$Path\banner.bmp</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DialogFile</maml:name>

<maml:Description><maml:para>The path to a bitmap file (.bmp). The image will be displayed on the first installer dialogue screen for your package. Defaults to 'dialog.bmp' in the current directory. If this can't be found an included PowerShell dialog image is used.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>$Path\dialog.bmp</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Exclude</maml:name>

<maml:Description><maml:para>An array of file and folder patterns to exclude from the generated MSI package files. Defaults to @('.git','.gitignore','\*.msi')

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>

<dev:type><maml:name>String[]</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>@('.git','.gitignore','*.msi')</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HelpLink</maml:name>

<maml:Description><maml:para>URL for more help. The URL will be displayed in 'Add/Remove Programs' for your package.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-WiXLocalConfig -HelpLink -Path $Path).HelpLink</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IconFile</maml:name>

<maml:Description><maml:para>The path to an icon file (.ico). The icon will be displayed in 'Add/Remove Programs' for your package. Defaults to 'icon.ico' in the current directory. If this can't be found an included PowerShell icon is used.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>$Path\icon.ico</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Increment</maml:name>

<maml:Description><maml:para>The part of the version number to increment.  To prevent a version number increment, set this to 0. Defaults to 3.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>

<dev:type><maml:name>Int32</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>3</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>LicenseFile</maml:name>

<maml:Description><maml:para>The Rich Text File (.rtf) to use as a licence during installation of your package.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>$Path\license.rtf</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Manufacturer</maml:name>

<maml:Description><maml:para>The package manufacturer

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-WiXLocalConfig -Manufacturer -Path $Path).Manufacturer</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>NoX64</maml:name>

<maml:Description><maml:para>Do not build x64 package.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>NoX86</maml:name>

<maml:Description><maml:para>Do not build x86 package.

</maml:para>

</maml:Description>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>OutputFolder</maml:name>

<maml:Description><maml:para>The path to the folder to out the MSI package files. Defaults to current directory.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-Location).Path</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ProductName</maml:name>

<maml:Description><maml:para>Product name

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-WiXLocalConfig -ProductName -Path $Path).ProductName</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ProductShortName</maml:name>

<maml:Description><maml:para>Short product name

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-WiXLocalConfig -ProductShortName -Path $Path).ProductShortName</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ProductVersion</maml:name>

<maml:Description><maml:para>{{Fill ProductVersion Description}}

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-WiXLocalConfig -ProductVersion -Path $Path).ProductVersion</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>UpgradeCodeX64</maml:name>

<maml:Description><maml:para>X64 upgrade code

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-WiXLocalConfig -UpgradeCodeX64 -Path $Path).UpgradeCodeX64</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>UpgradeCodeX86</maml:name>

<maml:Description><maml:para>X86 upgrade code

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-WiXLocalConfig -UpgradeCodeX86 -Path $Path).UpgradeCodeX86</dev:defaultValue>

</command:parameter>

</command:syntaxItem>

</command:syntax>

<command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AboutLink</maml:name>

<maml:Description><maml:para>URL for more information.  The URL will be displayed in 'Add/Remove Programs' for your package.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-WiXLocalConfig -AboutLink -Path $Path).AboutLink</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>BannerFile</maml:name>

<maml:Description><maml:para>The path to a bitmap file (.bmp). The image will be displayed at the top of dialogue screens for your package. Defaults to 'dialog.bmp' in the current directory. If this can't be found an included PowerShell dialog image is used.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>$Path\banner.bmp</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>DialogFile</maml:name>

<maml:Description><maml:para>The path to a bitmap file (.bmp). The image will be displayed on the first installer dialogue screen for your package. Defaults to 'dialog.bmp' in the current directory. If this can't be found an included PowerShell dialog image is used.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>$Path\dialog.bmp</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Exclude</maml:name>

<maml:Description><maml:para>An array of file and folder patterns to exclude from the generated MSI package files. Defaults to @('.git','.gitignore','\*.msi')

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>

<dev:type><maml:name>String[]</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>@('.git','.gitignore','*.msi')</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>HelpLink</maml:name>

<maml:Description><maml:para>URL for more help. The URL will be displayed in 'Add/Remove Programs' for your package.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-WiXLocalConfig -HelpLink -Path $Path).HelpLink</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IconFile</maml:name>

<maml:Description><maml:para>The path to an icon file (.ico). The icon will be displayed in 'Add/Remove Programs' for your package. Defaults to 'icon.ico' in the current directory. If this can't be found an included PowerShell icon is used.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>$Path\icon.ico</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Increment</maml:name>

<maml:Description><maml:para>The part of the version number to increment.  To prevent a version number increment, set this to 0. Defaults to 3.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>

<dev:type><maml:name>Int32</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>3</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>LicenseFile</maml:name>

<maml:Description><maml:para>The Rich Text File (.rtf) to use as a licence during installation of your package.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>$Path\license.rtf</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Manufacturer</maml:name>

<maml:Description><maml:para>The package manufacturer

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-WiXLocalConfig -Manufacturer -Path $Path).Manufacturer</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>NoX64</maml:name>

<maml:Description><maml:para>Do not build x64 package.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>NoX86</maml:name>

<maml:Description><maml:para>Do not build x86 package.

</maml:para>

</maml:Description>

<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

<dev:type><maml:name>SwitchParameter</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>False</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>OutputFolder</maml:name>

<maml:Description><maml:para>The path to the folder to out the MSI package files. Defaults to current directory.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-Location).Path</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"><maml:name>Path</maml:name>

<maml:Description><maml:para>The path to the folder containing the PowerShell module to be converted. Defaults to current directory.

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-Location).Path</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ProductName</maml:name>

<maml:Description><maml:para>Product name

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-WiXLocalConfig -ProductName -Path $Path).ProductName</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ProductShortName</maml:name>

<maml:Description><maml:para>Short product name

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-WiXLocalConfig -ProductShortName -Path $Path).ProductShortName</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ProductVersion</maml:name>

<maml:Description><maml:para>{{Fill ProductVersion Description}}

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-WiXLocalConfig -ProductVersion -Path $Path).ProductVersion</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>UpgradeCodeX64</maml:name>

<maml:Description><maml:para>X64 upgrade code

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-WiXLocalConfig -UpgradeCodeX64 -Path $Path).UpgradeCodeX64</dev:defaultValue>

</command:parameter>

<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>UpgradeCodeX86</maml:name>

<maml:Description><maml:para>X86 upgrade code

</maml:para>

</maml:Description>

<command:parameterValue required="true" variableLength="false">String</command:parameterValue>

<dev:type><maml:name>String</maml:name>

<maml:uri /></dev:type>

<dev:defaultValue>(Get-WiXLocalConfig -UpgradeCodeX86 -Path $Path).UpgradeCodeX86</dev:defaultValue>

</command:parameter>

</command:parameters>

<command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name>

</dev:type>

<maml:description><maml:para>

</maml:para>

</maml:description>

</command:inputType>

</command:inputTypes>

<command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name>

</dev:type>

<maml:description><maml:para>

</maml:para>

</maml:description>

</command:returnValue>

</command:returnValues>

<maml:alertSet><maml:alert><maml:para>NAME: Start-WixBuild

</maml:para>

<maml:para>AUTHOR: Richard Grainger grainger@gmail.com

</maml:para>

</maml:alert>

</maml:alertSet>

<command:examples><command:example><maml:title>Example 1</maml:title>

<dev:code>PS C:\&gt; Start-WixBuild</dev:code>

<dev:remarks><maml:para>Convert the current directory, containing a PowerShell module, into installable MSI package files.

</maml:para>

</dev:remarks>

</command:example>

<command:example><maml:title>Example 2</maml:title>

<dev:code>PS C:\&gt; Start-WixBuild -Path 'C:\users\myuser\mymodules\awesomemodule'</dev:code>

<dev:remarks><maml:para>Convert a PowerShell module in 'C:\users\myuser\mymodules\awesomemodule' into installable MSI package files.

</maml:para>

</dev:remarks>

</command:example>

</command:examples>

<command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText>

<maml:uri>https://gitlab.com/harbottle/powershell-wix/blob/master/docs/Start-WixBuild.md</maml:uri>

</maml:navigationLink>

</command:relatedLinks>

</command:command>

</helpItems>