0
0
mirror of https://github.com/zeromq/libzmq.git synced 2024-12-28 16:15:23 +08:00
libzmq/doc/zmq_msg_close.txt
2010-02-10 16:18:46 +01:00

54 lines
817 B
Plaintext

zmq_msg_close(3)
================
NAME
----
zmq_msg_close - destroys 0MQ message
SYNOPSIS
--------
'int zmq_msg_close (zmq_msg_t *msg);'
DESCRIPTION
-----------
Deallocates message 'msg' including any associated buffers (unless the buffer
is shared with another message). Not calling this function can result in
memory leaks.
RETURN VALUE
------------
In case of success the function returns zero. Otherwise it returns -1 and sets
'errno' to the appropriate value.
ERRORS
------
No errors are defined.
EXAMPLE
-------
----
zmq_msg_t msg;
rc = zmq_msg_init_size (&msg, 1000000);
assert (rc = 0);
rc = zmq_msg_close (&msg);
assert (rc = 0);
----
SEE ALSO
--------
linkzmq:zmq_msg_init[3]
linkzmq:zmq_msg_init_size[3]
linkzmq:zmq_msg_init_data[3]
AUTHOR
------
Martin Sustrik <sustrik at 250bpm dot com>