Edit

MsiSequenceA function (msiquery.h)

  • Article

The MsiSequence function executes another action sequence, as described in the specified table.

Syntax

UINT MsiSequenceA(
  [in] MSIHANDLE hInstall,
  [in] LPCSTR    szTable,
  [in] INT       iSequenceMode
);

Parameters

[in] hInstall

Handle to the installation provided to a DLL custom action or obtained through MsiOpenPackage, MsiOpenPackageEx, or MsiOpenProduct.

[in] szTable

Specifies the name of the table containing the action sequence.

[in] iSequenceMode

This parameter is currently unimplemented. It is reserved for future use and must be 0.

Return value

This function returns UINT.

Remarks

The MsiSequence function queries the specified table, ordering the actions by the numbers in the Sequence column. For each row retrieved, an action is executed, provided that any supplied condition expression does not evaluate to FALSE.

An action sequence containing any actions that update the system, such as the InstallFiles and WriteRegistryValues actions, cannot be run by calling MsiSequence. The exception to this rule is if MsiSequence is called from a custom action that is scheduled in the InstallExecuteSequence table between the InstallInitialize and InstallFinalize actions. Actions that do not update the system, such as AppSearch or CostInitialize, can be called.

Note

The msiquery.h header defines MsiSequence as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Windows Installer 5.0 on Windows Server 2012, Windows 8, Windows Server 2008 R2 or Windows 7. Windows Installer 4.0 or Windows Installer 4.5 on Windows Server 2008 or Windows Vista. Windows Installer on Windows Server 2003 or Windows XP
Target Platform Windows
Header msiquery.h
Library Msi.lib
DLL Msi.dll

See also

Installer Action Functions