IPXV_Inst::ShowMsgBoxWithOpt Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(3 intermediate revisions by 2 users not shown)
Line 5: Line 5:
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
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      pText,
+
<pre class="brush:cpp;gutter:false">HRESULT ShowMsgBoxWithOpt([in]                              BSTR      sText,
                           [in]                              BSTR      pTitle,
+
                           [in]                              BSTR      sTitle,
                           [in]                              BSTR      pHeader,
+
                           [in]                              BSTR      sHeader,
                           [in]                              BSTR      pOptionText,
+
                           [in]                              BSTR      sOptionText,
                           [in, out]                          LONG*      pOptionState,
+
                           [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*  pRes);</pre>
+
                           [out, retval, defaultvalue(NULL)]  LONG_PTR*  nRes);</pre>
  
 
== Parameters ==
 
== Parameters ==
;pText
+
;sText
 
:[in]  Text of message.
 
:[in]  Text of message.
;pTitle
+
;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.
;pHeader
+
;sHeader
 
:[in]  The text of header of message.
 
:[in]  The text of header of message.
;pOptionText
+
;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.
;pOptionState
+
;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]].
;pRes
+
;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 03: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.

See Also

IPXV_Inst