xref: /dragonfly/lib/librt/mq_close.2 (revision 9348a738)
1.\"	$NetBSD: mq_close.3,v 1.1 2009/01/05 21:19:49 rmind Exp $
2.\"
3.\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved
4.\"
5.Dd August 19, 2009
6.Dt MQ_CLOSE 2
7.Os
8.Sh NAME
9.Nm mq_close
10.Nd close a message queue (REALTIME)
11.Sh LIBRARY
12.Lb librt
13.Sh SYNOPSIS
14.In mqueue.h
15.Ft int
16.Fn mq_close "mqd_t mqdes"
17.Sh DESCRIPTION
18The
19.Fn mq_close
20function will remove the association between the message queue descriptor,
21.Fa mqdes ,
22and its message queue.
23.Pp
24If the process has successfully attached a notification request to
25the message queue via this
26.Fa mqdes ,
27this attachment will be removed, and the message queue is available
28for another process to attach for notification.
29.Sh RETURN VALUES
30.Rv -std mq_close
31.Sh ERRORS
32The
33.Fn mq_close
34function fails if:
35.Bl -tag -width Er
36.It Bq Er EBADF
37The
38.Fa mqdes
39argument is not a valid message queue descriptor.
40.El
41.Sh SEE ALSO
42.Xr mq_getattr 2 ,
43.Xr mq_notify 2 ,
44.Xr mq_open 2 ,
45.Xr mq_receive 2 ,
46.Xr mq_send 2 ,
47.Xr mq_setattr 2 ,
48.Xr mq_unlink 2
49.Sh STANDARDS
50This function conforms to the
51.St -p1003.1-2001
52standard.
53.Sh HISTORY
54The
55.Fn mq_close
56function first appeared in
57.Dx 2.5 .
58.Sh COPYRIGHT
59Portions of this text are reprinted and reproduced in electronic form
60from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
61-- Portable Operating System Interface (POSIX), The Open Group Base
62Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
63Electrical and Electronics Engineers, Inc and The Open Group.
64In the
65event of any discrepancy between this version and the original IEEE and
66The Open Group Standard, the original IEEE and The Open Group Standard
67is the referee document.
68The original Standard can be obtained online at
69http://www.opengroup.org/unix/online.html .
70