IPXV_Inst::ShowMsgBox Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
(10 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
+ | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXV_Inst::ShowMsgBox Method}} | {{#customTitle:IPXV_Inst::ShowMsgBox Method}} | ||
− | {{#parentPage:PXV:IPXV_Inst|ShowMsgBox | + | {{#parentPage:PXV:IPXV_Inst#Methods|ShowMsgBox|method}} |
− | + | ||
{{ToReview}} | {{ToReview}} | ||
− | + | Shows the message box in main thread. | |
== Syntax == | == Syntax == | ||
− | <pre class="brush:cpp;gutter:false">HRESULT ShowMsgBox([in] BSTR | + | <pre class="brush:cpp;gutter:false">HRESULT ShowMsgBox([in] BSTR sText, |
− | [in, defaultvalue("")] BSTR | + | [in, defaultvalue("")] BSTR sTitle, |
− | [in, defaultvalue("")] BSTR | + | [in, defaultvalue("")] 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] | + | :[in] The text of message. |
− | ; | + | ;sTitle |
− | :[in, defaultvalue("")] | + | :[in, defaultvalue("")] The title for message box. If empty then default application's title will be used. |
− | ; | + | ;sHeader |
− | :[in, defaultvalue("")] | + | :[in, defaultvalue("")] The text of header of message. |
;hWndParent | ;hWndParent | ||
− | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] The optional parameter that specifies the handle of parent window. |
;nStyle | ;nStyle | ||
− | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] Specifies the style of message box. See [[PXV:UIX_MsgBoxStyleFlags|UIX_MsgBoxStyleFlags]]. |
− | ; | + | ;nRes |
− | :[out, retval, defaultvalue(NULL)] | + | :[out, retval, defaultvalue(NULL)] Returns user's choice identifier. For possible values see [[PXV:UIX_MsgBoxResult|UIX_MsgBoxResult]]. |
== Return Value == | == Return Value == | ||
Line 33: | Line 33: | ||
== See Also == | == See Also == | ||
− | + | [[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IUIX_Inst_ShowMsgBox|IUIX_Inst::ShowMsgBox]], [[PXV:IPXV_Inst_ShowMsgBoxEx|IPXV_Inst::ShowMsgBoxEx]] |
Latest revision as of 02:57, 15 June 2015
Shows the message box in main thread.
Syntax
HRESULT ShowMsgBox([in] BSTR sText, [in, defaultvalue("")] BSTR sTitle, [in, defaultvalue("")] BSTR sHeader, [in, defaultvalue(0)] HANDLE_T hWndParent, [in, defaultvalue(0)] LONG nStyle, [out, retval, defaultvalue(NULL)] LONG_PTR* nRes);
Parameters
- sText
- [in] The text of message.
- sTitle
- [in, defaultvalue("")] The title for message box. If empty then default application's title will be used.
- sHeader
- [in, defaultvalue("")] The text of header of message.
- hWndParent
- [in, defaultvalue(0)] The optional parameter that specifies the handle of parent window.
- nStyle
- [in, defaultvalue(0)] Specifies the style of message box. See UIX_MsgBoxStyleFlags.
- nRes
- [out, retval, defaultvalue(NULL)] Returns user's choice identifier. For possible values see UIX_MsgBoxResult.
Return Value
Returns S_OK if operation was successful or error code in other cases.