summaryrefslogtreecommitdiff
path: root/docs/ref/stat/nng_stat_bool.adoc
blob: 9517464fcb10fb5484c33ec0a6c9498f0926b4d0 (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
## nng_stat_bool

Get statistic Boolean value.

### Synopsis

```c
#include <nng/nng.h>

typedef struct nng_stat nng_stat;

bool nng_stat_bool(nng_stat *stat);
```

### Description

The `nng_stat_bool` function returns the Boolean value for the statistic _stat_.
Otherwise, if the statistic is not of Boolean type, the result is indeterminate.
See xref:nng_stat_type.adoc[`nng_stat_type`] for a description of statistic types.

### Return Values

The boolean value associated with _stat_.

### See Also

xref:nng_stats_get.adoc[nng_stats_get],
xref:nng_stat_type.adoc[nng_stat_type],
xref:nng_stat_unit.adoc[nng_stat_unit],
xref:nng_stat_value.adoc[nng_stat_value]