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_set_output.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_set_output.adoc')
| -rw-r--r-- | docs/nng_aio_set_output.adoc | 58 |
1 files changed, 0 insertions, 58 deletions
diff --git a/docs/nng_aio_set_output.adoc b/docs/nng_aio_set_output.adoc deleted file mode 100644 index 4c3d4a21..00000000 --- a/docs/nng_aio_set_output.adoc +++ /dev/null @@ -1,58 +0,0 @@ -= nng_aio_set_output(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_output - set output result - -== SYNOPSIS - -[source, c] ------------ -#include <nng/nng.h> - -void nng_aio_set_output(nng_aio *aio, unsigned int index, void *result); ------------ - -== DESCRIPTION - -The `nng_aio_set_output()` function sets the output result at _index_ -to _result_ for the asynchronous operation associated with _aio_. - -The type and semantics of output results are determined by specific -operations; the operation must supply appropriate output results when -the operation completes successfully. - -The valid values of _index_ range from zero (0) to three (3), as no operation -currently defined can return more than four results. (This limit could -increase in the future.) - -NOTE: Note that attempts to set results with an _index_ greater than -three (3) will be ignored. - -An output result set with this function may be retrieved later with -the <<nng_aio_get_output#,nng_aio_get_output(3)>> function. - -== RETURN VALUES - -None. - -== ERRORS - -None. - -== SEE ALSO - -<<nng_aio_alloc#,nng_aio_alloc(3)>>, -<<nng_aio_finish#,nng_aio_finish(3)>>, -<<nng_aio_get_output#,nng_aio_get_output(3)>>, -<<nng_aio_result#,nng_aio_result(3)>>, -<<nng#,nng(7)>> |