IUIX_Inst::ShowMsgBoxEx Method

From PDF XChange PDF SDK
Jump to: navigation, search
Line 5: Line 5:
 
{{ToReview}}
 
{{ToReview}}
  
Displays configurable message box. Set required properties via '''pConfig''' parameter of [[PXV:UIX_MsgBoxConfig|UIX_MsgBoxConfig]] type.
+
Displays configurable message box.  
 +
 
 +
Set required message box properties via '''pConfig''' parameter of [[PXV:UIX_MsgBoxConfig|UIX_MsgBoxConfig]] type.
  
 
== Syntax ==
 
== Syntax ==
Line 20: Line 22:
 
:[out]  Pointer to LONG.
 
:[out]  Pointer to LONG.
 
;pSelectedRadioID
 
;pSelectedRadioID
:[out]  Pointer 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]  Pointer 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, defaultvalue(NULL)]  Pointer 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 ==

Revision as of 08:57, 27 May 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 operation was successful or error code in other cases.

See Also

IUIX_Inst