summaryrefslogtreecommitdiff
path: root/doc/zmq_msg_set.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/zmq_msg_set.txt')
-rw-r--r--doc/zmq_msg_set.txt46
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/zmq_msg_set.txt b/doc/zmq_msg_set.txt
new file mode 100644
index 0000000..6784478
--- /dev/null
+++ b/doc/zmq_msg_set.txt
@@ -0,0 +1,46 @@
+zmq_msg_set(3)
+==============
+
+
+NAME
+----
+
+zmq_msg_set - set message property
+
+
+SYNOPSIS
+--------
+*int zmq_msg_set (zmq_msg_t '*message', int 'property', int 'value');*
+
+
+DESCRIPTION
+-----------
+The _zmq_msg_set()_ function shall set the property specified by the
+'property' argument to the value of the 'value' argument for the 0MQ
+message fragment pointed to by the 'message' argument.
+
+Currently the _zmq_msg_set()_ function does not support any property names.
+
+
+RETURN VALUE
+------------
+The _zmq_msg_set()_ function shall return zero if successful. Otherwise it
+shall return `-1` and set 'errno' to one of the values defined below.
+
+
+ERRORS
+------
+*EINVAL*::
+The requested property _property_ is unknown.
+
+
+SEE ALSO
+--------
+linkzmq:zmq_msg_get[3]
+linkzmq:zmq[7]
+
+
+AUTHORS
+-------
+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>.