usr/src/man/man3c/mq_close.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright 1989 AT&T
  44 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
  45 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved
  46 .\"
  47 .TH MQ_CLOSE 3C "Feb 5, 2008"
  48 .SH NAME
  49 mq_close \- close a message queue
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <mqueue.h>
  54
  55 \fBint\fR \fBmq_close\fR(\fBmqd_t\fR \fImqdes\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBmq_close()\fR function removes the association between the message queue
  62 descriptor, \fImqdes\fR, and its message queue. The results of using this
  63 message queue descriptor after successful return from this \fBmq_close()\fR,
  64 and until the return of this message queue descriptor from a subsequent
  65 \fBmq_open\fR(3C), are undefined.
  66 .sp
  67 .LP
  68 If the process (or thread) has successfully attached a notification request to
  69 the message queue via this \fImqdes\fR, this attachment is removed and the
  70 message queue is available for another process to attach for notification.
  71 .SH RETURN VALUES
  72 .sp
  73 .LP
  74 Upon successful completion, \fBmq_close()\fR returns \fB0\fR; otherwise, the
  75 function returns \fB\(mi1\fR and sets \fBerrno\fR to indicate the error
  76 condition.
  77 .SH ERRORS
  78 .sp
  79 .LP
  80 The  \fBmq_close()\fR function will fail if:
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBEBADF\fR \fR
  85 .ad
  86 .RS 11n
  87 The \fImqdes\fR argument is an invalid message queue descriptor.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBENOSYS\fR \fR
  94 .ad
  95 .RS 11n
  96 The \fBmq_open()\fR function is not supported by the system.
  97 .RE
  98
  99 .SH ATTRIBUTES
 100 .sp
 101 .LP
 102 See \fBattributes\fR(5) for descriptions of the following attributes:
 103 .sp
 104
 105 .sp
 106 .TS
 107 box;
 108 c | c
 109 l | l .
 110 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 111 _
 112 Interface Stability     Committed
 113 _
 114 MT-Level        MT-Safe
 115 _
 116 Standard        See \fBstandards\fR(5).
 117 .TE
 118
 119 .SH SEE ALSO
 120 .sp
 121 .LP
 122 \fBmqueue.h\fR(3HEAD), \fBmq_notify\fR(3C), \fBmq_open\fR(3C),
 123 \fBmq_unlink\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)
 124 .SH NOTES
 125 .sp
 126 .LP
 127 Solaris 2.6 was the first release to support the Asynchronous Input and Output
 128 option. Prior to this release, this function always returned \fB\(mi1\fR and
 129 set \fBerrno\fR to \fBENOSYS\fR.