diff options
Diffstat (limited to 'man/v1.8.0/nng_alloc.3.html')
| -rw-r--r-- | man/v1.8.0/nng_alloc.3.html | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/man/v1.8.0/nng_alloc.3.html b/man/v1.8.0/nng_alloc.3.html new file mode 100644 index 00000000..b8c0a2d1 --- /dev/null +++ b/man/v1.8.0/nng_alloc.3.html @@ -0,0 +1,85 @@ +--- +version: v1.8.0 +layout: manpage_v2 +title: nng_alloc(3) +--- +<h1>nng_alloc(3)</h1> +<div class="sect1"> +<h2 id="_name">NAME</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>nng_alloc - allocate 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-o">*</span><span class="tok-nf">nng_alloc</span><span class="tok-p">(</span><span class="tok-kt">size_t</span><span class="tok-w"> </span><span class="tok-n">size</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_alloc()</code> function allocates a contiguous memory region of +at least <em>size</em> bytes. +The memory will be 64-bit aligned.</p> +</div> +<div class="paragraph"> +<p>The returned memory can be used to hold message buffers, in which +case it can be directly passed to <a href="nng_send.3.html"><code>nng_send()</code></a> using +the flag <code>NNG_FLAG_ALLOC</code>. Alternatively, it can be freed when no +longer needed using <a href="nng_free.3.html"><code>nng_free()</code></a>.</p> +</div> +<div class="admonitionblock important"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-important" title="Important"></i> +</td> +<td class="content"> +Do not use the system <code>free()</code> function to release this memory. +On some platforms this may work, but it is not guaranteed and may lead +to a crash or other undesirable and unpredictable behavior. +</td> +</tr> +</table> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_return_values">RETURN VALUES</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>This function returns a pointer to the allocated memory on success, +and <code>NULL</code> otherwise.</p> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_errors">ERRORS</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>No errors are returned, but a <code>NULL</code> return value should be +treated the same as <code>NNG_ENOMEM</code>.</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_free.3.html">nng_free(3)</a>, +<a href="nng_send.3.html">nng_send(3)</a>, +<a href="nng_strerror.3.html">nng_strerror(3)</a>, +<a href="nng.7.html">nng(7)</a></p> +</div> +</div> +</div> |
