MSI.ProcessMessage

OverviewExamples

number MSI.ProcessMessage (

number hInstall,

number Message,

number hRecord,

table DialogInfo = nil )

Description

Calls the MsiProcessMessage function that sends an error record to the installer for processing.

Parameters

hInstall

(number) The handle to the install.

Note: _hInstall is the default for this parameter. See Global Variables for more information.

Message

(number) The type of message to process. Choose from:

CONSTANT	VALUE	DESCRIPTION
INSTALLMESSAGE_FATALEXIT	0	Premature termination, possibly fatal out of memory.
INSTALLMESSAGE_ERROR	16777216	Formatted error message.
INSTALLMESSAGE_WARNING	33554432	Formatted warning message.
INSTALLMESSAGE_USER	50331648	User request message.
INSTALLMESSAGE_INFO	67108864	Informative message for log.
INSTALLMESSAGE_FILESINUSE	83886080	List of files currently in use that must be closed before being replaced.
INSTALLMESSAGE_RESOLVESOURCE	100663296	Request to determine a valid source location.
INSTALLMESSAGE_OUTOFDISKSPACE	117440512	Insufficient disk space message.
INSTALLMESSAGE_ACTIONSTART	134217728	Progress: start of action, [1] action name, [2] description, [3] template for ACTIONDATA messages.
INSTALLMESSAGE_ACTIONDATA	150994944	Action data. Record fields correspond to the template of ACTIONSTART message.
INSTALLMESSAGE_PROGRESS	167772160	Progress bar information. See the description of record fields below.
INSTALLMESSAGE_COMMONDATA	184549376	To enable the Cancel button set [1] to 2 and [2] to 1. To disable the Cancel button set [1] to 2 and [2] to 0
INSTALLMESSAGE_INITIALIZE	201326592	Indicates that the UI sequence has started.
INSTALLMESSAGE_TERMINATE	218103808	Indicates the end of the UI sequence.
INSTALLMESSAGE_SHOWDIALOG	234881024	The name of the current dialog.

hRecord

(number) Handle to a record containing message format and data.

DialogInfo

(table) A table containing the push button and icon identifiers to use when displaying a message box when INSTALLMESSAGE_ERROR, INSTALLMESSAGE_WARNING, or INSTALLMESSAGE_USER is the Message type to process. If nil is passed, Windows Installer will choose a default icon style based on the message type.
For example, a valid table could be:
my_table = {MB_ABORTRETRYIGNORE, MB_ICONWARNING};

The following push button and icons are available when creating the table:

CONSTANT	VALUE	DESCRIPTION
MB_OK	0	OK button.
MB_OKCANCEL	1	OK and Cancel buttons.
MB_ABORTRETRYIGNORE	2	Abort, Retry, and Ignore buttons.
MB_YESNOCANCEL	3	Yes, No, and Cancel buttons.
MB_YESNO	4	Yes and No buttons.
MB_RETRYCANCEL	5	Retry and Cancel buttons.
MB_DEFBUTTON1	0	The first button is the default.
MB_DEFBUTTON2	256	The second button is the default.
MB_DEFBUTTON3	512	The third button is the default.
MB_ICONERROR	16	An icon with an "X".
MB_ICONQUESTION	32	An icon with a question-mark.
MB_ICONWARNING	48	An icon with an exclamation-point.
MB_ICONINFORMATION	64	An icon with an "I" in a circle.

Returns

(number) One of the following.:

CONSTANT	VALUE	DESCRIPTION
	-1	An invalid parameter or handle was supplied.
	0	No action was taken.
IDOK	1	The function succeeded.
IDCANCEL	2	The process was canceled.
IDABORT	3	The process was stopped.
IDRETRY	4	Retry.
IDIGNORE	5	The process was ignored.
IDYES	6	Yes
IDNO	7	No.

You can use Application.GetLastError to determine whether this action failed, and why.