[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] Reference for unit 'InterfaceBase' (#lcl)

TWidgetSet.MessageBox

The MessageBox function displays an modal dialog, with the given text, caption, icon and buttons.

Declaration

Source position: winapih.inc line 198

public function TWidgetSet.MessageBox(

  hWnd: HWND;

  lpText: PChar;

  lpCaption: PChar;

  uType: Cardinal = MB_OK

):Integer; virtual;

Arguments

hWnd

  

The handle of the window that owns the MessageBox.

lpText

  

The text displayed in the MessageBox.

lpCaption

  

The caption of the MessageBox.

uType

  

Style flags specifiying the shown buttons etc.

Function result

The pressed button, or zero on failure.

Description

uType is a combination of flags from the following lists.

The shown buttons are selected by one of:

Add MB_HELP for an Help button. When the user clicks the Help button or presses F1, the owner window receives a WM_HELP message.

An icon can be added by one of:

The default button number, activated when the user presses Enter, can be indicated by one of:
MB_DEFBUTTON1 MB_DEFBUTTON2 MB_DEFBUTTON3 MB_DEFBUTTON4

Further Windows MessageBox specific options are not (yet) implemented on other platforms.

The function result corresponds to the pressed button:
IDABORT IDCANCEL IDCONTINUE IDIGNORE IDNO IDOK IDRETRY IDTRYAGAIN IDYES

The latest version of this document can be found at lazarus-ccr.sourceforge.net.