WiX Toolset

https://github.com/wixtoolset/wix
Admin
The WiX Toolset is a powerful set of tools for creating Windows installation experiences.
Tokens:624,800
Snippets:3,003
Trust Score:8.7
Update:2 days ago
Show doc for...
Tokens:
Raw
### Install WiX CLI tool

Source: https://github.com/wixtoolset/wix/blob/main/src/wix/pack-wix/README.md

Command to install the latest version of the WiX command-line tool globally.

```bash
dotnet tool install --global wix
```

--------------------------------

### Add WixToolset.Iis.wixext as a PackageReference in .wixproj

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Iis/README.md

Add the WiX extension as a PackageReference to your .wixproj. This is the first step in getting started with the IIS extension.

```xml
<Project Sdk="WixToolset.Sdk/8.0.0">
  <ItemGroup>
    <PackageReference Include="WixToolset.Iis.wixext" Version="8.0.0" />
  </ItemGroup>
</Project>
```

--------------------------------

### Verify WiX installation

Source: https://github.com/wixtoolset/wix/blob/main/src/wix/pack-wix/README.md

Command to verify that the WiX tool was successfully installed.

```bash
wix --version
```

--------------------------------

### Add WixToolset.Msmq.wixext PackageReference to .wixproj

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Msmq/README.md

Add the WixToolset.Msmq.wixext extension as a PackageReference in a .wixproj file. The example uses WixToolset.Sdk/8.0.0 and WixToolset.Msmq.wixext version 8.0.0.

```xml
<Project Sdk="WixToolset.Sdk/8.0.0">
  <ItemGroup>
    <PackageReference Include="WixToolset.Msmq.wixext" Version="8.0.0" />
  </ItemGroup>
</Project>
```

--------------------------------

### Add WixToolset.ComPlus.wixext as a PackageReference

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/ComPlus/README.md

Add the WiX extension as a PackageReference to your .wixproj file. The example uses version 8.0.0 of the extension.

```xml
<Project Sdk="WixToolset.Sdk/8.0.0">
  <ItemGroup>
    <PackageReference Include="WixToolset.ComPlus.wixext" Version="8.0.0" />
  </ItemGroup>
</Project>
```

--------------------------------

### Add WixToolset.NetFx.wixext as PackageReference

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/NetFx/README.md

Add the WiX extension as a PackageReference to your .wixproj. This example uses WixToolset.Sdk/8.0.0 and WixToolset.NetFx.wixext version 8.0.0.

```xml
<Project Sdk="WixToolset.Sdk/8.0.0">
  <ItemGroup>
    <PackageReference Include="WixToolset.NetFx.wixext" Version="8.0.0" />
  </ItemGroup>
</Project>
```

--------------------------------

### Add WixToolset.Util.wixext PackageReference to .wixproj

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Util/README.md

Add the WiX Extension as a PackageReference to your .wixproj. This example uses WixToolset.Sdk/8.0.0 and WixToolset.Util.wixext version 8.0.0.

```xml
<Project Sdk="WixToolset.Sdk/8.0.0">
  <ItemGroup>
    <PackageReference Include="WixToolset.Util.wixext" Version="8.0.0" />
  </ItemGroup>
</Project>
```

--------------------------------

### DDiff command-line usage and options

Source: https://github.com/wixtoolset/wix/blob/main/src/tools/Dtf/Documents/Guide/Content/powerdiff.htm

Shows the DDiff command syntax with examples for directories, MSI files, MSP patches with a target MSI, and CAB files. The /o option outputs results to a UTF8 text file, and /p specifies a target MSI for patch diffs.

```text
Usage: DDiff target1 target2 [options]
Example: DDiff d:\dir1 d:\dir2
Example: DDiff setup1.msi setup2.msi
Example: DDiff patch1.msp patch2.msp -patchtarget target.msi
Example: DDiff package1.cab package2.cab

Options:
  /o [filename]    Output results to text file (UTF8)
  /p [package.msi] Diff patches relative to target MSI
```

