summaryrefslogtreecommitdiff
path: root/docs/man/nng_msg_body.3.adoc
blob: e36e4bfdd188c2073ca276b10f674a5d3bd5d533 (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
= nng_msg_body(3)
//
// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
// Copyright 2018 Capitar IT Group BV <info@capitar.com>
//
// This document is supplied under the terms of the MIT License, a
// copy of which should be located in the distribution where this
// file was obtained (LICENSE.txt).  A copy of the license may also be
// found online at https://opensource.org/licenses/MIT.
//

== NAME

nng_msg_body - return message body

== SYNOPSIS

[source, c]
----
#include <nng/nng.h>

void *nng_msg_body(nng_msg *msg);
----

== DESCRIPTION

The `nng_msg_body()` function returns a pointer to the start of the body
content of the message _msg_.

NOTE: The value returned by this is invalidated by a call to any of the
functions that modify the message itself.
Such functions are
xref:nng_msg_free.3.adoc[`nng_msg_free()`],
xref:nng_msg_realloc.3.adoc[`nng_msg_realloc()`],
any of the xref:nng_msg_trim.3.adoc[`nng_msg_trim()`],
xref:nng_msg_chop.3.adoc[`nng_msg_chop()`],
xref:nng_msg_append.3.adoc[`nng_msg_append()`],
or xref:nng_msg_insert.3.adoc[`nng_msg_insert()`] variants.

== RETURN VALUES

Pointer to start of message body.

== ERRORS

None.

== SEE ALSO

[.text-left]
xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)],
xref:nng_msg_append.3.adoc[nng_msg_append(3)],
xref:nng_msg_chop.3.adoc[nng_msg_chop(3)],
xref:nng_msg_free.3.adoc[nng_msg_free(3)],
xref:nng_msg_insert.3.adoc[nng_msg_insert(3)],
xref:nng_msg_len.3.adoc[nng_msg_len(3)],
xref:nng_msg_realloc.3.adoc[nng_msg_realloc(3)],
xref:nng_msg_trim.3.adoc[nng_msg_trim(3)],
xref:nng_msg.5.adoc[nng_msg(5)],
xref:nng.7.adoc[nng(7)]