summaryrefslogtreecommitdiff
path: root/man/v1.6.0/nng_msg_alloc.3.html
diff options
context:
space:
mode:
Diffstat (limited to 'man/v1.6.0/nng_msg_alloc.3.html')
-rw-r--r--man/v1.6.0/nng_msg_alloc.3.html81
1 files changed, 81 insertions, 0 deletions
diff --git a/man/v1.6.0/nng_msg_alloc.3.html b/man/v1.6.0/nng_msg_alloc.3.html
new file mode 100644
index 00000000..151c037b
--- /dev/null
+++ b/man/v1.6.0/nng_msg_alloc.3.html
@@ -0,0 +1,81 @@
+---
+version: v1.6.0
+layout: manpage_v2
+title: nng_msg_alloc(3)
+---
+<h1>nng_msg_alloc(3)</h1>
+<div class="sect1">
+<h2 id="_name">NAME</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>nng_msg_alloc - allocate a message</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 class="tok-cp">#include</span> <span class="tok-cpf">&lt;nng/nng.h&gt;</span>
+
+<span class="tok-kt">int</span> <span class="tok-nf">nng_msg_alloc</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span> <span class="tok-o">**</span><span class="tok-n">msgp</span><span class="tok-p">,</span> <span class="tok-kt">size_t</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_msg_alloc()</code> function allocates a new message with body length <em>size</em>
+and stores the result in <em>msgp</em>.
+Messages allocated with this function contain a body and optionally a header.
+They are used with receive and transmit functions.</p>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_return_values">RETURN VALUES</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>This function returns 0 on success, and non-zero otherwise.</p>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_errors">ERRORS</h2>
+<div class="sectionbody">
+<div class="hdlist">
+<table>
+<tr>
+<td class="hdlist1">
+<code>NNG_ENOMEM</code>
+</td>
+<td class="hdlist2">
+<p>Insufficient free memory exists to allocate a message.</p>
+</td>
+</tr>
+</table>
+</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_msg_free.3.html">nng_msg_free(3)</a>,
+<a href="nng_msg_body.3.html">nng_msg_body(3)</a>,
+<a href="nng_msg_dup.3.html">nng_msg_dup(3)</a>,
+<a href="nng_msg_header.3.html">nng_msg_header(3)</a>,
+<a href="nng_msg_header_len.3.html">nng_msg_header_len(3)</a>,
+<a href="nng_msg_len.3.html">nng_msg_len(3)</a>,
+<a href="nng_msg_capacity.3.html">nng_msg_capacity(3)</a>,
+<a href="nng_msg_reserve.3.html">nng_msg_reserve(3)</a>,
+<a href="nng_msg_realloc.3.html">nng_msg_realloc(3)</a>,
+<a href="nng_strerror.3.html">nng_strerror(3)</a>,
+<a href="nng_msg.5.html">nng_msg(5)</a>,
+<a href="nng.7.html">nng(7)</a></p>
+</div>
+</div>
+</div>