MsiPreviewBillboard

[This is preliminary documentation and subject to change.]

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

UINT MsiPreviewBillboard(
  MSIHANDLE hPreview,     // preview handle (UI handle)
  LPCTSTR szControlName,  // name of control that accepts billboard
  LPCTSTR szBillboard     // name of billboard to display
);
 

Parameters

hPreview

Handle to the preview.

szControlName

Specifies the name of the host control.

szBillboard

Specifies the name of the billboard to display.

Return Values

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.

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 msiquery.h.
  Import Library: Use msi.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT.

See Also

Database Access Reference, User Interface Functions