Commit 99e6179e authored by Martin Lucina's avatar Martin Lucina

Documentation updates

The option_value parameter for zmq_getsockopt is in and out.
parent b4f3e0ac
......@@ -10,7 +10,7 @@ zmq_getsockopt - get 0MQ socket options
SYNOPSIS
--------
*int zmq_getsockopt (void '*socket', int 'option_name', void '*option_value', size_t 'option_len');*
*int zmq_getsockopt (void '*socket', int 'option_name', void '*option_value', size_t '*option_len');*
DESCRIPTION
......@@ -19,7 +19,9 @@ The _zmq_getsockopt()_ function shall retrieve the value for the option
specified by the 'option_name' argument for the 0MQ socket pointed to by the
'socket' argument, and store it in the buffer pointed to by the 'option_value'
argument. The 'option_len' argument is the size in bytes of the buffer pointed
to by 'option_value'.
to by 'option_value'; upon successful completion _zmq_getsockopt()_ shall
modify the 'option_value' argument to indicate the actual size of the option
value stored in the buffer.
The following options can be retrieved with the _zmq_getsockopt()_ function:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment