libzmq/doc/zmq_msg_set.txt
2012-02-15 19:28:29 -06:00

48 lines
1.0 KiB
Plaintext

zmq_msg_set(3)
==============
NAME
----
zmq_msg_set - set message options
SYNOPSIS
--------
*int zmq_msg_peek (zmq_msg_t '*message', int 'option_name', const void '*option_value', size_t '*option_len');*
DESCRIPTION
-----------
The _zmq_msg_set()_ function shall set the option specified by the
'option_name' argument to the value pointed to by the 'option_value' argument
for the 0MQ socket pointed to by the 'socket' argument. The 'option_len'
argument is the size of the option value in bytes.
Currently the _zmq_msg_set()_ function does not support any option 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 option _option_name_ is unknown, or the requested _option_len_ or
_option_value_ is invalid.
SEE ALSO
--------
linkzmq:zmq_msg_peek[3]
linkzmq:zmq[7]
AUTHORS
-------
This 0MQ manual page was written by Pieter Hintjens <ph@imatix.com>.