blob: 5139c17d905aac52c9497d56128c7286dc9e7a3e (
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
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
84
85
86
87
88
89
90
91
92
93
94
95
96
|
---
version: tip
layout: manpage_v2
title: nng_strfree(3)
---
<h1>nng_strfree(3)</h1>
<div class="sect1">
<h2 id="_name">NAME</h2>
<div class="sectionbody">
<div class="paragraph">
<p>nng_strfree - free memory</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-kt">void</span><span class="tok-w"> </span><span class="tok-nf">nng_strfree</span><span class="tok-p">(</span><span class="tok-kt">char</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-n">str</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_strfree()</code> function deallocates the string <em>str</em>.
This is equivalent to using <a href="nng_free.3.html"><code>nng_free()</code></a> with
the length of <em>str</em> plus one (for the <code>NUL</code> terminating byte) as
the size.</p>
</div>
<div class="admonitionblock important">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
</td>
<td class="content">
This should only be used with strings that were allocated
by <a href="nng_strdup.3.html"><code>nng_strdup()</code></a> or
<a href="nng_alloc.3.html"><code>nng_alloc()</code></a>.
In all cases, the allocation size of the string must be the same
as <code>strlen(<em>str</em>) + 1</code>.
</td>
</tr>
</table>
</div>
<div class="admonitionblock important">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
</td>
<td class="content">
Consequently, if the a string created with
<a href="nng_strdup.3.html"><code>nng_strdup()</code></a> is modified to be shorter, then
it is incorrect to call this function.
(The <a href="nng_free.3.html"><code>nng_free()</code></a> function can be used instead in that
case, using the length of the original string plus one for the size.)
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_return_values">RETURN VALUES</h2>
<div class="sectionbody">
<div class="paragraph">
<p>None.</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="nng_alloc.3.html">nng_alloc(3)</a>,
<a href="nng_free.3.html">nng_free(3)</a>,
<a href="nng_strdup.3.html">nng_strdup(3)</a>,
<a href="nng.7.html">nng(7)</a></p>
</div>
</div>
</div>
|
