generic-library/libzmq
1
0
Fork 0
mirror of https://github.com/zeromq/libzmq.git synced 2025-01-19 08:46:44 +01:00
Code Issues Projects Releases Wiki Activity

Documentation updates

Browse Source 
The option_value parameter for zmq_getsockopt is in and out.
This commit is contained in:
Martin Lucina 2010-05-31 17:24:50 +02:00
parent b4f3e0acd7
commit 99e6179edd
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/zmq_getsockopt.txt
View File

@ -10,7 +10,7 @@ zmq_getsockopt - get 0MQ socket options
SYNOPSIS 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 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 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' '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 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: The following options can be retrieved with the _zmq_getsockopt()_ function: