Dialogs.MessageDlgPosHelp Function

Displays a message dialog box whose help is supplied in a named help file.

Pascal

function MessageDlgPosHelp(const Msg: string; DlgType: TMsgDlgType; Buttons: TMsgDlgButtons; HelpCtx: Longint; X: Integer; Y: Integer; const HelpFileName: string): Integer; overload;
function MessageDlgPosHelp(const Msg: string; DlgType: TMsgDlgType; Buttons: TMsgDlgButtons; HelpCtx: Longint; X: Integer; Y: Integer; const HelpFileName: string; DefaultButton: TMsgDlgBtn): Integer; overload;

C++

int MessageDlgPosHelp(const AnsiString Msg, TMsgDlgType DlgType, TMsgDlgButtons Buttons, Longint HelpCtx, int X, int Y, const AnsiString HelpFileName);
int MessageDlgPosHelp(const AnsiString Msg, TMsgDlgType DlgType, TMsgDlgButtons Buttons, Longint HelpCtx, int X, int Y, const AnsiString HelpFileName, TMsgDlgBtn DefaultButton);

File

Dialogs

Description

Call MessageDlgPosHelp 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.

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.