IPXV_Inst::ShowMsgBoxWithOpt Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 3: Line 3:
 
{{#customTitle:IPXV_Inst::ShowMsgBoxWithOpt Method}}
 
{{#customTitle:IPXV_Inst::ShowMsgBoxWithOpt Method}}
 
{{#parentPage:PXV:IPXV_Inst#Methods|ShowMsgBoxWithOpt|method}}
 
{{#parentPage:PXV:IPXV_Inst#Methods|ShowMsgBoxWithOpt|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
Line 20: Line 19:
 
== Parameters ==
 
== Parameters ==
 
;pText
 
;pText
:[in]  Value of BSTR.
+
:[in]  Text of message.
 
;pTitle
 
;pTitle
:[in]  Value of BSTR.
+
:[in]  The title for dialog box. If empty then default application's title will be used.
 
;pHeader
 
;pHeader
:[in]  Value of BSTR.
+
:[in]  The text of header of message.
 
;pOptionText
 
;pOptionText
:[in]  Value of BSTR.
+
:[in]  Specifies the text for check-box control on the dialog. Setting of any non-empty text will show the check-box control.
 
;pOptionState
 
;pOptionState
:[in, out]  Pointer to LONG.
+
:[in, out]  Sets/gets the state of check-box on the dialog.
 
;hWndParent
 
;hWndParent
:[in, defaultvalue(0)]  Value of HANDLE_T.
+
:[in, defaultvalue(0)]  The optional parameter that specifies 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 the user's choice identifier. For possible values see [[PXV:UIX_MsgBoxResult|UIX_MsgBoxResult]].
  
 
== Return Value ==
 
== Return Value ==

Revision as of 17:55, 26 May 2015


The method of interface of PDF-XChange Editor SDK.

Syntax

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

Parameters

pText
[in] Text of message.
pTitle
[in] The title for dialog box. If empty then default application's title will be used.
pHeader
[in] The text of header of message.
pOptionText
[in] Specifies the text for check-box control on the dialog. Setting of any non-empty text will show the check-box control.
pOptionState
[in, out] Sets/gets the state of check-box on the dialog.
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.
pRes
[out, retval, defaultvalue(NULL)] Returns the 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