> 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/files/dir_9225c15707e5fd27b700c844799f6dc5/dir_7447c8e6446ba60664134d106c4ecb69/dir_8c13e55433a2f6247a8b0f337ff26c19/input__plugin_8h.md).

# input\_plugin.h

[Macros](#define-members) | [Functions](#func-members)

[Go to the source code of this file.](/s-adk-5.1-programmers-guide/input__plugin_8h_source.md)

|         |                                               |
| ------- | --------------------------------------------- |
| Macros  |                                               |
| #define | [DllSpec](#ad7c2e1cb200073ed64c64285a5f37231) |

|                                                                                                                                                                                                                           |                                                                                                |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| Functions                                                                                                                                                                                                                 |                                                                                                |
| [DllSpec](/s-adk-5.1-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void \* | [input\_start](#a8036e2b4b69426df4c7ed0ef02618671) (const char \*parameter, char \*\*log\_msg) |
| [DllSpec](/s-adk-5.1-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) char \* | [input\_poll](#a7cce0f5ade7700f0ab3ed38bd911e36d) (void \*handle)                              |
| [DllSpec](/s-adk-5.1-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void    | [input\_end](#a9fb84f242dcf5f00bfde9e01f7da1849) (void \*handle)                               |

### DetailedDescription <a href="#detailed-description" id="detailed-description"></a>

Interface for input plugin modules

### MacroDefinition Documentation <a href="#macro-definition-documentation" id="macro-definition-documentation"></a>

### DllSpec <a href="#ad7c2e1cb200073ed64c64285a5f37231" id="ad7c2e1cb200073ed64c64285a5f37231"></a>

\#define DllSpec

### FunctionDocumentation <a href="#function-documentation" id="function-documentation"></a>

### input\_end() <a href="#a9fb84f242dcf5f00bfde9e01f7da1849" id="a9fb84f242dcf5f00bfde9e01f7da1849"></a>

[DllSpec](/s-adk-5.1-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void input\_end

stop input and release all internal resources

**Parameters**

\[in] **handle** handle as returned by input\_start(). After input\_end() returns the handle is no longer valid.

### input\_poll() <a href="#a7cce0f5ade7700f0ab3ed38bd911e36d" id="a7cce0f5ade7700f0ab3ed38bd911e36d"></a>

[DllSpec](/s-adk-5.1-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) char\\\* input\_poll

poll for input. If input is ready it is returned as string.

**Parameters**

\[in] **handle** handle as returned by input\_start()

#### Returns

Input string or NULL if there is no input. The returned input string will be released using free().

{% hint style="info" %}
The format of the returned string is plugin-specific.
{% endhint %}

### input\_start() <a href="#a8036e2b4b69426df4c7ed0ef02618671" id="a8036e2b4b69426df4c7ed0ef02618671"></a>

[DllSpec](/s-adk-5.1-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void\\\* input\_start

start the input

**Parameters**

\[in] **parameter** string containing the parameters for the input plugin \[out] **log\_msg** pointer to log message. If not NULL ADKGUI will log the message at error level and release the returned string using free().

#### Returns

handle handle that will be passed to input\_poll and input\_end or NULL in case of error


---

# 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/files/dir_9225c15707e5fd27b700c844799f6dc5/dir_7447c8e6446ba60664134d106c4ecb69/dir_8c13e55433a2f6247a8b0f337ff26c19/input__plugin_8h.md?ask=<question>&goal=<endgoal>
```

`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.