--------------------------------

### Add the IIS extension namespace to the Wix element

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Iis/README.md

Add the extension's namespace to the Wix element. This is the second step in getting started with the IIS extension.

```xml
<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs"
     xmlns:iis="http://wixtoolset.org/schemas/v4/wxs/iis">

  ..
</Wix>
```

--------------------------------

### Add the COM+ extension namespace to WiX source

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/ComPlus/README.md

Add the extension's namespace to your WiX source file. The example shows the required xmlns declaration for the COM+ extension.

```xml
<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs"
     xmlns:complus="http://wixtoolset.org/schemas/v4/wxs/complus">

  ..
</Wix>
```

--------------------------------

### Add util namespace to WiX file

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Util/README.md

Add the extension's namespace to a WiX file. This example shows the xmlns:util attribute with the URI http://wixtoolset.org/schemas/v4/wxs/util.

```xml
<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs"
     xmlns:util="http://wixtoolset.org/schemas/v4/wxs/util">

  ..
</Wix>
```

--------------------------------

### Add netfx namespace to Wix element

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/NetFx/README.md

Add the extension's namespace to the Wix element. This example shows the xmlns:netfx attribute pointing to the v4 netfx schema.

```xml
<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs"
     xmlns:netfx="http://wixtoolset.org/schemas/v4/wxs/netfx">

  ..
</Wix>
```

--------------------------------

### Add MSMQ extension namespace to Wix element

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Msmq/README.md

Add the MSMQ extension namespace to the Wix element in a WiX source file. The example shows the xmlns:msmq attribute pointing to http://wixtoolset.org/schemas/v4/wxs/msmq.

```xml
<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs"
     xmlns:msmq="http://wixtoolset.org/schemas/v4/wxs/msmq">

  ..
</Wix>
```

--------------------------------

### Minimal .wixproj project file

Source: https://github.com/wixtoolset/wix/blob/main/src/wix/WixToolset.Sdk/README.md

A minimal SDK-style project file for WiX using the WixToolset.Sdk.

```xml
<Project Sdk="WixToolset.Sdk/8.0.0">
</Project>
```

--------------------------------

### Create a cabinet with CabInfo.Pack

Source: https://github.com/wixtoolset/wix/blob/main/src/tools/Dtf/Documents/Guide/Content/cabs.htm

Creates a new CabInfo instance for the target .cab file and packs an entire directory using the Pack method.

```csharp
    CabInfo cabInfo = new CabInfo("package.cab");
    cabInfo.Pack("D:\\FilesToCompress");
```

--------------------------------

### Build MSI command

Source: https://github.com/wixtoolset/wix/blob/main/src/wix/WixToolset.Sdk/README.md

Command to build the MSI from the command-line.

```bash
dotnet build
```

--------------------------------

### SampleCustomAction1: Log, Read Property, and Query Database

Source: https://github.com/wixtoolset/wix/blob/main/src/tools/Dtf/Documents/Guide/Content/samplecas.htm

Use this custom action to verify that a property value in the session matches the value stored in the MSI database. It logs a message, reads the 'SampleCATest' property from the session, executes a SQL query to fetch the same property from the 'Property' table, and returns Success if they match, otherwise Failure.

```C#
    [CustomAction]
    public static ActionResult SampleCustomAction1(Session session)
    {
        session.Log("Hello from SampleCA1");
        
        string testProp = session["SampleCATest"];
        string testProp2;
        testProp2 = (string) session.Database.ExecuteScalar(
            "SELECT `Value` FROM `Property` WHERE `Property` = 'SampleCATest'");
        
        if(testProp == testProp2)
        {
            session.Log("Simple property test passed.");
            return ActionResult.Success;
        }
        else
            return ActionResult.Failure;
    }
```

--------------------------------

### List cabinet contents with CabInfo.GetFiles

Source: https://github.com/wixtoolset/wix/blob/main/src/tools/Dtf/Documents/Guide/Content/cabs.htm

