IUIX_Inst::ShowMsgBoxEx Method
From PDF XChange PDF SDK
| (One intermediate revision by one other user not shown) | |||
| Line 3: | Line 3: | ||
{{#customTitle:IUIX_Inst::ShowMsgBoxEx Method}} | {{#customTitle:IUIX_Inst::ShowMsgBoxEx Method}} | ||
{{#parentPage:PXV:IUIX_Inst#Methods|ShowMsgBoxEx|method}} | {{#parentPage:PXV:IUIX_Inst#Methods|ShowMsgBoxEx|method}} | ||
| − | |||
| − | 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] | + | :[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] | + | :[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)] | + | :[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 | + | Returns S_OK if the operation was successful, or will return an error code if it fails. |
== See Also == | == See Also == | ||
[[PXV:IUIX_Inst|IUIX_Inst]] | [[PXV:IUIX_Inst|IUIX_Inst]] | ||
Latest revision as of 10: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
NULLif 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
NULLif 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.
