summaryrefslogtreecommitdiff
path: root/docs/ref/stat/nng_stat_desc.adoc
blob: b1079412103f045253b77afd0d4aeb37a0244e88 (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_desc

Get statistic description.

### Synopsis

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

typedef struct nng_stat nng_stat;

const char *nng_stat_desc(nng_stat *stat);
```

### Description

The `nng_stat_desc` function returns a brief, human-readable description for the statistic _stat_.

TIP: This description can be used for a tool-tip in user interfaces displaying these statistic values.

NOTE: At this time, only English descriptions are provided.

### Return Values

The description of statistic _stat_.

### See Also

xref:nng_stat_name.adoc[nng_stats_name],
xref:nng_stats_get.adoc[nng_stats_get]