IPXV_Inst::ShowMsgBox Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 3: Line 3:
 
{{#customTitle:IPXV_Inst::ShowMsgBox Method}}
 
{{#customTitle:IPXV_Inst::ShowMsgBox Method}}
 
{{#parentPage:PXV:IPXV_Inst#Methods|ShowMsgBox|method}}
 
{{#parentPage:PXV:IPXV_Inst#Methods|ShowMsgBox|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Shows the message box in main thread.
  
 
== Syntax ==
 
== Syntax ==
Line 18: Line 17:
 
== Parameters ==
 
== Parameters ==
 
;pText
 
;pText
:[in]  Value of BSTR.
+
:[in]  The text of message.
 
;pTitle
 
;pTitle
:[in, defaultvalue("")]  Value of BSTR.
+
:[in, defaultvalue("")]  The title for message box. If empty - then default application's title will be used.
 
;pHeader
 
;pHeader
:[in, defaultvalue("")]  Value of BSTR.
+
:[in, defaultvalue("")]  The text of header of message.
 
;hWndParent
 
;hWndParent
:[in, defaultvalue(0)]  Value of HANDLE_T.
+
:[in, defaultvalue(0)]  The optional parameter that contains the handle of parent window.
 
;nStyle
 
;nStyle
:[in, defaultvalue(0)]  Value of LONG.
+
:[in, defaultvalue(0)]  Specifies the style of message box. See [[PXV:UIX_MsgBoxStyleFlags|UIX_MsgBoxStyleFlags]].
 
;pRes
 
;pRes
:[out, retval, defaultvalue(NULL)]  Pointer to LONG_PTR.
+
:[out, retval, defaultvalue(NULL)]  Returns user's choice identifier. For possible values see [[PXV:UIX_MsgBoxResult|UIX_MsgBoxResult]].
  
 
== Return Value ==
 
== Return Value ==

Revision as of 17:29, 26 May 2015


Shows the message box in main thread.

Syntax

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

Parameters

pText
[in] The text of message.
pTitle
[in, defaultvalue("")] The title for message box. If empty - then default application's title will be used.
pHeader
[in, defaultvalue("")] The text of header of message.
hWndParent
[in, defaultvalue(0)] The optional parameter that contains the handle of parent window.
nStyle
[in, defaultvalue(0)] Specifies the style of message box. See UIX_MsgBoxStyleFlags.
pRes
[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