IUIX_Inst::ShowMsgBox Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_Inst::ShowMsgBox Method}}
 
{{#customTitle:IUIX_Inst::ShowMsgBox Method}}
 +
{{#parentPage:PXV:IUIX_Inst#Methods|ShowMsgBox|method}}
  
The method of interface of PDF-XChange Editor SDK.
+
 
 +
Displays simple message box with "Ok" button.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT ShowMsgBox([in] BSTR pText, [in] BSTR pTitle, [in] BSTR pHeader, [in, optional] HANDLE_T hWndParent, [in, optional] LONG nStyle, [out, retval, optional] LONG_PTR* pRes);</pre>
+
<pre class="brush:cpp;gutter:false">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);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pText''
+
;sText
:[in]  Value of BSTR.
+
:[in]  specifies message box text.
;''pTitle''
+
;sTitle
:[in]  Value of BSTR.
+
:[in]  specifies message box window title.
;''pHeader''
+
;sHeader
:[in]  Value of BSTR.
+
:[in]  specifies header, that is displayed above the main text of message box.
;''hWndParent''
+
;hWndParent
:[in, optionalValue of HANDLE_T.
+
:[in, defaultvalue(0)<code>HANDLE_T</code> value of parent window.
;''nStyle''
+
;nStyle
:[in, optionalValue of LONG.
+
:[in, defaultvalue(0)style flags of message box. See [[PXV:UIX_MsgBoxStyleFlags|UIX_MsgBoxStyleFlags]] enumeration for full list of message box style flags.
;''pRes''
+
;nRes
:[out, retval, optionalPointer to LONG_PTR.
+
:[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 ==
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