summaryrefslogtreecommitdiff
path: root/docs/reference/src/aio/nng_aio_get_output.md
blob: a7a82f56af774552cc9835ad737dcc94382740c1 (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
# nng_aio_get_output

## NAME

nng_aio_get_output --- return output result

## SYNOPSIS

```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`.

> [!IMPORTANT]
> 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 output from the operation, or `NULL`.

## SEE ALSO

[nng_aio_alloc][nng_aio_alloc],
[nng_aio_set_output](../aio_provider/nng_aio_set_output.md),
[nng_aio_result][nng_aio_result]

{{#include ../refs.md}}