IUIX_Inst::ShowMsgBox Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IUIX_Inst::ShowMsgBox Method}}
 
{{#customTitle:IUIX_Inst::ShowMsgBox Method}}
 
{{#parentPage:PXV:IUIX_Inst|ShowMsgBox Method|method}}
 
{{#parentPage:PXV:IUIX_Inst|ShowMsgBox Method|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Displays simple message box with "Ok" button.
  
 
== Syntax ==
 
== Syntax ==
Line 17: Line 16:
 
== Parameters ==
 
== Parameters ==
 
;pText
 
;pText
:[in]  Value of BSTR.
+
:[in]  specifies message box text.
 
;pTitle
 
;pTitle
:[in]  Value of BSTR.
+
:[in]  specifies message box window title.
 
;pHeader
 
;pHeader
:[in]  Value of BSTR.
+
:[in]  specifies header, which is displayed above the main text of message box.
 
;hWndParent
 
;hWndParent
:[in, defaultvalue(0)]  Value of HANDLE_T.
+
:[in, defaultvalue(0)]  <code>HANDLE_T</code> value of parent window.
 
;nStyle
 
;nStyle
:[in, defaultvalue(0)]  Value 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
 
;pRes
:[out, retval, defaultvalue(NULL)]  Pointer 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 ==

Revision as of 07:15, 19 May 2015


Displays simple message box with "Ok" button.

Syntax

HRESULT ShowMsgBox([in]                               BSTR       pText,
                   [in]                               BSTR       pTitle,
                   [in]                               BSTR       pHeader,
                   [in, defaultvalue(0)]              HANDLE_T   hWndParent,
                   [in, defaultvalue(0)]              LONG       nStyle,
                   [out, retval, defaultvalue(NULL)]  LONG_PTR*  pRes);

Parameters

pText
[in] specifies message box text.
pTitle
[in] specifies message box window title.
pHeader
[in] specifies header, which 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.
pRes
[out, retval, defaultvalue(NULL)] result value. See UIX_MsgBoxResult enumeration for full list of possible message box results.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

See also IUIX_Inst.