> 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/modules/group__vfigui/namespacevfigui.md). # vfigui [Data Structures](#nested-classes) | [Typedefs](#typedef-members) | [Enumerations](#enum-members) | [Functions](#func-members) | | | | --------------- | ---------------------------------------------------------------------------------------------------------------------------- | | Data Structures | | | struct | [UIBacklight](#structvfigui_1_1_u_i_backlight) | | class | [UICBData](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvfigui_1_1_u_i_c_b_data.md) | | class | [UIDrawing](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvfigui_1_1_u_i_drawing.md) | | struct | [UIErrorEntry](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/structvfigui_1_1_u_i_error_entry.md) | | struct | [UIMenuEntry](#structvfigui_1_1_u_i_menu_entry) | | struct | [UIRegion](#structvfigui_1_1_u_i_region) | | struct | [UIStatistics](#structvfigui_1_1_u_i_statistics) | | struct | [UITextWidth](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/structvfigui_1_1_u_i_text_width.md) | | | | | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Typedefs | | | typedef bool(\* | [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8)) (void \*data) | | typedef void(\* | [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7)) (void \*data, [UICBType](#a2eee911f81a366ee45341def47875e17) type, [UICBData](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvfigui_1_1_u_i_c_b_data.md) \&uidata) | | typedef void(\* | [uiDisconnectCallback](#ab8ea76e56e5a189126608d0674e79db7)) (int display) | | typedef void(\* | [uiPinStatusCallback](#a996cf8c4f9fc88f971a90d1b1ed5f7fa)) (int status, int digit\_count) | | typedef void(\* | [uiEventCallback](#a5ded57d248c0c7c8b719a61284a75453)) (void \*data, [UICanvasEvent](#ab39be9e8cfe25802d65abffda76e2ce9) event, int x, int y, int key, unsigned flags) | | | | | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Enumerations | | | enum |

UICBType {
UI\_CB\_RESULT, UI\_CB\_UPDATE, UI\_CB\_LOAD, UI\_CB\_ERROR\_LIST,
UI\_CB\_STATISTICS, UI\_CB\_EVENT
}

