aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_msg_body.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nng_msg_body.adoc')
-rw-r--r--docs/nng_msg_body.adoc55
1 files changed, 0 insertions, 55 deletions
diff --git a/docs/nng_msg_body.adoc b/docs/nng_msg_body.adoc
deleted file mode 100644
index 507c0e0d..00000000
--- a/docs/nng_msg_body.adoc
+++ /dev/null
@@ -1,55 +0,0 @@
-= 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
-<<nng_msg_free#,nng_msg_free(3)>>, <<nng_msg_realloc#,nng_msg_realloc(3)>>,
-any of the <<nng_msg_trim#,nng_msg_trim(3)>>,
-<<nng_msg_chop#,nng_msg_chop(3)>>, <<nng_msg_append#,nng_msg_append(3)>>,
-or <<nng_msg_insert#,nng_msg_insert(3)>> variants.
-
-== RETURN VALUES
-
-Pointer to start of message body.
-
-== ERRORS
-
-None.
-
-== SEE ALSO
-
-<<nng_msg_alloc#,nng_msg_alloc(3)>>,
-<<nng_msg_append#,nng_msg_append(3)>>,
-<<nng_msg_chop#,nng_msg_chop(3)>>,
-<<nng_msg_free#,nng_msg_free(3)>>,
-<<nng_msg_insert#,nng_msg_insert(3)>>,
-<<nng_msg_len#,nng_msg_len(3)>>,
-<<nng_msg_realloc#,nng_msg_realloc(3)>>,
-<<nng_msg_trim#,nng_msg_trim(3)>>,
-<<nng#,nng(7)>>