Creates a CabInfo instance and enumerates files using GetFiles, printing each file's name and length.

```csharp
    CabInfo cabInfo = new CabInfo("package.cab");
    foreach (CabFileInfo fileInfo in cabInfo.GetFiles())
        Console.WriteLine(fileInfo.Name + "\t" + fileInfo.Length);
```

--------------------------------

### Reading 64-bit Registry Values

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Bal/Samples/bafunctions/Readme.txt

Opens a registry key, reads a string value, and updates the InstallFolder variable.

```cpp
        hr = RegOpen(HKEY_LOCAL_MACHINE, L"SOFTWARE\\Microsoft\\NET Framework Setup\\NDP\\v3.5", KEY_READ | KEY_WOW64_64KEY, &hkKey);
        BalExitOnFailure(hr, "Failed to open registry key.");

        hr = RegReadString(hkKey, L"InstallPath", &sczValue);
        BalExitOnFailure(hr, "Failed to read registry value.");

        // Example of function call
        PathBackslashTerminate(&sczValue);

        hr = m_pEngine->SetVariableString(L"InstallFolder", sczValue);
        BalExitOnFailure(hr, "Failed to set variable.");
```

--------------------------------

### WiFile.exe usage syntax

Source: https://github.com/wixtoolset/wix/blob/main/src/tools/Dtf/Documents/Guide/Content/wifile.htm

Shows the command-line syntax for WiFile.exe to list, extract, or update files in an MSI or MSM package. Filenames are relative to the package and may include wildcards like *.exe or file?.dll.

```text
Usage: WiFile.exe package.msi /l [filename,filename2,...]
Usage: WiFile.exe package.msi /x [filename,filename2,...]
Usage: WiFile.exe package.msi /u [filename,filename2,...]

Lists (/l), extracts (/x) or updates (/u) files in an MSI or MSM.
Files are extracted using their source path relative to the package.
Specified filenames do not include paths.
Filenames may be a pattern such as *.exe or file?.dll
```

--------------------------------

### Update files in a product layout using InstallPackage

Source: https://github.com/wixtoolset/wix/blob/main/src/tools/Dtf/Documents/Guide/Content/packages.htm

Use this C# snippet to update files in an MSI package layout. It creates an InstallPackage instance, sets the working directory, copies files to their source paths, calls UpdateFiles to re-compress and update file metadata, then commits and cleans up.

```csharp
    using (InstallPackage pkg = new InstallPackage("d:\builds\product.msi",
        DatabaseOpenMode.Transact))
    {
        pkg.WorkingDirectory = Path.Combine(Path.GetTempFolder(), "pkgtmp");
        foreach (string fileKey in files.Keys)
        {
            string sourceFilePath = files[fileKey];
            string destFilePath = pkg.Files[fileKey].SourcePath;
            destFilePath = Path.Combine(pkg.WorkingDirectory, destFilePath);
            File.Copy(sourceFilePath, destFilePath, true);
        }
        pkg.UpdateFiles(new ArrayList(files.Keys));
        pkg.Commit();
        Directory.Delete(pkg.WorkingDirectory, true);
    }
```

--------------------------------

### CabPack and XPack command-line usage

Source: https://github.com/wixtoolset/wix/blob/main/src/tools/Dtf/Documents/Guide/Content/cabpack.htm

Command-line usage for the CabPack and XPack tools. CabPack packs a directory into a CAB file. XPack with /P packs a directory into a CAB or ZIP archive, overwriting any existing archive. XPack with /U unpacks a CAB or ZIP archive to a directory, overwriting existing files.

```text
Usage: CabPack.exe <directory> <package.cab>
Usage: XPack /P <archive.cab> <directory>
Usage: XPack /P <archive.zip> <directory>

Packs all files in a directory tree into an archive,
using either the cab or zip format. Any existing archive
with the same name will be overwritten.


Usage: XPack /U <archive.cab> <directory>
Usage: XPack /U <archive.zip> <directory>

Unpacks all files from a cab or zip archive to the
specified directory. Any existing files with the same
names will be overwritten.
```

