Tcl Windows API extension

This module provides commands for accessing the Microsoft Windows Installer (MSI) component through its COM interfaces. The primary motivation for this module is that although the Installer provides a COM type library, its type library may not be available on the target system. This module provides the required type definitions for the various interfaces.

Creation and Destruction of MSI objects

MSI objects are created through TWAPI's COM interface commands. The Installer object is created through the command

set msiobj [comobj WindowsInstaller.Installer]

Once an MSI object is no longer needed, it must be deleted like any other COM object.

$msiobj -destroy

Note a final call to $MSIOBJ -destroy is required for all MSI objects, not just the top-level Installer object.

Once an MSI object is created, its type library must be explicitly loaded by calling load_msi_prototypes with the object command and the object type.

twapi::load_msi_prototypes $msiobj Installer

Example: List installed products

load_msi_prototypes MSICOMOBJ MSITYPE: Loads the type information corresponding to the MSI type MSITYPE into the COM object command MSICOMOBJ. The sections below describe the various types of MSI objects that can be loaded. When an object of a type is created, it should be passed to load_msi_prototypes along with the type before making any method calls on the objects.

Installer object

An Installer object supports the following methods:

INSTALLEROBJ AddSource ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ ClearSourceList ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ CollectUserInfo ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ ComponentClients ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ ComponentPath ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ ComponentQualifiers ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ Components ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ ConfigureFeature ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ ConfigureProduct ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ CreateRecord ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ EnableLog ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ Environment ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ ExtractPatchXMLData ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ FeatureParent ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ Features ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ FeatureState ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ FeatureUsageCount ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ FeatureUsageDate ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ FileAttributes ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ FileSize ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ FileVersion ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ InstallProduct ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ LastErrorRecord ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ OpenPackage ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ OpenDatabase ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ OpenProduct ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ Patches ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ PatchesEx ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ ProductInfo ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ ProductsEx ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ Products ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ ProductState ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ ProvideComponent ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ RegistryValue ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ ReinstallFeature ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ ReinstallProduct ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ RelatedProducts ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ RemovePatches ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ ShortcutTarget ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ SummaryInformation ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ UILevel ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ UseFeature ARGS: Refer to Windows Installer Reference for a description and parameters.
INSTALLEROBJ Version ARGS: Refer to Windows Installer Reference for a description and parameters.

Database object

A MSI Database object supports the following methods:

MSIDBOBJ ApplyTransform ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIDBOBJ Commit ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIDBOBJ CreateTransformSummaryInfo ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIDBOBJ DatabaseState ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIDBOBJ EnableUIPreview ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIDBOBJ Export ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIDBOBJ GenerateTransform ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIDBOBJ Import ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIDBOBJ Merge ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIDBOBJ OpenView ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIDBOBJ PrimaryKeys ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIDBOBJ TablePersistent ARGS: Refer to Windows Installer Reference for a description and parameters.

Record object

A MSI Record object supports the following methods:

MSIRECORDOBJ ClearData ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIRECORDOBJ DataSize ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIRECORDOBJ FieldCount ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIRECORDOBJ FormatText ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIRECORDOBJ IntegerData ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIRECORDOBJ IsNull ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIRECORDOBJ ReadStream ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIRECORDOBJ SetStream ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIRECORDOBJ StringData ARGS: Refer to Windows Installer Reference for a description and parameters.

SummaryInfo object

A MSI SummaryInfo object supports the following methods:

MSISUMMARYOBJ Persist ARGS: Refer to Windows Installer Reference for a description and parameters.
MSISUMMARYOBJ Property ARGS: Refer to Windows Installer Reference for a description and parameters.
MSISUMMARYOBJ PropertyCount ARGS: Refer to Windows Installer Reference for a description and parameters.

StringList object

A MSI StringList object supports the following methods:

MSISTRINGLISTOBJ Count ARGS: Refer to Windows Installer Reference for a description and parameters.
MSISTRINGLISTOBJ Item ARGS: Refer to Windows Installer Reference for a description and parameters.

View object

A MSI View object supports the following methods:

MSIVIEWOBJ Close ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIVIEWOBJ ColumnInfo ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIVIEWOBJ Execute ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIVIEWOBJ Fetch ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIVIEWOBJ GetError ARGS: Refer to Windows Installer Reference for a description and parameters.
MSIVIEWOBJ Modify ARGS: Refer to Windows Installer Reference for a description and parameters.

Microsoft Windows Installer

SYNOPSIS

DESCRIPTION