IPXV_Inst::ShowMsgBoxWithOpt Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
(3 intermediate revisions by 2 users not shown) | |||
Line 5: | Line 5: | ||
{{ToReview}} | {{ToReview}} | ||
− | The method | + | The extended method to show the message box with check-option in main thread. |
== Syntax == | == Syntax == | ||
− | <pre class="brush:cpp;gutter:false">HRESULT ShowMsgBoxWithOpt([in] BSTR | + | <pre class="brush:cpp;gutter:false">HRESULT ShowMsgBoxWithOpt([in] BSTR sText, |
− | [in] BSTR | + | [in] BSTR sTitle, |
− | [in] BSTR | + | [in] BSTR sHeader, |
− | [in] BSTR | + | [in] BSTR sOptionText, |
− | [in, out] LONG* | + | [in, out] LONG* nOptionState, |
[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] Text of message. | :[in] Text of message. | ||
− | ; | + | ;sTitle |
:[in] The title for dialog box. If empty then default application's title will be used. | :[in] The title for dialog box. If empty then default application's title will be used. | ||
− | ; | + | ;sHeader |
:[in] The text of header of message. | :[in] The text of header of message. | ||
− | ; | + | ;sOptionText |
:[in] Specifies the text for check-box control on the dialog. Setting of any non-empty text will show the check-box control. | :[in] Specifies the text for check-box control on the dialog. Setting of any non-empty text will show the check-box control. | ||
− | ; | + | ;nOptionState |
:[in, out] Sets/gets the state of check-box on the dialog. | :[in, out] Sets/gets the state of check-box on the dialog. | ||
;hWndParent | ;hWndParent | ||
Line 32: | Line 32: | ||
;nStyle | ;nStyle | ||
:[in, defaultvalue(0)] Specifies the style of message box. See [[PXV:UIX_MsgBoxStyleFlags|UIX_MsgBoxStyleFlags]]. | :[in, defaultvalue(0)] Specifies the style of message box. See [[PXV:UIX_MsgBoxStyleFlags|UIX_MsgBoxStyleFlags]]. | ||
− | ; | + | ;nRes |
:[out, retval, defaultvalue(NULL)] Returns the user's choice identifier. For possible values see [[PXV:UIX_MsgBoxResult|UIX_MsgBoxResult]]. | :[out, retval, defaultvalue(NULL)] Returns the user's choice identifier. For possible values see [[PXV:UIX_MsgBoxResult|UIX_MsgBoxResult]]. | ||
Latest revision as of 02:57, 15 June 2015
The extended method to show the message box with check-option in main thread.
Syntax
HRESULT ShowMsgBoxWithOpt([in] BSTR sText, [in] BSTR sTitle, [in] BSTR sHeader, [in] BSTR sOptionText, [in, out] LONG* nOptionState, [in, defaultvalue(0)] HANDLE_T hWndParent, [in, defaultvalue(0)] LONG nStyle, [out, retval, defaultvalue(NULL)] LONG_PTR* nRes);
Parameters
- sText
- [in] Text of message.
- sTitle
- [in] The title for dialog box. If empty then default application's title will be used.
- sHeader
- [in] The text of header of message.
- sOptionText
- [in] Specifies the text for check-box control on the dialog. Setting of any non-empty text will show the check-box control.
- nOptionState
- [in, out] Sets/gets the state of check-box on the dialog.
- 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 the 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.