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

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" Copyright 1989 AT&T
   4 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
  10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  11 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  12 .TH MQ_UNLINK 3C "Feb 5, 2008"
  13 .SH NAME
  14 mq_unlink \- remove a message queue
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 #include <mqueue.h>
  19
  20 \fBint\fR \fBmq_unlink\fR(\fBconst char *\fR\fIname\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 The \fBmq_unlink()\fR function removes the message queue named by the pathname
  27 \fIname\fR. After a successful call to \fBmq_unlink()\fR with \fIname\fR, a
  28 call to \fBmq_open\fR(3C) with \fIname\fR fails if the flag \fBO_CREAT\fR is
  29 not set in \fIflags\fR. If one or more processes have the message queue open
  30 when \fBmq_unlink()\fR is called, destruction of the message queue is postponed
  31 until all references to the message queue have been closed. Calls to
  32 \fBmq_open\fR(3C) to re-create the message queue may fail until the message
  33 queue is actually removed. However, the \fBmq_unlink()\fR call need not block
  34 until all references have been closed; it may return immediately.
  35 .SH RETURN VALUES
  36 .sp
  37 .LP
  38 Upon successful completion, \fBmq_unlink()\fR returns \fB0\fR; otherwise, the
  39 named message queue is not changed by this function call, the function returns
  40 \fB\(mi1\fR and sets \fBerrno\fR to indicate the error.
  41 .SH ERRORS
  42 .sp
  43 .LP
  44 The  \fBmq_unlink()\fR function will fail if:
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fBEACCES\fR \fR
  49 .ad
  50 .RS 17n
  51 Permission is denied to unlink the named message queue.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBENAMETOOLONG\fR \fR
  58 .ad
  59 .RS 17n
  60 The length of the \fIname\fR string exceeds  \fBPATH_MAX\fR, or a pathname
  61 component is longer than  \fINAME_MAX\fR while  \fB_POSIX_NO_TRUNC\fR is in
  62 effect.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBENOENT\fR \fR
  69 .ad
  70 .RS 17n
  71 The named message queue, \fIname\fR, does not exist.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fBENOSYS\fR \fR
  78 .ad
  79 .RS 17n
  80 \fBmq_unlink()\fR is not supported by the system.
  81 .RE
  82
  83 .SH ATTRIBUTES
  84 .sp
  85 .LP
  86 See \fBattributes\fR(5) for descriptions of the following attributes:
  87 .sp
  88
  89 .sp
  90 .TS
  91 box;
  92 c | c
  93 l | l .
  94 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  95 _
  96 Interface Stability     Committed
  97 _
  98 MT-Level        MT-Safe
  99 _
 100 Standard        See \fBstandards\fR(5).
 101 .TE
 102
 103 .SH SEE ALSO
 104 .sp
 105 .LP
 106 \fBmqueue.h\fR(3HEAD), \fBmq_close\fR(3C), \fBmq_open\fR(3C),
 107 \fBattributes\fR(5), \fBstandards\fR(5)
 108 .SH NOTES
 109 .sp
 110 .LP
 111 Solaris 2.6 was the first release to support the Asynchronous Input and Output
 112 option. Prior to this release, this function always returned \fB\(mi1\fR and
 113 set \fBerrno\fR to \fBENOSYS\fR.