mqueues: Add librt (realtime library).
[dragonfly.git] / lib / librt / mq_close.2
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
18 The
19 .Fn mq_close
20 function will remove the association between the message queue descriptor,
21 .Fa mqdes ,
22 and its message queue.
23 .Pp
24 If the process has successfully attached a notification request to
25 the message queue via this
26 .Fa mqdes ,
27 this attachment will be removed, and the message queue is available
28 for another process to attach for notification.
29 .Sh RETURN VALUES
30 .Rv -std mq_close
31 .Sh ERRORS
32 The
33 .Fn mq_close
34 function fails if:
35 .Bl -tag -width Er
36 .It Bq Er EBADF
37 The
38 .Fa mqdes
39 argument is not a valid message queue descriptor.
40 .El
41 .Sh SEE ALSO
42 .Xr mq_getattr 3 ,
43 .Xr mq_notify 3 ,
44 .Xr mq_open 3 ,
45 .Xr mq_receive 3 ,
46 .Xr mq_send 3 ,
47 .Xr mq_setattr 3 ,
48 .Xr mq_unlink 3
49 .Sh STANDARDS
50 This function conforms to the
51 .St -p1003.1-2001
52 standard.
53 .Sh HISTORY
54 The
55 .Fn mq_close
56 function first appeared in
57 .Nx 5.0 .
58 .Sh COPYRIGHT
59 Portions of this text are reprinted and reproduced in electronic form
60 from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
61 -- Portable Operating System Interface (POSIX), The Open Group Base
62 Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
63 Electrical and Electronics Engineers, Inc and The Open Group.
64 In the
65 event of any discrepancy between this version and the original IEEE and
66 The Open Group Standard, the original IEEE and The Open Group Standard
67 is the referee document.
68 The original Standard can be obtained online at
69 http://www.opengroup.org/unix/online.html .