1= nng_aio_get_input(3)
2//
3// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
4// Copyright 2018 Capitar IT Group BV <info@capitar.com>
5//
6// This document is supplied under the terms of the MIT License, a
7// copy of which should be located in the distribution where this
8// file was obtained (LICENSE.txt).  A copy of the license may also be
9// found online at https://opensource.org/licenses/MIT.
10//
11
12== NAME
13
14nng_aio_get_input - return input parameter
15
16== SYNOPSIS
17
18[source, c]
19----
20#include <nng/nng.h>
21
22void *nng_aio_get_input(nng_aio *aio, unsigned int index);
23----
24
25== DESCRIPTION
26
27The `nng_aio_get_input()` function returns the value of the input parameter
28previously set at _index_ on _aio_ with the
29xref:nng_aio_set_input.3.adoc[`nng_aio_set_input()`] function.
30
31The valid values of _index_ range from zero (0) to three (3), as no operation
32currently defined can accept more than four parameters.
33(This limit could increase in the future.)
34If the index supplied is outside of this range,
35or of the input parameter was not previously set, then `NULL` is returned.
36
37== RETURN VALUES
38
39Value previously set, or `NULL`.
40
41== ERRORS
42
43None.
44
45== SEE ALSO
46
47[.text-left]
48xref:nng_aio_alloc.3.adoc[nng_aio_alloc(3)],
49xref:nng_aio_get_output.3.adoc[nng_aio_get_output(3)],
50xref:nng_aio_set_input.3.adoc[nng_aio_set_input(3)],
51xref:nng_aio_result.3.adoc[nng_aio_result(3)],
52xref:nng_aio.5.adoc[nng_aio(5)],
53xref:nng.7.adoc[nng(7)]
54