MsiPreviewBillboard Function

Windows Installer

MsiPreviewBillboard Function

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

Syntax

C++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

VersionWindows Installer 5.0 on 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, Windows XP, and Windows 2000
HeaderMsiquery.h
LibraryMsi.lib
DLLMsi.dll
Unicode and ANSI namesMsiPreviewBillboardW (Unicode) and MsiPreviewBillboardA (ANSI)

See Also

User Interface Functions

Send comments about this topic to Microsoft

Build date: 8/13/2009

© 2009 Microsoft Corporation. All rights reserved.