--------------------------------

### Add Firewall Extension PackageReference

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Firewall/README.md

Add the WixToolset.Firewall.wixext package to your .wixproj file to enable firewall configuration capabilities.

```xml
<Project Sdk="WixToolset.Sdk/8.0.0">
  <ItemGroup>
    <PackageReference Include="WixToolset.Firewall.wixext" Version="8.0.0" />
  </ItemGroup>
</Project>
```

--------------------------------

### Configure WixStandardBootstrapperApplication in Bundle

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Bal/wixext-backward-compatible/README.md

Define the bootstrapper application within the Bundle element using the bal namespace.

```xml
<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs"
     xmlns:bal="http://wixtoolset.org/schemas/v4/wxs/bal">
  <Bundle BundleId="AcmeCorp.Example" Name="Example Bundle" Version="0.0.0.1" Manufacturer="ACME Corporation">
    <BootstrapperApplication>
      <bal:WixStandardBootstrapperApplication LicenseUrl="http://wixtoolset.org/about/license/" Theme="hyperlinkLicense" />
    </BootstrapperApplication>
  </Bundle>
</Wix>
```

--------------------------------

### Add WixToolset.Http.wixext PackageReference

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Http/README.md

Include the extension in your .wixproj file using a PackageReference.

```xml
<Project Sdk="WixToolset.Sdk/8.0.0">
  <ItemGroup>
    <PackageReference Include="WixToolset.Http.wixext" Version="8.0.0" />
  </ItemGroup>
</Project>
```

--------------------------------

### Round-trip update with WiFile.exe

Source: https://github.com/wixtoolset/wix/blob/main/src/tools/Dtf/Documents/Guide/Content/wifile.htm

Round-trip update workflow: first extract all files from a compressed MSI/MSM package, then update the package with the changed files. The /u command also updates file metadata such as version, size, and hash.

```text
WiFile.exe package.msi /x *
```

```text
WiFile.exe package.msi /u *
```

--------------------------------

### Extract a cabinet with CabInfo.Unpack

Source: https://github.com/wixtoolset/wix/blob/main/src/tools/Dtf/Documents/Guide/Content/cabs.htm

Creates a CabInfo instance and extracts all files to a directory using the Unpack method.

```csharp
    CabInfo cabInfo = new CabInfo("package.cab");
    cabInfo.Unpack("D:\\ExtractedFiles");
```

--------------------------------

### Add WixToolset.BootstrapperApplications.wixext PackageReference to .wixproj

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Bal/README.md

Add the WiX Extension as a PackageReference to your .wixproj. Uses WixToolset.Sdk/8.0.0 and WixToolset.BootstrapperApplications.wixext version 8.0.0.

```xml
<Project Sdk="WixToolset.Sdk/8.0.0">
  <ItemGroup>
    <PackageReference Include="WixToolset.BootstrapperApplications.wixext" Version="8.0.0" />
  </ItemGroup>
</Project>
```

--------------------------------

### Add DirectX Extension PackageReference

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/DirectX/README.md

Add the WixToolset.DirectX.wixext package to your .wixproj file to enable DirectX support.

```xml
<Project Sdk="WixToolset.Sdk/8.0.0">
  <ItemGroup>
    <PackageReference Include="WixToolset.DirectX.wixext" Version="8.0.0" />
  </ItemGroup>
</Project>
```

--------------------------------

### Add WixToolset.UI.wixext PackageReference

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/UI/README.md

Include the extension as a PackageReference within your .wixproj file to enable UI functionality.

```xml
<Project Sdk="WixToolset.Sdk/8.0.0">
  <ItemGroup>
    <PackageReference Include="WixToolset.UI.wixext" Version="8.0.0" />
  </ItemGroup>
</Project>
```

--------------------------------

### Add WixToolset.Sql.wixext PackageReference

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Sql/README.md

