Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

INSTALLUI_HANDLER_RECORD callback function

The INSTALLUI_HANDLER_RECORD function prototype defines a callback function that the installer calls for progress notification and error messages. Call the MsiSetExternalUIRecord function to enable a record-base external user-interface (UI) handler.

Windows Installer 3.0 and Windows Installer 2.0:  Not supported. Available beginning with Windows Installer version 3.1 and later.

Syntax


INT CALLBACK InstalluiHandlerRecord(
  LPVOID pvContext,
  UINT iMessageType,
  MSIHANDLE hRecord
);

Parameters

pvContext

Pointer to an application context passed to the MsiSetExternalUIRecord function. This parameter can be used for error checking.

iMessageType

Specifies a combination of one message box style, one message box icon type, one default button, and one installation message type. This parameter must be one of the following.

Message box StylesFlagMeaning
MB_ABORTRETRYIGNORE

The message box contains the Abort, Retry, and Ignore buttons.

MB_OK

The message box contains the OK button. This is the default.

MB_OKCANCEL

The message box contains the OK and Cancel buttons.

MB_RETRYCANCEL

The message box contains the Retry and Cancel buttons.

MB_YESNO

The message box contains the Yes and No buttons.

MB_YESNOCANCEL

The message box contains the Yes, No, and Cancel buttons.

 

Message box IconTypesFlagMeaning
MB_ICONEXCLAMATION, MB_ICONWARNING

An exclamation point appears in the message box.

MB_ICONINFORMATION, MB_ICONASTERISK

The information sign appears in the message box.

MB_ICONQUESTION

A question mark appears in the message box.

MB_ICONSTOP, MB_ICONERROR, MB_ICONHAND

A stop sign appears in the message box.

 

Default ButtonsFlagMeaning
MB_DEFBUTTON1

The first button is the default button.

MB_DEFBUTTON2

The second button is the default button.

MB_DEFBUTTON3

The third button is the default button.

 

Install message TypesFlagMeaning
INSTALLMESSAGE_FATALEXIT

Premature termination

INSTALLMESSAGE_ERROR

Formatted error message

INSTALLMESSAGE_WARNING

Formatted warning message

INSTALLMESSAGE_USER

User request message.

INSTALLMESSAGE_INFO

Informative message for log

INSTALLMESSAGE_FILESINUSE

List of files currently in use that must be closed before being replaced

INSTALLMESSAGE_RESOLVESOURCE

Request to determine a valid source location

INSTALLMESSAGE_RMFILESINUSE

List of files currently in use that must be closed before being replaced. Available beginning with Windows Installer version 4.0. For more information about this message see Using Restart Manager with an External UI.

INSTALLMESSAGE_OUTOFDISKSPACE

Insufficient disk space message

INSTALLMESSAGE_ACTIONSTART

Start of action message. This message includes the action name and description.

INSTALLMESSAGE_ACTIONDATA

Formatted data associated with the individual action item.

INSTALLMESSAGE_PROGRESS

Progress gauge information. This message includes information on units so far and total number of units.

INSTALLMESSAGE_COMMONDATA

Formatted dialog information for user interface.

INSTALLMESSAGE_INITIALIZE

Sent prior to UI initialization, no string data

INSTALLMESSAGE_TERMINATE

Sent after UI termination, no string data

INSTALLMESSAGE_SHOWDIALOG

Sent prior to display of authored dialog or wizard

INSTALLMESSAGE_INSTALLSTART

Sent prior to installation of product.

INSTALLMESSAGE_INSTALLEND

Sent after installation of product.

 

The following defaults should be used if any of the preceding messages are missing: MB_OK, no icon, and MB_DEFBUTTON1. There is no default installation message type; a message type is always specified.

hRecord

Specifies a handle to the record object. For information about record objects, see the Record Processing Functions.

Return value

-1

An error was found in the message handler. Windows Installer ignores this returned value.

0

No action was taken.

The following return values map to the buttons specified by the message box style:

IDOK IDCANCEL IDABORT IDRETRY IDIGNORE IDYES IDNO

Remarks

This type of external UI handler should be used when it is known what type of errors or messages the caller is interested in, and wants to avoid the overhead of parsing the string message that is sent to an external UI handler of INSTALLUI_HANDLER type, but retrieve the data of interest from fields of hRecord.

For more information on returning values from an external user interface handler, see the Returning Values from an External User Interface Handler topic. The hRecord object sent to the record-based external UI handler is owned by Windows Installer and is valid only for the callback's lifetime. The callback should extract from the record any data it needs and it should not close that handle.

Any attempt by a record-based external UI handler to alter the data in the hRecord object will be ignored by Windows Installer.

For more information about using a record-based external handler, see Monitoring an Installation Using MsiSetExternalUIRecord.

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 3.1 on Windows Server 2003 or Windows XP.

Header

Msi.h

See also

MsiSetExternalUI
Not Supported in Windows Installer 3.0 and earlier

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.