IUIX_Inst::ShowMsgBoxEx Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_Inst::ShowMsgBoxEx Method}}
 
{{#customTitle:IUIX_Inst::ShowMsgBoxEx Method}}
 +
{{#parentPage:PXV:IUIX_Inst#Methods|ShowMsgBoxEx|method}}
  
The method of interface of PDF-XChange Editor SDK.
+
 
 +
Displays configurable message box.
 +
 
 +
Set required message box properties via '''pConfig''' parameter of [[PXV:UIX_MsgBoxConfig|UIX_MsgBoxConfig]] type.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT ShowMsgBoxEx([in] UIX_MsgBoxConfig* pConfig, [out, optional] LONG* pOptionState, [out, optional] LONG* pSelectedRadioID, [out, optional] BSTR* ppEditText, [out, retval, optional] LONG_PTR* pRes);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT ShowMsgBoxEx([in]                               UIX_MsgBoxConfig* pConfig,
 +
                    [out]                             LONG*             pOptionState,
 +
                    [out]                             LONG*             pSelectedRadioID,
 +
                    [out]                             BSTR*             ppEditText,
 +
                    [out, retval, defaultvalue(NULL)] LONG_PTR*         pRes);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pConfig''
+
;pConfig
:[in]  Pointer to [[PXV:UIX_MsgBoxConfig|UIX_MsgBoxConfig]].
+
:[in]  specifies message box properties via [[PXV:UIX_MsgBoxConfig|UIX_MsgBoxConfig]] structure.
;''pOptionState''
+
;pOptionState
:[out, optional]  Pointer to LONG.
+
:[out]  Pointer to LONG.
;''pSelectedRadioID''
+
;pSelectedRadioID
:[out, optionalPointer to LONG.
+
:[out]  returns numerical id of selected radio button (if message box was configured to display radio buttons). Set this parameter to <code>NULL</code> if this value is not required.
;''ppEditText''
+
;ppEditText
:[out, optionalPointer to BSTR.
+
:[out]  returns text entered by user in edit box (if message box was configured to display edit box). Set this parameter to <code>NULL</code> if no edit text value is required.
;''pRes''
+
;pRes
:[out, retval, optionalPointer to LONG_PTR.
+
:[out, retval, defaultvalue(NULL)returns [[PXV:UIX_MsgBoxResult|UIX_MsgBoxResult]] result value of button pressed on the end of message box.
  
 
== 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 11:38, 16 June 2015


Displays configurable message box.

Set required message box properties via pConfig parameter of UIX_MsgBoxConfig type.

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] specifies message box properties via UIX_MsgBoxConfig structure.
pOptionState
[out] Pointer to LONG.
pSelectedRadioID
[out] returns numerical id of selected radio button (if message box was configured to display radio buttons). Set this parameter to NULL if this value is not required.
ppEditText
[out] returns text entered by user in edit box (if message box was configured to display edit box). Set this parameter to NULL if no edit text value is required.
pRes
[out, retval, defaultvalue(NULL)] returns UIX_MsgBoxResult result value of button pressed on the end of message box.

Return Value

Returns S_OK if the operation was successful, or will return an error code if it fails.

See Also

IUIX_Inst