IPXV_Inst::ShowMsgBoxWithOpt Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 8: Line 8:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT ShowMsgBoxWithOpt([in]                              BSTR      sText,
+
<pre class="brush:cpp;gutter:false">HRESULT ShowMsgBoxWithOpt([in]                              BSTR      Text,
                           [in]                              BSTR      sTitle,
+
                           [in]                              BSTR      Title,
                           [in]                              BSTR      sHeader,
+
                           [in]                              BSTR      Header,
                           [in]                              BSTR      sOptionText,
+
                           [in]                              BSTR      OptionText,
                           [in, out]                          LONG*      nOptionState,
+
                           [in, out]                          LONG*      OptionState,
                           [in, defaultvalue(0)]              HANDLE_T  nWndParent,
+
                           [in, defaultvalue(0)]              HANDLE_T  hWndParent,
                           [in, defaultvalue(0)]              LONG      nStyle,
+
                           [in, defaultvalue(0)]              LONG      Style,
                           [out, retval, defaultvalue(NULL)]  LONG_PTR*  nRes);</pre>
+
                           [out, retval, defaultvalue(NULL)]  LONG_PTR*  Res);</pre>
  
 
== Parameters ==
 
== Parameters ==
;sText
+
;Text
 
:[in]  Text of message.
 
:[in]  Text of message.
;sTitle
+
;Title
 
:[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
+
;Header
 
:[in]  The text of header of message.
 
:[in]  The text of header of message.
;sOptionText
+
;OptionText
 
:[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
+
;OptionState
 
:[in, out]  Sets/gets the state of check-box on the dialog.
 
:[in, out]  Sets/gets the state of check-box on the dialog.
;nWndParent
+
;hWndParent
 
:[in, defaultvalue(0)]  The optional parameter that specifies the handle of parent window.
 
:[in, defaultvalue(0)]  The optional parameter that specifies the handle of parent window.
;nStyle
+
;Style
 
:[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
+
;Res
 
:[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]].
  

Revision as of 06:33, 12 June 2015


The extended method to show the message box with check-option in main thread.

Syntax

HRESULT ShowMsgBoxWithOpt([in]                               BSTR       Text,
                          [in]                               BSTR       Title,
                          [in]                               BSTR       Header,
                          [in]                               BSTR       OptionText,
                          [in, out]                          LONG*      OptionState,
                          [in, defaultvalue(0)]              HANDLE_T   hWndParent,
                          [in, defaultvalue(0)]              LONG       Style,
                          [out, retval, defaultvalue(NULL)]  LONG_PTR*  Res);

Parameters

Text
[in] Text of message.
Title
[in] The title for dialog box. If empty then default application's title will be used.
Header
[in] The text of header of message.
OptionText
[in] Specifies the text for check-box control on the dialog. Setting of any non-empty text will show the check-box control.
OptionState
[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.
Style
[in, defaultvalue(0)] Specifies the style of message box. See UIX_MsgBoxStyleFlags.
Res
[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