dxMessageDlgPosHelp(string,TMsgDlgType,TMsgDlgButtons,Longint,Integer,Integer,string) Method
Invokes a message box dialog whose help topic is supplied in a specified help file.
Declaration
function dxMessageDlgPosHelp(const AMessage: string; ADialogType: TMsgDlgType; AButtons: TMsgDlgButtons; AHelpContext: Longint; X: Integer; Y: Integer; const AHelpFileName: string): Integer;
Parameters
Name | Type | Description |
---|---|---|
AMessage | string | Content of the message dialog box. |
ADialogType | TMsgDlgType | The type of the message dialog box. This type determines the predefined caption, system icon, and sound of the message box. |
AButtons | TMsgDlgButtons | A set of buttons on the message dialog box form. |
AHelpContext | Longint | A context ID for the help topic that a click on the Help button or the F1 keystroke should invoke while the message box is displayed. |
X | Integer | A horizontal offset (in pixels) of the upper-left form corner from the upper-left screen corner. |
Y | Integer | A vertical offset (in pixels) of the upper-left form corner from the upper-left screen corner. |
AHelpFileName | string | The name of the help file that contains the help topic for the message dialog box. |
Returns
Type | Description |
---|---|
Integer | An integer value that indicates the button clicked to close the message box. The dxMessageBox function returns 0 if it fails to invoke a message box. Refer to the list of possible return values below. |
Remarks
Call this function to invoke the message dialog box associated with a help topic. The created message dialog box has the mdsMessageDlg style.
Return Values
- IDOK
- A user clicked the OK button to close the message box.
- IDCANCEL
- A user clicked the Cancel button to close the message box.
- IDABORT
- A user clicked the Abort button to close the message box.
- IDRETRY
- A user clicked the Retry button to close the message box.
- IDIGNORE
- A user clicked the Ignore button to close the message box.
- IDYES
- A user clicked the Yes button to close the message box.
- IDNO
- A user clicked the No button to close the message box.