src/WixToolset.Extensibility/Services/IWindowsInstallerBackendHelper.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.

namespace WixToolset.Extensibility.Services
{
    using WixToolset.Data;
    using WixToolset.Data.WindowsInstaller;

    /// <summary>
    /// Interface provided to help Windows Installer backend extensions.
    /// </summary>
    public interface IWindowsInstallerBackendHelper : IBackendHelper
    {
        /// <summary>
        /// Creates a <see cref="Row"/> in the specified table.
        /// </summary>
        /// <param name="section">Parent section.</param>
        /// <param name="symbol">Symbol with line information for the row.</param>
        /// <param name="data">Windows Installer data.</param>
        /// <param name="tableDefinition">Table definition for the row.</param>
        /// <returns>Row created in the <paramref name="data"/>.</returns>
        Row CreateRow(IntermediateSection section, IntermediateSymbol symbol, WindowsInstallerData data, TableDefinition tableDefinition);

        /// <summary>
        /// Looks up the registered <see cref="TableDefinition"/> for the given <see cref="IntermediateSymbol"/> and creates a <see cref="Row"/> in that table.
        /// Goes sequentially through each field in the symbol and assigns the value to the column with the same index as the field.
        /// If the symbol's Id is registered as the primary key then that is used for the first column and the column data is offset by 1.
        /// </summary>
        /// <param name="section">Parent section.</param>
        /// <param name="symbol">Symbol to create the row from.</param>
        /// <param name="data">Windows Installer data.</param>
        /// <param name="tableDefinitions">Table definitions that have been registered with the binder.</param>
        /// <returns>True if a row was created.</returns>
        bool TryAddSymbolToMatchingTableDefinitions(IntermediateSection section, IntermediateSymbol symbol, WindowsInstallerData data, TableDefinitionCollection tableDefinitions);
    }
}