libzmq/doc/zmq_msg_size.adoc

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

42 lines
997 B
Plaintext
Raw Permalink Normal View History

= zmq_msg_size(3)
2010-02-10 16:18:46 +01:00
== NAME
2010-03-09 18:47:31 +01:00
zmq_msg_size - retrieve message content size in bytes
2010-02-10 16:18:46 +01:00
== SYNOPSIS
2012-02-17 10:48:04 +01:00
*size_t zmq_msg_size (zmq_msg_t '*msg');*
2010-02-10 16:18:46 +01:00
== DESCRIPTION
2010-03-09 18:47:31 +01:00
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.
2010-02-10 16:18:46 +01:00
== RETURN VALUE
Upon successful completion, _zmq_msg_size()_ shall return the size of the
2010-03-09 18:47:31 +01:00
message content in bytes.
2010-02-10 16:18:46 +01:00
== ERRORS
2012-02-17 10:48:04 +01:00
No errors are defined.
2010-02-10 16:18:46 +01:00
== SEE ALSO
* xref:zmq_msg_data.adoc[zmq_msg_data]
* xref:zmq_msg_init.adoc[zmq_msg_init]
* xref:zmq_msg_init_size.adoc[zmq_msg_init_size]
* xref:zmq_msg_init_buffer.adoc[zmq_msg_init_buffer]
* xref:zmq_msg_init_data.adoc[zmq_msg_init_data]
* xref:zmq_msg_close.adoc[zmq_msg_close]
* xref:zmq.adoc[zmq]
2010-02-10 16:18:46 +01:00
== AUTHORS
This page was written by the 0MQ community. To make a change please
read the 0MQ Contribution Policy at <https://zeromq.org/how-to-contribute/>.