Add the WixToolset.Sql.wixext extension as a PackageReference in your .wixproj file. This is the first step to enable SQL Server support in your WiX project.

```xml
<Project Sdk="WixToolset.Sdk/8.0.0">
  <ItemGroup>
    <PackageReference Include="WixToolset.Sql.wixext" Version="8.0.0" />
  </ItemGroup>
</Project>
```

--------------------------------

### Add PackageReference to .wixproj

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Bal/wixext-backward-compatible/README.md

Include the WixToolset.BootstrapperApplications.wixext package in your WiX project file to enable bootstrapper application functionality.

```xml
<Project Sdk="WixToolset.Sdk/6.0.2">
  <ItemGroup>
    <PackageReference Include="WixToolset.BootstrapperApplications.wixext" Version="6.0.2" />
  </ItemGroup>
</Project>
```

--------------------------------

### BA Function Failure Handling

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Bal/Samples/bafunctions/Readme.txt

Demonstrates how to trigger a BA function failure using BalExitOnFailure.

```cpp
        hr = E_NOTIMPL;
        BalExitOnFailure(hr, "Test failure.");
```

--------------------------------

### Setting Burn Variables

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Bal/Samples/bafunctions/Readme.txt

Shows how to set string and numeric variables using the engine interface.

```cpp
        hr = m_pEngine->SetVariableString(L"Variable1", L"String value");
        BalExitOnFailure(hr, "Failed to set variable.");
        hr = m_pEngine->SetVariableNumeric(L"Variable2", 1234);
        BalExitOnFailure(hr, "Failed to set variable.");
```

--------------------------------

### Add Visual Studio WiX Extension PackageReference and Namespace

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/VisualStudio/README.md

Add the WixToolset.VisualStudio.wixext package as a PackageReference in your .wixproj, then add the extension's namespace to your WiX source file.

```xml
<Project Sdk="WixToolset.Sdk/8.0.0">
  <ItemGroup>
    <PackageReference Include="WixToolset.VisualStudio.wixext" Version="8.0.0" />
  </ItemGroup>
</Project>
```

```xml
<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs"
     xmlns:vs="http://wixtoolset.org/schemas/v4/wxs/vs">

  ..
</Wix>
```

--------------------------------

### Wrap CA package with MakeSfxCA.exe

Source: https://github.com/wixtoolset/wix/blob/main/src/tools/Dtf/Documents/Guide/Content/buildingcas.htm

Packages the CA assembly, CustomAction.config, and WixToolset.Dtf.WindowsInstaller.dll into a self-extracting CA DLL using MakeSfxCA.exe. The filenames of CustomAction.config and WixToolset.Dtf.WindowsInstaller.dll must not be changed because the proxy looks for them.

```text
MakeSfxCA.exe
    $(OutDir)\SampleCAsPackage.dll
    $(DTFbin)\SfxCA.dll
    SampleCAs.dll
    CustomAction.config
    $(DTFbin)\WixToolset.Dtf.WindowsInstaller.dll
```

--------------------------------

### Sample CustomAction.config with supportedRuntime

Source: https://github.com/wixtoolset/wix/blob/main/src/tools/Dtf/Documents/Guide/Content/caconfig.htm

A sample CustomAction.config file that specifies the .NET Framework runtime version v2.0.50727 using the supportedRuntime element. This file follows the standard .NET Framework configuration schema. It is recommended to specify only the versions you have tested against to avoid compatibility issues.

```xml
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <startup>
        <supportedRuntime version="v2.0.50727"/>
    </startup>
</configuration>
```

--------------------------------

### Minimal .wxs source code

Source: https://github.com/wixtoolset/wix/blob/main/src/wix/WixToolset.Sdk/README.md

A basic WiX source file defining a package and a file to be included.

```xml
<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
  <Package Id="AcmeCorp.QuickStart" Name="QuickStart Example" Manufacturer="ACME Corp" Version="0.0.1">
    <File Source="example.txt" />
  </Package>
</Wix>
```

--------------------------------

