diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-10-12 11:36:52 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-10-12 11:36:52 -0700 |
| commit | f26952c3bcbc83358e3a69d5d2e613f61fd657e1 (patch) | |
| tree | afbbe30788e933169bb3779e6cecd694e5537f2a /docs/man/nng_msg_dup.3.adoc | |
| parent | 522293fc3c121af6189bdca0b4285c03118d9cd6 (diff) | |
| download | nng-f26952c3bcbc83358e3a69d5d2e613f61fd657e1.tar.gz nng-f26952c3bcbc83358e3a69d5d2e613f61fd657e1.tar.bz2 nng-f26952c3bcbc83358e3a69d5d2e613f61fd657e1.zip | |
nng_msg docs converted to mdbook
We're moving to fewer man pages, with related functions grouped
together in the same man page, and this continues the trend.
Diffstat (limited to 'docs/man/nng_msg_dup.3.adoc')
| -rw-r--r-- | docs/man/nng_msg_dup.3.adoc | 49 |
1 files changed, 0 insertions, 49 deletions
diff --git a/docs/man/nng_msg_dup.3.adoc b/docs/man/nng_msg_dup.3.adoc deleted file mode 100644 index b985d5bb..00000000 --- a/docs/man/nng_msg_dup.3.adoc +++ /dev/null @@ -1,49 +0,0 @@ -= 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 - -[horizontal] -`NNG_ENOMEM`:: Insufficient free memory exists to duplicate a message. - -== SEE ALSO - -[.text-left] -xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)], -xref:nng_msg_free.3.adoc[nng_msg_free(3)], -xref:nng_strerror.3.adoc[nng_strerror(3)], -xref:nng_msg.5.adoc[nng_msg(5)], -xref:nng.7.adoc[nng(7)] |
