diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
| commit | 87795b46f2bc732bd11067805709161bdc00d6b6 (patch) | |
| tree | 892f3bcea1a14df5dde8dba413d394f5ccb0a0e0 /docs/nng_aio_get_input.adoc | |
| parent | 545942f7ace7cde8a1b8a6a5289cecc185b08fbc (diff) | |
| download | nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.gz nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.bz2 nng-87795b46f2bc732bd11067805709161bdc00d6b6.zip | |
More man page reorganization.
Man pages need special handling, and we can have other kinds of documentation
like initial starting guides, etc., which would have different processing
applied. So lets move them off into their own directory.
Diffstat (limited to 'docs/nng_aio_get_input.adoc')
| -rw-r--r-- | docs/nng_aio_get_input.adoc | 50 |
1 files changed, 0 insertions, 50 deletions
diff --git a/docs/nng_aio_get_input.adoc b/docs/nng_aio_get_input.adoc deleted file mode 100644 index 73b0acd2..00000000 --- a/docs/nng_aio_get_input.adoc +++ /dev/null @@ -1,50 +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_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)>> |
