MsiPreviewDialog function

The MsiPreviewDialog function displays a dialog box as modeless and inactive.

Syntax


UINT MsiPreviewDialog(
  _In_ MSIHANDLE hPreview,
  _In_ LPCTSTR   szDialogName
);

Parameters

hPreview [in]

Handle to the preview.

szDialogName [in]

Specifies the name of the dialog box to preview.

Return value

ERROR_FUNCTION_FAILED

The function failed.

ERROR_FUNCTION_NOT_CALLED

The function was not called.

ERROR_INSTALL_FAILURE

An installation failure occurred.

ERROR_INSTALL_SUSPEND

The installation was suspended.

ERROR_INSTALL_USEREXIT

The user exited the installation.

ERROR_INVALID_HANDLE

An invalid or inactive handle was supplied.

ERROR_INVALID_HANDLE_STATE

An invalid handle state was supplied.

ERROR_INVALID_PARAMETER

An invalid parameter was supplied.

ERROR_SUCCESS

The function succeeded.

Remarks

Supplying a null name in the MsiPreviewDialog function removes any current dialog box.

Requirements

Version

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

Header

Msiquery.h

Library

Msi.lib

DLL

Msi.dll

Unicode and ANSI names

MsiPreviewDialogW (Unicode) and MsiPreviewDialogA (ANSI)

See also

User Interface Functions

 

 

Show: