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_msg_header.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_msg_header.3.html')
| -rw-r--r-- | man/v1.7.3/nng_msg_header.3.html | 96 |
1 files changed, 96 insertions, 0 deletions
diff --git a/man/v1.7.3/nng_msg_header.3.html b/man/v1.7.3/nng_msg_header.3.html new file mode 100644 index 00000000..2c9b75c8 --- /dev/null +++ b/man/v1.7.3/nng_msg_header.3.html @@ -0,0 +1,96 @@ +--- +version: v1.7.3 +layout: manpage_v2 +title: nng_msg_header(3) +--- +<h1>nng_msg_header(3)</h1> +<div class="sect1"> +<h2 id="_name">NAME</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>nng_msg_header - return message header</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_msg_header</span><span class="tok-p">(</span><span class="tok-n">nng_msg</span><span class="tok-w"> </span><span class="tok-o">*</span><span class="tok-n">msg</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_header()</code> function returns a pointer to the start of the header +content of the message <em>msg</em>.</p> +</div> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +The message header contains protocol-specific header content. Most +applications should not need to access this content, but it is available +for raw mode sockets (set with the +<a href="nng_options.5.html#NNG_OPT_RAW"><code>NNG_OPT_RAW</code></a> option.) +</td> +</tr> +</table> +</div> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +The value returned by this is invalidated by a call to any of the +functions that modify the message or the header content. +</td> +</tr> +</table> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_return_values">RETURN VALUES</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>Pointer to start of message header.</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_msg_alloc.3.html">nng_msg_alloc(3)</a>, +<a href="nng_msg_body.3.html">nng_msg_body(3)</a>, +<a href="nng_msg_free.3.html">nng_msg_free(3)</a>, +<a href="nng_msg_header_append.3.html">nng_msg_header_append(3)</a>, +<a href="nng_msg_header_chop.3.html">nng_msg_header_chop(3)</a>, +<a href="nng_msg_header_insert.3.html">nng_msg_header_insert(3)</a> +<a href="nng_msg_header_len.3.html">nng_msg_header_len(3)</a>, +<a href="nng_msg_header_trim.3.html">nng_msg_header_trim(3)</a>, +<a href="nng_msg.5.html">nng_msg(5)</a>, +<a href="nng.7.html">nng(7)</a></p> +</div> +</div> +</div> |
