usr/src/man/man3c/sem_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 SEM_UNLINK 3C "Feb 5, 2008"
  13 .SH NAME
  14 sem_unlink \- remove a named semaphore
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 #include <semaphore.h>
  19
  20 \fBint\fR \fBsem_unlink\fR(\fBconst char *\fR\fIname\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 The \fBsem_unlink()\fR function removes the semaphore named by the string
  27 \fIname\fR. If the semaphore named by \fIname\fR is currently referenced by
  28 other processes, then \fBsem_unlink()\fR has no effect on the state of the
  29 semaphore.  If one or more processes have the semaphore open when
  30 \fBsem_unlink()\fR is called, destruction of the semaphore is postponed until
  31 all references to the semaphore have been destroyed by calls to
  32 \fBsem_close\fR(3C), \fB_Exit\fR(2), or one of the \fBexec\fR functions (see
  33 \fBexec\fR(2)) . Calls to \fBsem_open\fR(3C) to re-create or re-connect to the
  34 semaphore refer to a new semaphore after  \fBsem_unlink()\fR is called.  The
  35 \fBsem_unlink()\fR call does not block until all references have been
  36 destroyed; it returns immediately.
  37 .SH RETURN VALUES
  38 .sp
  39 .LP
  40 Upon successful completion, \fBsem_unlink()\fR returns \fB0\fR. Otherwise, the
  41 semaphore is not changed and the function returns a value of \fB\(mi1\fR and
  42 sets \fBerrno\fR to indicate the error.
  43 .SH ERRORS
  44 .sp
  45 .LP
  46 The  \fBsem_unlink()\fR function will fail if:
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBEACCES\fR \fR
  51 .ad
  52 .RS 17n
  53 Permission is denied to unlink the named semaphore.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fBENAMETOOLONG\fR \fR
  60 .ad
  61 .RS 17n
  62 The length of \fIname\fR string exceeds \fIPATH_MAX\fR, or a pathname component
  63 is longer than \fINAME_MAX\fR while \fB_POSIX_NO_TRUNC\fR is in effect.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBENOENT\fR \fR
  70 .ad
  71 .RS 17n
  72 The named semaphore does not exist.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBENOSYS\fR \fR
  79 .ad
  80 .RS 17n
  81 The \fBsem_unlink()\fR function is not supported by the system.
  82 .RE
  83
  84 .SH ATTRIBUTES
  85 .sp
  86 .LP
  87 See \fBattributes\fR(5) for descriptions of the following attributes:
  88 .sp
  89
  90 .sp
  91 .TS
  92 box;
  93 c | c
  94 l | l .
  95 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  96 _
  97 Interface Stability     Committed
  98 _
  99 MT-Level        MT-Safe
 100 _
 101 Standard        See \fBstandards\fR(5).
 102 .TE
 103
 104 .SH SEE ALSO
 105 .sp
 106 .LP
 107 \fBexec\fR(2), \fBexit\fR(2), \fBsem_close\fR(3C), \fBsem_open\fR(3C),
 108 \fBattributes\fR(5), \fBstandards\fR(5)
 109 .SH NOTES
 110 .sp
 111 .LP
 112 Solaris 2.6 was the first release to support the Asynchronous Input and Output
 113 option. Prior to this release, this function always returned \fB\(mi1\fR and
 114 set \fBerrno\fR to \fBENOSYS\fR.