diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
| commit | 87795b46f2bc732bd11067805709161bdc00d6b6 (patch) | |
| tree | 892f3bcea1a14df5dde8dba413d394f5ccb0a0e0 /docs/nng_msg_alloc.adoc | |
| parent | 545942f7ace7cde8a1b8a6a5289cecc185b08fbc (diff) | |
| download | nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.gz nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.bz2 nng-87795b46f2bc732bd11067805709161bdc00d6b6.zip | |
More man page reorganization.
Man pages need special handling, and we can have other kinds of documentation
like initial starting guides, etc., which would have different processing
applied. So lets move them off into their own directory.
Diffstat (limited to 'docs/nng_msg_alloc.adoc')
| -rw-r--r-- | docs/nng_msg_alloc.adoc | 50 |
1 files changed, 0 insertions, 50 deletions
diff --git a/docs/nng_msg_alloc.adoc b/docs/nng_msg_alloc.adoc deleted file mode 100644 index 40f31552..00000000 --- a/docs/nng_msg_alloc.adoc +++ /dev/null @@ -1,50 +0,0 @@ -= nng_msg_alloc(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_alloc - allocate a message - -== SYNOPSIS - -[source, c] ------------ -#include <nng/nng.h> - -int nng_msg_alloc(nng_msg **msgp, size_t size); ------------ - -== DESCRIPTION - -The `nng_msg_alloc()` function allocates a new message with body length _size_ -and stores the result in __msgp__. -Messages allocated with this function contain a body and optionally a header. -They are used with receive and transmit functions. - -== RETURN VALUES - -This function returns 0 on success, and non-zero otherwise. - -== ERRORS - -`NNG_ENOMEM`:: Insufficient free memory exists to allocate a message. - -== SEE ALSO - -<<nng_msg_free#,nng_msg_free(3)>>, -<<nng_msg_body#,nng_msg_body(3)>>, -<<nng_msg_dup#,nng_msg_dup(3)>>, -<<nng_msg_header#,nng_msg_header(3)>>, -<<nng_msg_header_len#,nng_msg_header_len(3)>>, -<<nng_msg_len#,nng_msg_len(3)>>, -<<nng_msg_realloc#,nng_msg_realloc(3)>>, -<<nng_strerror#,nng_strerror(3)>>, -<<nng#,nng(7)>> |