IPXV_Inst::ShowMsgBox 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 ShowMsgBox([in]                              BSTR      sText,
+
<pre class="brush:cpp;gutter:false">HRESULT ShowMsgBox([in]                              BSTR      Text,
                   [in, defaultvalue("")]            BSTR      sTitle,
+
                   [in, defaultvalue("")]            BSTR      Title,
                   [in, defaultvalue("")]            BSTR      sHeader,
+
                   [in, defaultvalue("")]            BSTR      Header,
                   [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]  The text of message.
 
:[in]  The text of message.
;sTitle
+
;Title
 
:[in, defaultvalue("")]  The title for message box. If empty then default application's title will be used.
 
:[in, defaultvalue("")]  The title for message box. If empty then default application's title will be used.
;sHeader
+
;Header
 
:[in, defaultvalue("")]  The text of header of message.  
 
:[in, defaultvalue("")]  The text of header of message.  
;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 user's choice identifier. For possible values see [[PXV:UIX_MsgBoxResult|UIX_MsgBoxResult]].
 
:[out, retval, defaultvalue(NULL)]  Returns user's choice identifier. For possible values see [[PXV:UIX_MsgBoxResult|UIX_MsgBoxResult]].
  

Revision as of 07:33, 12 June 2015


Shows the message box in main thread.

Syntax

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

Parameters

Text
[in] The text of message.
Title
[in, defaultvalue("")] The title for message box. If empty then default application's title will be used.
Header
[in, defaultvalue("")] The text of header of message.
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 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, IUIX_Inst::ShowMsgBox, IPXV_Inst::ShowMsgBoxEx