Vcl.Dialogs.TaskMessageDlgPosHelp
Delphi
function TaskMessageDlgPosHelp(const Title, Msg: string; DlgType: TMsgDlgType;
Buttons: TMsgDlgButtons; HelpCtx: Longint; X, Y: Integer;
const HelpFileName: string): Integer;
function TaskMessageDlgPosHelp(const Title, Msg: string; DlgType: TMsgDlgType;
Buttons: TMsgDlgButtons; HelpCtx: Longint; X, Y: Integer;
const HelpFileName: string; DefaultButton: TMsgDlgBtn): Integer;
function TaskMessageDlgPosHelp(const Title, Msg: string; DlgType: TMsgDlgType;
Buttons: TMsgDlgButtons; HelpCtx: Longint; X, Y: Integer;
const HelpFileName: string; DefaultButton: TMsgDlgBtn; CustomButtonCaptions: array of string): Integer;
C++
extern DELPHI_PACKAGE int __fastcall TaskMessageDlgPosHelp(const System::UnicodeString Title, const System::UnicodeString Msg, System::Uitypes::TMsgDlgType DlgType, System::Uitypes::TMsgDlgButtons Buttons, int HelpCtx, int X, int Y, const System::UnicodeString HelpFileName)/* overload */;
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| function | public | Vcl.Dialogs.pas Vcl.Dialogs.hpp |
Vcl.Dialogs | Vcl.Dialogs |
Description
Displays a message task dialog box whose help is supplied in a named help file.
Call TaskMessageDlgPosHelp to bring up a message box when the associated help comes from a help file other than the default help file.
Msg is the content of the message that appears.
DlgType indicates the purpose of the dialog.
| DlgType Value | Meaning |
|---|---|
|
mtWarning |
A message box containing a yellow exclamation point symbol. |
|
mtError |
A message box containing a red stop sign. |
|
mtInformation |
A message box containing a blue "i". |
|
mtConfirmation |
A message box containing a green question mark. |
|
mtCustom |
A message box containing no bitmap. The caption of the message box is the name of the application's executable file. |
Buttons indicates what buttons should appear in the message box.
HelpCtx specifies the context ID for the help topic in the file specified by HelpFileName. This topic appears when the user clicks the help button or presses F1 while the dialog is displayed.
X and Y specify the screen coordinates where the dialog should appear.
HelpFileName specifies the help file that contains the help topic for this message box.
MessageDlgPosHelp returns the value of the button the user selected. The following table lists the TMsgDlgBtn values for each type of button that can appear in the message box, and the corresponding value that is returned if the user selects that button:
| TMsgDlgBtn Value | Corresponding return value |
|---|---|
|
mbOK |
mrOk |
|
mbCancel |
mrCancel |
|
mbYes |
mrYes |
|
mbNo |
mrNo |
|
mbAbort |
mrAbort |
|
mbRetry |
mrRetry |
|
mbIgnore |
mrIgnore |
|
mbAll |
mrAll |
|
mbNoToAll |
mrNoToAll |
|
mbYesToAll |
mrYesToAll |
|
mbClose |
mrClose |
Note: If the user types Ctrl+C in the message box, the text of the message is copied to the clipboard.