> 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/s-adk-5.1-programmers-guide/readme/modules/group__vfigui.md).
# Graphical User Interface
[Namespaces](#namespaces) | [Macros](#define-members) | [Enumerations](#enum-members)
| | |
| ---------- | -------------------------------------------------------------------------------------- |
| Namespaces | |
| | [vfigui](/s-adk-5.1-programmers-guide/readme/modules/group__vfigui/namespacevfigui.md) |
| | |
| ------- | ---------------------------------------------- |
| Macros | |
| #define | [DllSpec](#gad7c2e1cb200073ed64c64285a5f37231) |
| #define | [DllSpec](#gad7c2e1cb200073ed64c64285a5f37231) |
| | |
| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Enumerations | |
| enum | UIError {
UI\_ERR\_OK = 0, UI\_ERR\_ABORT = -1, UI\_ERR\_BACK = -2, UI\_ERR\_TIMEOUT = -3,
UI\_ERR\_PROPERTY = -4, UI\_ERR\_WRONG\_PIN = -5, UI\_ERR\_PARAMETER = -6, UI\_ERR\_PERMISSION = -7,
UI\_ERR\_CANCELLED = -8, UI\_ERR\_REGION = -9, UI\_ERR\_FAIL = -10, UI\_ERR\_UNSUPPORTED = -11,
UI\_ERR\_INVALID = -12, UI\_ERR\_WAIT\_TIMEOUT = -13, UI\_ERR\_CONNECTION\_LOST = -14, UI\_ERR\_PROTOCOL = -15,
UI\_ERR\_SCRIPT = -16, UI\_ERR\_FILE\_READ = -17, UI\_ERR\_RESTRICTED = -18, UI\_ERR\_MODIFIED = -19,
UI\_ERR\_ACTION = -20, UI\_ERR\_DISPLAY = -21, UI\_ERR\_PIN\_ENTRY\_DENIED = -22
}
|
### DetailedDescription
### MacroDefinition Documentation
### DllSpec\[1/2]
\#define DllSpec
### DllSpec\[2/2]
\#define DllSpec
### EnumerationType Documentation
### UIError
enum \[UIError]\(#ga83f7c4e297519549c9a54137e2eab4fe)
Verifone GUI namespace error codes returned by the functions
| | |
| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Enumerator | |
| UI\_ERR\_OK | no error |
| UI\_ERR\_ABORT | abort by user |
| UI\_ERR\_BACK | user selected back button |
| UI\_ERR\_TIMEOUT | dialog timeout |
| UI\_ERR\_PROPERTY | the property does not exist |
| UI\_ERR\_WRONG\_PIN | wrong PIN was entered |
| UI\_ERR\_PARAMETER | parameter error |
| UI\_ERR\_PERMISSION | insufficient permissions |
| UI\_ERR\_CANCELLED | the dialog has been cancelled by callback or by displaying another dialog |
| UI\_ERR\_REGION | the region is not known |
| UI\_ERR\_FAIL | generic error |
| UI\_ERR\_UNSUPPORTED | the function requested is not supported on the current platform/device/... |
| UI\_ERR\_INVALID | an invalid transaction ID was provided |
| UI\_ERR\_WAIT\_TIMEOUT | timeout while waiting for the result of an async function |
| UI\_ERR\_CONNECTION\_LOST | cannot connect or lost connection to server |
| UI\_ERR\_PROTOCOL | data received violated the protocol |
| UI\_ERR\_SCRIPT | error occurred during script processing, check [uiScriptError()](/s-adk-5.1-programmers-guide/readme/modules/group__vfigui/namespacevfigui.md#a6f12172a8274bd06e3f1bca6a9c4d9de) for more information about the error |
| UI\_ERR\_FILE\_READ | the file was not found or could not be read |
| UI\_ERR\_RESTRICTED | the dialog was not shown due to security restrictions, e.g. using more than 3 buttons |
| UI\_ERR\_MODIFIED | the old layout does not match |
| UI\_ERR\_ACTION | invalid action provided |
| UI\_ERR\_DISPLAY | invalid display |
| UI\_ERR\_PIN\_ENTRY\_DENIED | requesting too many PIN sessions in a short period of time. |
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://sandbox-docs.verifone.com/s-adk-5.1-programmers-guide/readme/modules/group__vfigui.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.