| | enum | { [UI\_REGION\_DEFAULT](#a99fb83031ce9923c84392b4e92f956b5ab7c758bc6ba3fd0e57fbb46ee178b43f) =0 } | | enum | { [UI\_REGION\_FLAG\_HIDDEN](#abc6126af1d45847bc59afa0aa3216b04aa53740e76041bfa278474eea977aa607) =1 } | | enum |

UIPropertyInt {
UI\_PROP\_TIMEOUT =0, UI\_PROP\_PASSWORD\_CHAR, UI\_PROP\_DEFAULT\_FONT\_SIZE, UI\_PROP\_PIN\_AUTO\_ENTER,
UI\_PROP\_PIN\_CLEAR\_ALL, UI\_PROP\_PIN\_BYPASS\_KEY, UI\_PROP\_PIN\_ALGORITHM, UI\_PROP\_PIN\_INTERCHAR\_TIMEOUT,
UI\_PROP\_PASSWORD\_SHOW\_CHAR, UI\_PROP\_KEEP\_DISPLAY, UI\_PROP\_UPDATE\_EVENTS, UI\_PROP\_CIRCULAR\_MENU,
UI\_PROP\_TOUCH\_ACTION\_BEEP, UI\_PROP\_STATISTICS, UI\_PROP\_RESTRICTED, UI\_PROP\_CP\_APP\_MODE,
UI\_PROP\_SCROLL\_COLOR, UI\_PROP\_INPUT\_ERROR\_BEEP, UI\_PROP\_ZOOM\_MAX, UI\_PROP\_SCROLL\_DISPLAY,
UI\_PROP\_JS\_QUOTA\_SIZE, UI\_PROP\_SCROLL\_WIDTH, UI\_PROP\_LONG\_PRESS, UI\_PROP\_LONG\_IMMEDIATE,
UI\_PROP\_OVERFLOW\_EXT, UI\_DEVICE\_WIDTH =1000, UI\_DEVICE\_HEIGHT, UI\_DEVICE\_COLOR\_DEPTH,
UI\_DEVICE\_SUPPORTS\_TOUCH, UI\_DEVICE\_SUPPORTS\_BEEPER, UI\_DEVICE\_SUPPORTS\_AUDIO, UI\_DEVICE\_SUPPORTS\_VIDEO,
UI\_DEVICE\_SUPPORTS\_SIGCAP, UI\_DEVICE\_SUPPORTS\_COLOR\_DISPLAY, UI\_DEVICE\_HAS\_CAP\_TOUCH\_KEYPAD, UI\_DEVICE\_SUPPORTS\_NAVIGATOR\_MODE,
UI\_DEVICE\_KEY\_COUNT
}

| | enum |

UIPropertyString {
UI\_PROP\_DECIMAL\_SEPARATOR =2000, UI\_PROP\_THOUSANDS\_SEPARATOR, UI\_PROP\_DEFAULT\_FONT, UI\_PROP\_RESOURCE\_PATH,
UI\_PROP\_FILE\_PREFIX, UI\_PROP\_KEYMAP, UI\_PROP\_CSS, UI\_PROP\_RESOURCE\_DEFAULT\_PATH,
UI\_PROP\_GUI\_EXTENSIONS, UI\_PROP\_HTTP\_HEADER\_FIELDS, UI\_PROP\_CP\_APP\_DIR, UI\_PROP\_LANGUAGE,
UI\_PROP\_JS\_ROOT, UI\_PROP\_PRINT\_ROOT, UI\_PROP\_PRINT\_CSS, UI\_PROP\_JS\_QUOTA\_ROOT,
UI\_DEVICE\_MODEL =3000
}

| | enum | [UIServerProperty](#a84ff3a6d9454d39192c2fccc92900230) { [UI\_SERVER\_TOUCH\_ACTION\_BEEP](#a84ff3a6d9454d39192c2fccc92900230acb6d3a1a7ef8fe6696e2686ddfac439b), [UI\_SERVER\_INPUT\_ERROR\_BEEP](#a84ff3a6d9454d39192c2fccc92900230a10e894a7b837b3e8797a3c45a39f1b15), [UI\_SERVER\_KEYMAP](#a84ff3a6d9454d39192c2fccc92900230a7a1c49a08b2e2aa4ddd7ad9394f1dcff) } | | enum |

{
UI\_TRANS\_UP =0x1, UI\_TRANS\_RIGHT =0x2, UI\_TRANS\_DOWN =0x4, UI\_TRANS\_LEFT =0x8,
UI\_TRANS\_DIRECTION\_MASK =0xf, UI\_TRANS\_EASE\_IN =0x10, UI\_TRANS\_EASE\_OUT =0x20, UI\_TRANS\_EASE\_INOUT =0x30,
UI\_TRANS\_EASE\_MASK =0x30, UI\_TRANS\_NONE =0x000, UI\_TRANS\_SLIDE =0x100, UI\_TRANS\_SLIDEON =0x200,
UI\_TRANS\_SWAP =0x300, UI\_TRANS\_CROSSFADE =0x400, UI\_TRANS\_TYPE\_MASK =0xfff00
}

| | enum | [UILEDShape](#ab9093178bd56d7fa93a9f14269817087) { [UI\_SHAPE\_RECTANGLE](#ab9093178bd56d7fa93a9f14269817087ad9c71758cfa4e04ca6df76c8bd15a1f2), [UI\_SHAPE\_ELLIPSE](#ab9093178bd56d7fa93a9f14269817087a8a7d344d0b9202c920ed4790a1a1443b) } | | enum | [UIEdge](#a953c1b2cadd586de592b1f3dc07eab7e) { [UI\_EDGE\_TOP](#a953c1b2cadd586de592b1f3dc07eab7ea4336eca5d4a88bfd695b374a9f54799f), [UI\_EDGE\_RIGHT](#a953c1b2cadd586de592b1f3dc07eab7eae446ca2d01032490cf1062a32e0b68a3), [UI\_EDGE\_BOTTOM](#a953c1b2cadd586de592b1f3dc07eab7ea836f3413e753708c6a3da2af37023abe), [UI\_EDGE\_LEFT](#a953c1b2cadd586de592b1f3dc07eab7ea1063a026e87b7c8837ff876aef8f9b1b) } | | enum | [UIScrollPosition](#a09efbc077884a4944a73602edd62f2c4) { [UI\_SCROLL\_TOP](#a09efbc077884a4944a73602edd62f2c4a5680925a69ff89175050925fb88737f7), [UI\_SCROLL\_BOTTOM](#a09efbc077884a4944a73602edd62f2c4a8cec25f66c4fc093fa5f31ba25588f3d) } | | enum |

UIPinStatus {
UI\_PS\_IDLE = 0, UI\_PS\_CONFIRM = 1, UI\_PS\_CANCEL = 2, UI\_PS\_TIMEOUT = 3,
UI\_PS\_BYPASS = 4, UI\_PS\_ACTIVE = 0x10, UI\_PS\_UNDERFLOW = 0x11, UI\_PS\_OVERFLOW = 0x12,
UI\_PS\_DIGIT = 0x13, UI\_PS\_BACKSPACE = 0x14, UI\_PS\_ASTERISK = 0x15, UI\_PS\_HASH = 0x16,
UI\_PS\_F1 = 0x17, UI\_PS\_F2 = 0x18, UI\_PS\_F3 = 0x19, UI\_PS\_F4 = 0x1a,
UI\_PS\_NAVIGATOR = 0x20, UI\_PS\_NAVIGATOR\_DIGIT\_SELECTED = 0x21, UI\_PS\_NAVIGATOR\_CANCEL\_SELECTED = 0x22, UI\_PS\_NAVIGATOR\_BACKSPACE\_SELECTED = 0x23,
UI\_PS\_NAVIGATOR\_CONFIRM\_SELECTED = 0x24, UI\_PS\_NAVIGATOR\_MULTIPLE\_TOUCHES = 0x25, UI\_PS\_NAVIGATOR\_ASTERISK\_SELECTED = 0x26, UI\_PS\_NAVIGATOR\_HASH\_SELECTED = 0x27,
UI\_PS\_NAVIGATOR\_F1\_SELECTED = 0x28, UI\_PS\_NAVIGATOR\_F2\_SELECTED = 0x29, UI\_PS\_NAVIGATOR\_F3\_SELECTED = 0x2a, UI\_PS\_NAVIGATOR\_F4\_SELECTED = 0x2b
}

| | enum | [UIBeep](#a8810a38d55f6476c22d819dfc6fc8876) { [UI\_BEEP\_NORMAL](#a8810a38d55f6476c22d819dfc6fc8876a4fb144f79440b6b39d0d0667cce2268c), [UI\_BEEP\_ERROR](#a8810a38d55f6476c22d819dfc6fc8876afce2759a2a4103c8463afdc9f816b43a) } | | enum | [UINagScreenType](#a1b866918923778597a21f37a9cb6d821) { [UI\_NAG\_TEST\_DEVICE](#a1b866918923778597a21f37a9cb6d821a1ec8ecba7a8282c4a269df71fde3afc9) } | | enum |

UICanvasEvent {
UI\_PUSH, UI\_DRAG, UI\_RELEASE, UI\_KEYDOWN,
UI\_KEYUP, UI\_TERMINATE
}

| | enum | [UIMenuOptions](#aa90b029c4b564092e6cdb23f518b6bb8) { [UI\_MENU\_DISABLED](#aa90b029c4b564092e6cdb23f518b6bb8a60b7fb3952f82aa365ac1d4e13335797) =1 } | | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Functions | | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void | [uiSetConnectAttempts](#a82b5e57ef72c921533d54743b31b7fb2) (int num) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiGetConnectAttempts](#a75d81778a108be5377e3557f4a314c49) () | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void | [uiSetDisconnectCallback](#a65a2c9a477b2fdaeff369e84983affd8) ([uiDisconnectCallback](#ab8ea76e56e5a189126608d0674e79db7) cb) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) [uiDisconnectCallback](#ab8ea76e56e5a189126608d0674e79db7) | [uiGetDisconnectCallback](#a44ec86d46a855923f7b262a4fafa3241) () | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void | [uiSetKeepalive](#acbd9c4046c5f740d62624e060f5cc455) (int count, int interval) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void | [uiGetKeepalive](#af4e3a2ba9b7f5189d363e118fe8a42c6) (int \&count, int \&interval) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void | [uiDisconnect](#ac7bfe0876088a31cdc9187485e047e19) (int display) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiReadRuntimeID](#add0fbe2ab1e98634bede1d672f8b1049) (int display, std::string \&id, int timeout\_msec=5000) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string | [uiPrint](#af8b1a2c34408a1c5b1267c0a43e4f4ee) (const char \*format,...) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string | [uiPrintV](#a2601c394a0761a7273046f232ca006a5) (const char \*format, va\_list va) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiDisplayCount](#a8b97b38ea285770cf0c747710f36b86a) () | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiDisplay](#a016ce5f26e09bf3f341484fe9b302491) (int display, int region\_id, const std::string \&text) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiDisplay](#afca736475af5b2ec8faca935097ffb75) (int region\_id, const std::string \&text) | | int | [uiDisplay](#a8494cc44676b84fbfda16ecda7178336) (const std::string \&text) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInvoke](#af330e250493b2c6546274bea96d87fca) (int display, int region\_id, [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), const std::string \&text, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInvoke](#aa82de4c15bf16726400a8845b10b18bc) (int region\_id, [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), const std::string \&text, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | int | [uiInvoke](#a4cd07ae9a08f56122f27b38e96240622) ([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), const std::string \&text, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | int | [uiInvoke](#a29496ad50b00842c47ab9e50cdfdc3af) (int display, int region\_id, const std::string \&text, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | int | [uiInvoke](#a2ed9f6f4fdc09fa553b6a9cff6318dd0) (int region\_id, const std::string \&text, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | int | [uiInvoke](#aacc1ef716ff7d3923319981b25df9f7a) (const std::string \&text, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInvokeTemplate](#a9b7f3db241a31f1558bec12a0b7b0578) (int display, int region\_id, [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), const std::string \&template\_name, const std::string \&text, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInvokeTemplate](#ad125e62d8be0760ce2e50f71c73701d4) (int region\_id, [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), const std::string \&template\_name, const std::string \&text, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | int | [uiInvokeTemplate](#ab16852bef6c6a94fd96fd631d8a3d9bf) ([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), const std::string \&template\_name, const std::string \&text, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | int | [uiInvokeTemplate](#ac97efb88cd31d4f1fcf30cc1e2664281) (int display, int region\_id, const std::string \&template\_name, const std::string \&text, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | int | [uiInvokeTemplate](#a7dd297f6a9064389d667ecc8e25a2a67) (int region\_id, const std::string \&template\_name, const std::string \&text, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | int | [uiInvokeTemplate](#a9f7246af56ca281d9db90a81477209c2) (const std::string \&template\_name, const std::string \&text, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInvokeURL](#af5812cac4b8cd48873fcac4608f3082d) (int display, int region\_id, [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), const char \*url, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInvokeURL](#ae26ec4b97b6ccb5a047e2d2bdbe77836) (int region\_id, [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), const char \*url, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | int | [uiInvokeURL](#ac8e3a0145e4dd63bb993ceaa3a4c9991) ([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), const char \*url, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | int | [uiInvokeURL](#a7938fd28144f570b7d100c5e040eeaa9) (int display, int region\_id, const char \*url, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | int | [uiInvokeURL](#a20a3d7e8198a57adfad068dd83dd094d) (int region\_id, const char \*url, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | int | [uiInvokeURL](#af1c97d985b0b73fa2648880368e9b328) (const char \*url, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInvokeURL](#a02cf023ea21242e5845ffdf6bb1553b7) (int display, int region\_id, [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), const std::string \&url, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | int | [uiInvokeURL](#a3d4b8e9c000df8a904681223fc8a4fbc) (int region\_id, [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), const std::string \&url, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | int | [uiInvokeURL](#a209dd0b731df45bda0b4bf2a5391240d) ([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), const std::string \&url, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | int | [uiInvokeURL](#a3379e35ca75cf95ebdbc6129d8996724) (int display, int region\_id, const std::string \&url, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | int | [uiInvokeURL](#aaa6a2593d8fa1ff90490faed5247e142) (int region\_id, const std::string \&url, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | int | [uiInvokeURL](#adebea7c8615efacdc05e7da8952681ac) (const std::string \&url, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInvokeAsync](#add2574c4d093c99c0708c23b4c92e23d) (int display, int region\_id, const [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), const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInvokeAsync](#a753f2409eaf1889d2133bafcf7e61d68) (int region\_id, const [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), const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiInvokeAsync](#ac2b2c7917a78c4c0b8ccb011d1e09acc) (const [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), const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiInvokeAsync](#abd48f321943cf1bbe299ea2c4a41d072) (int display, int region\_id, const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiInvokeAsync](#aa0fa50585387defa76b00688ab9a8fb2) (int region\_id, const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiInvokeAsync](#a4dfeb030d818d2b6327dd7814f6ef5a0) (const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInvokeTemplateAsync](#a2281e14acba78d6d5f32d72b2d70f77b) (int display, int region\_id, const [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), const std::string \&template\_name, const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInvokeTemplateAsync](#ace0dd2491977346d7c26bda121f9fc5a) (int region\_id, const [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), const std::string \&template\_name, const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiInvokeTemplateAsync](#a8f61b95dea16f7281baff6aebaf85478) (const [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), const std::string \&template\_name, const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiInvokeTemplateAsync](#a64d6f7a95be527b409cb95c434e4d5f9) (int display, int region\_id, const std::string \&template\_name, const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiInvokeTemplateAsync](#a9579e1ca702ed055f8e379cb6838a930) (int region\_id, const std::string \&template\_name, const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiInvokeTemplateAsync](#a68736b559c5a0ec957d40aaf621034c3) (const std::string \&template\_name, const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInvokeURLAsync](#a7144a4bea5f4f98d9b3c45d95959389b) (int display, int region\_id, const [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), const char \*url, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInvokeURLAsync](#a75aa771f95566f619d9ef4fa02c53a61) (int region\_id, const [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), const char \*url, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiInvokeURLAsync](#a1ec0618ea41447138849fc3c32be3c86) (const [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), const char \*url, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiInvokeURLAsync](#ab1c880bacf1a33c75e9b0bf346a3e94b) (int display, int region\_id, const char \*url, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiInvokeURLAsync](#ae8e60a3ea452be0ec00c2fe57d8c7f5c) (int region\_id, const char \*url, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiInvokeURLAsync](#a5a99ca667d8ac14aaeffccaa29077118) (const char \*url, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInvokeURLAsync](#afe482f678a4531ba58dbac63fb340ac2) (int display, int region\_id, const [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), const std::string \&url, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiInvokeURLAsync](#aa36daa6e9b2343149e184f3c5a399a7b) (int region\_id, const [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), const std::string \&url, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiInvokeURLAsync](#aeb48f4ead8e267174d647841da917274) (const [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), const std::string \&url, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiInvokeURLAsync](#a607f46e880513775bde539f98680694f) (int display, int region\_id, const std::string \&url, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiInvokeURLAsync](#ad0e763c7f22e01b7afe8b52c20686aeb) (int region\_id, const std::string \&url, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiInvokeURLAsync](#a79bc9a31568a53f0be76879e1f87cd07) (const std::string \&url, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInvokeWait](#a1736105f217b0ece50660d95fa6c8b4e) (int txn\_id, std::map< std::string, std::string > &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), int timeout\_msec=-1) | | int | [uiInvokeWait](#ab8aa72661d81348a481e147dae55e62f) (int txn\_id, int timeout\_msec=-1) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInvokeCancel](#a151d71877a0f6426b3e2bbee47f88f0e) (int txn\_id, std::map< std::string, std::string > &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | int | [uiInvokeCancel](#aa495d8f9eb8b11f9c431e97ad7c5ea48) (int txn\_id) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInvokeCancelAsync](#a3ccd62fc69ee72f1c85f446f881446bd) (int txn\_id) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInvokeURLDetached](#a95f72e582b6a5a19d4215120592708a9) (int display, int region\_id, const char \*url) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInvokeURLDetached](#ac603c487c81b99b609d2a885bc275490) (int region\_id, const char \*url) | | int | [uiInvokeURLDetached](#a1ef56d27857daf197c533c4f9a4470d5) (const char \*url) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiClear](#aea621e3bdf3f7b1fd03b455af5976d11) (int display, int region\_id) | | int | [uiClear](#ac03b2873b401569d8a649d8bc7af726a) (int region\_id) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiSetPropertyInt](#ac94648784fbac056c2d259dbfc3e50aa) (int display, enum [UIPropertyInt](#a0c064fcc5409b0845e11925a55f324bd) property, int [value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiSetPropertyInt](#a9ed0a622cfa42b1ce68f4be26126c135) (enum [UIPropertyInt](#a0c064fcc5409b0845e11925a55f324bd) property, int [value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiGetPropertyInt](#aff979f20dc673ae471cbac14d4b082b0) (int display, enum [UIPropertyInt](#a0c064fcc5409b0845e11925a55f324bd) property, int \*[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiGetPropertyInt](#aa41752be42e095baf01c259ca270896a) (enum [UIPropertyInt](#a0c064fcc5409b0845e11925a55f324bd) property, int \*[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiSetPropertyString](#a3c03200cb65db47c2437f9729b87151a) (int display, enum [UIPropertyString](#a72b6555c0bdbb3b9869dd1f7c05f67bb) property, const char \*[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiSetPropertyString](#ace3792ba4b0cea7b7ecd1d6fb150cc60) (enum [UIPropertyString](#a72b6555c0bdbb3b9869dd1f7c05f67bb) property, const char \*[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | int | [uiSetPropertyString](#a0da88a730c997e2eb5887dbc7a8e40cc) (int display, enum [UIPropertyString](#a72b6555c0bdbb3b9869dd1f7c05f67bb) property, const std::string &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | int | [uiSetPropertyString](#a73e6560d375dfad439e518137ed19577) (enum [UIPropertyString](#a72b6555c0bdbb3b9869dd1f7c05f67bb) property, const std::string &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiGetPropertyString](#a623cbc7d8743e2e3d8498d50777fa3ad) (int display, enum [UIPropertyString](#a72b6555c0bdbb3b9869dd1f7c05f67bb) property, char \*[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), int len) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiGetPropertyString](#a7eac3808b596fa431ee1ff1608bab62b) (enum [UIPropertyString](#a72b6555c0bdbb3b9869dd1f7c05f67bb) property, char \*[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), int len) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiGetPropertyString](#acae11dad6e37787a7e85b4dcd3d4d786) (int display, enum [UIPropertyString](#a72b6555c0bdbb3b9869dd1f7c05f67bb) property, std::string &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiGetPropertyString](#a1ad6020f90cd47d52adbe0c71fd35cbd) (enum [UIPropertyString](#a72b6555c0bdbb3b9869dd1f7c05f67bb) property, std::string &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiSetServerProperty](#a32a889dab6f3831aa979c1c8b4483c4d) (int display, enum [UIServerProperty](#a84ff3a6d9454d39192c2fccc92900230) property, const std::string &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiGetServerProperty](#abc71804e99267efb2c9915482e3d7925) (int display, enum [UIServerProperty](#a84ff3a6d9454d39192c2fccc92900230) property, std::string &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string | [uiGetTerminalResourceDir](#a617e79a2394c49a8c9cb0c2b5aa15dbc) (int display, const std::string \&www\_path) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string | [uiGetTerminalResourceDir](#a45b314b70044f48c33586fa612c5aa75) (const std::string \&www\_path) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string | [uiGetKeypadType](#ab800f2b1c4ab30c0781a89747bf39049) (int display) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void | [uiSetLocalProperties](#a7e717916b36544241bf0bc5e2242f08e) (bool local) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) bool | [uiGetLocalProperties](#a7c4242334f3a30685d37f1a77bc42e9e) () | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiLayout](#af855d00b4a448abba99ca993a7b629eb) (int display, const [UIRegion](#structvfigui_1_1_u_i_region) \*region, int regcnt, const [UIRegion](#structvfigui_1_1_u_i_region) \*oldreg, int oldregcnt) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiLayout](#a2308e46a8b61fa63abdef60d827172c9) (const [UIRegion](#structvfigui_1_1_u_i_region) \*region, int regcnt, const [UIRegion](#structvfigui_1_1_u_i_region) \*oldreg, int oldregcnt) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiLayout](#a2b870737fa6f93f758500172412417c3) (int display, const [UIRegion](#structvfigui_1_1_u_i_region) \*region, int regcnt) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiLayout](#ae1d4310482c2c5fd22af4ded6e30ec68) (const [UIRegion](#structvfigui_1_1_u_i_region) \*region, int regcnt) | | int | [uiLayout](#a5973e71a4a5388d5eb726065251c806c) (int display, const std::vector< [UIRegion](#structvfigui_1_1_u_i_region) > \®) | | int | [uiLayout](#a64434790277988d09750ff6aa4f4adf3) (const std::vector< [UIRegion](#structvfigui_1_1_u_i_region) > \®) | | int | [uiLayout](#af0598abe1d1d654dc0d6ecc7de63349f) (int display, const std::vector< [UIRegion](#structvfigui_1_1_u_i_region) > \®, const std::vector< [UIRegion](#structvfigui_1_1_u_i_region) > \&oldreg) | | int | [uiLayout](#a088e9d110d91bc4ef66ae5a4ff690002) (const std::vector< [UIRegion](#structvfigui_1_1_u_i_region) > \®, const std::vector< [UIRegion](#structvfigui_1_1_u_i_region) > \&oldreg) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiLayout](#a1102efd15c6c51773f53f23af850d984) (int display, const char \*name) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiLayout](#a8ac6977e18c3105bf9753170bc2c762d) (const char \*name) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiGetLayout](#a81b3d717d2eeb276b10d2209f28fe4ba) (int display, std::vector< [UIRegion](#structvfigui_1_1_u_i_region) > \®ion) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiGetLayout](#ab147f3a7405d7d74e0191e02ead220ca) (std::vector< [UIRegion](#structvfigui_1_1_u_i_region) > \®ion) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiGetRegionSize](#a94a69e2807585364f39d692ba0e3011b) (int display, int region\_id, int \&width, int \&height) | | int | [uiGetRegionSize](#ac053ca37ca59edfed7faccacf384f72a) (int region\_id, int \&width, int \&height) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiEnterRegion](#a63902ad7b3ac76cb853b5a136a4c37bb) (int display, int region\_id) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiEnterRegion](#ae1b5ad17e85c54d2415b3b734243546f) (int region\_id) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiLeaveRegion](#ab3d02556e61ec80ef434358669b6f585) (int display) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiLeaveRegion](#a6ce8e954aefd094c8bc3ae793ab2d21b) () | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string | [uiCurrentRegionPath](#a0244df175be1611bc7a85dd93c948784) (int display) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string | [uiCurrentRegionPath](#a4550efc3cba40e765619411c8d7e46be) () | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiSetCurrentRegionPath](#a7c0abf751a9ab9db14ff5e5aff4b5166) (int display, const std::string \&path) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiSetCurrentRegionPath](#a9fa755e87d1d00378dc8d6e53b627067) (const std::string \&path) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiRegionIsVisible](#a6bdba0a661bb96f7e1a6f2fdf83ff2f3) (int display, int region\_id) | | int | [uiRegionIsVisible](#a42e30d569d84d36c8cdf52266c786e9d) (int region\_id) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void | [uiReadConfig](#ae1d86be38dabed0b93f804b91805a3d3) (int display) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void | [uiReadConfig](#ac02f0e1a367e0f7afbacd2f4f72462d4) () | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiSetCatalog](#ab103c683852a0d4b19695e76f90dcf82) (int display, const std::string \&filename) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiSetCatalog](#a1287e55b44eac5be44111aa26dff62d2) (const std::string \&filename) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string | [uiGetCatalog](#a4a44408bb3f87835196a3df9d7cb35ea) (int display) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string | [uiGetCatalog](#a725611680ba95d088972f30ef93dc6d4) () | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void | [uiCatalogSetDelayedRelease](#aac69533e0d547c76b34253f4458c525c) (unsigned num) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) unsigned | [uiCatalogGetDelayedRelease](#a145a22220c96bcb561f120babf33a75f) () | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string | [uiGetText](#a742c67e3b8c81268853ca4aa1302eaa6) (int display, const std::string \&name, const std::string \&deflt="") | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string | [uiGetText](#ac1917b2cdc02c811c2c9ad69ca23614f) (const std::string \&name, const std::string \&deflt="") | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string | [uiGetText](#aa8e23a4d766e1ec759c6109325ac633a) (int display, const std::string \&filename, const std::string \&name, const std::string \&deflt) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string | [uiGetText](#a0d47522c23d1a4448e631bc5f3c83279) (const std::string \&filename, const std::string \&name, const std::string \&deflt) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiGetHtml](#a1aa8f65012e1de871a5fdd4aaa92d0c4) (int display, const std::map< std::string, std::string > &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&text, std::string \&html) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiGetHtml](#a324c711ce8e6b643c9dfdd4d75e4b1fe) (const std::map< std::string, std::string > &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&text, std::string \&html) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiGetHtmlURL](#a4d40320933b1af7172eece218230e821) (int display, const std::map< std::string, std::string > &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&url, std::string \&html) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiGetHtmlURL](#ab5c65c2de21eb90827944b29818339e9) (const std::map< std::string, std::string > &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&url, std::string \&html) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string | [uiGetURLPath](#a703feb5d5ee2f1f6bbfc5dac3ff48c55) (int display, const std::string \&url) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string | [uiGetURLPath](#a9fbfc7262a6c318fc9c350c0a92a3a05) (const std::string \&url) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiScreenshotPNG](#a1b6f8628a0f9ae48eafa86f55315ba7e) (int display, const char \*filename) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiScreenshotPNG](#a190aab1a86115eb896eeacbbda6bd606) (const char \*filename) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiScreenshotPNG](#a2574c87baaf2c30025ecfe4ccae1fa8d) (int display, const char \*filename, int x, int y, int w, int h) | | int | [uiScreenshotPNG](#a28a32b9d5541aa1b95983506d4ad6c7f) (const char \*filename, int x, int y, int w, int h) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiScreenshotPNGData](#a476e8b97ea419cb7239cbcd638880006) (int display, std::vector< unsigned char > \&data) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiScreenshotPNGData](#a7c60c796d87df62fd95412146c28a307) (std::vector< unsigned char > \&data) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiScreenshotPNGData](#a8cb483bdcecf0b8f06bcbb04d072999d) (int display, std::vector< unsigned char > \&data, int x, int y, int w, int h) | | int | [uiScreenshotPNGData](#a6d1773d3b1885dbd97531d28b3f289ce) (std::vector< unsigned char > \&data, int x, int y, int w, int h) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiURL2PNG](#a9591b1a690de93e3c4a98aa7a721f83f) (const char \*filename, int width, int height, const std::map< std::string, std::string > &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&url) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiURL2PNGData](#a016be7fe29764536c92f235eb684471d) (std::vector< unsigned char > \&data, int width, int height, const std::map< std::string, std::string > &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&url) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiHTML2PNG](#a914abf000bf14f2f5aed24c56273ca7b) (const char \*filename, int width, int height, const std::map< std::string, std::string > &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&text) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiHTML2PNGData](#aa969466735eb2bb92fc50d708a9f168f) (std::vector< unsigned char > \&data, int width, int height, const std::map< std::string, std::string > &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&text) | | const [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) char \* | [uiLibVersion](#ad6be50feb08194512b140d6a56d93f98) () | | const [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) char \* | [gui\_GetVersion](#a50f3479412fe3105d4066f4e6219b578) () | | const [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) char \* | [gui\_GetSvcVersion](#a0595a6bb7288c587bf5c99220c383521) (int display) | | const [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) char \* | [gui\_GetSvcVersion](#a6f6b104be963114f33362e6a2af2cce1) () | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiSetTransition](#a8c1bfe6d0439d6cf0a6e30401bc97f72) (int display, int region\_id, unsigned transtype, int duration\_ms) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiSetTransition](#a72378ccc5306877110bc3c5a83c9f3ac) (int region\_id, unsigned transtype, int duration\_ms) | | int | [uiSetTransition](#af384ac04b7e3d4c8599e20696857aba9) (unsigned transtype, int duration\_ms) | | const [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::vector< [UIErrorEntry](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/structvfigui_1_1_u_i_error_entry.md) > & | [uiErrorList](#aba34f6eef06a651ed7d9ce0149864af9) () | | const [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) [UIStatistics](#structvfigui_1_1_u_i_statistics) & | [uiStatistics](#a24336e28feb91acfc20a2923e9efa924) () | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string | [uiScriptError](#a6f12172a8274bd06e3f1bca6a9c4d9de) () | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiGetIdleTime](#aba3b5d38c1416e167c8e53d47f5d017b) (int display=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void | [uiSetLogMask](#acad448fa6ecc86a6a9fe1c888fb02ece) (unsigned mask) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) unsigned | [uiGetLogMask](#a3a15c62f2a57d17c7cf9d3e87b284267) (void) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiConfigLEDs](#a1c1a705a5c98aeef8602de84d9cb7e9c) (int display, [UILEDShape](#ab9093178bd56d7fa93a9f14269817087) shape, int width, int height, unsigned off\_rgba, unsigned on0\_rgba, unsigned on1\_rgba, unsigned on2\_rgba, unsigned on3\_rgba) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiConfigLEDs](#a134ca348bbdf9510cb20d8f74fc69188) ([UILEDShape](#ab9093178bd56d7fa93a9f14269817087) shape, int width, int height, unsigned off\_rgba, unsigned on0\_rgba, unsigned on1\_rgba, unsigned on2\_rgba, unsigned on3\_rgba) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiConfigLEDs](#a2debe337036ea68eeab9a45c92100af7) (int display, const char \*filename) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiConfigLEDs](#a2ce39c0e56da282966166f00f8d95867) (const char \*filename) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiShowLEDArea](#a805135597b3ce4a1f776415ebdeb22d4) (int display, [UIEdge](#a953c1b2cadd586de592b1f3dc07eab7e) edge, int width, int height, unsigned bg\_rgba) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiShowLEDArea](#a9128b151b3360ef3380e02236eb396e4) ([UIEdge](#a953c1b2cadd586de592b1f3dc07eab7e) edge, int width, int height, unsigned bg\_rgba) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiHideLEDArea](#a838a0e3e4a7230d791dbea64c3f5398b) (int display) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiHideLEDArea](#aca6beb2abadaebfb2af604aeb836b5f9) () | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiSetLED](#aeeb84d055718fd760d2db795f5c7159c) (int display, unsigned led, bool state) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiSetLED](#a2d552e5f0863af3ad7aeb9789c6f0e0c) (unsigned led, bool state) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiSetBacklightConfig](#ac23c57f93cde8fd315c9730cff1e199f) (int display, const std::vector< [UIBacklight](#structvfigui_1_1_u_i_backlight) > \&levels) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiGetBacklightConfig](#a84dbe3f9f4ba9bdb6f5d6e86220b17f8) (int display, std::vector< [UIBacklight](#structvfigui_1_1_u_i_backlight) > \&levels) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiSetBacklightLevel](#a6f1182c769b590e85cd0e62dbcb46fc4) (int display, int level) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiGetBacklightLevel](#ab5737b28abc50bdf419763e7f3e8c476) (int display, int \&level) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiSetInput](#a068db1d363c4d36a444f1a86f198d3f4) (int display, int region\_id, const std::string \&name, const std::string &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | int | [uiSetInput](#a72fcffe0e977430ec6e159edc9f37863) (int region\_id, const std::string \&name, const std::string &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiRunAction](#a82e45a48b655b42d50b4428c4245f917) (int display, int region\_id, const std::string \&name) | | int | [uiRunAction](#afb940cb2a741ac6647694c077fd5b01f) (int region\_id, const std::string \&name) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiRunAction2](#ab651b84144ad71093985dc06d541415f) (int display, int region\_id, const std::string \&name) | | int | [uiRunAction2](#a53334623e82aad1f5ad24f2990891183) (int region\_id, const std::string \&name) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiAddOption](#ab45a226e8e8b51af7a6b966e4a1e3b9d) (int display, int region\_id, const std::string \&name, const std::string &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&text, const std::string \&style="", const std::string \&action="", int position=-1) | | int | [uiAddOption](#a1015c2e749c417375eb07a87be83115d) (int region\_id, const std::string \&name, const std::string &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&text, const std::string \&style="", const std::string \&action="", int position=-1) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiScrollOption](#a708b83cb207311e9ee0ce89fdbc64b2b) (int display, int region\_id, const std::string \&name, const std::string &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), [UIScrollPosition](#a09efbc077884a4944a73602edd62f2c4) pos) | | int | [uiScrollOption](#a9b5cf25b433267281eed58a43269ecb8) (int region\_id, const std::string \&name, const std::string &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), [UIScrollPosition](#a09efbc077884a4944a73602edd62f2c4) pos) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiRemoveOption](#a127a7511d72753958ee9568cbe56addc) (int display, int region\_id, const std::string \&name, const std::string &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | int | [uiRemoveOption](#a91540198a82cf57a06e8e4b3962272b4) (int region\_id, const std::string \&name, const std::string &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void | [uiSetPinStatusCallback](#abda9f05a851f1542310fdfe20bc14110) ([uiPinStatusCallback](#a996cf8c4f9fc88f971a90d1b1ed5f7fa) cb) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) [uiPinStatusCallback](#a996cf8c4f9fc88f971a90d1b1ed5f7fa) | [uiGetPinStatusCallback](#a1f3c973952772ea04be963f81b6f31dd) () | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiDisablePINOK](#a2b9dd85f581cd18f44ac0f6e2e298a02) (int display=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiEnablePINOK](#a507a546dba483793386d45565eac84e7) (int display=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiUpdate](#ab3d6c9c83c3b9c6cded334180a5dbc54) (int display, int region\_id, const std::string \&name, const std::string \&html) | | int | [uiUpdate](#a5308d7d8d56f446e4f66be3eebe6eb34) (int region\_id, const std::string \&name, const std::string \&html) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiBeep](#af6e906366931be49e599366c1618e06f) (int display, [UIBeep](#a8810a38d55f6476c22d819dfc6fc8876) beep) | | int | [uiBeep](#a2b44558ec990325748ca107b6839e841) ([UIBeep](#a8810a38d55f6476c22d819dfc6fc8876) beep) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiNagScreen](#a51199b2daa138383c44d62efb596267f) (int display, enum [UINagScreenType](#a1b866918923778597a21f37a9cb6d821) type, int hide, int show) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiCanvas](#a4f50c305f35961d8b4571fbd01d12c2c) (int display, int region\_id, [uiEventCallback](#a5ded57d248c0c7c8b719a61284a75453) cb, void \*data=0) | | int | [uiCanvas](#ae7f512a15498b2a7a5e49d237381fddf) (int region\_id, [uiEventCallback](#a5ded57d248c0c7c8b719a61284a75453) cb, void \*data=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiDraw](#a59738042ac30693d8958da57b7a2e884) (int display, int region\_id, const [UIDrawing](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvfigui_1_1_u_i_drawing.md) \&drawing) | | int | [uiDraw](#af552cd7e86e5777747e40dec0f637fdf) (int region\_id, const [UIDrawing](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvfigui_1_1_u_i_drawing.md) \&drawing) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiDrawAsync](#a913ea01e97aab7a98098ba2a53a4fd19) (int display, int region\_id, const [UIDrawing](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvfigui_1_1_u_i_drawing.md) \&drawing, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiDrawAsync](#a045bc5d515a9474781924826e8542dc8) (int region\_id, const [UIDrawing](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvfigui_1_1_u_i_drawing.md) \&drawing, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiTextMetrics](#a7a8977fe87e931923e1ce8b4cf458643) (int display, int region\_id, const std::string \&font, int size, unsigned style, std::vector< [UITextWidth](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/structvfigui_1_1_u_i_text_width.md) > \&width, int \&height, int \&descent) | | int | [uiTextMetrics](#a83fbf6e1275e851ec71bfc99efa6c03d) (int region\_id, const std::string \&font, int size, unsigned style, std::vector< [UITextWidth](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/structvfigui_1_1_u_i_text_width.md) > \&width, int \&height, int \&descent) | | const [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) char \* | [uiDataURLType](#aefeddf255ffe45c5a8ae06cca4b55e1e) (const std::string \&in) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) bool | [uiDataURLToString](#a2285cfd3a19cfe70d5c9ab5bb02a5c64) (std::string \&out, const std::string \&in) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) bool | [uiDataURLToFile](#a4d0003af3471b1179db3249777c66471) (const char \*filename, const std::string \&in) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiDisplay](#ad8a2161c5d5a12d5555951b2f6b103df) (int display, int region\_id, const std::string \&templateName, const std::string \&text) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiDisplay](#ae1cbfaf2abb0590395fbf5261db6669d) (int region\_id, const std::string \&templateName, const std::string \&text) | | int | [uiDisplay](#a7dfffbe598f9b851ce1494efcf7c7016) (const std::string \&templateName, const std::string \&text) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiDisplayAsync](#a7ef65e67ea8ea8f74e8473bb3b393567) (int display, int region\_id, const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiDisplayAsync](#a0981cb984ea5389bd4f6a2b8d98011c3) (int region\_id, const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiDisplayAsync](#a07e92040457dc9b34b784f5ca7eb8613) (const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiDisplayAsync](#aa8c8c7cd53187a0ddaf1ad952ac2fa89) (int display, int region\_id, const std::string \&templateName, const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiDisplayAsync](#ab7b5e17d8c22f9f234f938163a55ed35) (int region\_id, const std::string \&templateName, const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiDisplayAsync](#a6eac13906076612f805ab58793a43cce) (const std::string \&templateName, const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiDisplayWait](#a8579cb74c1f8b3d0d855d7b8ca06f462) (int txn\_id, int timeout\_msec=-1) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiConfirm](#a30b5d12037b46ee2ab8261bd9edcc047) (int display, int region\_id, const std::string \&templateName, const std::string \&text, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiConfirm](#aa69b25bb68c919f8a8e27a4850ed741d) (int region\_id, const std::string \&templateName, const std::string \&text, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | int | [uiConfirm](#a9f4db443faab5f8a3c9fbccf81229451) (const std::string \&templateName, const std::string \&text, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiConfirmAsync](#a6bfa2fed6af97902225d42d89f7e6598) (int display, int region\_id, const std::string \&templateName, const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiConfirmAsync](#a57dc5b62e7f7fb17adaa60bc70cb4b4e) (int region\_id, const std::string \&templateName, const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiConfirmAsync](#a820f14caba76881f193b683b8f464ceb) (const std::string \&templateName, const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiConfirmWait](#a932cb60db6f53cfe8bc8759d05e6e09e) (int txn\_id, int timeout\_msec=-1) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInput](#abc2e22a493f5dbdb8bfad06dd187d51a) (int display, int region\_id, const std::string \&templateName, std::vector< std::string > &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&text, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInput](#a1f7eb2e08d981c8985042e63f99a8c00) (int region\_id, const std::string \&templateName, std::vector< std::string > &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&text, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | int | [uiInput](#a3945d4b563dba269f81f03506e1672e5) (const std::string \&templateName, std::vector< std::string > &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&text, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInputAsync](#a6c27e35cafa80cbcc8464b472a8346f7) (int display, int region\_id, const std::string \&templateName, const std::vector< std::string > &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInputAsync](#aa7ff3a4e3261b4ebacbf7f8d193fa337) (int region\_id, const std::string \&templateName, const std::vector< std::string > &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiInputAsync](#af464dd48aaf1446db4f0c0b8b8f1b571) (const std::string \&templateName, const std::vector< std::string > &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInputWait](#afebb1f35d2b398978a3fc6baf6a72e3e) (int txn\_id, std::vector< std::string > &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), int timeout\_msec=-1) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInputPINCheck](#a89a70f269a838ac0cf8011856f1e7882) (int display, int region\_id, const std::string \&templateName, const std::string \&referencePIN, const std::string \&text, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInputPINCheck](#afc9d66509cc8c12b2e9a0f6236cabb92) (int region\_id, const std::string \&templateName, const std::string \&referencePIN, const std::string \&text, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | int | [uiInputPINCheck](#a40aa14783303e452b6f82ad687a26eed) (const std::string \&templateName, const std::string \&referencePIN, const std::string \&text, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInputPINCheckAsync](#af83bcb0d3c6baa8de991d79d81014b87) (int display, int region\_id, const std::string \&templateName, const std::string \&referencePIN, const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInputPINCheckAsync](#a704739c768ff6350c1d163aaa5deb3a1) (int region\_id, const std::string \&templateName, const std::string \&referencePIN, const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiInputPINCheckAsync](#abc8bc6e55c13d89e51d5a174dabf7e99) (const std::string \&templateName, const std::string \&referencePIN, const std::string \&text, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiInputPINCheckWait](#ae23c072e72e864549ed92e34d7eba717) (int txn\_id, int timeout\_msec=-1) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiMenu](#a98d3ffe172afda1fbc4586f09af7606c) (int display, int region\_id, const std::string \&templateName, const std::string \&text, const struct [UIMenuEntry](#structvfigui_1_1_u_i_menu_entry) menu\[], int menusize, int preselect, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiMenu](#a51553a615e55eb90a3a5b9da1a0b55c0) (int region\_id, const std::string \&templateName, const std::string \&text, const struct [UIMenuEntry](#structvfigui_1_1_u_i_menu_entry) menu\[], int menusize, int preselect, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | int | [uiMenu](#a9b7020c4f8fb93cd3b19df1d1064b106) (const std::string \&templateName, const std::string \&text, const struct [UIMenuEntry](#structvfigui_1_1_u_i_menu_entry) menu\[], int menusize, int preselect, [uiCallback](#a2f8a971ed8de9b7a30c70f4a60cf2da8) cb=0, void \*cbdata=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiMenuAsync](#abce089ab208df1ad1bfa04561f3d322c) (int display, int region\_id, const std::string \&templateName, const std::string \&text, const struct [UIMenuEntry](#structvfigui_1_1_u_i_menu_entry) menu\[], int menusize, int preselect, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiMenuAsync](#a5e360bdfb7050535067e3fcd93176769) (int region\_id, const std::string \&templateName, const std::string \&text, const struct [UIMenuEntry](#structvfigui_1_1_u_i_menu_entry) menu\[], int menusize, int preselect, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | int | [uiMenuAsync](#a02210718552d1e11062bb7823f7bf630) (const std::string \&template\_name, const std::string \&text, const struct [UIMenuEntry](#structvfigui_1_1_u_i_menu_entry) menu\[], int menusize, int preselect, [uiAsyncCallback](#a29ea0490208725e330b8b11f770b51a7) cb=0, void \*data=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [uiMenuWait](#a7bcce0289e8d528e362c8da5657ffafb) (int txn\_id, int timeout\_msec=-1) | ### DetailedDescription Verifone GUI namespace *** ### DataStructure Documentation ### vfigui::UIBacklight struct vfigui::UIBacklight backlight brightness level | | | | | ----------- | ---------- | ----------------------------------------------------------------------------------------- | | Data Fields | | | | unsigned | brightness | brightness level (0..100) | | unsigned | timeout | timeout in milliseconds after which to switch to the next level (if there is another one) | ### vfigui::UIMenuEntry struct vfigui::UIMenuEntry structure for menu entries #### Examples [demo-sysinfo.cpp](/adk-5.0-programmers-guide/readme/examples/demo-sysinfo_8cpp-example.md#_a2), [mac\_demo1.cpp](/adk-5.0-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#_a10), [mac\_demo2.cpp](/adk-5.0-programmers-guide/readme/examples/mac_demo2_8cpp-example.md#_a3), and [pm-demo.cpp](/adk-5.0-programmers-guide/readme/examples/pm-demo_8cpp-example.md#_a6). | | | | | ----------- | ------- | ------------------------------------------------------------------------ | | Data Fields | | | | unsigned | options | options, see [vfigui::UIMenuOptions](#aa90b029c4b564092e6cdb23f518b6bb8) | | string | text | text to be displayed | | int | value | return value | ### vfigui::UIRegion struct vfigui::UIRegion structure describing the position and size of an output region | | | | | ----------- | ------ | ------------------------------------------------ | | Data Fields | | | | int | bottom | bottom position in pixels (+=height if negative) | | int | flags | flags: UI\_REGION\_FLAG\_HIDDEN | | int | id | region ID, 0 is the default region | | int | left | left position in pixels (+=width if negative) | | int | right | right position in pixels (+=width if negative) | | int | top | top position in pixels (+=height if negative) | ### vfigui::UIStatistics struct vfigui::UIStatistics Statistics information Collaboration diagram for UIStatistics: ![Collaboration graph](/files/JLRib5m8vJLdGQY14QL2) \[[legend](/adk-5.0-programmers-guide/graph_legend.md)] | | | | | -------------------------------------------------------------------------------------------------------------------- | ----- | -------------------------------------------------------------------------------------- | | Data Fields | | | | [TimeStamp](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvfihtml_1_1_time_stamp.md) | css | css loading and parsing has finished | | [TimeStamp](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvfihtml_1_1_time_stamp.md) | draw | sending drawing commands to gfx system has finished (initial drawing of the HTML page) | | [TimeStamp](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvfihtml_1_1_time_stamp.md) | html | html loading, parsing and layout has finished | | [TimeStamp](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvfihtml_1_1_time_stamp.md) | start | starting time | ### TypedefDocumentation ### uiAsyncCallback typedef void(\\\* uiAsyncCallback) (void \\\*data, \[UICBType]\(#a2eee911f81a366ee45341def47875e17) type, [UICBData](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvfigui_1_1_u_i_c_b_data.md) \&uidata) callback function that is called when a dialog has returned some data. In case of dialog sequences (e.g. a dialog uses the load-URL action) the callback is invoked after each step of the sequence. **Parameters** \[in] **data** data pointer provided by the application \[in] **type** type / reason why the callback was invoked \[in] **uidata** object to access data of the current transaction {% hint style="info" %} The callback will be run within a different thread context, so make sure to use appropriate locking if required. All callback functions share the same thread. Therefore, do not use functions that block for a long time, in particular [uiInvokeWait()](#a1736105f217b0ece50660d95fa6c8b4e) must not be called. {% endhint %} ### uiCallback typedef bool(\\\* uiCallback) (void \\\*data) ## Parameter Overloading Most functions take a `display` and `region_id` parameter. For convenience these functions are overloaded so that these parameters may be omitted when using the default display and region: * When the default display is to be used, `display` may be omitted * When the default region on the default display is to be used `display` and `region_id` may be omitted. If the key-value map is not required for a specific purpose, an overloaded version is provided so that the key-value map can be omitted. callback function that is called at regular intervals while the dialog is displayed. If the callback returns false, the dialog is cancelled; **Parameters** \[in] **data** data pointer provided by the application ### uiDisconnectCallback typedef void(\\\* uiDisconnectCallback) (int display) callback function that is called when the contact to a server is lost. It runs in parallel to UI functions that will return UI\_ERR\_CONNECTION\_LOST so the order of returning the error and invocation of the callback is unspecified. **Parameters** \[in] **display** display number ### uiEventCallback typedef void(\\\* uiEventCallback) (void \\\*data, \[UICanvasEvent]\(#ab39be9e8cfe25802d65abffda76e2ce9) event, int x, int y, int key, unsigned flags) callback function for receiving Canvas events. **Parameters** \[in] **data** data pointer provided by the application \[in] **event** event type \[in] **x** x-coordinate (for UI\_PUSH, UI\_DRAG and UI\_RELEASE) \[in] **y** y-coordinate (for UI\_PUSH, UI\_DRAG and UI\_RELEASE) \[in] **key** key code (for UI\_KEYDOWN and UI\_KEYUP) or return code (UI\_TERMINATE) \[in] **flags** reserved for future use, currently always 0 {% hint style="info" %} The callback will be run within a different thread context, so make sure to use appropriate locking if required. All callback functions share the same thread. Therefore, do not use functions that block for a long time, in particular [uiInvokeWait()](#a1736105f217b0ece50660d95fa6c8b4e) must not be called. {% endhint %} ### uiPinStatusCallback typedef void(\\\* uiPinStatusCallback) (int status, int digit\_count) Callback function for PIN entry status updates. **Parameters** \[in] **status** PIN entry status (see UIPinStatus) \[in] **digit\_count** number of entered PIN digits {% hint style="info" %} The callback runs in a separate thread context. ADKGUI functions may be called from within it, but [uiInvokeWait()](#a1736105f217b0ece50660d95fa6c8b4e) must not be called. {% endhint %} ### EnumerationType Documentation ### anonymousenum anonymous enum | | | | ------------------- | ----------------- | | Enumerator | | | UI\_REGION\_DEFAULT | default region ID | ### anonymousenum anonymous enum | | | | ------------------------ | --------------------------------------------------------------------------- | | Enumerator | | | UI\_REGION\_FLAG\_HIDDEN | do not show region: Hiding a region does not terminate the contained dialog | ### anonymousenum anonymous enum bit mask constants for describing the transition | | | | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | Enumerator | | | UI\_TRANS\_UP | movement direction: up, depending on the transition type horizontal an vertical movement may be combined. | | UI\_TRANS\_RIGHT | movement direction: right, depending on the transition type horizontal an vertical movement may be combined. | | UI\_TRANS\_DOWN | movement direction: down, depending on the transition type horizontal an vertical movement may be combined. | | UI\_TRANS\_LEFT | movement direction: left, depending on the transition type horizontal an vertical movement may be combined. | | UI\_TRANS\_DIRECTION\_MASK | mask containing the movement direction bits | | UI\_TRANS\_EASE\_IN | transition accelerates after the start | | UI\_TRANS\_EASE\_OUT |

transition decelerates before the end

| | UI\_TRANS\_EASE\_INOUT | combination of UI\_TRANS\_EASE\_IN and UI\_TRANS\_EASE\_OUT | | UI\_TRANS\_EASE\_MASK | mask containing the acceleration bits | | UI\_TRANS\_NONE | No transition | | UI\_TRANS\_SLIDE | The dialog slides to the screen shifting out the old one | | UI\_TRANS\_SLIDEON | The dialog slides to the screen covering the old one | | UI\_TRANS\_SWAP | The new dialog starts behind the old one. Then both slide to opposite sides and then back, this time with the new dialog in front. | | UI\_TRANS\_CROSSFADE | Crossfade between old and new dialog. The movement direction flags are ignored. | | UI\_TRANS\_TYPE\_MASK | mask containing the transition type bits | ### UIBeep enum \[UIBeep]\(#a8810a38d55f6476c22d819dfc6fc8876) Beep | | | | ---------------- | ----------- | | Enumerator | | | UI\_BEEP\_NORMAL | normal beep | | UI\_BEEP\_ERROR | error beep | ### UICanvasEvent enum \[UICanvasEvent]\(#ab39be9e8cfe25802d65abffda76e2ce9) Canvas events | | | | ------------- | ---------------------------------------------------------------- | | Enumerator | | | UI\_PUSH | The user has touched the screen | | UI\_DRAG | The user is dragging the finger on the screen | | UI\_RELEASE | The user has released the screen | | UI\_KEYDOWN | The user has pressed a button on the keypad | | UI\_KEYUP | The user has released a button on the keypad | | UI\_TERMINATE | The dialog has terminated, the return code can be found in *key* | ### UICBType enum \[UICBType]\(#a2eee911f81a366ee45341def47875e17) Reason why the callback was invoked | | | | ------------------- | ----------------------------------------------------- | | Enumerator | | | UI\_CB\_RESULT | callback was invoked due to receiving the result | | UI\_CB\_UPDATE | callback was invoked due to receiving an update event | | UI\_CB\_LOAD | callback was invoked due to switching to a new dialog | | UI\_CB\_ERROR\_LIST | callback was invoked due to receiving error data | | UI\_CB\_STATISTICS | callback was invoked due to receiving statistics data | | UI\_CB\_EVENT | callback was invoked due to receiving a custom event | ### UIEdge enum \[UIEdge]\(#a953c1b2cadd586de592b1f3dc07eab7e) Display edge selection | | | | ---------------- | ---------------------- | | Enumerator | | | UI\_EDGE\_TOP | top edge of display | | UI\_EDGE\_RIGHT | right edge of display | | UI\_EDGE\_BOTTOM | bottom edge of display | | UI\_EDGE\_LEFT | left edge of display | ### UILEDShape enum \[UILEDShape]\(#ab9093178bd56d7fa93a9f14269817087) LED shape | | | | -------------------- | ----------------- | | Enumerator | | | UI\_SHAPE\_RECTANGLE | rectangular shape | | UI\_SHAPE\_ELLIPSE | elliptic shape | ### UIMenuOptions enum \[UIMenuOptions]\(#aa90b029c4b564092e6cdb23f518b6bb8) menu options | | | | ------------------ | --------------------------------------------------------------------- | | Enumerator | | | UI\_MENU\_DISABLED | show the menu entry as disabled or leave it out (depending on device) | ### UINagScreenType enum \[UINagScreenType]\(#a1b866918923778597a21f37a9cb6d821) Nag screen type | | | | --------------------- | ----------------------- | | Enumerator | | | UI\_NAG\_TEST\_DEVICE | device is a test device | ### UIPinStatus enum \[UIPinStatus]\(#ad19526a83cc32cdb5b53af389b82fc4b) PIN entry status codes | | | | -------------------------------------- | ---------------------------------------- | | Enumerator | | | UI\_PS\_IDLE | no PIN entry active | | UI\_PS\_CONFIRM | PIN has been entered | | UI\_PS\_CANCEL | PIN entry has been cancelled | | UI\_PS\_TIMEOUT | PIN entry has timed out | | UI\_PS\_BYPASS | PIN bypass was selected | | UI\_PS\_ACTIVE | PIN entry is active | | UI\_PS\_UNDERFLOW | OK pressed with too few digits | | UI\_PS\_OVERFLOW | too many digits entered | | UI\_PS\_DIGIT | a digit was pressed | | UI\_PS\_BACKSPACE | backspace was pressed | | UI\_PS\_ASTERISK | asterisk was pressed | | UI\_PS\_HASH | hash button was pressed | | UI\_PS\_F1 | F1 button was pressed | | UI\_PS\_F2 | F2 button was pressed | | UI\_PS\_F3 | F3 button was pressed | | UI\_PS\_F4 | F4 button was pressed | | UI\_PS\_NAVIGATOR | start of navigator status range | | UI\_PS\_NAVIGATOR\_DIGIT\_SELECTED | navigator: digit key highlighted | | UI\_PS\_NAVIGATOR\_CANCEL\_SELECTED | navigator: cancel key highlighted | | UI\_PS\_NAVIGATOR\_BACKSPACE\_SELECTED | navigator: backspace key highlighted | | UI\_PS\_NAVIGATOR\_CONFIRM\_SELECTED | navigator: confirm key highlighted | | UI\_PS\_NAVIGATOR\_MULTIPLE\_TOUCHES | navigator: multiple simultaneous touches | | UI\_PS\_NAVIGATOR\_ASTERISK\_SELECTED | navigator: asterisk key highlighted | | UI\_PS\_NAVIGATOR\_HASH\_SELECTED | navigator: hash key highlighted | | UI\_PS\_NAVIGATOR\_F1\_SELECTED | navigator: F1 key highlighted | | UI\_PS\_NAVIGATOR\_F2\_SELECTED | navigator: F2 key highlighted | | UI\_PS\_NAVIGATOR\_F3\_SELECTED | navigator: F3 key highlighted | | UI\_PS\_NAVIGATOR\_F4\_SELECTED | navigator: F4 key highlighted | ### UIPropertyInt enum \[UIPropertyInt]\(#a0c064fcc5409b0845e11925a55f324bd) Int properties for configuring global GUI options | | | | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Enumerator | | | UI\_PROP\_TIMEOUT | Idle timeout in milliseconds, set to -1 to deactivate | | UI\_PROP\_PASSWORD\_CHAR | Password masking character | | UI\_PROP\_DEFAULT\_FONT\_SIZE | Default font size | | UI\_PROP\_PIN\_AUTO\_ENTER | Automatically terminate the PIN entry when the maximum number of digits has been reached | | UI\_PROP\_PIN\_CLEAR\_ALL | The clear key deletes all entered digits instead of only the last one | | UI\_PROP\_PIN\_BYPASS\_KEY | Key code that is used for PIN bypass. Setting it to 0 disables PIN bypass. Supported bypass keys are: 13 (enter/confirm key), 8 (clear/backspace key) Add 1000 to disable bypass as soon as a digit has been entered, e.g. using 1013 will use the enter key as bypass key but only if no digit has been entered in between. | | UI\_PROP\_PIN\_ALGORITHM | value used for iPS\_SelectPINAlgo(), e.g. EMV\_PIN, see "MX 900 Series Programmers Guide" | | UI\_PROP\_PIN\_INTERCHAR\_TIMEOUT | if >0: inter character timeout for PIN entry in milliseconds | | UI\_PROP\_PASSWORD\_SHOW\_CHAR | Time (in ms) to show last entered password character before masking it (ignored for PIN entry) | | UI\_PROP\_KEEP\_DISPLAY | Determines whether the display is cleared (0) or whether the display keeps displaying the old content (1) when updating the layout using uiLayout. Keeping the display on layout updates does not work on all platforms, therefore, default is to clear. | | UI\_PROP\_UPDATE\_EVENTS | if not 0 send update events each time the content of an input field changes or if the URL changes due to a load action (default: 0) | | UI\_PROP\_CIRCULAR\_MENU | if not 0 the actions "up" and "down" actions of the menu will not stop at the start/end of the menu but jump to the last/first element instead. (default: 0) | | UI\_PROP\_TOUCH\_ACTION\_BEEP | if set (1) beep when an action was triggered from the touch screen. (default: 0) May be overwritten by server setting, see also [UI\_SERVER\_TOUCH\_ACTION\_BEEP](#a84ff3a6d9454d39192c2fccc92900230acb6d3a1a7ef8fe6696e2686ddfac439b) | | UI\_PROP\_STATISTICS | if not 0 update statistics information that can be read using uiStatistics. (default: 0) | | UI\_PROP\_RESTRICTED | if set (1) only up to three digit keys may be entered in a row. (default: 0) | | UI\_PROP\_CP\_APP\_MODE | if set (1) activate CP app specific restrictions, (default: 0) | | UI\_PROP\_SCROLL\_COLOR | RGBA color value used for the scrollbar overlays, the value is an unsigned cast to an int (default: 0x00000060) | | UI\_PROP\_INPUT\_ERROR\_BEEP | if set (1) beep when an input character cannot be inserted into an input field (input field full or invalid character) (default: 0) May be overwritten by server setting, see also [UI\_SERVER\_INPUT\_ERROR\_BEEP](#a84ff3a6d9454d39192c2fccc92900230a10e894a7b837b3e8797a3c45a39f1b15) | | UI\_PROP\_ZOOM\_MAX | maximum zoom in percent (multitouch enabled ADKGUI only, default:400, minimum:100) | | UI\_PROP\_SCROLL\_DISPLAY | time to show the scrollbar overlays in milliseconds. Scrollbar overlays are disabled by setting this to 0. When set to a negative value, overlays are displayed permanently | | UI\_PROP\_JS\_QUOTA\_SIZE |

If >0 filesystem quota in kilobytes for use by JavaScript, see also UI\_PROP\_JS\_QUOTA\_ROOT

| | UI\_PROP\_SCROLL\_WIDTH | width of the scrollbar overlay in pixels, if 0 width is selected automatically based on screen resolution (default: 0) | | UI\_PROP\_LONG\_PRESS | time for long press in milliseconds, set to 0 to use the system default (default: 0) | | UI\_PROP\_LONG\_IMMEDIATE | If 1, detect long press immediately and not after releasing a buttun (default: 0) | | UI\_PROP\_OVERFLOW\_EXT | if set (1) enable non-standard overflow extensions (ticker, etc.) in the WebKit renderer. For the FLTK renderer this property is ignored (extensions are always enabled). (default: 0) | | UI\_DEVICE\_WIDTH | width of the display in pixels | | UI\_DEVICE\_HEIGHT | height of the display in pixels | | UI\_DEVICE\_COLOR\_DEPTH |

color depth in bits

| | UI\_DEVICE\_SUPPORTS\_TOUCH | 1 if the device supports touch, else 0 | | UI\_DEVICE\_SUPPORTS\_BEEPER | | | UI\_DEVICE\_SUPPORTS\_AUDIO | 1 if the device supports audio output, else 0 | | UI\_DEVICE\_SUPPORTS\_VIDEO | 1 if the device supports video output, else 0 | | UI\_DEVICE\_SUPPORTS\_SIGCAP | 1 if the device supports signature capture, else 0 | | UI\_DEVICE\_SUPPORTS\_COLOR\_DISPLAY | 1 if the device supports color display, else 0 (B/W display) | | UI\_DEVICE\_HAS\_CAP\_TOUCH\_KEYPAD | 1 if the device has a capacitive touch keypad, else 0 | | UI\_DEVICE\_SUPPORTS\_NAVIGATOR\_MODE | 1 if the device supports navigator mode | | UI\_DEVICE\_KEY\_COUNT | number of keypad keys | ### UIPropertyString enum \[UIPropertyString]\(#a72b6555c0bdbb3b9869dd1f7c05f67bb) String properties for configuring global GUI options | | | | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Enumerator | | | UI\_PROP\_DECIMAL\_SEPARATOR |

Decimal separator

| | UI\_PROP\_THOUSANDS\_SEPARATOR |

Thousands separator

| | UI\_PROP\_DEFAULT\_FONT |

Default font name

| | UI\_PROP\_RESOURCE\_PATH | Resource path, default is www/\ | | UI\_PROP\_FILE\_PREFIX | prefix that is added in front of the URL in uiInvokeURL and to the template names, e.g. using "en/" would access the files in the subdirectory "en". | | UI\_PROP\_KEYMAP | Keymap string of the format: "\=\\...\\n\=\..." | | UI\_PROP\_CSS | name of a CSS file | | UI\_PROP\_RESOURCE\_DEFAULT\_PATH | Resource default path, default is www/default (or resource/default) | | UI\_PROP\_GUI\_EXTENSIONS | (removed) | | UI\_PROP\_HTTP\_HEADER\_FIELDS | (removed) | | UI\_PROP\_CP\_APP\_DIR | CP app directory, if set only dialogs from the app dir can be shown. It should point to the base app directory without platform, e.g. /home/sys14/www/\ on V/OS | | UI\_PROP\_LANGUAGE | ISO 639-1 language code (2 bytes, lowercase) or BCP 47 locale (5 bytes, 2 bytes lowercase language code, '-', 2 bytes uppercase country code, e.g. "en-US"). Setting the language loads catalog file \.ctlg. It is searched in the resource folder (e.g. www/VX820) and in the default resource folder (www/default) In case of a 5-byte locale if the file cannot be found, the country code is stripped and a catalog file just using the language code is searched. For example, using "de-AT", it would search for de-AT.ctlg in the resource and default resource folder and then it would search for de.ctlg in those two folders. | | UI\_PROP\_JS\_ROOT | Setting this path activates the JavaScript filesystem module. I/O is restricted to happen inside this path. Use "$APPDIR" to refer to this path from within JavaScript. Images and videos may also use "$APPDIR" to refer to files in this path. | | UI\_PROP\_PRINT\_ROOT |

Setting this path activates JavaScript printing support. Receipts to be printed are looked up relative to this path.

Note JavaScript printing may not be available for some platforms.

| | UI\_PROP\_PRINT\_CSS | Name of the CSS file used for JavaScript printing. Default is "print.css" | | UI\_PROP\_JS\_QUOTA\_ROOT | If not empty base directory for JavaScript quota calculation, default is "", see also [UI\_PROP\_JS\_QUOTA\_SIZE](#a0c064fcc5409b0845e11925a55f324bda03cccd4d7a09fc598eaeeec1274b920b) | | UI\_DEVICE\_MODEL | Terminal model name, e.g. "Razor" or "VX820" | ### UIScrollPosition enum \[UIScrollPosition]\(#a09efbc077884a4944a73602edd62f2c4) scroll position for uiScrollOption | | | | ------------------ | -------------------------------- | | Enumerator | | | UI\_SCROLL\_TOP | scroll element to top of menu | | UI\_SCROLL\_BOTTOM | scroll element to bottom of menu | ### UIServerProperty enum \[UIServerProperty]\(#a84ff3a6d9454d39192c2fccc92900230) Server properties | | | | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Enumerator | | | UI\_SERVER\_TOUCH\_ACTION\_BEEP | Configure action beep. "" use the application setting from [UI\_PROP\_TOUCH\_ACTION\_BEEP](#a0c064fcc5409b0845e11925a55f324bda8cb02148a645c7ab36456e9fcddf9b95), "on" ignore [UI\_PROP\_TOUCH\_ACTION\_BEEP](#a0c064fcc5409b0845e11925a55f324bda8cb02148a645c7ab36456e9fcddf9b95) and play an action beep, "off" ignore [UI\_PROP\_TOUCH\_ACTION\_BEEP](#a0c064fcc5409b0845e11925a55f324bda8cb02148a645c7ab36456e9fcddf9b95) and do not play an action beep | | UI\_SERVER\_INPUT\_ERROR\_BEEP | Configure input error beep. "" use the application setting from [UI\_PROP\_INPUT\_ERROR\_BEEP](#a0c064fcc5409b0845e11925a55f324bdafc6554130369f8897206c325c8e23a1f), "on" ignore [UI\_PROP\_INPUT\_ERROR\_BEEP](#a0c064fcc5409b0845e11925a55f324bdafc6554130369f8897206c325c8e23a1f) and play an input error beep, "off" ignore [UI\_PROP\_INPUT\_ERROR\_BEEP](#a0c064fcc5409b0845e11925a55f324bdafc6554130369f8897206c325c8e23a1f) and do not play an input error beep | | UI\_SERVER\_KEYMAP | Configure global keymap that overrides application settings. The format is the same as for [UI\_PROP\_KEYMAP](#a72b6555c0bdbb3b9869dd1f7c05f67bbab9e8bf7593993c8604294fe9b1a04aae). Set to "" to revert to application settings | ### FunctionDocumentation ### gui\_GetSvcVersion()\[1/2] const [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) char\\\* vfigui::gui\_GetSvcVersion ### gui\_GetSvcVersion()\[2/2] const [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) char\\\* vfigui::gui\_GetSvcVersion returns a zero-terminated string with version and build information of guiserver/guiprtserver in ADK version string format: \.\.\-\, e.g. "1.2.3-4" **Parameters** \[in] **display** display #### Returns version string ### gui\_GetVersion() const [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) char\\\* vfigui::gui\_GetVersion returns a zero-terminated string with version and build information of libvfiguiprt in ADK version string format: \.\.\-\, e.g. "1.2.3-4" #### Returns version string ### uiAddOption()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiAddOption Add an option to a \ element \[in] **value** value of the element to be added \[in] **text** text to be displayed \[in] **style** CSS style, if empty use default style \[in] **action** optional action \[in] **position** position at which to insert the entry. Negative values refer to the position from the end, e.g. -1 adds the element to the end. #### Returns error code {% hint style="info" %} Only a subset of the style settings is supported (setting style and color of text). {% endhint %} ### uiAddOption()\[2/2] int vfigui::uiAddOption inline shortcut for uiAddOption(0,region\_id,name,value,text,style,action,position); ### uiBeep()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiBeep play beep **Parameters** \[in] **display** display \[in] **beep** kind of beep to play #### Returns error code ### uiBeep()\[2/2] int vfigui::uiBeep inline shortcut for uiBeep(0,beep); ### uiCanvas()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiCanvas install a canvas for drawing in the given region **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in] **cb** event callback function, it is invoked for touch and keyboard events. \[in] **data** data pointer that is passed on to the callback function #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) or transaction ID. ### uiCanvas()\[2/2] int vfigui::uiCanvas inline shortcut for uiCanvas(0,region\_id,cb,data); ### uiCatalogGetDelayedRelease() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) unsigned vfigui::uiCatalogGetDelayedRelease Get the maximum number of unused catalogs that are kept in memory. #### Returns number of catalogs {% hint style="info" %} Catalog storage is shared with the printer module, i.e. this setting may be changed by calls to [prtCatalogSetDelayedRelease()](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfiprt.md#acc2a03e3c65b5c8c03f9c47d3731b7ef) {% endhint %} ### uiCatalogSetDelayedRelease() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void vfigui::uiCatalogSetDelayedRelease Set the maximum number of catalogs that are kept in memory although being unused. This improves load time when a catalog is used again, since when still in memory it does not need to be read from disk (default: 0) **Parameters** \[in] **num** number of catalogs {% hint style="info" %} Catalog storage is shared with the printer module, i.e. this setting may be changed by calls to [prtCatalogSetDelayedRelease()](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfiprt.md#acc2a03e3c65b5c8c03f9c47d3731b7ef) {% endhint %} ### uiClear()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiClear Remove a dialog or sub-regions from a region. If the dialog is still active, it is cancelled. After the the dialog has been removed, the region is empty, i.e. it displays nothing and does not clear the region. **Parameters** \[in] **display** display \[in] **region\_id** region id #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) ### uiClear()\[2/2] int vfigui::uiClear inline shortcut for uiClear(0,region\_id); ### uiConfigLEDs()\[1/4] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiConfigLEDs shortcut for accessing display 0 ### uiConfigLEDs()\[2/4] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiConfigLEDs set LED configuration from PNG file. The PNG file has to contain 5 LEDs next to each other. The first LED shows the off state, the remaining 4 LEDs show the on state of the 4 LEDs on screen. The alpha channel is supported to display non-rectangular LEDs. If present the LED area is cleared with the background color and the LEDs are drawn in off-state. **Parameters** \[in] **display** display \[in] **filename** file name of the PNG image #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) ### uiConfigLEDs()\[3/4] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiConfigLEDs set LED configuration. If present the LED area is cleared with the background color and the LEDs are drawn in off-state. **Parameters** \[in] **display** display \[in] **shape** LED shape \[in] **width** width of a single LED \[in] **height** height of a single LED \[in] **off\_rgba** color of the LED when switched off \[in] **on0\_rgba** color of LED 0 when switched on \[in] **on1\_rgba** color of LED 1 when switched on \[in] **on2\_rgba** color of LED 2 when switched on \[in] **on3\_rgba** color of LED 3 when switched on #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) ### uiConfigLEDs()\[4/4] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiConfigLEDs shortcut for accessing display 0 ### uiConfirm()\[1/3] int vfigui::uiConfirm inline ### uiConfirm()\[2/3] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiConfirm Display an HTML confirmation dialog on screen using a template file. **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in] **templateName** name of a template file. The HTML code found in text is inserted into the template \[in] **text** string containing an HTML fragment (i.e. the part between \ and \). \[in] **cb** optional callback function \[in] **cbdata** data pointer passed on to the callback function #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) or return value specified in the template {% hint style="info" %} *display* and *region\_id* are optional, see [Parameter Overloading](#gui_overloading) {% endhint %} #### Examples [demo-sysinfo.cpp](/adk-5.0-programmers-guide/readme/examples/demo-sysinfo_8cpp-example.md#a17), [mac\_demo1.cpp](/adk-5.0-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a22), [mac\_demo2.cpp](/adk-5.0-programmers-guide/readme/examples/mac_demo2_8cpp-example.md#a14), and [pm-demo.cpp](/adk-5.0-programmers-guide/readme/examples/pm-demo_8cpp-example.md#a23). ### uiConfirm()\[3/3] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiConfirm ### uiConfirmAsync()\[1/3] int vfigui::uiConfirmAsync inline ### uiConfirmAsync()\[2/3] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiConfirmAsync Asynchronously display an HTML confirmation dialog on screen using a template file. **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in] **templateName** name of a template file. The HTML code found in text is inserted into the template \[in] **text** string containing an HTML fragment (i.e. the part between \ and \). \[in] **cb** optional callback function that is called when the dialog has returned \[in] **data** data pointer that is passed on to the callback function #### Returns transaction ID or error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) {% hint style="info" %} *display* and *region\_id* are optional, see [Parameter Overloading](#gui_overloading) use [uiConfirmWait()](#a932cb60db6f53cfe8bc8759d05e6e09e) to wait for the dialog to finish or use [uiInvokeCancel()](#a151d71877a0f6426b3e2bbee47f88f0e) to cancel the dialog {% endhint %} ### uiConfirmAsync()\[3/3] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiConfirmAsync ### uiConfirmWait() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiConfirmWait Wait for the confirm dialog to finish **Parameters** \[in] **txn\_id** transaction id as returned by uiConfirmAsync() \[in] **timeout\_msec** timeout in milliseconds. In case of a negative timeout wait forever. #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) or return value specified in the HTML fragment. In case of a timeout UI\_ERR\_WAIT\_TIMEOUT is returned and [uiConfirmWait()](#a932cb60db6f53cfe8bc8759d05e6e09e) may be called again. ### uiCurrentRegionPath()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string vfigui::uiCurrentRegionPath shortcut for uiCurrentRegionPath(0); ### uiCurrentRegionPath()\[2/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string vfigui::uiCurrentRegionPath Return the current region path that was constructed using [uiEnterRegion()](#a63902ad7b3ac76cb853b5a136a4c37bb). The region path contains the regions passed on to successive calls of [uiEnterRegion()](#a63902ad7b3ac76cb853b5a136a4c37bb) separated by '/', e.g calling the sequence uiEnterRegion(1); uiEnterRegion(2); uiEnterRegion(3); the region path would be "1/2/3". If no region path is used, the empty string is returned. **Parameters** \[in] **display** display #### Returns current region path {% hint style="info" %} *display* is optional, see [Parameter Overloading](#gui_overloading) {% endhint %} ### uiDataURLToFile() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) bool vfigui::uiDataURLToFile extract data from data URL to file **Parameters** \[in] **filename** file name \[in] **in** data URL #### Returns true in case of success, else false ### uiDataURLToString() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) bool vfigui::uiDataURLToString extract data from data URL to string **Parameters** \[out] **out** extracted data \[in] **in** data URL #### Returns true in case of success, else false ### uiDataURLType() const [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) char\\\* vfigui::uiDataURLType check if a string contains a data URL and return the type as string (e.g. "png" for a PNG image) **Parameters** \[in] **s** string containing data #### Returns file type as string or NULL if *s* does not contain a known data URL type. ### uiDisablePINOK() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiDisablePINOK disable the OK button during PIN entry, e.g. since the amount has not yet been displayed. Use [uiEnablePINOK()](#a507a546dba483793386d45565eac84e7) to re-enable the OK button. The dialog must already be displayed to disable the OK button, i.e. use it after [uiInvokeAsync()](#add2574c4d093c99c0708c23b4c92e23d). When invoked when no PIN entry is active UI\_ERR\_PARAMETER is returned. **Parameters** \[in] **display** display #### Returns error code. ### uiDisconnect() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void vfigui::uiDisconnect disconnect from GUI server. The next call to another GUI function will implicitely reconnect to the server **Parameters** \[in] **display** display ### uiDisplay()\[1/6] int vfigui::uiDisplay inline ### uiDisplay()\[2/6] int vfigui::uiDisplay inline ### uiDisplay()\[3/6] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiDisplay Display an HTML document on screen using a template file. **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in] **templateName** name of a template file. The HTML code found in text is inserted into the template \[in] **text** string containing an HTML fragment (i.e. the part between \ and \). #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) {% hint style="info" %} *display* and *region\_id* are optional, see [Parameter Overloading](#gui_overloading) {% endhint %} ### uiDisplay()\[4/6] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiDisplay Display an HTML document on screen **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in] **text** string containing an HTML fragment (i.e. the part between \ and \). #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) {% hint style="info" %} *display* and *region\_id* are optional, see [Parameter Overloading](#gui_overloading) {% endhint %} ### uiDisplay()\[5/6] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiDisplay ### uiDisplay()\[6/6] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiDisplay ### uiDisplayAsync()\[1/6] int vfigui::uiDisplayAsync inline ### uiDisplayAsync()\[2/6] int vfigui::uiDisplayAsync inline ### uiDisplayAsync()\[3/6] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiDisplayAsync Asynchronously display an HTML document on screen using a template file. **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in] **templateName** name of a template file. The HTML code found in text is inserted into the template \[in] **text** string containing an HTML fragment (i.e. the part between \ and \). \[in] **cb** optional callback function that is called when the dialog has returned \[in] **data** data pointer that is passed on to the callback function #### Returns transaction ID or error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) {% hint style="info" %} *display* and *region\_id* are optional, see [Parameter Overloading](#gui_overloading) use [uiDisplayWait()](#a8579cb74c1f8b3d0d855d7b8ca06f462) to wait for the dialog to finish or use uiInvokeCancl() to cancel the dialog {% endhint %} ### uiDisplayAsync()\[4/6] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiDisplayAsync Asynchronously display an HTML document on screen **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in] **text** string containing an HTML fragment (i.e. the part between \ and \). \[in] **cb** optional callback function that is called when the dialog has returned \[in] **data** data pointer that is passed on to the callback function #### Returns transaction ID or error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) {% hint style="info" %} *display* and *region\_id* are optional, see [Parameter Overloading](#gui_overloading) use [uiDisplayWait()](#a8579cb74c1f8b3d0d855d7b8ca06f462) to wait for the dialog to finish or use [uiInvokeCancel()](#a151d71877a0f6426b3e2bbee47f88f0e) to cancel the dialog {% endhint %} #### Examples [demo-sysinfo.cpp](/adk-5.0-programmers-guide/readme/examples/demo-sysinfo_8cpp-example.md#a148). ### uiDisplayAsync()\[5/6] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiDisplayAsync ### uiDisplayAsync()\[6/6] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiDisplayAsync ### uiDisplayCount() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiDisplayCount determine the number of displays #### Returns number of displays ### uiDisplayWait() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiDisplayWait Wait for the result of the display **Parameters** \[in] **txn\_id** transaction id as returned by uiDisplayAsync() \[in] **timeout\_msec** timeout in milliseconds. In case of a negative timeout wait forever. #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) or return value specified in the HTML fragment. In case of a timeout UI\_ERR\_WAIT\_TIMEOUT is returned and [uiDisplayWait()](#a8579cb74c1f8b3d0d855d7b8ca06f462) may be called again. ### uiDraw()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiDraw draw to canvas **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in] **drawing** set of drawing primitives #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) ### uiDraw()\[2/2] int vfigui::uiDraw inline shortcut for uiDraw(0,region\_id,drawing); ### uiDrawAsync()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiDrawAsync Asynchronously draw to canvas **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in] **drawing** set of drawing primitives #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) ### uiDrawAsync()\[2/2] int vfigui::uiDrawAsync inline shortcut for uiDraw(0,region\_id,drawing); ### uiEnablePINOK() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiEnablePINOK enable the OK button when it has been disabled using [uiDisablePINOK()](#a2b9dd85f581cd18f44ac0f6e2e298a02). Use [uiEnablePINOK()](#a507a546dba483793386d45565eac84e7) to re-enable the OK button **Parameters** \[in] **display** display #### Returns error code. {% hint style="info" %} Invocation of this function is only required if uiDisablePINOK has been used. {% endhint %} ### uiEnterRegion()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiEnterRegion Enter region *region\_id* making it the parent region for all successive [uiLayout()](#af855d00b4a448abba99ca993a7b629eb) and [uiGetLayout()](#a81b3d717d2eeb276b10d2209f28fe4ba) commands. This is used to create a tree of regions. **Parameters** \[in] **display** display \[in] **region\_id** region ID #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) {% hint style="info" %} *display* is optional, see [Parameter Overloading](#gui_overloading) a new default region is created if required. {% endhint %} ### uiEnterRegion()\[2/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiEnterRegion shortcut for uiEnterRegion(0,region\_id); ### uiErrorList() const [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::vector\\<[UIErrorEntry](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/structvfigui_1_1_u_i_error_entry.md)\\>& vfigui::uiErrorList obtain list of non-fatal errors that happened while displaying a dialog. In case of synchronous dialogs the error list is reset as part of displaying the dialog. In case of asynchronous dialogs this list is reset when displaying the dialog using one of the ui\*Async functions and when calling uiInvokeWait (or one of the other ui\*Wait functions) #### Returns reference to the error list of the last dialog shown in this thread. ### uiGetBacklightConfig() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiGetBacklightConfig read backlight parameters **Parameters** \[in] **display** display \[out] **levels** backlight brightness levels and timeouts #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) ### uiGetBacklightLevel() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiGetBacklightLevel get backlight level **Parameters** \[in] **display** display \[out] **level** current level in the range 0..levels.size()-1 #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) ### uiGetCatalog()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string vfigui::uiGetCatalog shortcut for uiGetCatalog(0); ### uiGetCatalog()\[2/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string vfigui::uiGetCatalog **Parameters** \[in] **display** display #### Returns file name of the current catalog file or empty string in case none has been loaded {% hint style="info" %} *display* is optional, see [Parameter Overloading](#gui_overloading) {% endhint %} ### uiGetConnectAttempts() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiGetConnectAttempts get the number of attempts to contact the server #### Returns Number of attempts ### uiGetDisconnectCallback() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) \[uiDisconnectCallback]\(#ab8ea76e56e5a189126608d0674e79db7) vfigui::uiGetDisconnectCallback get callback that gets invoked if the contact to the server is lost #### Returns callback function as set with [uiSetDisconnectCallback()](#a65a2c9a477b2fdaeff369e84983affd8); ### uiGetHtml()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiGetHtml shortcut for uiGetHtml(0,value,text,html); ### uiGetHtml()\[2/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiGetHtml preprocess HTML code and return the resulting string **Parameters** \[in] **display** display whose settings should be used (e.g. text catalog, css file, etc.) \[in] **value** name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing. \[in] **text** string containing an HTML fragment (i.e. the part between \ and \). \[out] **html** resulting HTML code #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) {% hint style="info" %} *display* is optional, see [Parameter Overloading](#gui_overloading) {% endhint %} ### uiGetHtmlURL()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiGetHtmlURL shortcut for uiGetHtmlURL(0,value,url,html); ### uiGetHtmlURL()\[2/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiGetHtmlURL preprocess HTML code and return the resulting string **Parameters** \[in] **display** display whose settings should be used (e.g. text catalog, css file, etc.) \[in] **value** name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing. \[in] **url** location of the dialog file. The location is prefixed by the resource path and by the optional prefix (see also UI\_PROP\_RESOURCE\_PATH, UI\_PROP\_FILE\_PREFIX) unless an absolute path was provided. \[out] **html** resulting HTML code #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) {% hint style="info" %} *display* is optional, see [Parameter Overloading](#gui_overloading) {% endhint %} ### uiGetIdleTime() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiGetIdleTime Determine the amount of time passed since the last user interaction. #### Returns Idle time in milliseconds (>=0) or error code (<0). ### uiGetKeepalive() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void vfigui::uiGetKeepalive get keepalive settings **Parameters** \[out] **count** number of keepalive probes to send before dropping the link \[out] **interval** time in seconds between sending keepalive probes ### uiGetKeypadType() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string vfigui::uiGetKeypadType determine the keypad type #### Returns keypad type ### uiGetLayout()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiGetLayout read the current layout setting **Parameters** \[in] **display** display \[out] **region** returned region layout #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) {% hint style="info" %} *display* is optional, see [Parameter Overloading](#gui_overloading) {% endhint %} ### uiGetLayout()\[2/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiGetLayout shortcut for uiGetLayout(0,region); ### uiGetLocalProperties() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) bool vfigui::uiGetLocalProperties #### Returns true if thread local properties are used, else return false ### uiGetLogMask() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) unsigned vfigui::uiGetLogMask Get log mask #### Returns current log mask ### uiGetPinStatusCallback() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) \[uiPinStatusCallback]\(#a996cf8c4f9fc88f971a90d1b1ed5f7fa) vfigui::uiGetPinStatusCallback Get the currently set PIN status callback. #### Returns callback function as set with [uiSetPinStatusCallback()](#abda9f05a851f1542310fdfe20bc14110), or NULL ### uiGetPropertyInt()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiGetPropertyInt shortcut for uiGetPropertyInt(0,property,value); ### uiGetPropertyInt()\[2/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiGetPropertyInt get int property **Parameters** \[in] **display** display \[in] **property** property to be set \[out] **value** current value #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) {% hint style="info" %} *display* is optional, see [Parameter Overloading](#gui_overloading) {% endhint %} #### Examples [demo-sysinfo.cpp](/adk-5.0-programmers-guide/readme/examples/demo-sysinfo_8cpp-example.md#a136). ### uiGetPropertyString()\[1/4] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiGetPropertyString shortcut for uiGetPropertyString(0,property,value,len); ### uiGetPropertyString()\[2/4] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiGetPropertyString shortcut for uiGetPropertyString(0,property,value); ### uiGetPropertyString()\[3/4] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiGetPropertyString get string property **Parameters** \[in] **display** display \[in] **property** property to be set \[out] **value** current value \[in] **len** size ouf output buffer value in bytes #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) {% hint style="info" %} *display* is optional, see [Parameter Overloading](#gui_overloading) {% endhint %} ### uiGetPropertyString()\[4/4] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiGetPropertyString get string property **Parameters** \[in] **display** display \[in] **property** property to be set \[out] **value** current value #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) {% hint style="info" %} *display* is optional, see [Parameter Overloading](#gui_overloading) {% endhint %} ### uiGetRegionSize()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiGetRegionSize Determine size of a region in pixels **Parameters** \[in] **display** display; \[in] **region\_id** region ID; \[out] **width** width in pixels \[out] **height** height in pixels #### Returns error code ### uiGetRegionSize()\[2/2] int vfigui::uiGetRegionSize inline shortcut for uiGetRegionSize(0,region\_id,width,height); ### uiGetServerProperty() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiGetServerProperty get global server property **Parameters** \[in] **display** display \[in] **property** property to be set \[out] **value** current value #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) ### uiGetTerminalResourceDir()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string vfigui::uiGetTerminalResourceDir shortcut for uiGetTerminalResourceDir(0,www\_path); ### uiGetTerminalResourceDir()\[2/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string vfigui::uiGetTerminalResourceDir determine the HW dependent terminal specific subdirectory inside the 'www' directory **Parameters** \[in] **display** display \[in] **www\_path** path of the www directory containing the resource files #### Returns path to the terminal specific subdirectory {% hint style="info" %} *display* is optional, see [Parameter Overloading](#gui_overloading) The environment variable GUIPRT\_APPNAME is not considered. {% endhint %} ### uiGetText()\[1/4] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string vfigui::uiGetText shortcut for uiGetText(0,filename,name,deflt); ### uiGetText()\[2/4] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string vfigui::uiGetText shortcut for uiGetText(0,name,deflt); ### uiGetText()\[3/4] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string vfigui::uiGetText lookup a text from a catalog file referred by *filename*. In difference to [uiGetText()](#a742c67e3b8c81268853ca4aa1302eaa6) functions above, the catalog need not to be loaded with [uiSetCatalog()](#ab103c683852a0d4b19695e76f90dcf82), thus, is not applied to UI property context. {% hint style="info" %} Applications must call [uiSetCatalog()](#ab103c683852a0d4b19695e76f90dcf82) before HTML documents can use XML processing instructions \. Parameter *display* is ignored, if *filename* contains an absolute file path. In case of a relative file path, the function looks up the file relative to UI\_PROP\_RESOURCE\_PATH and UI\_PROP\_RESOURCE\_DEFAULT\_PATH, therefore, parameter *display* is required to get the related UI resource paths from the UI property context. This function might delete another unused catalog, which was kept in internal catalog cache. For more details, see [uiCatalogSetDelayedRelease()](#aac69533e0d547c76b34253f4458c525c). {% endhint %} \*\*Parameters\*\* \[in] **filename** of the catalog \[in] **display** display \[in] **name** of key used to lookup the text in calalog \[in] **deflt** text that is returned, if text is not found in calalog #### Returns text from catalog for success, else value in parameter *default* {% hint style="info" %} *display* is optional, see [Parameter Overloading](#gui_overloading) {% endhint %} ### uiGetText()\[4/4] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string vfigui::uiGetText lookup a text from current loaded catalog by *key* name. If text is not found in catalog or no catalog is loaded the function returns value in in parameter *default*. **Parameters** \[in] **display** display \[in] **name** of key used to lookup the text in calalog \[in] **deflt** text that is returned, if text is not found in calalog #### Returns text from catalog for success, else value in parameter *default* {% hint style="info" %} *display* is optional, see [Parameter Overloading](#gui_overloading) {% endhint %} ### uiGetURLPath()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string vfigui::uiGetURLPath shortcut for uiGetURLPath(0,url); ### uiGetURLPath()\[2/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string vfigui::uiGetURLPath determine the full path of an url taking into account all settings and rules for looking up files **Parameters** \[in] **display** display whose settings should be used (e.g. text catalog, css file, etc.) \[in] **url** location of the dialog file. The location is prefixed by the resource path and by the optional prefix (see also UI\_PROP\_RESOURCE\_PATH, UI\_PROP\_FILE\_PREFIX) unless an absolute path was provided. #### Returns full path of the HTML file or empty string if not found. {% hint style="info" %} *display* is optional, see [Parameter Overloading](#gui_overloading) {% endhint %} ### uiHideLEDArea()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiHideLEDArea shortcut for accessing display 0 ### uiHideLEDArea()\[2/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiHideLEDArea Decrement the LED area reference counter and hide the LED area if the counter reaches 0. **Parameters** \[in] **display** display #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) ### uiHTML2PNG() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiHTML2PNG convert a dialog to a PNG image **Parameters** \[in] **filename** file name of the PNG file \[in] **width** width of the image \[in] **height** height of the image \[in] **value** name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing. \[in] **text** HTML code #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) ### uiHTML2PNGData() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiHTML2PNGData convert a dialog to a PNG image **Parameters** \[out] **data** data of PNG file \[in] **width** width of the image \[in] **height** height of the image \[in] **value** name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing. \[in] **text** HTML code #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) ### uiInput()\[1/3] int vfigui::uiInput inline ### uiInput()\[2/3] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInput Display an HTML input dialog on screen using a template file. **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in] **templateName** name of a template file. The HTML code found in text is inserted into the template \[in,out] **value** initial value and returned value of the input fields. The first value refers to the first input field, the second to the second, etc. \[in] **text** string containing an HTML fragment (i.e. the part between \ and \). The input fields have to be specified as HTML input fields (e.g. \). The following input types are supported:text: text inputpassword: password inputcheckbox: checkboxnumber: numeric input (HTML extension)mask: masked input (HTML extension)pin: PIN input The following attributes are supported:allowed\_chars: list of allowed charactersmask: input mask (HTML extension): '\*' is used as place holder for filling in charactersmaxlengh: maximum input lengthname: name of the input fieldprecision: number of decimal placessize: size of the input field in characters for display on screen \[in] **cb** optional callback function \[in] **cbdata** data pointer passed on to the callback function #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) or return value specified in the template {% hint style="info" %} *display* and *region\_id* are optional, see [Parameter Overloading](#gui_overloading) PIN input cannot be combined with other input types since the keyboard is exclusively locked by the PIN entry function. In case of PIN entry the value returned in *value* is the number of digits entered or "error" in case of an error, "cancel" if the user pressed CANCEL, "clear" if the user pressed CLEAR, "bypass" in case of PIN bypass and "timeout" in case of timeout. Radio buttons will not behave as expected since these use more than one input element to represent a single input value. {% endhint %} ### uiInput()\[3/3] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInput ### uiInputAsync()\[1/3] int vfigui::uiInputAsync inline ### uiInputAsync()\[2/3] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInputAsync Asynchronously display an HTML input dialog on screen using a template file. **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in] **templateName** name of a template file. The HTML code found in text is inserted into the template \[in] **value** initial value of the input fields. The first value refers to the first input field, the second to the second, etc. \[in] **text** string containing an HTML fragment \[in] **cb** optional callback function that is called when the dialog has returned \[in] **data** data pointer that is passed on to the callback function #### Returns transaction ID or error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) {% hint style="info" %} *display* and *region\_id* are optional, see [Parameter Overloading](#gui_overloading) see also [uiInput()](#abc2e22a493f5dbdb8bfad06dd187d51a) use [uiInputWait()](#afebb1f35d2b398978a3fc6baf6a72e3e) to wait for the dialog to finish or use [uiInvokeCancel()](#a151d71877a0f6426b3e2bbee47f88f0e) to cancel the dialog {% endhint %} ### uiInputAsync()\[3/3] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInputAsync ### uiInputPINCheck()\[1/3] int vfigui::uiInputPINCheck inline ### uiInputPINCheck()\[2/3] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInputPINCheck Display a PIN check dialog: The entered PIN is checkec against a known PIN **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in] **templateName** name of a template file. The HTML code found in text is inserted into the template \[in] **referencePIN** reference PIN \[in] **text** string containing an HTML fragment \[in] **cb** optional callback function \[in] **cbdata** data pointer passed on to the callback function #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) (UI\_ERR\_WRON\_PIN in case of a wrong PIN, UI\_ERR\_OK in case the PIN was OK) {% hint style="info" %} *display* and *region\_id* are optional, see [Parameter Overloading](#gui_overloading) {% endhint %} ### uiInputPINCheck()\[3/3] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInputPINCheck ### uiInputPINCheckAsync()\[1/3] int vfigui::uiInputPINCheckAsync inline ### uiInputPINCheckAsync()\[2/3] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInputPINCheckAsync Asynchronously display a PIN check dialog: The entered PIN is checkec against a known PIN **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in] **templateName** name of a template file. The HTML code found in text is inserted into the template \[in] **text** string containing an HTML fragment \[in] **referencePIN** reference PIN \[in] **cb** optional callback function that is called when the dialog has returned \[in] **data** data pointer that is passed on to the callback function #### Returns transaction ID or error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) {% hint style="info" %} *display* and *region\_id* are optional, see [Parameter Overloading](#gui_overloading) use [uiInputPINCheckWait()](#ae23c072e72e864549ed92e34d7eba717) to wait for the dialog to finish or use [uiInvokeCancel()](#a151d71877a0f6426b3e2bbee47f88f0e) to cancel the dialog {% endhint %} ### uiInputPINCheckAsync()\[3/3] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInputPINCheckAsync ### uiInputPINCheckWait() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInputPINCheckWait Wait for the PIN check dialog to finish **Parameters** \[in] **txn\_id** transaction id as returned by uiInputPINCheckAsync() \[in] **timeout\_msec** timeout in milliseconds. In case of a negative timeout wait forever. #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) or return value specified in the HTML fragment. In case of a timeout UI\_ERR\_WAIT\_TIMEOUT is returned and [uiInputPINCheckWait()](#ae23c072e72e864549ed92e34d7eba717) may be called again. {% hint style="info" %} update events are currently not supported for [uiInputPINCheckWait()](#ae23c072e72e864549ed92e34d7eba717). {% endhint %} ### uiInputWait() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInputWait Wait for the input dialog to finish **Parameters** \[in] **txn\_id** transaction id as returned by uiInputAsync() \[in] **value** returned value of the input fields. The first value refers to the first input field, the second to the second, etc. \[in] **timeout\_msec** timeout in milliseconds. In case of a negative timeout wait forever. #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) or return value specified in the HTML fragment. In case of a timeout UI\_ERR\_WAIT\_TIMEOUT is returned and [uiInputWait()](#afebb1f35d2b398978a3fc6baf6a72e3e) may be called again. ### uiInvoke()\[1/6] int vfigui::uiInvoke inline ### uiInvoke()\[2/6] int vfigui::uiInvoke inline ### uiInvoke()\[3/6] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInvoke Invoke an HTML dialog. **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in,out] **value** name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing. On return value contains the updated input values. \[in] **text** string containing an HTML fragment (i.e. the part between \ and \). \[in] **cb** optional callback function \[in] **cbdata** data pointer passed on to the callback function #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) or return value specified in the HTML fragment {% hint style="info" %} *display*, *region\_id* and *value* are optional, see [Parameter Overloading](#gui_overloading) {% endhint %} #### Examples [demo-sysinfo.cpp](/adk-5.0-programmers-guide/readme/examples/demo-sysinfo_8cpp-example.md#a141). ### uiInvoke()\[4/6] int vfigui::uiInvoke inline ### uiInvoke()\[5/6] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInvoke ### uiInvoke()\[6/6] int vfigui::uiInvoke inline ### uiInvokeAsync()\[1/6] int vfigui::uiInvokeAsync inline shortcut for uiInvokeAsync(0,UI\_REGION\_DEFAULT, dummy\_value, text,cb,data); ### uiInvokeAsync()\[2/6] int vfigui::uiInvokeAsync inline shortcut for uiInvokeAsync(0,UI\_REGION\_DEFAULT, value, text,cb,data); ### uiInvokeAsync()\[3/6] int vfigui::uiInvokeAsync inline shortcut for uiInvokeAsync(display, region\_id,dummy\_value,text,cb,data); ### uiInvokeAsync()\[4/6] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInvokeAsync Asynchronously invoke an HTML dialog. **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in] **value** name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing. \[in] **text** string containing an HTML fragment (i.e. the part between \ and \). \[in] **cb** optional callback function that is called when the dialog has returned \[in] **data** data pointer that is passed on to the callback function #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) or transaction ID. The transaction ID is required for obtaining the dialog result using [uiInvokeWait()](#a1736105f217b0ece50660d95fa6c8b4e) {% hint style="info" %} *display*, *region\_id* and *value* are optional, see [Parameter Overloading](#gui_overloading) If no callback was provided, [uiInvokeWait()](#a1736105f217b0ece50660d95fa6c8b4e) must be called to obtain the result and release allocated memory or [uiInvokeCancel()](#a151d71877a0f6426b3e2bbee47f88f0e) needs to be called to cancel the dialog. If a callback was provided [uiInvokeWait()](#a1736105f217b0ece50660d95fa6c8b4e) cannot be used and will return UI\_ERR\_INVALID. {% endhint %} ### uiInvokeAsync()\[5/6] int vfigui::uiInvokeAsync inline shortcut for uiInvokeAsync(0,region\_id,dummy\_value,text,cb,data); ### uiInvokeAsync()\[6/6] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInvokeAsync shortcut for uiInvokeAsync(0,region\_id,value,text,cb,data); ### uiInvokeCancel()\[1/2] int vfigui::uiInvokeCancel inline the same as [uiInvokeCancel(int txn\_id, std::map\ \&value)](#a151d71877a0f6426b3e2bbee47f88f0e) but discards returned input values ### uiInvokeCancel()\[2/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInvokeCancel Cancel dialog. This may be called whenever [uiInvokeWait()](#a1736105f217b0ece50660d95fa6c8b4e) can be called and cancels the dialog. **Parameters** \[in] **txn\_id** Request ID of the dialog \[out] **value** entered values are added to this map #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)). For asynchronous calls with callback function the return value cannot be obtained since it is delivered to the callback function. In this case always UI\_ERR\_OK is returned. Normally the error code will be UI\_ERR\_CANCELLED, however, the returncode reflects the true result of the dialog, i.e. if the user terminated the dialog just before cancelling it, the returncode will contain the result of the dialog. ### uiInvokeCancelAsync() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInvokeCancelAsync Cancel dialog without reading the result, i.e. [uiInvokeWait()](#a1736105f217b0ece50660d95fa6c8b4e) will have to be called afterwards. **Parameters** \[in] **txn\_id** Request ID of the dialog #### Returns error code ### uiInvokeTemplate()\[1/6] int vfigui::uiInvokeTemplate inline ### uiInvokeTemplate()\[2/6] int vfigui::uiInvokeTemplate inline ### uiInvokeTemplate()\[3/6] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInvokeTemplate Invoke an HTML dialog with template: The provided text is inserted into the template file and then displayed. **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in,out] **value** name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing. On return value contains the updated input values. \[in] **template\_name** file name of template into which text is inserted \[in] **text** string containing an HTML fragment (i.e. the part between \ and \). \[in] **cb** optional callback function \[in] **cbdata** data pointer passed on to the callback function #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) or return value specified in the HTML fragment {% hint style="info" %} *display*, *region\_id* and *value* are optional, see [Parameter Overloading](#gui_overloading) {% endhint %} ### uiInvokeTemplate()\[4/6] int vfigui::uiInvokeTemplate inline ### uiInvokeTemplate()\[5/6] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInvokeTemplate ### uiInvokeTemplate()\[6/6] int vfigui::uiInvokeTemplate inline ### uiInvokeTemplateAsync()\[1/6] int vfigui::uiInvokeTemplateAsync inline shortcut for uiInvokeTemplateAsync(0,UI\_REGION\_DEFAULT, dummy\_value, template\_name, text, cb,data); ### uiInvokeTemplateAsync()\[2/6] int vfigui::uiInvokeTemplateAsync inline shortcut for uiInvokeTemplateAsync(0, UI\_REGION\_DEFAULT, value, template\_name, text, cb,data); ### uiInvokeTemplateAsync()\[3/6] int vfigui::uiInvokeTemplateAsync inline shortcut for uiInvokeTemplateAsync(display,region\_id,dummy\_value,template\_name,text, cb,data); ### uiInvokeTemplateAsync()\[4/6] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInvokeTemplateAsync Asynchronously invoke an HTML dialog. The provided text is inserted into the template file and then the dialog is displayed **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in] **value** name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing. \[in] **template\_name** template file \[in] **text** string containing an HTML fragment (i.e. the part between \ and \). \[in] **cb** optional callback function that is called when the dialog has returned \[in] **data** data pointer that is passed on to the callback function #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) or transaction ID. The transaction ID is required for obtaining the dialog result using [uiInvokeWait()](#a1736105f217b0ece50660d95fa6c8b4e) {% hint style="info" %} *display*, *region\_id* and *value* are optional, see [Parameter Overloading](#gui_overloading) If no callback was provided, [uiInvokeWait()](#a1736105f217b0ece50660d95fa6c8b4e) must be called to obtain the result and release allocated memory or [uiInvokeCancel()](#a151d71877a0f6426b3e2bbee47f88f0e) needs to be called to cancel the dialog. If a callback was provided [uiInvokeWait()](#a1736105f217b0ece50660d95fa6c8b4e) cannot be used and will return UI\_ERR\_INVALID. {% endhint %} ### uiInvokeTemplateAsync()\[5/6] int vfigui::uiInvokeTemplateAsync inline shortcut for uiInvokeTemplateAsync(0,region\_id,dummy\_value,template\_name,text, cb,data); ### uiInvokeTemplateAsync()\[6/6] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInvokeTemplateAsync shortcut for uiInvokeTemplateAsync(0,region\_id,value,template\_name,text,cb,data); ### uiInvokeURL()\[1/12] int vfigui::uiInvokeURL inline shortcut for uiInvokeURL(0,UI\_REGION\_DEFAULT,dummy\_value,url,cb,cbdata); ### uiInvokeURL()\[2/12] int vfigui::uiInvokeURL inline shortcut for uiInvokeURL(0,UI\_REGION\_DEFAULT, dummy\_value,url,cb,cbdata); ### uiInvokeURL()\[3/12] int vfigui::uiInvokeURL inline shortcut for uiInvokeURL(display, region\_id, dummy\_value,url,cb,cbdata); ### uiInvokeURL()\[4/12] int vfigui::uiInvokeURL inline shortcut for uiInvokeURL(display,region\_id,dummy\_value,url,cb,cbdata); ### uiInvokeURL()\[5/12] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInvokeURL display a dialog **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in,out] **value** name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing. On return value contains the updated input values. \[in] **url** location of the dialog file. The location is prefixed by the resource path and by the optional prefix (see also UI\_PROP\_RESOURCE\_PATH, UI\_PROP\_FILE\_PREFIX) \[in] **cb** optional callback function \[in] **cbdata** data pointer passed on to the callback function #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) or return value specified in the HTML fragment {% hint style="info" %} *display*, *region\_id* and *value* are optional, see [Parameter Overloading](#gui_overloading) {% endhint %} #### Examples [demo-sysinfo.cpp](/adk-5.0-programmers-guide/readme/examples/demo-sysinfo_8cpp-example.md#a68), and [mac\_demo1.cpp](/adk-5.0-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a34). ### uiInvokeURL()\[6/12] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInvokeURL display a dialog **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in,out] **value** name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing. On return value contains the updated input values. \[in] **url** location of the dialog file. The location is prefixed by the resource path and by the optional prefix (see also UI\_PROP\_RESOURCE\_PATH, UI\_PROP\_FILE\_PREFIX) \[in] **cb** optional callback function \[in] **cbdata** data pointer passed on to the callback function #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) or return value specified in the HTML fragment {% hint style="info" %} *display*, *region\_id* and *value* are optional, see [Parameter Overloading](#gui_overloading) {% endhint %} ### uiInvokeURL()\[7/12] int vfigui::uiInvokeURL inline shortcut for uiInvokeURL(0,region\_id,dummy\_value,url,cb,cbdata); ### uiInvokeURL()\[8/12] int vfigui::uiInvokeURL inline shortcut for uiInvokeURL(0,region\_id,dummy\_value,url,cb,cbdata); ### uiInvokeURL()\[9/12] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInvokeURL shortcut for uiInvokeURL(0,region\_id,value,url,cb,cbdata); ### uiInvokeURL()\[10/12] int vfigui::uiInvokeURL inline shortcut for iInvokeURL(0,region\_id,value,url,cb,cbdata); ### uiInvokeURL()\[11/12] int vfigui::uiInvokeURL inline shortcut for uiInvokeURL(0,UI\_REGION\_DEFAULT,value,url,cb,cbdata); ### uiInvokeURL()\[12/12] int vfigui::uiInvokeURL inline shortcut for iInvokeURL(0,UI\_REGION\_DEFAULT,value,url,cb,cbdata); ### uiInvokeURLAsync()\[1/12] int vfigui::uiInvokeURLAsync inline shortcut for uiInvokeURLAsync(0, UI\_REGION\_DEFAULT, dummy\_value, url,cb,data); ### uiInvokeURLAsync()\[2/12] int vfigui::uiInvokeURLAsync inline shortcut for uiInvokeURLAsync(0, UI\_REGION\_DEFAULT, dummy\_value, url,cb,data); ### uiInvokeURLAsync()\[3/12] int vfigui::uiInvokeURLAsync inline shortcut for uiInvokeURLAsync(0, UI\_REGION\_DEFAULT, value, url,cb,data); ### uiInvokeURLAsync()\[4/12] int vfigui::uiInvokeURLAsync inline shortcut for uiInvokeURLAsync(0, UI\_REGION\_DEFAULT, value, url,cb,data); ### uiInvokeURLAsync()\[5/12] int vfigui::uiInvokeURLAsync inline shortcut for uiInvokeURLAsync(display, region\_id,dummy\_value,url,cb,data); ### uiInvokeURLAsync()\[6/12] int vfigui::uiInvokeURLAsync inline shortcut for uiInvokeURLAsync(display, region\_id,dummy\_value,url,cb,data); ### uiInvokeURLAsync()\[7/12] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInvokeURLAsync Asynchronously invoke an HTML dialog **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in] **value** name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing. \[in] **url** location of the dialog file. The location is prefixed by the resource path and by the optional prefix (see also UI\_PROP\_RESOURCE\_PATH, UI\_PROP\_FILE\_PREFIX) \[in] **cb** optional callback function that is called when the dialog has returned \[in] **data** data pointer that is passed on to the callback function #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) or transaction ID. The transaction ID is required for obtaining the dialog result using [uiInvokeWait()](#a1736105f217b0ece50660d95fa6c8b4e) {% hint style="info" %} *display*, *region\_id* and *value* are optional, see [Parameter Overloading](#gui_overloading) If no callback was provided, [uiInvokeWait()](#a1736105f217b0ece50660d95fa6c8b4e) must be called to obtain the result and release allocated memory or [uiInvokeCancel()](#a151d71877a0f6426b3e2bbee47f88f0e) needs to be called to cancel the dialog. If a callback was provided [uiInvokeWait()](#a1736105f217b0ece50660d95fa6c8b4e) cannot be used and will return UI\_ERR\_INVALID. {% endhint %} ### uiInvokeURLAsync()\[8/12] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInvokeURLAsync Asynchronously invoke an HTML dialog **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in] **value** name value pairs that are used as initial value of input fields, checkboxes, etc. and that are used during script processing. \[in] **url** location of the dialog file. The location is prefixed by the resource path and by the optional prefix (see also UI\_PROP\_RESOURCE\_PATH, UI\_PROP\_FILE\_PREFIX) \[in] **cb** optional callback function that is called when the dialog has returned \[in] **data** data pointer that is passed on to the callback function #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) or transaction ID. The transaction ID is required for obtaining the dialog result using [uiInvokeWait()](#a1736105f217b0ece50660d95fa6c8b4e) {% hint style="info" %} *display*, *region\_id* and *value* are optional, see [Parameter Overloading](#gui_overloading) If no callback was provided, [uiInvokeWait()](#a1736105f217b0ece50660d95fa6c8b4e) must be called to obtain the result and release allocated memory or [uiInvokeCancel()](#a151d71877a0f6426b3e2bbee47f88f0e) needs to be called to cancel the dialog. If a callback was provided [uiInvokeWait()](#a1736105f217b0ece50660d95fa6c8b4e) cannot be used and will return UI\_ERR\_INVALID. {% endhint %} ### uiInvokeURLAsync()\[9/12] int vfigui::uiInvokeURLAsync inline shortcut for uiInvokeURLAsync(0,region\_id,dummy\_value,url,cb,data); ### uiInvokeURLAsync()\[10/12] int vfigui::uiInvokeURLAsync inline shortcut for uiInvokeURLAsync(0,region\_id,dummy\_value,url,cb,data); ### uiInvokeURLAsync()\[11/12] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInvokeURLAsync shortcut for uiInvokeURLAsync(0,region\_id,value,url,cb,data); ### uiInvokeURLAsync()\[12/12] int vfigui::uiInvokeURLAsync inline shortcut for uiInvokeURLAsync(0, region\_id, value, url,cb,data); ### uiInvokeURLDetached()\[1/3] int vfigui::uiInvokeURLDetached inline shortcut for uiInvokeURLDetached(0,UI\_REGION\_DEFAULT,url); ### uiInvokeURLDetached()\[2/3] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInvokeURLDetached Create a new thread and display a dialog from within this thread. The thread terminates when the dialog terminates. Dialog return values are discarded. **Parameters** \[in] **display** display \[in] **region\_id** region id \[in] **url** location of the dialog file. The location is prefixed by the resource path and by the optional prefix (see also UI\_PROP\_RESOURCE\_PATH, UI\_PROP\_FILE\_PREFIX) #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) (but no result from dialog) {% hint style="info" %} *display* and *region\_id* are optional, see [Parameter Overloading](#gui_overloading) This function is useful for example for displaying some kind of virtual keyboard. {% endhint %} ### uiInvokeURLDetached()\[3/3] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInvokeURLDetached shortcut for uiInvokeURLDetached(0,region\_id,url); ### uiInvokeWait()\[1/2] int vfigui::uiInvokeWait inline the same as uiInvokeWait(int txn\_id, std::map\ \&value, int timeout\_msec=-1) but discards returned input values ### uiInvokeWait()\[2/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiInvokeWait Wait for a dialog to finish **Parameters** \[in] **txn\_id** Request ID of the dialog \[out] **value** entered values are added to this map \[in] **timeout\_msec** timeout in milliseconds. In case of a negative timeout wait forever. #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) or return value specified in the HTML fragment. In case of a timeout UI\_ERR\_WAIT\_TIMEOUT is returned and [uiInvokeWait()](#a1736105f217b0ece50660d95fa6c8b4e) has to be called again or memory may be leaked. As an alternative [uiInvokeCancel()](#a151d71877a0f6426b3e2bbee47f88f0e) may be called to cancel the dialog. {% hint style="info" %} uiInvokeWait cannot be called if a callback function has been provided when invoking the dialog. When displaying dialog sequences (e.g. using load url in an action) [uiInvokeWait()](#a1736105f217b0ece50660d95fa6c8b4e) handles the switching to the next dialog in the sequence. {% endhint %} ### uiLayout()\[1/10] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiLayout shortcut for uiLayout(0,name); ### uiLayout()\[2/10] int vfigui::uiLayout inline shortcut for uiLayout(0,reg); ### uiLayout()\[3/10] int vfigui::uiLayout inline shortcut for uiLayout(0,reg,oldreg); ### uiLayout()\[4/10] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiLayout shortcut for uiLayout(0,region,regcnt,0,0); ### uiLayout()\[5/10] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiLayout shortcut for uiLayout(0,region,regcnt,oldreg,oldregcnt); ### uiLayout()\[6/10] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiLayout define output regions of the display. The layout definition is read from section *name* of gui.ini **Parameters** \[in] **display** display \[in] **name** name of the layout section in gui.ini #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)), in case the section is not found in gui.ini or it is does not contain a valid configuration, then UI\_ERR\_REGION is returned. {% hint style="info" %} *display* is optional, see [Parameter Overloading](#gui_overloading) changing the layout may cancel all currently active dialogs {% endhint %} ### uiLayout()\[7/10] int vfigui::uiLayout inline define output regions on the display. Region with id==0 is the default region. **Parameters** \[in] **display** display \[in] **reg** vector containing the regions, at least one region must be provided #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) {% hint style="info" %} *display* is optional, see [Parameter Overloading](#gui_overloading) If a region is removed that still contains a dialog this dialog is cancelled. {% endhint %} ### uiLayout()\[8/10] int vfigui::uiLayout inline define output regions on the display. Region with id==0 is the default region. The old layout provided in *oldreg* must match the current layout in guiserver or the layout will not be updated and UI\_ERR\_MODIFIED will be returned. **Parameters** \[in] **display** display \[in] **reg** vector containing the regions, at least one region must be provided \[in] **oldreg** vector containing the previous set of regions. #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) {% hint style="info" %} *display* is optional, see [Parameter Overloading](#gui_overloading) If a region is removed that still contains a dialog this dialog is cancelled. {% endhint %} ### uiLayout()\[9/10] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiLayout shortcut for uiLayout(display, region,regcnt,0,0); ### uiLayout()\[10/10] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiLayout define output regions on the display. Region with id==0 is the default region. For incremental layout updates the previous layout may be provided to be checked before applying the new layout. If the previous layout does not match the current layout in guiserver, UI\_ERR\_MODIFIED is returned. This feature can be used to detect and prevent race conditions if several processes concurrently try to update a layout. **Parameters** \[in] **display** display \[in] **region** array containing the regions, at least one region must be provided \[in] **regcnt** number of entries in region \[in] **oldreg** optional: if not NULL array containing the previous set of regions \[in] **oldregcnt** optional: number of entries in oldreg #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) {% hint style="info" %} *display* is optional, see [Parameter Overloading](#gui_overloading) If a region is removed that still contains a dialog this dialog is cancelled. {% endhint %} #### Examples [demo-sysinfo.cpp](/adk-5.0-programmers-guide/readme/examples/demo-sysinfo_8cpp-example.md#a6). ### uiLeaveRegion()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiLeaveRegion shortcut for uiLeaveRegion(0); ### uiLeaveRegion()\[2/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiLeaveRegion Ascend one level in the tree of regions. #### Returns error code: UI\_ERR\_OK if region was left, UI\_ERR\_REGION if already at the highest level {% hint style="info" %} *display* is optional, see [Parameter Overloading](#gui_overloading) {% endhint %} ### uiLibVersion() const [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) char\\\* vfigui::uiLibVersion read library version #### Returns string containing the version ### uiMenu()\[1/3] int vfigui::uiMenu inline ### uiMenu()\[2/3] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiMenu Display an HTML menu dialog on screen using a template file. **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in] **templateName** name of a template file. The HTML code found in text is inserted into the template \[in] **text** string containing an HTML fragment (i.e. the part between \ and lt;/body>). \[in] **menu** array containing menu entries \[in] **menusize** number of entries in the array \[in] **preselect** value of the menu entry to be preselected. \[in] **cb** optional callback function \[in] **cbdata** data pointer passed on to the callback function #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) or value of selected menu entry. {% hint style="info" %} *display* and *region\_id* are optional, see [Parameter Overloading](#gui_overloading) {% endhint %} #### Examples [demo-sysinfo.cpp](/adk-5.0-programmers-guide/readme/examples/demo-sysinfo_8cpp-example.md#a11), [mac\_demo1.cpp](/adk-5.0-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a19), [mac\_demo2.cpp](/adk-5.0-programmers-guide/readme/examples/mac_demo2_8cpp-example.md#a10), and [pm-demo.cpp](/adk-5.0-programmers-guide/readme/examples/pm-demo_8cpp-example.md#a16). ### uiMenu()\[3/3] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiMenu ### uiMenuAsync()\[1/3] int vfigui::uiMenuAsync inline ### uiMenuAsync()\[2/3] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiMenuAsync Asynchronously display an HTML menu dialog on screen using a template file. **Parameters** \[in] **display** display \[in] **region\_id** region ID \[in] **templateName** name of a template file. The HTML code found in text is inserted into the template \[in] **text** string containing an HTML fragment (i.e. the part between \ and \). \[in] **menu** array containing menu entries \[in] **menusize** number of entries in the array \[in] **preselect** value of the menu entry to be preselected. \[in] **cb** optional callback function that is called when the dialog has returned \[in] **data** data pointer that is passed on to the callback function #### Returns transaction ID or error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) {% hint style="info" %} *display* and *region\_id* are optional, see [Parameter Overloading](#gui_overloading) use [uiMenuWait()](#a7bcce0289e8d528e362c8da5657ffafb) to wait for the dialog to finish or use [uiInvokeCancel()](#a151d71877a0f6426b3e2bbee47f88f0e) to cancel the dialog {% endhint %} ### uiMenuAsync()\[3/3] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiMenuAsync ### uiMenuWait() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiMenuWait Wait for the menu dialog to finish **Parameters** \[in] **txn\_id** transaction id as returned by uiMenuAsync() \[in] **timeout\_msec** timeout in milliseconds. In case of a negative timeout wait forever. #### Returns error code (see [UIError](/adk-5.0-programmers-guide/readme/modules/group__vfigui.md#ga83f7c4e297519549c9a54137e2eab4fe)) or value of selected menu entry. In case of a timeout UI\_ERR\_WAIT\_TIMEOUT is returned and [uiMenuWait()](#a7bcce0289e8d528e362c8da5657ffafb) may be called again. ### uiNagScreen() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiNagScreen trigger display of a nag screen. The nag screen is hidden and shown in a loop hide and show times can be configured. Once triggered, the nag screen cannot be disabled for security reasons until next reboot. Currently only useful on VOS3 **Parameters** \[in] **display** display \[in] **type** nag screen type \[in] **hide** hide time in seconds \[in] **show** show time in seconds #### Returns error code; ### uiPrint() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string vfigui::uiPrint perform printf-like formatting. **Parameters** \[in] **format** printf-like format string. It supports the commonly known format specifiers 's', 'i', 'd', 'u', 'o', 'x', 'X', 'p', 'c', 'f', 'e', 'g'. In addition the following format specifiers are supported:'S': format as string and substitute the special HTML characters '&', '<', '>', '"' and '\\'' by character references (e.g. '&', '<' ...).'C': format as character and sustitute HTML characters #### Returns formatted string #### Examples [demo-sysinfo.cpp](/adk-5.0-programmers-guide/readme/examples/demo-sysinfo_8cpp-example.md#a18), [mac\_demo1.cpp](/adk-5.0-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a23), [mac\_demo2.cpp](/adk-5.0-programmers-guide/readme/examples/mac_demo2_8cpp-example.md#a15), and [pm-demo.cpp](/adk-5.0-programmers-guide/readme/examples/pm-demo_8cpp-example.md#a24). ### uiPrintV() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string vfigui::uiPrintV perfom printf-like formatting. This is the same as [uiPrint()](#af8b1a2c34408a1c5b1267c0a43e4f4ee) just taking a va\_list instead of a variable number of arguments ### uiReadConfig()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void vfigui::uiReadConfig shortcut for uiReadConfig(0); ### uiReadConfig()\[2/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void vfigui::uiReadConfig re-read configuration from file gui.ini from within the resource directory associated with a display **Parameters** \[in] **display** display {% hint style="info" %} *display* is optional, see [Parameter Overloading](#gui_overloading) gui.ini is read automatically on startup. Invoking [uiReadConfig()](#ae1d86be38dabed0b93f804b91805a3d3) is required if gui.ini has been modified by the application or the resource path has been changed by updating UI\_PROP\_RESOURCE\_PATH and re-reading of the file is required. {% endhint %} ### uiReadRuntimeID() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiReadRuntimeID read runtime ID: This is a random string, that remains the same during the runtime of the server and changes, if the server has been restarted **Parameters** \[in] **display** display \[out] **id** runtime ID string \[in] **timeout\_msec** timeout in milliseconds. In case of a negative timeout wait forever. #### Returns error code ### uiRegionIsVisible()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiRegionIsVisible check if region is visible on screen or hidden **Parameters** \[in] **display** display \[in] **region\_id** region ID #### Returns 1 if visible, 0 if not visible, <0 if error ### uiRegionIsVisible()\[2/2] int vfigui::uiRegionIsVisible inline check if region is visible on screen or hidden **Parameters** \[in] **region\_id** region ID #### Returns 1 if visible, 0 if not visible, <0 if error ### uiRemoveOption()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiRemoveOption Remove an option from a \ element \[in] **value** value of the element to be removed #### Returns error code ### uiRemoveOption()\[2/2] int vfigui::uiRemoveOption inline shortcut for uiRemoveOption(0,region\_id,name,value); ### uiRunAction()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfigui::uiRunAction Run the action of an input element on screen. This covers \, \, \ element to the top or bottom position **Parameters** \[in] **display** display \[in] **region\_id** region id \[in] **name** name of the \ and \