aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_aio_get_input.adoc
blob: 96c9c1aef909b8531eccfddc625c84589cddb227 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
= nng_aio_get_input(3)
:doctype: manpage
:manmanual: nng
:mansource: nng
:manvolnum: 3
:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \
            Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \
            {blank} + \
            This document is supplied under the terms of the \
            https://opensource.org/licenses/MIT[MIT License].

== NAME

nng_aio_set_input - return input parameter

== SYNOPSIS

[source, c]
-----------
#include <nng/nng.h>

void *nng_aio_get_input(nng_aio *aio, unsigned int index);
-----------

== DESCRIPTION

The `nng_aio_get_input()` function returns the value of the input parameter
previously set at _index_ on _aio_ with the
<<nng_aio_set_input#,nng_aio_set_input(3)>> function.

The valid values of _index_ range from zero (0) to three (3), as no operation
currently defined can accept more than four parameters.  (This limit could
increase in the future.)  If the index supplied is outside of this range,
or of the input parameter was not previously set, then `NULL` is returned.

== RETURN VALUES

Value previously set, or `NULL`.

== ERRORS

None.

== SEE ALSO

<<nng_aio_alloc#,nng_aio_alloc(3)>>,
<<nng_aio_get_output#,nng_aio_get_output(3)>>,
<<nng_aio_set_input#,nng_aio_set_input(3)>>,
<<nng_aio_result#,nng_aio_result(3)>>,
<<nng#,nng(7)>>

== COPYRIGHT

{copyright}