logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

mq_close.3p (2675B)

    

  1. '\" et
  2. .TH MQ_CLOSE "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. mq_close
  12. \(em close a message queue
  13. (\fBREALTIME\fP)
  14. .SH SYNOPSIS
  15. .LP
  16. .nf
  17. #include <mqueue.h>
  18. .P
  19. int mq_close(mqd_t \fImqdes\fP);
  20. .fi
  21. .SH DESCRIPTION
  22. The
  23. \fImq_close\fR()
  24. function shall remove the association between the message queue
  25. descriptor,
  26. .IR mqdes ,
  27. and its message queue. The results of using this message queue
  28. descriptor after successful return from this
  29. \fImq_close\fR(),
  30. and until the return of this message queue descriptor from a subsequent
  31. \fImq_open\fR(),
  32. are undefined.
  33. .P
  34. If the process has successfully attached a notification request to the
  35. message queue via this
  36. .IR mqdes ,
  37. this attachment shall be removed, and the message queue is available
  38. for another process to attach for notification.
  39. .SH "RETURN VALUE"
  40. Upon successful completion, the
  41. \fImq_close\fR()
  42. function shall return a value of zero; otherwise, the function shall
  43. return a value of \-1 and set
  44. .IR errno
  45. to indicate the error.
  46. .SH ERRORS
  47. The
  48. \fImq_close\fR()
  49. function shall fail if:
  50. .TP
  51. .BR EBADF
  52. The
  53. .IR mqdes
  54. argument is not a valid message queue descriptor.
  55. .LP
  56. .IR "The following sections are informative."
  57. .SH EXAMPLES
  58. None.
  59. .SH "APPLICATION USAGE"
  60. None.
  61. .SH RATIONALE
  62. None.
  63. .SH "FUTURE DIRECTIONS"
  64. None.
  65. .SH "SEE ALSO"
  66. .IR "\fImq_open\fR\^(\|)",
  67. .IR "\fImq_unlink\fR\^(\|)",
  68. .IR "\fImsgctl\fR\^(\|)",
  69. .IR "\fImsgget\fR\^(\|)",
  70. .IR "\fImsgrcv\fR\^(\|)",
  71. .IR "\fImsgsnd\fR\^(\|)"
  72. .P
  73. The Base Definitions volume of POSIX.1\(hy2017,
  74. .IR "\fB<mqueue.h>\fP"
  75. .\"
  76. .SH COPYRIGHT
  77. Portions of this text are reprinted and reproduced in electronic form
  78. from IEEE Std 1003.1-2017, Standard for Information Technology
  79. -- Portable Operating System Interface (POSIX), The Open Group Base
  80. Specifications Issue 7, 2018 Edition,
  81. Copyright (C) 2018 by the Institute of
  82. Electrical and Electronics Engineers, Inc and The Open Group.
  83. In the event of any discrepancy between this version and the original IEEE and
  84. The Open Group Standard, the original IEEE and The Open Group Standard
  85. is the referee document. The original Standard can be obtained online at
  86. http://www.opengroup.org/unix/online.html .
  87. .PP
  88. Any typographical or formatting errors that appear
  89. in this page are most likely
  90. to have been introduced during the conversion of the source files to
  91. man page format. To report such errors, see
  92. https://www.kernel.org/doc/man-pages/reporting_bugs.html .