IUIX_Inst::ShowMsgBox Method
From PDF XChange PDF SDK
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IUIX_Inst::ShowMsgBox Method}} | {{#customTitle:IUIX_Inst::ShowMsgBox Method}} | ||
| − | {{#parentPage:PXV:IUIX_Inst|ShowMsgBox | + | {{#parentPage:PXV:IUIX_Inst#Methods|ShowMsgBox|method}} |
| − | + | ||
Displays simple message box with "Ok" button. | Displays simple message box with "Ok" button. | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT ShowMsgBox([in] BSTR | + | <pre class="brush:cpp;gutter:false">HRESULT ShowMsgBox([in] BSTR sText, |
| − | [in] BSTR | + | [in] BSTR sTitle, |
| − | [in] BSTR | + | [in] BSTR sHeader, |
[in, defaultvalue(0)] HANDLE_T hWndParent, | [in, defaultvalue(0)] HANDLE_T hWndParent, | ||
[in, defaultvalue(0)] LONG nStyle, | [in, defaultvalue(0)] LONG nStyle, | ||
| − | [out, retval, defaultvalue(NULL)] LONG_PTR* | + | [out, retval, defaultvalue(NULL)] LONG_PTR* nRes);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;sText |
:[in] specifies message box text. | :[in] specifies message box text. | ||
| − | ; | + | ;sTitle |
:[in] specifies message box window title. | :[in] specifies message box window title. | ||
| − | ; | + | ;sHeader |
| − | :[in] specifies header, | + | :[in] specifies header, that is displayed above the main text of message box. |
;hWndParent | ;hWndParent | ||
:[in, defaultvalue(0)] <code>HANDLE_T</code> value of parent window. | :[in, defaultvalue(0)] <code>HANDLE_T</code> value of parent window. | ||
;nStyle | ;nStyle | ||
:[in, defaultvalue(0)] style flags of message box. See [[PXV:UIX_MsgBoxStyleFlags|UIX_MsgBoxStyleFlags]] enumeration for full list of message box style flags. | :[in, defaultvalue(0)] style flags of message box. See [[PXV:UIX_MsgBoxStyleFlags|UIX_MsgBoxStyleFlags]] enumeration for full list of message box style flags. | ||
| − | ; | + | ;nRes |
:[out, retval, defaultvalue(NULL)] result value. See [[PXV:UIX_MsgBoxResult|UIX_MsgBoxResult]] enumeration for full list of possible message box results. | :[out, retval, defaultvalue(NULL)] result value. See [[PXV:UIX_MsgBoxResult|UIX_MsgBoxResult]] enumeration for full list of possible message box results. | ||
== Return Value == | == Return Value == | ||
| − | Returns S_OK if operation was successful or error code | + | Returns S_OK if the operation was successful, or will return an error code if it fails. |
== See Also == | == See Also == | ||
| − | + | [[PXV:IUIX_Inst|IUIX_Inst]] | |
Latest revision as of 10:30, 16 June 2015
Displays simple message box with "Ok" button.
Syntax
HRESULT ShowMsgBox([in] BSTR sText,
[in] BSTR sTitle,
[in] BSTR sHeader,
[in, defaultvalue(0)] HANDLE_T hWndParent,
[in, defaultvalue(0)] LONG nStyle,
[out, retval, defaultvalue(NULL)] LONG_PTR* nRes);
Parameters
- sText
- [in] specifies message box text.
- sTitle
- [in] specifies message box window title.
- sHeader
- [in] specifies header, that is displayed above the main text of message box.
- hWndParent
- [in, defaultvalue(0)]
HANDLE_Tvalue of parent window. - nStyle
- [in, defaultvalue(0)] style flags of message box. See UIX_MsgBoxStyleFlags enumeration for full list of message box style flags.
- nRes
- [out, retval, defaultvalue(NULL)] result value. See UIX_MsgBoxResult enumeration for full list of possible message box results.
Return Value
Returns S_OK if the operation was successful, or will return an error code if it fails.
