summaryrefslogtreecommitdiff
path: root/docs/reference/src/msg/nng_msg_body.md
blob: 1fd67227013106ce055885a52dad1cf633eea6c4 (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
# nng_msg_body

## NAME

nng_msg_body --- return message body

## SYNOPSIS

```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 {{i:body}}
content of the [message][msg] _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
> [`nng_msg_free()`][nng_msg_free],
> [`nng_msg_realloc()`][nng_msg_realloc],
> any of the [`nng_msg_trim()`][nng_msg_trim],
> [`nng_msg_chop()`][nng_msg_chop],
> [`nng_msg_append()`][nng_msg_append],
> or [`nng_msg_insert()`][nng_msg_insert] variants.

## RETURN VALUES

Pointer to start of message body.

## SEE ALSO

[nng_msg_alloc][nng_msg_alloc],
[nng_msg_append][nng_msg_append],
[nng_msg_capacity][nng_msg_capacity],
[nng_msg_chop][nng_msg_chop],
[nng_msg_clear][nng_msg_clear],
[nng_msg_free][nng_msg_free],
[nng_msg_insert][nng_msg_insert],
[nng_msg_len][nng_msg_len],
[nng_msg_reserve][nng_msg_reserve],
[nng_msg_realloc][nng_msg_realloc],
[nng_msg_trim][nng_msg_trim]

{{#include ../refs.md}}