diff options
| author | Martin Lucina <mato@kotelna.sk> | 2010-05-31 17:24:50 +0200 |
|---|---|---|
| committer | Martin Lucina <mato@kotelna.sk> | 2010-05-31 17:24:50 +0200 |
| commit | 99e6179edd9e3552fcdb7f4fce3306cd174f3359 (patch) | |
| tree | 1e536dec4ba65f69085ef25f9a6c4f1ac2e9f167 | |
| parent | b4f3e0acd72de97bc5ef46ea74d9cd7ed7f9efc2 (diff) | |
Documentation updates
The option_value parameter for zmq_getsockopt is in and out.
| -rw-r--r-- | doc/zmq_getsockopt.txt | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/zmq_getsockopt.txt b/doc/zmq_getsockopt.txt index 4aef71c..3225a18 100644 --- a/doc/zmq_getsockopt.txt +++ b/doc/zmq_getsockopt.txt @@ -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: |