diff options
| author | Staysail Systems, Inc <info@staysail.tech> | 2024-03-01 07:04:14 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-03-01 07:07:37 -0800 |
| commit | e4e646a6a9982ff932d83633157106a0b34975a2 (patch) | |
| tree | 9ee71c33531a9592ba0c66ad97ceb10c42168519 /man/v1.7.3/nng_stat_string.3.html | |
| parent | 66e28ffa9fe663908539550bf104716c5b4dc213 (diff) | |
| download | nng-e4e646a6a9982ff932d83633157106a0b34975a2.tar.gz nng-e4e646a6a9982ff932d83633157106a0b34975a2.tar.bz2 nng-e4e646a6a9982ff932d83633157106a0b34975a2.zip | |
Manual page updates for v1.7.3
Diffstat (limited to 'man/v1.7.3/nng_stat_string.3.html')
| -rw-r--r-- | man/v1.7.3/nng_stat_string.3.html | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/man/v1.7.3/nng_stat_string.3.html b/man/v1.7.3/nng_stat_string.3.html new file mode 100644 index 00000000..410ceadf --- /dev/null +++ b/man/v1.7.3/nng_stat_string.3.html @@ -0,0 +1,83 @@ +--- +version: v1.7.3 +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"><nng/nng.h></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> |