MsiPreviewBillboard function

The MsiPreviewBillboard function displays a billboard with the host control in the displayed dialog box.

Syntax


UINT MsiPreviewBillboard(
  _In_  MSIHANDLE hPreview,
  _In_  LPCTSTR szControlName,
  _In_  LPCTSTR szBillboard
);

Parameters

hPreview [in]

Handle to the preview.

szControlName [in]

Specifies the name of the host control.

szBillboard [in]

Specifies the name of the billboard to display.

Return value

ERROR_FUNCTION_FAILED

The function failed.

ERROR_INVALID_HANDLE

An invalid or inactive handle was supplied.

ERROR_INVALID_PARAMETER

An invalid parameter was supplied.

ERROR_SUCCESS

The function succeeded.

Remarks

Supplying a null billboard name in the MsiPreviewBillboard function removes any billboard displayed.

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

MsiPreviewBillboardW (Unicode) and MsiPreviewBillboardA (ANSI)

See also

User Interface Functions

 

 

Community Additions

ADD
Show:
© 2014 Microsoft