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      Text,
+
<pre class="brush:cpp;gutter:false">HRESULT ShowMsgBox([in]                              BSTR      sText,
                   [in, defaultvalue("")]            BSTR      Title,
+
                   [in, defaultvalue("")]            BSTR      sTitle,
                   [in, defaultvalue("")]            BSTR      Header,
+
                   [in, defaultvalue("")]            BSTR      sHeader,
 
                   [in, defaultvalue(0)]              HANDLE_T  hWndParent,
 
                   [in, defaultvalue(0)]              HANDLE_T  hWndParent,
                   [in, defaultvalue(0)]              LONG      Style,
+
                   [in, defaultvalue(0)]              LONG      nStyle,
                   [out, retval, defaultvalue(NULL)]  LONG_PTR*  Res);</pre>
+
                   [out, retval, defaultvalue(NULL)]  LONG_PTR*  nRes);</pre>
  
 
== Parameters ==
 
== Parameters ==
;Text
+
;sText
 
:[in]  The text of message.
 
:[in]  The text of message.
;Title
+
;sTitle
 
:[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.
;Header
+
;sHeader
 
:[in, defaultvalue("")]  The text of header of message.  
 
:[in, defaultvalue("")]  The text of header of message.  
 
;hWndParent
 
;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.
;Style
+
;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]].
;Res
+
;nRes
 
:[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]].
  

Latest revision as of 03: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.

See Also

IPXV_Inst, IUIX_Inst::ShowMsgBox, IPXV_Inst::ShowMsgBoxEx