aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_msg_header_len.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man/nng_msg_header_len.adoc')
-rw-r--r--docs/man/nng_msg_header_len.adoc41
1 files changed, 41 insertions, 0 deletions
diff --git a/docs/man/nng_msg_header_len.adoc b/docs/man/nng_msg_header_len.adoc
new file mode 100644
index 00000000..68dfbcff
--- /dev/null
+++ b/docs/man/nng_msg_header_len.adoc
@@ -0,0 +1,41 @@
+= nng_msg_header_len(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_header_len - return message header length
+
+== SYNOPSIS
+
+[source, c]
+-----------
+#include <nng/nng.h>
+
+size_t nng_msg_header_len(nng_msg *msg);
+-----------
+
+== DESCRIPTION
+
+The `nng_msg_header_len()` returns the length of message header of _msg_.
+
+== RETURN VALUES
+
+Length of message header.
+
+== ERRORS
+
+None.
+
+== SEE ALSO
+
+<<nng_msg_alloc#,nng_msg_alloc(3)>>,
+<<nng_msg_header#,nng_msg_header(3)>>,
+<<nng#,nng(7)>>