summaryrefslogtreecommitdiff
path: root/doc/zmq_msg_move.txt
diff options
context:
space:
mode:
authorMartin Lucina <mato@kotelna.sk>2010-02-10 16:18:46 +0100
committerMartin Lucina <mato@kotelna.sk>2010-02-10 16:18:46 +0100
commit354efc513fdb4096f8830e6c2e3e8f1311303e61 (patch)
treec8dec6949c70e6f41832e42326594ebb889b1ee2 /doc/zmq_msg_move.txt
parent2d44bf3644c8e12aa86c48e9da4df19bfa9ea703 (diff)
Convert documentation to AsciiDoc
Diffstat (limited to 'doc/zmq_msg_move.txt')
-rw-r--r--doc/zmq_msg_move.txt55
1 files changed, 55 insertions, 0 deletions
diff --git a/doc/zmq_msg_move.txt b/doc/zmq_msg_move.txt
new file mode 100644
index 0000000..d8ce667
--- /dev/null
+++ b/doc/zmq_msg_move.txt
@@ -0,0 +1,55 @@
+zmq_msg_move(3)
+===============
+
+
+NAME
+----
+zmq_msg_move - moves content of a message to another message
+
+
+SYNOPSIS
+--------
+int zmq_msg_move (zmq_msg_t *dest, zmq_msg_t *src);
+
+
+DESCRIPTION
+-----------
+Move the content of the message from 'src' to 'dest'. The content isn't
+copied, just moved. 'src' becomes an empty message after the call. Original
+content of 'dest' message is deallocated.
+
+
+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 dest;
+rc = zmq_msg_init (&dest);
+assert (rc == 0);
+rc = zmq_msg_move (&dest, &src);
+assert (rc == 0);
+----
+
+
+SEE ALSO
+--------
+linkzmq:zmq_msg_copy[3]
+linkzmq:zmq_msg_init[3]
+linkzmq:zmq_msg_init_size[3]
+linkzmq:zmq_msg_init_data[3]
+linkzmq:zmq_msg_close[3]
+
+
+AUTHOR
+------
+Martin Sustrik <sustrik at 250bpm dot com>