libzmq/doc/zmq_msg_size.txt
Pieter Hintjens 77a3c36ff1 Various changes to documentation project:
* Added documentation for zmq_deviced, which we're developing
* Created consistent page footer in documentation template
* Page footer notes doc authors and copyright statement
2010-08-04 14:43:33 +02:00

45 lines
747 B
Plaintext

zmq_msg_size(3)
===============
NAME
----
zmq_msg_size - retrieve message content size in bytes
SYNOPSIS
--------
*size_t zmq_msg_size (zmq_msg_t '*msg');*
DESCRIPTION
-----------
The _zmq_msg_size()_ function shall return the size in bytes of the content of
the message object referenced by 'msg'.
CAUTION: Never access 'zmq_msg_t' members directly, instead always use the
_zmq_msg_ family of functions.
RETURN VALUE
------------
Upon successful completion, _zmq_msg_data()_ shall return the size of the
message content in bytes.
ERRORS
------
No errors are defined.
SEE ALSO
--------
linkzmq:zmq_msg_data[3]
linkzmq:zmq_msg_init[3]
linkzmq:zmq_msg_init_size[3]
linkzmq:zmq_msg_init_data[3]
linkzmq:zmq_msg_close[3]
linkzmq:zmq[7]