man/tip/nng_stat_string.3.html


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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

---
version: tip
layout: manpage_v2
title: nng_stat_string(3)
---
<h1>nng_stat_string(3)</h1>
<div class="sect1">
<h2 id="_name">NAME</h2>
<div class="sectionbody">
<div class="paragraph">
<p>nng_stat_string - get statistic string value</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="c"><span></span><span class="tok-cp">#include</span><span class="tok-w"> </span><span class="tok-cpf">&lt;nng/nng.h&gt;</span>

<span class="tok-k">typedef</span><span class="tok-w"> </span><span class="tok-k">struct</span><span class="tok-w"> </span><span class="tok-nc">nng_stat</span><span class="tok-w"> </span><span class="tok-n">nng_stat</span><span class="tok-p">;</span>

<span class="tok-k">const</span><span class="tok-w"> </span><span class="tok-kt">char</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-nf">nng_stat_string</span><span class="tok-p">(</span><span class="tok-n">nng_stat</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-n">stat</span><span class="tok-p">);</span></code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The <code>nng_stat_string()</code> function returns a string value for the statistic <em>stat</em>,
which must be of type <code>NNG_STAT_STRING</code> (see <a href="nng_stat_type.3.html"><code>nng_stat_type(3)</code></a>).</p>
</div>
<div class="paragraph">
<p>If the statistic is not of type <code>NNG_STAT_STRING</code>, then <code>NULL</code> will be returned.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
The returned string is valid until <a href="nng_stats_free.3.html"><code>nng_stats_free()</code></a> is called to
free the memory for the snapshot.
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_return_values">RETURN VALUES</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The string value associated with <em>stat</em>, or <code>NULL</code> if the statistic is not
a string type.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_errors">ERRORS</h2>
<div class="sectionbody">
<div class="paragraph">
<p>None.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_see_also">SEE ALSO</h2>
<div class="sectionbody">
<div class="paragraph text-left">
<p><a href="libnng.3.html">libnng(3)</a>,
<a href="nng_stats_get.3.html">nng_stats_get(3)</a>,
<a href="nng_stat_type.3.html">nng_stats_type(3)</a>,
<a href="nng_stat_value.3.html">nng_stats_value(3)</a>,
<a href="nng_stat.5.html">nng_stat(5)</a>,
<a href="nng.7.html">nng(7)</a></p>
</div>
</div>
</div>