IUIX_Inst::ShowMsgBoxEx Method

From PDF XChange PDF SDK
Revision as of 11:38, 16 June 2015 by Johnv (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


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