zmq_msg_move.txt 1.23 KB
Newer Older
1 2 3 4 5 6
zmq_msg_move(3)
===============


NAME
----
Martin Lucina's avatar
Martin Lucina committed
7
zmq_msg_move - move content of a message to another message
8 9 10 11


SYNOPSIS
--------
Martin Lucina's avatar
Martin Lucina committed
12
*int zmq_msg_move (zmq_msg_t '*dest', zmq_msg_t '*src');*
13 14 15 16


DESCRIPTION
-----------
Martin Lucina's avatar
Martin Lucina committed
17 18 19 20 21 22 23 24
The _zmq_msg_move()_ function shall move the content of the message object
referenced by 'src' to the message object referenced by 'dest'. No actual
copying of message content is performed, 'dest' is simply updated to reference
the new content. 'src' becomes an empty message after calling _zmq_msg_move()_.
The original content of 'dest', if any, shall be released.

CAUTION: Never access 'zmq_msg_t' members directly, instead always use the
_zmq_msg_ family of functions.
25 26 27 28


RETURN VALUE
------------
Martin Lucina's avatar
Martin Lucina committed
29
The _zmq_msg_move()_ function shall return zero if successful. Otherwise it
Martin Lucina's avatar
Martin Lucina committed
30
shall return `-1` and set 'errno' to one of the values defined below.
31 32 33 34


ERRORS
------
35 36
*EFAULT*::
Invalid message.
37 38 39 40 41 42 43


SEE ALSO
--------
linkzmq:zmq_msg_copy[3]
linkzmq:zmq_msg_init[3]
linkzmq:zmq_msg_init_size[3]
44
linkzmq:zmq_msg_init_buffer[3]
45 46
linkzmq:zmq_msg_init_data[3]
linkzmq:zmq_msg_close[3]
Martin Lucina's avatar
Martin Lucina committed
47
linkzmq:zmq[7]
48 49


50 51
AUTHORS
-------
52 53
This page was written by the 0MQ community. To make a change please
read the 0MQ Contribution Policy at <http://www.zeromq.org/docs:contributing>.