diff options
| author | Garrett D'Amore <garrett@damore.org> | 2025-10-10 07:59:34 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2025-10-10 21:53:00 -0700 |
| commit | b98e03b26bfc593326bd7c1d56fd69626f6a93cb (patch) | |
| tree | 0e8d9d395e3b9e4f2a92dd5f984dfca984f339da /docs/man/nng_aio_get_input.3.adoc | |
| parent | b86377903b9ea64bf728a4538eea4d0c8c78653e (diff) | |
| download | nng-b98e03b26bfc593326bd7c1d56fd69626f6a93cb.tar.gz nng-b98e03b26bfc593326bd7c1d56fd69626f6a93cb.tar.bz2 nng-b98e03b26bfc593326bd7c1d56fd69626f6a93cb.zip | |
fixes #2183 docs: convert AIO provider docs
Diffstat (limited to 'docs/man/nng_aio_get_input.3.adoc')
| -rw-r--r-- | docs/man/nng_aio_get_input.3.adoc | 52 |
1 files changed, 0 insertions, 52 deletions
diff --git a/docs/man/nng_aio_get_input.3.adoc b/docs/man/nng_aio_get_input.3.adoc deleted file mode 100644 index ef331312..00000000 --- a/docs/man/nng_aio_get_input.3.adoc +++ /dev/null @@ -1,52 +0,0 @@ -= nng_aio_get_input(3) -// -// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> -// Copyright 2018 Capitar IT Group BV <info@capitar.com> -// -// This document is supplied under the terms of the MIT License, a -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. -// - -== NAME - -nng_aio_get_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 -xref:nng_aio_set_input.3.adoc[`nng_aio_set_input()`] 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 - -[.text-left] -xref:nng_aio_get_output.3.adoc[nng_aio_get_output(3)], -xref:nng_aio_set_input.3.adoc[nng_aio_set_input(3)], -xref:nng_aio_result.3.adoc[nng_aio_result(3)], -xref:nng_aio.5.adoc[nng_aio(5)], -xref:nng.7.adoc[nng(7)] |
