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_header_trim.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_header_trim.3.adoc')
| -rw-r--r-- | docs/man/nng_msg_header_trim.3.adoc | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/man/nng_msg_header_trim.3.adoc b/docs/man/nng_msg_header_trim.3.adoc index dae56184..39d8052e 100644 --- a/docs/man/nng_msg_header_trim.3.adoc +++ b/docs/man/nng_msg_header_trim.3.adoc @@ -27,7 +27,7 @@ int nng_msg_header_trim_u32(nng_msg *msg, uint32_t *val32); == DESCRIPTION The `nng_msg_header_trim()` and `nng_msg_header_trim_u32()` functions remove -data from the start of the header of message _msg_. +data from the start of the header of message _msg_. The first function removes _size_ bytes. The second function removes 4 bytes, and stores them in the value _val32_, after converting them from network-byte order (big-endian) to native @@ -39,10 +39,12 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_EINVAL`:: The message header is too short to remove the requested data. == SEE ALSO +[.text-left] <<nng_msg_alloc.3#,nng_msg_alloc(3)>>, <<nng_msg_header.3#,nng_msg_header(3)>>, <<nng_msg_header_append.3#,nng_msg_header_append(3)>>, |