summaryrefslogtreecommitdiff
path: root/docs/man/nng_msg_dup.3.adoc
blob: 2018f9c7d92f37def80d687a4c351402f21a7025 (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
= nng_msg_dup(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_dup - duplicate a message

== SYNOPSIS

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

int nng_msg_dup(nng_msg **dup, nng_msg_t *orig);
----

== DESCRIPTION

The `nng_msg_dup()` makes a duplicate of the original message _orig_, and
saves the result in the location pointed by _dup_.
The actual message body and header content is copied,
but the duplicate may contain a
different amount of unused space than the original message.

== RETURN VALUES

This function returns 0 on success, and non-zero otherwise.

== ERRORS

`NNG_ENOMEM`:: Insufficient free memory exists to duplicate a message.

== SEE ALSO

<<nng_msg_alloc.3#,nng_msg_alloc(3)>>,
<<nng_msg_free.3#,nng_msg_free(3)>>,
<<nng_strerror.3#,nng_strerror(3)>>,
<<nng_msg.5#,nng_msg(5)>>,
<<nng.7#,nng(7)>>