projects / thirdparty / man-pages.git / blame
| Commit | Line | Data |
|---|---|---|
| 80a99f39 | 1 | '\" t |
| c11b1abf | 2 | .\" Copyright (C) 2006 Michael Kerrisk <mtk.manpages@gmail.com> |
| 80a99f39 | 3 | .\" |
| 93015253 | 4 | .\" %%%LICENSE_START(VERBATIM) |
| 80a99f39 MK |
5 | .\" Permission is granted to make and distribute verbatim copies of this |
| 6 | .\" manual provided the copyright notice and this permission notice are | |
| 7 | .\" preserved on all copies. | |
| 8 | .\" | |
| 9 | .\" Permission is granted to copy and distribute modified versions of this | |
| 10 | .\" manual under the conditions for verbatim copying, provided that the | |
| 11 | .\" entire resulting derived work is distributed under the terms of a | |
| 12 | .\" permission notice identical to this one. | |
| c13182ef | 13 | .\" |
| 80a99f39 MK |
14 | .\" Since the Linux kernel and libraries are constantly changing, this |
| 15 | .\" manual page may be incorrect or out-of-date. The author(s) assume no | |
| 16 | .\" responsibility for errors or omissions, or for damages resulting from | |
| 10d76543 MK |
17 | .\" the use of the information contained herein. The author(s) may not |
| 18 | .\" have taken the same level of care in the production of this manual, | |
| 19 | .\" which is licensed free of charge, as they might when working | |
| 20 | .\" professionally. | |
| c13182ef | 21 | .\" |
| 80a99f39 MK |
22 | .\" Formatted or processed versions of this manual, if unaccompanied by |
| 23 | .\" the source, must acknowledge the copyright and authors of this work. | |
| 4b72fb64 | 24 | .\" %%%LICENSE_END |
| 80a99f39 | 25 | .\" |
| 4b8c67d9 | 26 | .TH MQ_CLOSE 3 2017-09-15 "Linux" "Linux Programmer's Manual" |
| 80a99f39 MK |
27 | .SH NAME |
| 28 | mq_close \- close a message queue descriptor | |
| 29 | .SH SYNOPSIS | |
| 30 | .nf | |
| 31 | .B #include <mqueue.h> | |
| 68e4db0a | 32 | .PP |
| c9e83f06 | 33 | .BI "int mq_close(mqd_t " mqdes ); |
| 80a99f39 | 34 | .fi |
| 68e4db0a | 35 | .PP |
| 1b2d3fca | 36 | Link with \fI\-lrt\fP. |
| 80a99f39 MK |
37 | .SH DESCRIPTION |
| 38 | .BR mq_close () | |
| 39 | closes the message queue descriptor | |
| 40 | .IR mqdes . | |
| 847e0d88 | 41 | .PP |
| bcdd78a0 MK |
42 | If the calling process has attached a notification request (see |
| 43 | .RB ( mq_notify (3)) | |
| 80a99f39 MK |
44 | to this message queue via |
| 45 | .IR mqdes , | |
| c13182ef | 46 | then this request is removed, |
| 80a99f39 | 47 | and another process can now attach a notification request. |
| 80a99f39 MK |
48 | .SH RETURN VALUE |
| 49 | On success | |
| 50 | .BR mq_close () | |
| 51 | returns 0; on error, \-1 is returned, with | |
| c13182ef | 52 | .I errno |
| 80a99f39 MK |
53 | set to indicate the error. |
| 54 | .SH ERRORS | |
| 55 | .TP | |
| 56 | .B EBADF | |
| 1cd9229c | 57 | The message queue descriptor specified in |
| 80a99f39 MK |
58 | .I mqdes |
| 59 | is invalid. | |
| 0e7d2e7f | 60 | .SH ATTRIBUTES |
| 2f75eb08 PH |
61 | For an explanation of the terms used in this section, see |
| 62 | .BR attributes (7). | |
| 63 | .TS | |
| 64 | allbox; | |
| 65 | lb lb lb | |
| 66 | l l l. | |
| 67 | Interface Attribute Value | |
| 68 | T{ | |
| 0e7d2e7f | 69 | .BR mq_close () |
| 2f75eb08 PH |
70 | T} Thread safety MT-Safe |
| 71 | .TE | |
| 80a99f39 | 72 | .SH CONFORMING TO |
| ea5545db | 73 | POSIX.1-2001, POSIX.1-2008. |
| 2b2581ee MK |
74 | .SH NOTES |
| 75 | All open message queues are automatically closed on process termination, | |
| 76 | or upon | |
| 77 | .BR execve (2). | |
| 47297adb | 78 | .SH SEE ALSO |
| 80a99f39 MK |
79 | .BR mq_getattr (3), |
| 80 | .BR mq_notify (3), | |
| 81 | .BR mq_open (3), | |
| 82 | .BR mq_receive (3), | |
| 83 | .BR mq_send (3), | |
| 84 | .BR mq_unlink (3), | |
| 85 | .BR mq_overview (7) |