> For the complete documentation index, see [llms.txt](https://sandbox-docs.verifone.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sandbox-docs.verifone.com/adk-5.0-programmers-guide/readme/files/dir_44d926a17fc606d3c25449ba60427c63/dir_048f823fee1bfb22502a8732b9a001aa/ui_8h.md). # ui.h [Data Structures](#nested-classes) | [Macros](#define-members) | [Enumerations](#enum-members) | [Functions](#func-members) `#include "`[html/types.h](/adk-5.0-programmers-guide/types_8h_source.md)`"` `#include "`[html/gui.h](/adk-5.0-programmers-guide/gui_8h_source.md)`"` `#include "csd.h"` `#include "`[sdi\_lang.h](/adk-5.0-programmers-guide/sdi__lang_8h_source.md)`"` Include dependency graph for ui.h: ![](/files/nyTpabkIBTXdZYac1ciO) This graph shows which files directly or indirectly include this file: ![](/files/ruZ77NgMcDdbhyNIyauU) [Go to the source code of this file.](/adk-5.0-programmers-guide/ui_8h_source.md) | | | | --------------- | ----------------------------------------------------------------------------- | | Data Structures | | | class | [UICatalog](/adk-5.0-programmers-guide/readme/annotated/class_u_i_catalog.md) | | | | | ------- | ------------------------------------------------------------------------------ | | Macros | | | #define | [TOO\_MANY\_DIGITS\_ENTERED](#a419f69613fd3444396c9af77b9d47373) 0xFB | | #define | [TOO\_FEW\_DIGITS\_ENTERED](#ae49db04824fdd7a151a457fb4968c499) 0xFC | | #define | [INVALID\_VALUE\_ENTERED](#a8c8fff356b0fe8c881ce84b5811c832d) 0xFD | | #define | [PAN\_ENTERED\_CHECK\_AND\_CONFIRM](#ac58a59fe7cf09a094b60c02f551622c8) 0xFE | | #define | [CONT\_VAL\_CONTINUE](#ad63d347097f5fee92132ab988f1d3330) 0x01 | | #define | [CONT\_VAL\_REENTER](#a492f2ee0aab63c46e662d50f37f40644) 0x02 | | #define | [CONT\_VAL\_ABORT](#a33684442ed28588ba245da01ebcda01e) 0x03 | | #define | [CONT\_MODE\_INITIAL](#aac748c8bfe6a6cacfa6debe95e11d67b) 0x00 | | #define | [CONT\_MODE\_CONTINUE](#a0382e04565af914cd803e0c76319eebb) 0x01 | | #define | [CONT\_MODE\_BYPASS](#aaed9dc7793d609ee3adf9f9a3f1112fc) 0x02 | | #define | [CONT\_MODE\_SKIP](#a6e13f7249b6924bec5502b337eb054b7) 0x03 | | | | | | | | | | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------ | ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | ------------------------ | | Enumerations | | | | | | | | enum |

ui\_async\_result {
UI\_AR\_NONE = 0, UI\_AR\_IN\_PROGRESS = 1, UI\_AR\_KEY\_ENTER = 2, UI\_AR\_KEY\_CANCEL = 3,
UI\_AR\_KEY\_CLEAR = 4, UI\_AR\_TIMEOUT = 5, UI\_AR\_FAILED = 6
}

| | | | | | | enum | [DataEntryType](#a20ac1546c46d429507d181c015aaa912) { [TYPE\_PAN](#a20ac1546c46d429507d181c015aaa912aca54464035e00c84a71d87ab6573d969), [TYPE\_EXPIRYDATE](#a20ac1546c46d429507d181c015aaa912a8194ea92bc96f55706436de26b62cb1f), [TYPE\_CVV](#a20ac1546c46d429507d181c015aaa912ac73221990f14f0a82761dc3170b4f50e) } | | | | | | | enum |

Ui\_MenuOpts {
MENU\_NoOpts = 0x00, MENU\_Beep = 0x01, MENU\_NoLEDs = 0x02, MENU\_ClearOnReturn = 0x04,
MENU\_AbortOnCardRemove = 0x08, MENU\_IgnoreExtAbort = 0x10, MENU\_NoHeader = 0x20, MENU\_AllowedExtOptions = (MENU\_Beep | MENU\_NoLEDs | MENU\_ClearOnReturn | MENU\_AbortOnCardRemove | MENU\_IgnoreExtAbort | MENU\_NoHeader)
}

| | enum |

Ui\_PinOpts {
PIN\_NoOpts = 0x0, PIN\_NoLEDs = 0x1, PIN\_NoHeader = 0x2, PIN\_NoAmount = 0x4,
PIN\_NoCardAppLabel = 0x8, PIN\_AllowedExtOptions = (PIN\_NoLEDs | PIN\_NoHeader | PIN\_NoAmount | PIN\_NoCardAppLabel), PIN\_ClearOnReturn = 0x100, PIN\_AbortOnCardRemove = 0x200,
PIN\_IgnoreExtAbort = 0x400, PIN\_NavigatorMode\_1 = 0x800, PIN\_NavigatorMode\_2 = 0x1000, PIN\_ClearAllDigits = 0x2000,
PIN\_AutoEnter = 0x4000, PIN\_Beep = 0x8000
}

| | | | enum |

Ui\_PinBypass {
PINBypass\_Disabled = 0, PINBypass\_Enter = 1, PINBypass\_Clear = 2, PINBypass\_DisableByDigit = 4,
PINBypass\_MaskAllowed = (PINBypass\_Enter | PINBypass\_Clear | PINBypass\_DisableByDigit)
}

| | | | | enum |

Ui\_DialogOpts {
DLG\_DisplayOnly = 0x0000, DLG\_Beep = 0x0001, DLG\_CancelKey = 0x0002, DLG\_ClearKey = 0x0004,
DLG\_EnterKey = 0x0008, DLG\_NoLEDs = 0x0010, DLG\_CtlsLogo = 0x0020, DLG\_QuestionLogo = 0x0040,
DLG\_WarningLogo = 0x0080, DLG\_ErrorLogo = 0x0100, DLG\_SuccessLogo = 0x0200, DLG\_WaitLogo = 0x0400,
DLG\_Async = 0x0800, DLG\_StoreAsyncResult = 0x1000, DLG\_HideSoftKeys = 0x2000, DLG\_TextAlignLeft = 0x4000,
DLG\_TextAlignRight = 0x8000, DLG\_TextAlignTop = 0x10000, DLG\_TextAlignBottom = 0x20000, DLG\_NoHeader = 0x40000,
DLG\_ExtDialogCompat = 0x80000, DLG\_ClearOnReturn = 0x100000, DLG\_AbortOnCardRemove = 0x200000, DLG\_IgnoreExtAbort = 0x400000,
DLG\_AllowedExtOptions, DLG\_AllowedOptsHtmlDialog = (DLG\_Beep | DLG\_ClearOnReturn | DLG\_AbortOnCardRemove | DLG\_IgnoreExtAbort)
}

| | | | enum |

Ui\_IdleScreenOpts {
IDLE\_DisplayOnly = 0x0000, IDLE\_MenuKey = 0x0001, IDLE\_InfoKey = 0x0002, IDLE\_NoLEDs = 0x0004,
IDLE\_AdminMode = 0x0008, IDLE\_WaitLogo = 0x0010
}

| | | | | | | | | | ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Functions | | | int | [ui\_externalDialog](#a19379bd666609efb538105ce2ae7a807) (unsigned char templateId, [vfigui::stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), unsigned char confirmation, unsigned options, unsigned short timeout, int \*raw\_ui\_error) | | int | [ui\_htmlDialog](#a6110a48d377884750953d5d64d08f3b4) (const std::string \&htmlFileName, [vfigui::stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), unsigned short timeout, sdi::Language lang, int options, int \*raw\_ui\_error) | | int | [ui\_handleSecureInput](#a05673c488203ddc624574dbfc0bd68b6) (unsigned char templateId, sdi::Language textLanguage, unsigned char beep, unsigned short timeout, [vfigui::stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), char maskingCharacter, char \*inputFormatString, unsigned char \*amount=0, unsigned short currency=0) | | int | [ui\_handleSignatureCapture](#a0cd6b4fc4f709ac8ad90198cdb1f97d1) (sdi::Language textLanguage, unsigned short timeout, [vfigui::stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | int | [ui\_handleMenu](#afd08dfc1f42b0f1bd659824a5306b445) ([vfigui::stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), unsigned options=[MENU\_NoOpts](#a03c36e7a7b2a4a8348a923d1bbea40cdae4fbe9039b772ade068e88f8265108be), int timeout=30, int \*raw\_ui\_error=0) | | int | [ui\_handleCardRequestDisplay](#ab30732de7d5a5c7664efde3ba8904adc) (unsigned char CardTec, unsigned char displayMode, unsigned char \*amount, unsigned short currency, unsigned char cancel\_allowed, unsigned char transType) | | int | [ui\_handleManualCardDataEntry](#af52e15c4b9cfcc11bdfc7f8d7452d97a) (sdi::Language textLanguage, unsigned short timeout, csd::csd\_stringmap &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), unsigned char cardEntryValueDeactivation, unsigned char cardEntryMode, char \*inputFormatString, char \*touchCoordinates=NULL, unsigned char nbrTouchButtons=0, unsigned char minPanLen=10, unsigned char maxPanLen=19, unsigned char skipCb9FFE=0) | | int | [ui\_getInputMinLength](#a73cf2c8bc44322fd8bc317d8209d33eb) (std::string text) | | int | [ui\_EnterPin](#a53aab43e03449d3bdacdde9bd16720a6) (sdi::Language pinTextLanguage, unsigned short timeout=30, unsigned char \*pinBypass=0, unsigned opts=[PIN\_NoOpts](#ae6494117b1b0c196ab1b9981ab683c49a17596fceda9610ca318260b1f8b23ae0), unsigned char minPINLength=4, unsigned char maxPINLength=12, unsigned interchar\_tout=0, [vfigui::stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) \*[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)=0, int password\_char=' \*', char \*touchCoordinates=NULL, unsigned char nbrTouchButtons=0) | | void | [ui\_displayTextKey](#a16368be7b4e7be2510250e631e574d5f) (const std::string \&textKey, sdi::Language language) | | int | [ui\_confirmTextKey](#ae691f65eca85109b97ccd8deac99d31b) (const std::string \&textKey, sdi::Language language, [vfigui::stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) \*[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)=0, unsigned short timeout=30) | | int | [ui\_dialog](#a4b7319a86c184959120dce38a728d0b6) (const std::string \&msg, unsigned options, int timeout=30, [vfigui::stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) \*[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)=0, bool \*abort=0) | | int | [ui\_idlescreen](#aea3e6754899767db82e0d6f833217d86) (const std::string \&msg, int options, int timeout=-1, void \*data=0) | | void | [ui\_init](#a68956acd7367ab924e908aa21ff69977) ([vfigui::uiAsyncCallback](/adk-5.0-programmers-guide/readme/modules/group__vfigui/namespacevfigui.md#a29ea0490208725e330b8b11f770b51a7) idlescreen\_cb) | | bool | [ui\_enabled](#a1ad32d548b03e8a236234a14a403b542) (void) | | void | [ui\_clear](#a1acba8dd875b196c56fd81343bd7268c) (void) | | enum [ui\_async\_result](#ac7e05259c409a7da9ce23ecc55fb7965) | [ui\_getAsyncResult](#a40088972f5ff382908110f7ca09c4562) (bool reset=true, int \*raw\_ui\_error=0) | | void | [ui\_enableLEDs](#a0d50a3becade3528b73e45167104edb2) (bool enable=true) | | void | [ui\_dispLEDs](#a00dd9f7eda4dffa9bfd85ee9640edd15) (unsigned char leds) | ### MacroDefinition Documentation ### CONT\_MODE\_BYPASS \#define CONT\_MODE\_BYPASS 0x02 ### CONT\_MODE\_CONTINUE \#define CONT\_MODE\_CONTINUE 0x01 ### CONT\_MODE\_INITIAL \#define CONT\_MODE\_INITIAL 0x00 ### CONT\_MODE\_SKIP \#define CONT\_MODE\_SKIP 0x03 ### CONT\_VAL\_ABORT \#define CONT\_VAL\_ABORT 0x03 ### CONT\_VAL\_CONTINUE \#define CONT\_VAL\_CONTINUE 0x01 ### CONT\_VAL\_REENTER \#define CONT\_VAL\_REENTER 0x02 ### INVALID\_VALUE\_ENTERED \#define INVALID\_VALUE\_ENTERED 0xFD ### PAN\_ENTERED\_CHECK\_AND\_CONFIRM \#define PAN\_ENTERED\_CHECK\_AND\_CONFIRM 0xFE ### TOO\_FEW\_DIGITS\_ENTERED \#define TOO\_FEW\_DIGITS\_ENTERED 0xFC ### TOO\_MANY\_DIGITS\_ENTERED \#define TOO\_MANY\_DIGITS\_ENTERED 0xFB ### EnumerationType Documentation ### DataEntryType enum \[DataEntryType]\(#a20ac1546c46d429507d181c015aaa912) Data which have to be enetered | | | | ---------------- | ----------------------- | | Enumerator | | | TYPE\_PAN | PAN | | TYPE\_EXPIRYDATE | Expiry Date | | TYPE\_CVV | Card Verifivcation Code | ### ui\_async\_result enum \[ui\_async\_result]\(#ac7e05259c409a7da9ce23ecc55fb7965) | | | | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Enumerator | | | UI\_AR\_NONE | no async dialog started (no result) | | UI\_AR\_IN\_PROGRESS | async dialog in progress (no result returned yet) | | UI\_AR\_KEY\_ENTER | ENTER/CONFIRM hardkey/softkey was pressed | | UI\_AR\_KEY\_CANCEL | CANCEL/ABORT hardkey/softkey was pressed | | UI\_AR\_KEY\_CLEAR | BACK/CLEAR hardkey/softkey was pressed | | UI\_AR\_TIMEOUT | async dialog has timed out | | UI\_AR\_FAILED | async dialog has failed (more details will provide ADKGUI raw error code, see parameter `raw_ui_error` of function [ui\_getAsyncResult()](#a40088972f5ff382908110f7ca09c4562) | ### Ui\_DialogOpts enum \[Ui\_DialogOpts]\(#ae940dc1b4b4dc186b37f3bba108b17c4) | | | | -------------------------- | - | | Enumerator | | | DLG\_DisplayOnly | | | DLG\_Beep | | | DLG\_CancelKey | | | DLG\_ClearKey | | | DLG\_EnterKey | | | DLG\_NoLEDs | | | DLG\_CtlsLogo | | | DLG\_QuestionLogo | | | DLG\_WarningLogo | | | DLG\_ErrorLogo | | | DLG\_SuccessLogo | | | DLG\_WaitLogo | | | DLG\_Async | | | DLG\_StoreAsyncResult | | | DLG\_HideSoftKeys | | | DLG\_TextAlignLeft | | | DLG\_TextAlignRight | | | DLG\_TextAlignTop | | | DLG\_TextAlignBottom | | | DLG\_NoHeader | | | DLG\_ExtDialogCompat | | | DLG\_ClearOnReturn | | | DLG\_AbortOnCardRemove | | | DLG\_IgnoreExtAbort | | | DLG\_AllowedExtOptions | | | DLG\_AllowedOptsHtmlDialog | | ### Ui\_IdleScreenOpts enum \[Ui\_IdleScreenOpts]\(#abec9dedd169e58d1b41f008e16d3a8eb) | | | | ----------------- | - | | Enumerator | | | IDLE\_DisplayOnly | | | IDLE\_MenuKey | | | IDLE\_InfoKey | | | IDLE\_NoLEDs | | | IDLE\_AdminMode | | | IDLE\_WaitLogo | | ### Ui\_MenuOpts enum \[Ui\_MenuOpts]\(#a03c36e7a7b2a4a8348a923d1bbea40cd) | | | | ----------------------- | - | | Enumerator | | | MENU\_NoOpts | | | MENU\_Beep | | | MENU\_NoLEDs | | | MENU\_ClearOnReturn | | | MENU\_AbortOnCardRemove | | | MENU\_IgnoreExtAbort | | | MENU\_NoHeader | | | MENU\_AllowedExtOptions | | ### Ui\_PinBypass enum \[Ui\_PinBypass]\(#a35047e077ef95212c81b8fbba2fbb3e1) | | | | ------------------------- | - | | Enumerator | | | PINBypass\_Disabled | | | PINBypass\_Enter | | | PINBypass\_Clear | | | PINBypass\_DisableByDigit | | | PINBypass\_MaskAllowed | | ### Ui\_PinOpts enum \[Ui\_PinOpts]\(#ae6494117b1b0c196ab1b9981ab683c49) | | | | ---------------------- | - | | Enumerator | | | PIN\_NoOpts | | | PIN\_NoLEDs | | | PIN\_NoHeader | | | PIN\_NoAmount | | | PIN\_NoCardAppLabel | | | PIN\_AllowedExtOptions | | | PIN\_ClearOnReturn | | | PIN\_AbortOnCardRemove | | | PIN\_IgnoreExtAbort | | | PIN\_NavigatorMode\_1 | | | PIN\_NavigatorMode\_2 | | | PIN\_ClearAllDigits | | | PIN\_AutoEnter | | | PIN\_Beep | | ### FunctionDocumentation ### ui\_clear() void ui\_clear Removes the last rendered UI dialog and clears the display. ### ui\_confirmTextKey() int ui\_confirmTextKey display a confirmation dialog, which text is taken from UI catalog looked up by specified text key *textKey*. Language ID *language* will the select the corresponding language specific UI catalog. **Parameters** \[in] **textKey** to look up text from UI catalog to display \[in] **language** language ID \[in] **value** Initial UI key value map (or NULL if not provided). Following additional UI string parameters can be passed:Key "header\_text" with value used as PIN dialog header text (instead of customer logo)Key "amount" used as displayed amount (must come along with "curr")Key "curr" used as displayed currency (must come along with "amount") \[in] **timeout** dialog timeout in seconds (default: 30) #### Returns RESULT\_OK if the configuration dialog was confirmed, else RESULT\_USER\_CANCEL if confirmation was declined. Finally other error codes (as returned by [ui\_dialog()](#a4b7319a86c184959120dce38a728d0b6), e.g. RESULT\_FAIL, RESULT\_MOBILE\_ABORT, RESULT\_NO\_LINK, RESULT\_TIMEOUT) can be returned. ### ui\_dialog() int ui\_dialog display a generic dialog. Depending on option `DLG_Async` the function is invoked asynchronously (returning immediately) or synchronously (waiting for the dialog result). For synchronous calls the dialog result is returned as function return value. For asynchronous calls, the user may set additional option `DLG_StoreAsyncResult` to buffer the result and read it with function [ui\_getAsyncResult()](#a40088972f5ff382908110f7ca09c4562) afterwards. **Parameters** \[in] **msg** dialog text message \[in] **options** dialog options, see enum Ui\_DialogOpts \[in] **timeout** dialog timeout in seconds, a negative value means infinite timeout \[in,out] **value** an optional value map passed to uiInvoke()/uiInvokeAsync(). UI result values are returned in this map to the caller. \[in] **abort** optional pointer to flag variable, which can be set to true, to abort the synchronous dialog. Set this parameter NULL to disable abort by this flag. In this case of successfull abort, RESULT\_USER\_CANCEL is returned. Please note that this flag is ignored for asynchronous calls with option DLG\_Async. #### Returns Result codes for synchronous calls: RESULT\_OK: Enter softkey/hardkey pressed RESULT\_CLEAR\_BUTTON: Clear softkey/hardkey pressed RESULT\_USER\_CANCEL: Cancel softkey/hardkey pressed or flag `abort` set to true RESULT\_TIMEOUT: Dialog timed out RESULT\_MOBILE\_ABORT: Abort received from mobile device (see option DLG\_IgnoreExtAbort) RESULT\_NO\_LINK: Link to mobile device disturbed (see option DLG\_IgnoreExtAbort) RESULT\_FAIL: Card was removed (see option DLG\_AbortOnCardRemove) RESULT\_FAIL: For other errors Result codes for asynchronous calls: RESULT\_OK: dialog invocation successful RESULT\_FAIL: dialog invocation failed ### ui\_displayTextKey() void ui\_displayTextKey display a message dialog, which text is taken from UI catalog looked up by specified text key *textKey*. Language ID *language* will the select the corresponding language specific UI catalog. The dialog is invoked asynchornously so that this function returns immediately. **Parameters** \[in] **textKey** text key to look up text from UI catalog to display \[in] **language** language ID to select the UI catalog ### ui\_dispLEDs() void ui\_dispLEDs ### ui\_enabled() bool ui\_enabled Returns true, if UI interface of SDI server was enabled with call of [ui\_init()](#a68956acd7367ab924e908aa21ff69977). #### Returns true, if UI interface of SDI server was enabled ### ui\_enableLEDs() void ui\_enableLEDs ### ui\_EnterPin() int ui\_EnterPin Enter the PIN **Parameters** \[in] **pinTextLanguage** language for the PIN entry text (ignored for headless mode) \[in] **timeout** timeout value for PIN entry in seconds \[in,out] **pinBypass** Input values: Bitmask, see enum Ui\_PinBypass Passing a NULL pointer also disables PIN bypass. Output values: (only valid if function returns RESULT\_OK) 0: no PIN bypass done 1: PIN bypass with Enter key 2: PIN bypass with Clear key \[in] **opts** PIN entry options, see enum Ui\_PinOpts for more details \[in] **minPINLength** minimum number of PIN digits to enter, default is 4 \[in] **maxPINLength** maximum number of PIN digits to enter, default is 12 \[in] **interchar\_tout** inter-character timeout (in ms). 0 means no timeout specified (default). \[in] **value** Initial UI key value map (or NULL if not provided). Following additional UI string parameters can be passed:Key "header\_text" with value used as PIN dialog header text (instead of customer logo), please note that this value is ignored, if option PIN\_NoHeader is set.Key "amount" used as displayed amount (must come along with "curr"), please note that this value is ignored, if option PIN\_NoAmount is set.Key "curr" used as displayed currency (must come along with "amount"), please note that this value is ignored, if option PIN\_NoAmount is set.Key "prefname" as application preferred name (or card application name), please note that this value is ignored, if option PIN\_NoCardAppLabel is set. \[in] **password\_char** Echo character to display for an entered digit (default: '\*') \[in] **touchCoordinates** pointer to the memory for the touch coordinates (default: NULL) \[in] **nbrTouchButtons** 0: no touch buttons defined, else > 0 #### Returns RESULT\_OK if PIN is entered successfully (check for pinBypass return value), RESULT\_FAIL, RESULT\_MOBILE\_ABORT, RESULT\_NO\_LINK, RESULT\_TIMEOUT, RESULT\_USER\_CANCEL ### ui\_externalDialog() int ui\_externalDialog Displays an external dialog for command Handle Display (24-03) with a specified template *templateId*. For templateId==1, SDI server used default dialog dialog.html, otherwise the following file is looked up: template\_e\_\.html. The templateId in the filename is filled up to 3 digits, e.g. templateId==2 will look up template\_e\_002.html. **Parameters** \[in] **templateId** Template Identifier as passed in TLV tag DFA010 (default: 1 for dialog.html). \[in] **value** Stringmap including the text to display \[in] **confirmation** Confirmation requested (0 = no, 1 = yes) => this parameter is ignored, if options hasn't set bit DLG\_ExtDialogCompat \[in] **options** dialog options as supported for ui\_dialog(), see enum Ui\_DialogOpts \[in] **timeout** Timeout in seconds \[out] **raw\_ui\_error** if a pointer is passed the related variable is set with the raw error code of ADKGUI #### Returns RESULT\_OK or RESULT\_FAIL ### ui\_getAsyncResult() enum \[ui\_async\_result]\(#ac7e05259c409a7da9ce23ecc55fb7965) ui\_getAsyncResult ### ui\_getInputMinLength() int ui\_getInputMinLength ### ui\_handleCardRequestDisplay() int ui\_handleCardRequestDisplay Handles the displays for card requests **Parameters** \[in] **CardTec** Supported card technology \[in] **displayMode** Display mode: 0 = default, 1 = Fallback, 2 = retry \[in] **amount** Pointer to amount (BCD buffer of 6 bytes) or NULL if no amount used \[in] **currency** Currency code or 0 if no currency used \[in] **cancel\_allowed** Cancel button allowed or not \[in] **transType** Transaction Type according to EMV-ADK #### Returns RESULT\_OK or RESULT\_FAIL ### ui\_handleManualCardDataEntry() int ui\_handleManualCardDataEntry Handles the manual card data entry **Parameters** \[in] **textLanguage** Language to use \[in] **timeout** Timeout in seconds \[out] **value** Stringmap including the input data \[in] **cardEntryValueDeactivation** Value Deactivation (0 = enter all values, 1 = skip CVV, 2 = skip Expiry Date and CVV) \[in] **cardEntryMode** Entry Mode (0 = enter data in one screen, 1 = enter data in separate screens) \[in] **inputFormatString** Alternative Format string (see separate documentation for details) \[in] **touchCoordinates** pointer to the memory for the touch coordinates (default: NULL) \[in] **nbrTouchButtons** 0: no touch buttons defined, else > 0 \[in] **minPanLen** Minimum number of PAN digits, default: 10 \[in] **minPanLen** Maximum number of PAN digits, default: 19 \[in] **skipCb9FFE** 0: CB 9FFE active, 1: CB 9FFE skipped #### Returns RESULT\_OK or RESULT\_FAIL ### ui\_handleMenu() int ui\_handleMenu display a menu dialog. Menu entries are passed in value map `value`, which supports the following values: "headline": a text line used as menu headline "menu": a JSON formatted string. The JSON data consist of an array, each entry represents a menu item having additional options and values as follows: \[ { "icon\_id": "checked", "selected": true, "submenu": true, "text": "LAN", "value": 0 },{ "icon\_id": "unchecked", "selected": false, "submenu": false, "text": "USB", "value": 1 } ] Meaning of JSON values for each menu item entry: "icon\_id": an icon ID referring to an CSS class to display a icon next to the item text "checked" is recently used to display a checked radio button icon "unchecked" is recently used to display an un-checked radio buttion Omitting "icon\_id" or an empty value means displaying no icon. "selected": sets the menu item as pre-selected. The pre-selection may be a background color, which differs from un-selected menu icons. Confirming the pre-selected item with enter hardkey/softkey lets [ui\_handleMenu()](#afd08dfc1f42b0f1bd659824a5306b445) return the value assigned to "value". Omitting "selected" or setting to false means the item is not pre-selected. "submenu": the menu item is displayed as submenu item. On selection the item shall display submenu and on return of this menu the previous menu shall be displayed. Recently an arrow icon is displayed next to the item text. Omitting "submenu" or setting to false means the item is displayed as normal item entry. "text": text line used as menu item text "value": value, which is returned [ui\_handleMenu()](#afd08dfc1f42b0f1bd659824a5306b445), if the menu item is selected. Please note to use positive values (>=0) to distingish menu times from error codes returned for failures or aborts. **Parameters** \[out] **value** Stringmap including the selected menu entry \[in] **options** menu dialog options, see enum Ui\_MenuOpts \[in] **timeout** menu dialog timeout in seconds, a value <=0 means infinite timeout \[out] **raw\_ui\_error** if a pointer is passed the related variable is set with the raw error code of ADKGUI #### Returns For a selected menu item, the "value" for the selected menu item is returned. This is usually value >=0. Negative values indicate the following errors: RESULT\_USER\_CANCEL: Cancel softkey/hardkey pressed to abort the menu dialog without selection of an menu item. RESULT\_TIMEOUT: Menu dialog timed out RESULT\_MOBILE\_ABORT: Abort received from mobile device (see option MENU\_IgnoreExtAbort) RESULT\_NO\_LINK: Link to mobile device disturbed (see option MENU\_IgnoreExtAbort) RESULT\_FAIL: Card was removed (see option MENU\_AbortOnCardRemove) RESULT\_FAIL: For other errors ### ui\_handleSecureInput() int ui\_handleSecureInput Handles secure inputs **Parameters** \[in] **templateId** Template identifier as passed in TLV tag DFA007 of command Handle Secure Input (24-04) \[in] **textLanguage** Language to use \[in] **beep** Beep when text will be displayed (0 = no, 1 = yes) \[in] **timeout** Timeout in seconds \[out] **value** Stringmap including the input data \[in] **maskingCharacter** Masking character to be use during the input \[in] **inputFormatString** Alternative Format string (see separate documentation for details) \[in] **amount** Amount to be displayed during the input \[in] **currency** Currency to be displayed during the input #### Returns RESULT\_OK or RESULT\_FAIL ### ui\_handleSignatureCapture() int ui\_handleSignatureCapture Handles the signature capture **Parameters** \[in] **textLanguage** Language to use \[in] **timeout** Timeout in seconds \[out] **value** Stringmap for the captured signature #### Returns RESULT\_OK or RESULT\_FAIL ### ui\_htmlDialog() int ui\_htmlDialog Displays an external HTML dialog specified by cusomer specific HTML file **Parameters** \[in] **htmlFileName** Name of the HTML file \[in,out] **value** Stringmap including the HTML input and output values (needs to be matched with the corresponding HTML file) \[in] **timeout** Timeout in seconds \[in] **lang** Language to use \[in] **options** dialog options as used for ui\_dialog(), see enum Ui\_DialogOpts. Supported options are defined by DLG\_AllowedOptsHtmlDialog. \[out] **raw\_ui\_error** if a pointer is passed the related variable is set with the raw error code of ADKGUI #### Returns SDI result code (e.g. RESULT\_OK or RESULT\_FAIL) ### ui\_idlescreen() int ui\_idlescreen display the idlescreen. This function is always called asynchronously and dialog results are reported via callback, which was passed as parameter `idlescreen_cb` to function [`ui_init()`](#a68956acd7367ab924e908aa21ff69977). If both, parameters `msg` and `logo` are empty, the idlescreen displays the standard idle text referred by text ID TXT\_IDLE\_SCREEN. A filled string for `msg` and/or `logo` will remove the standard idle text and display the text message and/or the image logo on idlescreen. **Parameters** \[in] **msg** idlescreen text message \[in] **options** idlescreen options, see enum Ui\_IdleScreenOpts \[in] **timeout** idlescreen timeout in seconds, a negative value means infinite timeout \[in] **data** pointer directly passed to idlescreen callback idlescreen\_cb set by function ui\_init() #### Returns RESULT\_OK: idlescreen invocation successful RESULT\_FAIL: idlescreen invocation failed ### ui\_init() void ui\_init Enable and initialize the UI interface of SDI server. **Parameters** \[in] **idlescreen\_cb** idlescreen result callback function, which is invoked, if asynchronous idlescreen dialog returns (see function ui\_idlescreen()). {% hint style="info" %} The function must be called at once at startup (SDI standard mode). After UI initialization, the function [ui\_enabled()](#a1ad32d548b03e8a236234a14a403b542) returns true. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://sandbox-docs.verifone.com/adk-5.0-programmers-guide/readme/files/dir_44d926a17fc606d3c25449ba60427c63/dir_048f823fee1bfb22502a8732b9a001aa/ui_8h.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.