MsiPreviewBillboardA function (msiquery.h)

Article
02/22/2024

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

Syntax

UINT MsiPreviewBillboardA(
  [in] MSIHANDLE hPreview,
  [in] LPCSTR    szControlName,
  [in] LPCSTR    szBillboard
);

Parameters

[in] hPreview

Handle to the preview.

[in] szControlName

Specifies the name of the host control.

[in] szBillboard

Specifies the name of the billboard to display.

Return value

This function returns UINT.

Remarks

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

Note

The msiquery.h header defines MsiPreviewBillboard as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

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