MsiEnableUIPreview function (msiquery.h)

The MsiEnableUIPreview function enables preview mode of the user interface to facilitate authoring of user-interface dialog boxes. This function returns a handle that should be closed using MsiCloseHandle.

Syntax

UINT MsiEnableUIPreview(
  [in]  MSIHANDLE hDatabase,
  [out] MSIHANDLE *phPreview
);

Parameters

[in] hDatabase

Handle to the database.

[out] phPreview

Pointer to a returned handle for user-interface preview capability.

Return value

This function returns UINT.

Remarks

Note that it is recommended to use variables of type PMSIHANDLE because the installer closes PMSIHANDLE objects as they go out of scope, whereas you must close MSIHANDLE objects by calling MsiCloseHandle. For more information see Use PMSIHANDLE instead of HANDLE section in the Windows Installer Best Practices.

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

User Interface Functions