MsiSetInternalUI

[This is preliminary documentation and subject to change.]

The MsiSetInternalUI function enables the installer's internal user interface. This user interface is then used for all subsequent calls to user-interface-generating installer functions in this process.

INSTALLUILEVEL MsiSetInternalUI(
  INSTALLUILEVEL dwUILevel,  // UI level
  HWND *phWnd                // handle of owner window
);
 

Parameters

dwUILevel

Specifies the level of complexity of the user interface. This parameter can be one of the following values.

Value	Meaning
INSTALLUILEVEL_FULL	Authored user interface with wizards, progress, and errors.
INSTALLUILEVEL_REDUCED	Authored user interface with wizard dialog boxes suppressed.
INSTALLUILEVEL_BASIC	Simple progress and error handling.
INSTALLUILEVEL_DEFAULT	The installer chooses an appropriate user interface level.
INSTALLUILEVEL_NOCHANGE	The installation level is not changed.
INSTALLUILEVEL_NONE	Completely silent installation.

phWnd

Pointer to a window. This window becomes the owner of any user interface created. A pointer to the previous owner of the user interface is returned. If this parameter is NULL, the owner of the user interface does not change.

Return Values

The previous user interface level is returned. If an invalid dwUILevel is passed, then INSTALLUILEVEL_NOCHANGE is returned.

Remarks

The MsiSetInternalUI function is useful when the installer must display a user interface. For example, if a feature is installed, but the source is a compact disc that must be inserted, the installer prompts the user for the compact disc. Depending on the nature of the installation, the application might also display progress indicators or query the user for information.

When Msi.dll is loaded, the user interface level is set to DEFAULT and the user interface owner is set to 0 (that is, the initial user interface owner is the desktop).

QuickInfo

  Windows NT: Requires version 4.0 or later. Available as a redistributable for Windows NT 4.0.
  Windows: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Windows CE: Unsupported.
  Header: Declared in msi.h.
  Import Library: Use msi.lib.

See Also

Interface and Logging Functions