diff options
author | Martin Lucina <mato@kotelna.sk> | 2010-02-10 16:18:46 +0100 |
---|---|---|
committer | Martin Lucina <mato@kotelna.sk> | 2010-02-10 16:18:46 +0100 |
commit | 354efc513fdb4096f8830e6c2e3e8f1311303e61 (patch) | |
tree | c8dec6949c70e6f41832e42326594ebb889b1ee2 /doc/zmq_msg_close.txt | |
parent | 2d44bf3644c8e12aa86c48e9da4df19bfa9ea703 (diff) |
Convert documentation to AsciiDoc
Diffstat (limited to 'doc/zmq_msg_close.txt')
-rw-r--r-- | doc/zmq_msg_close.txt | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/doc/zmq_msg_close.txt b/doc/zmq_msg_close.txt new file mode 100644 index 0000000..1b043a2 --- /dev/null +++ b/doc/zmq_msg_close.txt @@ -0,0 +1,53 @@ +zmq_msg_close(3) +================ + + +NAME +---- +zmq_msg_close - destroys 0MQ message + + +SYNOPSIS +-------- +'int zmq_msg_close (zmq_msg_t *msg);' + + +DESCRIPTION +----------- +Deallocates message 'msg' including any associated buffers (unless the buffer +is shared with another message). Not calling this function can result in +memory leaks. + + +RETURN VALUE +------------ +In case of success the function returns zero. Otherwise it returns -1 and sets +'errno' to the appropriate value. + + +ERRORS +------ +No errors are defined. + + +EXAMPLE +------- +---- +zmq_msg_t msg; +rc = zmq_msg_init_size (&msg, 1000000); +assert (rc = 0); +rc = zmq_msg_close (&msg); +assert (rc = 0); +---- + + +SEE ALSO +-------- +linkzmq:zmq_msg_init[3] +linkzmq:zmq_msg_init_size[3] +linkzmq:zmq_msg_init_data[3] + + +AUTHOR +------ +Martin Sustrik <sustrik at 250bpm dot com> |