usr/src/man/man3c/mq_unlink.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_UNLINK 3C "Feb 5, 2008"
  48 .SH NAME
  49 mq_unlink \- remove a message queue
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <mqueue.h>
  54
  55 \fBint\fR \fBmq_unlink\fR(\fBconst char *\fR\fIname\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBmq_unlink()\fR function removes the message queue named by the pathname
  62 \fIname\fR. After a successful call to \fBmq_unlink()\fR with \fIname\fR, a
  63 call to \fBmq_open\fR(3C) with \fIname\fR fails if the flag \fBO_CREAT\fR is
  64 not set in \fIflags\fR. If one or more processes have the message queue open
  65 when \fBmq_unlink()\fR is called, destruction of the message queue is postponed
  66 until all references to the message queue have been closed. Calls to
  67 \fBmq_open\fR(3C) to re-create the message queue may fail until the message
  68 queue is actually removed. However, the \fBmq_unlink()\fR call need not block
  69 until all references have been closed; it may return immediately.
  70 .SH RETURN VALUES
  71 .sp
  72 .LP
  73 Upon successful completion, \fBmq_unlink()\fR returns \fB0\fR; otherwise, the
  74 named message queue is not changed by this function call, the function returns
  75 \fB\(mi1\fR and sets \fBerrno\fR to indicate the error.
  76 .SH ERRORS
  77 .sp
  78 .LP
  79 The  \fBmq_unlink()\fR function will fail if:
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBEACCES\fR \fR
  84 .ad
  85 .RS 17n
  86 Permission is denied to unlink the named message queue.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fBENAMETOOLONG\fR \fR
  93 .ad
  94 .RS 17n
  95 The length of the \fIname\fR string exceeds  \fBPATH_MAX\fR, or a pathname
  96 component is longer than  \fINAME_MAX\fR while  \fB_POSIX_NO_TRUNC\fR is in
  97 effect.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fBENOENT\fR \fR
 104 .ad
 105 .RS 17n
 106 The named message queue, \fIname\fR, does not exist.
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fBENOSYS\fR \fR
 113 .ad
 114 .RS 17n
 115 \fBmq_unlink()\fR is not supported by the system.
 116 .RE
 117
 118 .SH ATTRIBUTES
 119 .sp
 120 .LP
 121 See \fBattributes\fR(5) for descriptions of the following attributes:
 122 .sp
 123
 124 .sp
 125 .TS
 126 box;
 127 c | c
 128 l | l .
 129 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 130 _
 131 Interface Stability     Committed
 132 _
 133 MT-Level        MT-Safe
 134 _
 135 Standard        See \fBstandards\fR(5).
 136 .TE
 137
 138 .SH SEE ALSO
 139 .sp
 140 .LP
 141 \fBmqueue.h\fR(3HEAD), \fBmq_close\fR(3C), \fBmq_open\fR(3C),
 142 \fBattributes\fR(5), \fBstandards\fR(5)
 143 .SH NOTES
 144 .sp
 145 .LP
 146 Solaris 2.6 was the first release to support the Asynchronous Input and Output
 147 option. Prior to this release, this function always returned \fB\(mi1\fR and
 148 set \fBerrno\fR to \fBENOSYS\fR.