> 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__sdidisplay.md).
# Display interface
[Enumerations](#enum-members) | [Functions](#func-members)
| | |
| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Enumerations | |
| enum | [IdleScreenMode](#gacdffce6b62c4db2a50dd9cdae6caba78) { [IDLE\_HOTKEY\_ADMIN](#ggacdffce6b62c4db2a50dd9cdae6caba78a4f3405ef030cb85be40c62851dedd293) =0, [IDLE\_NO\_ADMIN](#ggacdffce6b62c4db2a50dd9cdae6caba78a43e3b94725d1c312edc4bb14576ab9ee) =1, [IDEL\_SHOW\_ADMIN](#ggacdffce6b62c4db2a50dd9cdae6caba78a27549d2e45dc641b812b29bf0c3ac692) =2 } |
| | |
| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Functions | |
| int | [displayText](#ga440d80337e047a445a11d9c4a2e41de7) (int template\_id, const std::string \&data\_name, const std::string \&data\_value, int timeout=0, bool confirm=false, bool beep=false, int dest=1) |
| int | [displayText](#ga3947b5121e12c60255720f0e4b65ade0) (int template\_id, unsigned dialog\_opt, 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::map< std::string, std::string > \&key\_actions, const char \*header\_text=0, const char \*enter\_text=0, const char \*clear\_text=0, const char \*cancel\_text=0, int timeout=0, int dest=1) |
| int | [displayText](#gacfe3552d7e940337249c23e10250e3f2) (const std::string \&data\_value, int timeout=0, bool confirm=false, bool beep=false, int dest=1) |
| int | [displayInput](#ga1318cae26cf697940b77f5ae3cd7b836) (std::string \&out, [InputType](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a5fc772c800c3d40d2b95564e8a839bab) type, [Language](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a315ca917ad583797f709ea477dd28705) language=[LANGUAGE\_NO\_LANGUAGE](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a315ca917ad583797f709ea477dd28705aabdfcddde54087079139e916b59fe058), char maskchar=0, const std::string \&altformat="", int timeout=0, bool beep=false, int dest=1) |
| int | [displayInputTipWithAmount](#ga80ccc4543482b08097ff08df6b985758) (std::string \&out, [Language](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a315ca917ad583797f709ea477dd28705) language, const [BCD](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvfisdi_1_1_b_c_d.md)< 6 > \&amount, [Currency](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a59f74bf9ae55ffd390b8806b2559021c) currency, char maskchar=0, const std::string \&altformat="", int timeout=0, bool beep=false, int dest=1) |
| int | [displayMenu](#ga2414de266c381974616ae16049a98f2b) (const std::string \&prompt, const std::vector< std::string > \&entries, int timeout=0, bool beep=false, int dest=1) |
| int | [displayMenu](#gacc10db22aa6042f969f329dbf0cad703) (unsigned dialog\_opt, const std::string \&prompt, const std::vector< std::string > \&entries, int preselect, const std::map< std::string, std::string > \&key\_actions, const char \*header\_text=0, const char \*enter\_text=0, const char \*cancel\_text=0, const char \*up\_text=0, const char \*down\_text=0, int timeout=0, int dest=1) |
| int | [displayCardRequest](#gaef4175d6f3f65d71489a32680a8fd61f) (unsigned char tec, unsigned char mode, const [BCD](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvfisdi_1_1_b_c_d.md)< 6 > amount, int currency, int dest=1) |
| int | [displayCardRequest](#ga56f054652c2dcbe92fb6f52c819fd14f) (unsigned char tec, unsigned char mode, int dest=1) |
| int | [displayCardRequest](#gaea500b47f5c11b0fdb725dc88e409499) (unsigned char tec, unsigned char mode, const [BCD](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvfisdi_1_1_b_c_d.md)< 6 > amount, int currency, enum [EMVTransaction](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a36a1ebacbf82d10a5db76377f8e225fd) txn, int dest=1) |
| int | [displayCardRequest](#ga40b78a6727d9738c638b32e304aeee20) (unsigned char tec, unsigned char mode, enum [EMVTransaction](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a36a1ebacbf82d10a5db76377f8e225fd) txn, int dest=1) |
| int | [displayIdleScreen](#ga3465958027d8b0b80dd2eef84345d39d) (int dest=1) |
| int | [displayIdleScreenMode](#ga3c96a2b500a3a1a03298d44242c188c7) (enum [IdleScreenMode](#gacdffce6b62c4db2a50dd9cdae6caba78) mode, int dest=1) |
| int | [displaySignatureCapture](#gaf658018de94876a5d65e50f090fa5a63) (std::string \&outformat, [bytevector](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/classvfisdi_1_1_s_d_i_client.md#a64b5be62be31dcda165d2c6c3c262fb5) \&outdata, [Language](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a315ca917ad583797f709ea477dd28705) lang, unsigned short timeout=0, int dest=1) |
| int | [displayLEDs](#ga81bcd0770b43444e43fd6ab3c9489827) (bool on) |
| int | [displayDialog](#ga0940e7bff1e3ca3f71e752e11e68e892) (const std::string \&filename, 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), [Language](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a315ca917ad583797f709ea477dd28705) lang=[LANGUAGE\_NO\_LANGUAGE](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a315ca917ad583797f709ea477dd28705aabdfcddde54087079139e916b59fe058), bool beep=false, int dest=1) |
| int | [displayDialog](#ga16d8bea3e5a11f7164e3ce225ece9500) (unsigned dialog\_opt, const std::string \&filename, 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), [Language](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a315ca917ad583797f709ea477dd28705) lang=[LANGUAGE\_NO\_LANGUAGE](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a315ca917ad583797f709ea477dd28705aabdfcddde54087079139e916b59fe058), int dest=1) |
| int | [displayGetAsyncResult](#gaaa69909a79a4a18a0cdacaa103a1ad77) (enum [DialogAsyncStatus](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a948de32bb8a31f38655af1ad0f5a969c) \&status, int dest=1) |
### DetailedDescription
### EnumerationType Documentation
### IdleScreenMode
enum \[IdleScreenMode]\(#gacdffce6b62c4db2a50dd9cdae6caba78)
idle screen mode (if enabled in config.json), (DFA155)
| | |
| ------------------- | ------------------------------------------------- |
| Enumerator | |
| IDLE\_HOTKEY\_ADMIN | Admin menu can be activated using 2-5-8 (default) |
| IDLE\_NO\_ADMIN | Admin menu is disabled |
| IDEL\_SHOW\_ADMIN | Admin menu is enabled |
### FunctionDocumentation
### displayCardRequest()\[1/4]
int displayCardRequest
Show card request display according the given parameter. It can be used directly before the Card Detection command (23-01) to show the corresponding display including the contactless logo if required. Only physical card technologies are supported. For manual card data entry only this command is not to be used because the user dialog is handled automatically inside the Card Detection command. (24-06)
**Parameters**
\[in] **tec** bit mask of supported card technology (DFA108):1: CT smart card2: magnetic stripe4: CTLS smart card8: manual card entry \[in] **mode** mode: 0 = default, 1 = fallback, 2 = retry \[in] **amount** amount \[in] **currency** currency (Currency) \[in] **txn** EMV transaction type \[in] **dest** display destination: countertop=1, EPP=2
#### Returns
SDI error code ([Result](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a28287671eaf7406afd604bd055ba4066))
### displayCardRequest()\[2/4]
int displayCardRequest
Show card request display according the given parameter. It can be used directly before the Card Detection command (23-01) to show the corresponding display including the contactless logo if required. Only physical card technologies are supported. For manual card data entry only this command is not to be used because the user dialog is handled automatically inside the Card Detection command. (24-06)
**Parameters**
\[in] **tec** bit mask of supported card technology (DFA108):1: CT smart card2: magnetic stripe4: CTLS smart card8: manual card entry \[in] **mode** mode: 0 = default, 1 = fallback, 2 = retry \[in] **amount** amount \[in] **currency** currency (Currency) \[in] **dest** display destination: countertop=1, EPP=2
#### Returns
SDI error code ([Result](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a28287671eaf7406afd604bd055ba4066))
### displayCardRequest()\[3/4]
int displayCardRequest
inline
Show card request display without amount. (24-06)
**Parameters**
\[in] **tec** bit mask of supported card technology (DFA108):1: CT smart card2: magnetic stripe4: CTLS smart card8: manual card entry \[in] **mode** mode: 0 = default, 1 = fallback, 2 = retry \[in] **txn** EMV transaction type \[in] **dest** display destination: countertop=1, EPP=2
#### Returns
SDI error code ([Result](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a28287671eaf7406afd604bd055ba4066))
### displayCardRequest()\[4/4]
int displayCardRequest
inline
Show card request display without amount. (24-06)
**Parameters**
\[in] **tec** bit mask of supported card technology (DFA108):1: CT smart card2: magnetic stripe4: CTLS smart card8: manual card entry \[in] **mode** mode: 0 = default, 1 = fallback, 2 = retry \[in] **dest** display destination: countertop=1, EPP=2
#### Returns
SDI error code ([Result](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a28287671eaf7406afd604bd055ba4066))
### displayDialog()\[1/2]
int displayDialog
Display customer specific HTML dialog.The dialog has to be stored in a separate user signed HTML file. The appearance of the dialog can be controlled with a corresponding CSS file. (24-0A)
**Parameters**
\[in] **filename** HTML file name without path \[in,out] **value** key value map containing the values for display. It gets updated by the values that have been entered in the dialog. \[in] **lang** language \[in] **beep** beep when text will be displayed \[in] **dest** display destination: countertop=1, EPP=2
#### Returns
Dialog result (>=0) or SDI error code ([Result](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a28287671eaf7406afd604bd055ba4066))
{% hint style="info" %}
GUI error codes are mapped to SDI error codes!
{% endhint %}
### displayDialog()\[2/2]
int displayDialog
Display customer specific HTML dialog.The dialog has to be stored in a separate user signed HTML file. The appearance of the dialog can be controlled with a corresponding CSS file. (24-0A)
**Parameters**
\[in] **dialog\_opt** dialog options (DialogOptions) (DFA13D) \[in] **filename** HTML file name without path \[in,out] **value** key value map containing the values for display. It gets updated by the values that have been entered in the dialog. \[in] **lang** language \[in] **beep** beep when text will be displayed \[in] **dest** display destination: countertop=1, EPP=2
#### Returns
Dialog result (>=0) or SDI error code ([Result](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a28287671eaf7406afd604bd055ba4066))
{% hint style="info" %}
GUI error codes are mapped to SDI error codes!
{% endhint %}
### displayGetAsyncResult()
int displayGetAsyncResult
get the result of an input started with dialog option DLG\_ASYNC
**Parameters**
\[out] **status** async dialog status \[in] **dest** display destination: countertop=1, EPP=2
#### Returns
Dialog result (>=0) or SDI error code ([Result](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a28287671eaf7406afd604bd055ba4066))
### displayIdleScreen()
int displayIdleScreen
Display idle screen, check the SDI server documentation for more information on the idle screen (24-07)
**Parameters**
\[in] **dest** display destination: countertop=1, EPP=2
#### Returns
SDI error code ([Result](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a28287671eaf7406afd604bd055ba4066))
### displayIdleScreenMode()
int displayIdleScreenMode
Display idle screen with selecting admin mode, check the SDI server documentation for more information on the idle screen (24-07)
**Parameters**
\[in] **mode** idle screen mode \[in] **dest** display destination: countertop=1, EPP=2
#### Returns
SDI error code ([Result](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a28287671eaf7406afd604bd055ba4066))
### displayInput()
int displayInput
secure input (24-04)
**Parameters**
\[out] **out** entered value \[in] **type** InputType \[in] **language** language (e.g. LANGUAGE\_ENGLISH) \[in] **maskchar** masking character in the range 20..7E, 0 disables masking character \[in] **altformat** alternate format string, if not empty \[in] **timeout** timeout in seconds, 0 means no timeout \[in] **beep** beep when text will be displayed \[in] **dest** display destination: countertop=1, EPP=2
#### Returns
SDI error code ([Result](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a28287671eaf7406afd604bd055ba4066))
### displayInputTipWithAmount()
int displayInputTipWithAmount
secure tip input with display of the payment amount (24-04)
**Parameters**
\[out] **out** entered value \[in] **language** language (e.g. LANGUAGE\_ENGLISH) \[in] **amount** payment amount \[in] **currency** currency \[in] **maskchar** masking character in the range 20..7E, 0 disables masking character \[in] **altformat** alternate format string, if not empty \[in] **timeout** timeout in seconds, 0 means no timeout \[in] **beep** beep when text will be displayed \[in] **dest** display destination: countertop=1, EPP=2
#### Returns
SDI error code ([Result](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a28287671eaf7406afd604bd055ba4066))
### displayLEDs()
int displayLEDs
Activate / deactivate display of virtual CTLS LED area on the display. The command itself doesn't change the display at all. The display content will be updated with the next screen update. The payment application is responsible for the correct command order. (24-09)
**Parameters**
\[in] **on** true to activate, false to deactivate
#### Returns
SDI error code ([Result](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a28287671eaf7406afd604bd055ba4066))
### displayMenu()\[1/2]
int displayMenu
display menu (24-05)
**Parameters**
\[in] **prompt** menu prompt \[in] **dialog\_opt** dialog options (DialogOptions) (DFA13D) \[in] **entries** menu entries \[in] **timeout** timeout in seconds, 0 means no timeout \[in] **beep** beep when text will be displayed \[in] **dest** display destination: countertop=1, EPP=2
#### Returns
Selected menu entry (first menu entry has index 0) (>=0) or SDI error code (<0).
{% hint style="info" %}
GUI error codes are mapped to SDI error codes!
{% endhint %}
### displayMenu()\[2/2]
int displayMenu
display menu (24-05)
**Parameters**
\[in] **prompt** menu prompt (DFA00A) \[in] **dialog\_opt** dialog options (DialogOptions) (DFA13D) \[in] **entries** menu entries (DFA00B) \[in] **preselect** if >0 preselected menu entry, index of first entry is 1 (DFA00C) \[in] **key\_actions** (FFA106) \[in] **header\_text** optional header text. If provided flag DLG\_NO\_HEADER is ignored. (DFA143) \[in] **enter\_text** optional enter button text. (DFA13E) \[in] **cancel\_text** optional cancel button text. (DFA140) \[in] **up\_text** optional up button text. (DFA141) \[in] **down\_text** optional down button text. (DFA142) \[in] **timeout** timeout in seconds, 0 means no timeout \[in] **dest** display destination: countertop=1, EPP=2
#### Returns
Selected menu entry (first menu entry has index 1) / exit code (>=0) or SDI error code (<0).
{% hint style="info" %}
IMPORTANT: This function uses a different indexing of menu entries than the other (old) displayMenu function. The reason for this is that SDI uses indexes starting at 1 and mapping the menu index to be 0-based could collide with return values configured in key\_actions so that this mapping can no longer be provided.
{% endhint %}
{% hint style="info" %}
GUI error codes are mapped to SDI error codes!
{% endhint %}
### displaySignatureCapture()
int displaySignatureCapture
Show signature capture dialog (24-08)
**Parameters**
\[out] **outformat** signature format, e.g. "png" \[out] **outdata** signature data \[in] **lang** language (e.g. LANGUAGE\_ENGLISH) \[in] **timeout** timeout in seconds, 0 to deactivate timeout \[in] **dest** display destination: countertop=1, EPP=2
#### Returns
SDI error code ([Result](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a28287671eaf7406afd604bd055ba4066))
### displayText()\[1/3]
int displayText
inline
display text using display template\_id=1 and data\_name="text" (24-03)
**Parameters**
\[in] **data\_value** display data value (e.g UTF-8 coded text string) \[in] **timeout** timeout in seconds, 0 means no timeout \[in] **confirm** confirmation requested \[in] **beep** beep when text will be displayed \[in] **dest** display destination: countertop=1, EPP=2
#### Returns
SDI error code ([Result](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a28287671eaf7406afd604bd055ba4066))
### displayText()\[2/3]
int displayText
display text (24-03)
**Parameters**
\[in] **template\_id** display template identifier (DFA010) \[in] **data\_name** display data name (DFA012) \[in] **data\_value** display data value (e.g UTF-8 coded text string) (DFA013) \[in] **timeout** timeout in seconds, 0 means no timeout (DFA005) \[in] **confirm** confirmation requested (DFA006) \[in] **beep** beep when text will be displayed (DFA00D) \[in] **dest** display destination: countertop=1, EPP=2 (DFA150)
#### Returns
SDI error code ([Result](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a28287671eaf7406afd604bd055ba4066))
### displayText()\[3/3]
int displayText
display text (24-03)
**Parameters**
\[in] **template\_id** display template identifier (DFA010) \[in] **dialog\_opt** dialog options (DialogOptions) (DFA13D) \[in] **value** display data key value map (FFA011) \[in] **key\_actions** (FFA106) \[in] **header\_text** optional header text. If provided flag DLG\_NO\_HEADER is ignored. (DFA143) \[in] **enter\_text** optional enter button text. If provided flag DLG\_ENTER\_KEY is implicitly added. (DFA13E) \[in] **clear\_text** optional clear button text. If provided flag DLG\_CLEAR\_KEY is implicitly added. (DFA13F) \[in] **cancel\_text** optional cancel button text. If provided flag DLG\_CANCEL\_KEY is implicitly added. (DFA140) \[in] **timeout** timeout in seconds, 0 means no timeout (DFA005) \[in] **dest** display destination: countertop=1, EPP=2 (DFA150)
#### Returns
SDI error code ([Result](/adk-5.0-programmers-guide/readme/namespaces/namespacevfisdi.md#a28287671eaf7406afd604bd055ba4066))
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://sandbox-docs.verifone.com/adk-5.0-programmers-guide/readme/modules/group__sdidisplay.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.