### Compile CA assembly with csc.exe

Source: https://github.com/wixtoolset/wix/blob/main/src/tools/Dtf/Documents/Guide/Content/buildingcas.htm

Compiles the custom action assembly as a library, referencing WixToolset.Dtf.WindowsInstaller.dll and outputting SampleCAs.dll. The assembly must reference this DLL and mark exported custom actions with CustomActionAttribute.

```text
csc.exe
    /target:library
    /r:$(DTFbin)\WixToolset.Dtf.WindowsInstaller.dll
    /out:SampleCAs.dll
    *.cs
```

--------------------------------

### Add PackageReference to .wixproj

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Dependency/README.md

Include the WixToolset.Dependency.wixext package in your project file to enable dependency configuration features.

```xml
<Project Sdk="WixToolset.Sdk/8.0.0">
  <ItemGroup>
    <PackageReference Include="WixToolset.Dependency.wixext" Version="8.0.0" />
  </ItemGroup>
</Project>
```

--------------------------------

### Declare UI Namespace

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/UI/README.md

Add the ui namespace to your WiX source file to utilize the extension's features.

```xml
<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs"
     xmlns:ui="http://wixtoolset.org/schemas/v4/wxs/ui">

  ..
</Wix>
```

--------------------------------

### Calling HRESULT Functions

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Bal/Samples/bafunctions/Readme.txt

Demonstrates calling a custom function that returns an HRESULT and handling potential errors.

```cpp
        hr = GetFileVersion();
        BalExitOnFailure(hr, "Failed to get version.");
```

--------------------------------

### LINQ query to fetch custom actions from MSI database

Source: https://github.com/wixtoolset/wix/blob/main/src/tools/Dtf/Documents/Guide/Content/whatsnew.htm

Use this LINQ query to retrieve Action, Target, and Sequence for all Type 1 (DLL) custom actions from an MSI database. The query is lazily executed when the foreach loop enumerates, and results are printed to the console. Requires .NET Framework 3.5 and the DTF LINQ to MSI library.

```C#
    var actions = from a in db.InstallExecuteSequences
                  join ca in db.CustomActions on a.Action equals ca.Action
                  where ca.Type == CustomActionTypes.Dll
                  orderby a.Sequence
                  select new {
                      Name = a.Action,
                      Target = ca.Target,
                      Sequence = a.Sequence };
          
    foreach (var a in actions)
    {
        Console.WriteLine(a);
    }
    
```

--------------------------------

### Update a Binary table field with a stream

Source: https://github.com/wixtoolset/wix/blob/main/src/tools/Dtf/Documents/Guide/Content/databases.htm

Opens a database in Direct mode, creates a view for an UPDATE statement, and executes it with a record that contains a stream from a file. It demonstrates explicit resource management with a finally block to close the record, view, and database. The view's SQL uses parameter tokens (?) and String.Format syntax for substitution.

```C#
    Database db = null;
    View view = null;
    Record rec = null;
    try
    {
        db = new Database("product.msi", DatabaseOpenMode.Direct);
        view = db.OpenView("UPDATE `Binary` SET `Data` = ? WHERE `Name` = '{0}'", binName))
        rec = new Record(1);
        rec.SetStream(1, binFile);
        view.Execute(rec);
        db.Commit();
    }
    finally
    {
        if (rec != null) rec.Close();
        if (view != null) view.Close();
        if (db != null) db.Close();
    }

```

--------------------------------

### Add PowerShell WiX extension package and namespace

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/PowerShell/README.md

Add the WixToolset.PowerShell.wixext package as a PackageReference in your .wixproj, then declare the PowerShell extension namespace in your WiX source. The namespace prefix 'ps' is used for PowerShell-specific elements.

```xml
<Project Sdk="WixToolset.Sdk/8.0.0">
  <ItemGroup>
    <PackageReference Include="WixToolset.PowerShell.wixext" Version="8.0.0" />
  </ItemGroup>
</Project>
```

