usr/src/man/man3c/sem_destroy.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 SEM_DESTROY 3C "Feb 5, 2008"
  48 .SH NAME
  49 sem_destroy \- destroy an unnamed semaphore
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <semaphore.h>
  54
  55 \fBint\fR \fBsem_destroy\fR(\fBsem_t *\fR\fIsem\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBsem_destroy()\fR function is used to destroy the unnamed semaphore
  62 indicated by \fIsem\fR. Only a semaphore that was created using
  63 \fBsem_init\fR(3C) may be destroyed using \fBsem_destroy()\fR; the effect of
  64 calling \fBsem_destroy()\fR with a named semaphore is undefined. The effect of
  65 subsequent use of the semaphore \fIsem\fR is undefined until \fIsem\fR is
  66 re-initialized by another call to \fBsem_init\fR(3C).
  67 .sp
  68 .LP
  69 It is safe to destroy an initialised semaphore upon which no threads are
  70 currently blocked. The effect of destroying a semaphore upon which other
  71 threads  are currently blocked is undefined.
  72 .SH RETURN VALUES
  73 .sp
  74 .LP
  75 If successful, \fBsem_destroy()\fR returns \fB0\fR, otherwise it returns
  76 \fB\(mi1\fR and sets \fBerrno\fR to indicate the error.
  77 .SH ERRORS
  78 .sp
  79 .LP
  80 The  \fBsem_destroy()\fR function will fail if:
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBEINVAL\fR \fR
  85 .ad
  86 .RS 11n
  87 The \fIsem\fR argument is not a valid semaphore.
  88 .RE
  89
  90 .sp
  91 .LP
  92 The \fBsem_destroy()\fR function may fail if:
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBEBUSY\fR \fR
  97 .ad
  98 .RS 10n
  99 There are currently processes (or LWPs or threads) blocked on the semaphore.
 100 .RE
 101
 102 .SH ATTRIBUTES
 103 .sp
 104 .LP
 105 See \fBattributes\fR(5) for descriptions of the following attributes:
 106 .sp
 107
 108 .sp
 109 .TS
 110 box;
 111 l | l
 112 l | l .
 113 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 114 _
 115 Interface Stability     Committed
 116 _
 117 MT-Level        MT-Safe
 118 _
 119 Standard        See \fBstandards\fR(5).
 120 .TE
 121
 122 .SH SEE ALSO
 123 .sp
 124 .LP
 125 \fBsem_init\fR(3C), \fBsem_open\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)