diff options
| author | Martin Sustrik <sustrik@fastmq.commkdir> | 2009-11-23 09:22:25 +0100 |
|---|---|---|
| committer | Martin Sustrik <sustrik@fastmq.commkdir> | 2009-11-23 09:22:25 +0100 |
| commit | 5cd98bc575517ea72c435770a5313711484f7d34 (patch) | |
| tree | 5efe4d8904ecb84fa864c8d7cd1aba5bdc072b47 /man/man3/zmq_msg_close.3 | |
| parent | e90ada0d044636201c57786307a49a52f9cf7643 (diff) | |
the rest of man3 man pages filled in
Diffstat (limited to 'man/man3/zmq_msg_close.3')
| -rw-r--r-- | man/man3/zmq_msg_close.3 | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/man/man3/zmq_msg_close.3 b/man/man3/zmq_msg_close.3 index ee9d009..6613360 100644 --- a/man/man3/zmq_msg_close.3 +++ b/man/man3/zmq_msg_close.3 @@ -4,9 +4,29 @@ zmq_msg_close \- destroys 0MQ message .SH SYNOPSIS .B int zmq_msg_close (zmq_msg_t *msg); .SH DESCRIPTION +Deallocates message +.IR msg +including any associated buffers (unless the buffer is +shared with another message). Not calling this function can result in +memory leaks. .SH RETURN VALUE +In case of success the function returns zero. Otherwise it returns -1 and +sets +.IR errno +to the appropriate value. .SH ERRORS +No errors are defined. .SH EXAMPLE +.nf +zmq_msg_t msg; +rc = zmq_msg_init_size (&msg, 1000000); +assert (rc = 0); +rc = zmq_msg_close (&msg); +assert (rc = 0); +.fi .SH SEE ALSO +.BR zmq_msg_init (3) +.BR zmq_msg_init_size (3) +.BR zmq_msg_init_data (3) .SH AUTHOR Martin Sustrik <sustrik at 250bpm dot com> |