```xml
<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs"
     xmlns:ps="http://wixtoolset.org/schemas/v4/wxs/powershell">

  ..
</Wix>
```

--------------------------------

### Query a database property with ExecuteScalar

Source: https://github.com/wixtoolset/wix/blob/main/src/tools/Dtf/Documents/Guide/Content/databases.htm

Creates a read-only Database instance and executes a parameterized SQL query to fetch a single value from a Property table. The ExecuteScalar method is a shortcut for opening a view, executing, and fetching a single value. The query uses String.Format syntax for parameter substitution.

```C#
    using (Database db = new Database("product.msi", DatabaseOpenMode.ReadOnly))
    {
        string value = (string) db.ExecuteScalar(
            "SELECT `Value` FROM `Property` WHERE `Property` = '{0}'", propName);
    }

```

--------------------------------

### Include Firewall Namespace

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Firewall/README.md

Add the firewall namespace (fw) to your WiX source file to use the extension's elements.

```xml
<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs"
     xmlns:fw="http://wixtoolset.org/schemas/v4/wxs/firewall">

  ..
</Wix>
```

--------------------------------

### Add http namespace to WiX source

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Http/README.md

Declare the http namespace in the Wix element to use the extension's features.

```xml
<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs"
     xmlns:http="http://wixtoolset.org/schemas/v4/wxs/http">

  ..
</Wix>
```

--------------------------------

### Add SQL Extension Namespace

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Sql/README.md

Add the SQL extension namespace to your WiX source file. This is required to use SQL Server elements in your WiX project.

```xml
<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs"
     xmlns:sql="http://wixtoolset.org/schemas/v4/wxs/sql">

  ..
</Wix>
```

--------------------------------

### Declare DirectX Namespace

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/DirectX/README.md

Include the DirectX namespace in your WiX source file to use the extension's features.

```xml
<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs"
     xmlns:dx="http://wixtoolset.org/schemas/v4/wxs/directx">

  ..
</Wix>
```

--------------------------------

### Reading and Formatting Burn Variables

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Bal/Samples/bafunctions/Readme.txt

Retrieves a variable, formats the string, and updates the engine variables.

```cpp
        BalGetStringVariable(L"InstallFolder", &sczValue);
        BalExitOnFailure(hr, "Failed to get variable.");

        hr = m_pEngine->SetVariableString(L"Variable5", sczValue);
        BalExitOnFailure(hr, "Failed to set variable.");

        BalFormatString(sczValue, &sczFormatedValue);
        BalExitOnFailure(hr, "Failed to format variable.");

        hr = m_pEngine->SetVariableString(L"Variable6", sczFormatedValue);
        BalExitOnFailure(hr, "Failed to set variable.");
```

--------------------------------

### Add Dependency Namespace to Wix element

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Dependency/README.md

Declare the dependency namespace in your WiX source file to use the extension's elements.

```xml
<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs"
     xmlns:dep="http://wixtoolset.org/schemas/v4/wxs/dependency">

  ..
</Wix>
```

--------------------------------

### Reading Burn Variables

Source: https://github.com/wixtoolset/wix/blob/main/src/ext/Bal/Samples/bafunctions/Readme.txt

Retrieves a bundle variable and assigns its value to another variable.

```cpp
        BalGetStringVariable(L"WixBundleName", &sczValue);
        BalExitOnFailure(hr, "Failed to get variable.");

        hr = m_pEngine->SetVariableString(L"Variable4", sczValue);
        BalExitOnFailure(hr, "Failed to set variable.");
```

--------------------------------

### Managed Custom Action Method Signature

Source: https://github.com/wixtoolset/wix/blob/main/src/tools/Dtf/Documents/Guide/Content/writingcas.htm

Declares a custom action function as public static, taking a Session object and returning an ActionResult enumeration. The CustomActionAttribute enables linking to a proxy function and can take an optional name parameter for the exported entrypoint.

```C#
    [CustomAction]
    public static ActionResult MyCustomAction(Session session)
```
Tokens:
Raw