IPXV_Inst::ShowMsgBoxEx Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 3: Line 3:
 
{{#customTitle:IPXV_Inst::ShowMsgBoxEx Method}}
 
{{#customTitle:IPXV_Inst::ShowMsgBoxEx Method}}
 
{{#parentPage:PXV:IPXV_Inst#Methods|ShowMsgBoxEx|method}}
 
{{#parentPage:PXV:IPXV_Inst#Methods|ShowMsgBoxEx|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
The extended method to show the custom message box.
  
 
== Syntax ==
 
== Syntax ==
Line 17: Line 16:
 
== Parameters ==
 
== Parameters ==
 
;pConfig
 
;pConfig
:[in]  Pointer to [[PXV:UIX_MsgBoxConfig|UIX_MsgBoxConfig]].
+
:[in]  Pointer to [[PXV:UIX_MsgBoxConfig|UIX_MsgBoxConfig]] structure.
 
;pOptionState
 
;pOptionState
:[out]  Pointer to LONG.
+
:[out]  Returns actual state of check-box on the message dialog.
 
;pSelectedRadioID
 
;pSelectedRadioID
:[out]  Pointer to LONG.
+
:[out]  Returns ID of selected radio-box on the message dialog.
 
;ppEditText
 
;ppEditText
:[out]  Pointer to BSTR.
+
:[out]  Returns the text, entered by user in edit-box on the message dialog.
 
;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 ==
Line 31: Line 30:
  
 
== See Also ==
 
== See Also ==
[[PXV:IPXV_Inst|IPXV_Inst]]
+
[[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IUIX_Inst_ShowMsgBoxEx|IUIX_Inst_ShowMsgBoxEx]]

Revision as of 17:47, 26 May 2015


The extended method to show the custom message box.

Syntax

HRESULT ShowMsgBoxEx([in]                               UIX_MsgBoxConfig*  pConfig,
                     [out]                              LONG*              pOptionState,
                     [out]                              LONG*              pSelectedRadioID,
                     [out]                              BSTR*              ppEditText,
                     [out, retval, defaultvalue(NULL)]  LONG_PTR*          pRes);

Parameters

pConfig
[in] Pointer to UIX_MsgBoxConfig structure.
pOptionState
[out] Returns actual state of check-box on the message dialog.
pSelectedRadioID
[out] Returns ID of selected radio-box on the message dialog.
ppEditText
[out] Returns the text, entered by user in edit-box on the message dialog.
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, IUIX_Inst_ShowMsgBoxEx