aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_aio_get_output.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nng_aio_get_output.adoc')
-rw-r--r--docs/nng_aio_get_output.adoc58
1 files changed, 58 insertions, 0 deletions
diff --git a/docs/nng_aio_get_output.adoc b/docs/nng_aio_get_output.adoc
new file mode 100644
index 00000000..4073e7a2
--- /dev/null
+++ b/docs/nng_aio_get_output.adoc
@@ -0,0 +1,58 @@
+= nng_aio_get_output(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_get_output - return output result
+
+== SYNOPSIS
+
+[source, c]
+-----------
+#include <nng/nng.h>
+
+void *nng_aio_get_output(nng_aio *aio, unsigned int index);
+-----------
+
+== DESCRIPTION
+
+The `nng_aio_get_output()` function returns the output result at _index_
+resulting from the asynchronous operation associated with _aio_.
+
+The type and semantics of output parameters are determined by specific
+operations.
+
+NOTE: If the _index_ does not correspond to a defined output for the operation,
+or the operation did not succeed, then the return value will be `NULL`.
+
+CAUTION: It is an error to call this function while the _aio_ is currently
+in use by an active asynchronous operation, or if no operation has been
+performed using the _aio_ yet.
+
+== RETURN VALUES
+
+The __index__th result of the operation, 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}