diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-05-29 17:03:51 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-05-29 18:14:55 -0700 |
| commit | 0ddaee41ec753805fa12eeabd679870802528dac (patch) | |
| tree | 3418859f4f22e9857b5ae979b3bc4eb53fd70035 /docs/man/nng_msg_insert.3.adoc | |
| parent | 33dc5d611f578ace9833a80dc006a34b09da18af (diff) | |
| download | nng-0ddaee41ec753805fa12eeabd679870802528dac.tar.gz nng-0ddaee41ec753805fa12eeabd679870802528dac.tar.bz2 nng-0ddaee41ec753805fa12eeabd679870802528dac.zip | |
fixes #495 SEE ALSO should use [align=left]
fixes #494 ERRORS section should use [horizontal]
These changes address some basic formatting consistency things,
and ultimately (when combined with other tooling changes that are
not part of this repo) lead to vastly improved layout in the
printed documentation.
While here we removed trailing whitespace, and did certain other
minor markup tweaks.
Diffstat (limited to 'docs/man/nng_msg_insert.3.adoc')
| -rw-r--r-- | docs/man/nng_msg_insert.3.adoc | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/man/nng_msg_insert.3.adoc b/docs/man/nng_msg_insert.3.adoc index 7955a2fb..ddc8d46d 100644 --- a/docs/man/nng_msg_insert.3.adoc +++ b/docs/man/nng_msg_insert.3.adoc @@ -16,19 +16,19 @@ nng_msg_insert, nng_msg_insert_u32 - prepend to message body == SYNOPSIS [source, c] ------------ +---- #include <nng/nng.h> int nng_msg_insert(nng_msg *msg, const void *val, size_t size); int nng_msg_insert(nng_msg *msg, uint32_t val32); ------------ +---- == DESCRIPTION The `nng_msg_insert()` and `nng_msg_insert_u32()` functions prepend data to the front of the body of message _msg_, reallocating it if necessary. -The first function prepends _size_ bytes, copying them from _val_. +The first function prepends _size_ bytes, copying them from _val_. The second function prepends the value _val32_ in network-byte order (big-endian). @@ -43,10 +43,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient free memory exists. == SEE ALSO +[.text-left] <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, <<nng_msg_append.3#,nng_msg_append(3)>>, <<nng_msg_body.3#,nng_msg_body(3)>>, |