diff options
| author | Martin Sustrik <sustrik@250bpm.com> | 2010-05-07 21:53:55 +0200 |
|---|---|---|
| committer | Martin Sustrik <sustrik@250bpm.com> | 2010-05-07 21:53:55 +0200 |
| commit | 4d33c43913dd640853cec75ce21080c2b33d8526 (patch) | |
| tree | a0a243147330d9d57a2db5da23f0d04b427c96fc | |
| parent | 4a3b857c4cf35261751d562ad7e4acc5ecf58be0 (diff) | |
caution about zmq_msg_init_* functions added to the docs
| -rw-r--r-- | doc/zmq_msg_init.txt | 4 | ||||
| -rw-r--r-- | doc/zmq_msg_init_data.txt | 4 | ||||
| -rw-r--r-- | doc/zmq_msg_init_size.txt | 4 |
3 files changed, 12 insertions, 0 deletions
diff --git a/doc/zmq_msg_init.txt b/doc/zmq_msg_init.txt index 5f3e54d..d31dbae 100644 --- a/doc/zmq_msg_init.txt +++ b/doc/zmq_msg_init.txt @@ -21,6 +21,10 @@ before receiving a message with _zmq_recv()_. CAUTION: Never access 'zmq_msg_t' members directly, instead always use the _zmq_msg_ family of functions. +CAUTION: The functions _zmq_msg_init()_, _zmq_msg_init_data()_ and +_zmq_msg_init_size()_ are mutually exclusive. Never initialize the same +'zmq_msg_t' twice. + RETURN VALUE ------------ diff --git a/doc/zmq_msg_init_data.txt b/doc/zmq_msg_init_data.txt index 4164717..8378757 100644 --- a/doc/zmq_msg_init_data.txt +++ b/doc/zmq_msg_init_data.txt @@ -28,6 +28,10 @@ supplied to _zmq_msg_init_data()_. CAUTION: Never access 'zmq_msg_t' members directly, instead always use the _zmq_msg_ family of functions. +CAUTION: The functions _zmq_msg_init()_, _zmq_msg_init_data()_ and +_zmq_msg_init_size()_ are mutually exclusive. Never initialize the same +'zmq_msg_t' twice. + RETURN VALUE ------------ diff --git a/doc/zmq_msg_init_size.txt b/doc/zmq_msg_init_size.txt index ad24b13..b4ef393 100644 --- a/doc/zmq_msg_init_size.txt +++ b/doc/zmq_msg_init_size.txt @@ -25,6 +25,10 @@ _zmq_msg_init_size()_ shall not clear the message data. CAUTION: Never access 'zmq_msg_t' members directly, instead always use the _zmq_msg_ family of functions. +CAUTION: The functions _zmq_msg_init()_, _zmq_msg_init_data()_ and +_zmq_msg_init_size()_ are mutually exclusive. Never initialize the same +'zmq_msg_t' twice. + RETURN VALUE ------------ |