MsiProcessMessage

[This is preliminary documentation and subject to change.]

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

int MsiProcessMessage(
  MSIHANDLE hInstall,       // installer handle
  MSIMESSAGE eMessageType,  // type of message
  MISHANDLE hRecord         // record handle
);
 

Parameters

hInstall

Handle to the installation.

eMessageType

Specifies the message type. This parameter can be one of the following values.

Value	Meaning
MSIMESSAGE_OutOfMemory	The process is out of memory, may call recursively.
MSIMESSAGE_Error	Error message, [1] is message number in Error table.
MSIMESSAGE_Warning	Warning message, [1] is message number in Error table.
MSIMESSAGE_User	User request, [1] is message number in Error table.
MSIMESSAGE_Info	Informative message for log, not to be displayed.
MSIMESSAGE_Diagnostic	Debug notification, displayed only if no log.
MSIMESSAGE_CommonData	Info for UI: [1]=language ID, [2]=dialog caption.
MSIMESSAGE_Reserved	Reserved for future use.
MSIMESSAGE_ActionStar	Progress: start of action, [1] action name, [2] description.
MSIMESSAGE_ActionData	Progress: data associated with individual action item.
MSIMESSAGE_Progress	Progress: gauge info, [1] units so far, [2] total.
MSIMESSAGE_ActionData	Progress: end of action sequence, exit modeless dialog.

hRecord

Handle to a record containing message format and data.

Return Values

-1

An invalid parameter or handle was supplied.

0

No action was taken.

IDABORT

The process was stopped.

IDCANCEL

The process was canceled.

IDIGNORE

The process was ignored.

IDOK

The function succeeded.

IDNO

No.

IDRETRY

Retry.

IDYES

Yes.

Remarks

The MsiProcessMessage function performs any enabled logging operations and defers execution. You can selectively enable logging for various message types.

If field 0 is not set, field 1 must be set to the error code corresponding to the error message in the Error table. Then, the message is formatted using the template from the Error table before passing it to the user-interface handler for display.

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.

See Also

Database Access Reference, Installer Action Functions