IUIX_Inst::ShowMsgBox Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(One intermediate revision by one other user not shown)
Line 3: Line 3:
 
{{#customTitle:IUIX_Inst::ShowMsgBox Method}}
 
{{#customTitle:IUIX_Inst::ShowMsgBox Method}}
 
{{#parentPage:PXV:IUIX_Inst#Methods|ShowMsgBox|method}}
 
{{#parentPage:PXV:IUIX_Inst#Methods|ShowMsgBox|method}}
{{ToReview}}
+
 
  
 
Displays simple message box with "Ok" button.
 
Displays simple message box with "Ok" button.
  
 
== 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]                              BSTR      Title,
+
                   [in]                              BSTR      sTitle,
                   [in]                              BSTR      Header,
+
                   [in]                              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]  specifies message box text.
 
:[in]  specifies message box text.
;Title
+
;sTitle
 
:[in]  specifies message box window title.
 
:[in]  specifies message box window title.
;Header
+
;sHeader
 
:[in]  specifies header, that is displayed above the main text of message box.
 
:[in]  specifies header, that is displayed above the main text of message box.
 
;hWndParent
 
;hWndParent
 
:[in, defaultvalue(0)]  <code>HANDLE_T</code> value of parent window.
 
:[in, defaultvalue(0)]  <code>HANDLE_T</code> value of parent window.
;Style
+
;nStyle
 
:[in, defaultvalue(0)]  style flags of message box. See [[PXV:UIX_MsgBoxStyleFlags|UIX_MsgBoxStyleFlags]] enumeration for full list of message box style flags.
 
:[in, defaultvalue(0)]  style flags of message box. See [[PXV:UIX_MsgBoxStyleFlags|UIX_MsgBoxStyleFlags]] enumeration for full list of message box style flags.
;Res
+
;nRes
 
:[out, retval, defaultvalue(NULL)]  result value. See [[PXV:UIX_MsgBoxResult|UIX_MsgBoxResult]] enumeration for full list of possible message box results.
 
:[out, retval, defaultvalue(NULL)]  result value. See [[PXV:UIX_MsgBoxResult|UIX_MsgBoxResult]] enumeration for full list of possible message box results.
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if operation was successful or error code in other cases.
+
Returns S_OK if the operation was successful, or will return an error code if it fails.  
  
 
== See Also ==
 
== See Also ==
 
[[PXV:IUIX_Inst|IUIX_Inst]]
 
[[PXV:IUIX_Inst|IUIX_Inst]]

Latest revision as of 10:30, 16 June 2015


Displays simple message box with "Ok" button.

Syntax

HRESULT ShowMsgBox([in]                               BSTR       sText,
                   [in]                               BSTR       sTitle,
                   [in]                               BSTR       sHeader,
                   [in, defaultvalue(0)]              HANDLE_T   hWndParent,
                   [in, defaultvalue(0)]              LONG       nStyle,
                   [out, retval, defaultvalue(NULL)]  LONG_PTR*  nRes);

Parameters

sText
[in] specifies message box text.
sTitle
[in] specifies message box window title.
sHeader
[in] specifies header, that is displayed above the main text of message box.
hWndParent
[in, defaultvalue(0)] HANDLE_T value of parent window.
nStyle
[in, defaultvalue(0)] style flags of message box. See UIX_MsgBoxStyleFlags enumeration for full list of message box style flags.
nRes
[out, retval, defaultvalue(NULL)] result value. See UIX_MsgBoxResult enumeration for full list of possible message box results.

Return Value

Returns S_OK if the operation was successful, or will return an error code if it fails.

See Also

IUIX_Inst