lib/libpthread/man/sem_destroy.3

   1 .\" Copyright (C) 2000 Jason Evans <jasone@freebsd.org>.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice(s), this list of conditions and the following disclaimer as
   9 .\"    the first lines of this file unmodified other than the possible
  10 .\"    addition of one or more copyright notices.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice(s), this list of conditions and the following disclaimer in
  13 .\"    the documentation and/or other materials provided with the
  14 .\"    distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
  17 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
  20 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  23 .\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  24 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  25 .\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  26 .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .Dd February 15, 2000
  30 .Dt SEM_DESTROY 3
  31 .Os
  32 .Sh NAME
  33 .Nm sem_destroy
  34 .Nd destroy an unnamed semaphore
  35 .Sh LIBRARY
  36 .Lb libc_r
  37 .Sh SYNOPSIS
  38 .Fd #include <semaphore.h>
  39 .Ft int
  40 .Fn sem_destroy "sem_t *sem"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn sem_destroy
  44 function destroys the unnamed semaphore pointed to by
  45 .Fa sem .
  46 After a successful call to
  47 .Fn sem_destroy ,
  48 .Fa sem
  49 is unuseable until re-initialized by another call to
  50 .Fn sem_init .
  51 .Sh RETURN VALUES
  52 If successful,
  53 .Fn sem_destroy
  54 returns 0.  Otherwise, -1 is returned and
  55 .Va errno
  56 is set to indicate the type of
  57 error.
  58 .Sh ERRORS
  59 .Fn sem_destroy
  60 will fail if:
  61 .Bl -tag -width Er
  62 .It Bq Er EINVAL
  63 .Fa sem
  64 points to an invalid semaphore.
  65 .It Bq Er EBUSY
  66 There are currently threads blocked on the semaphore that
  67 .Fa sem
  68 points to.
  69 .El
  70 .Sh SEE ALSO
  71 .Xr sem_init 3
  72 .Sh STANDARDS
  73 .Fn sem_destroy
  74 conforms to ISO/IEC 9945-1 ANSI/IEEE
  75 .Pq Dq Tn POSIX
  76 Std 1003.1 1996 Edition.
  77 .Pp
  78 POSIX does not define the behavior of
  79 .Fn sem_destroy
  80 if called while there are threads blocked on
  81 .Fa sem ,
  82 but this implementation is guaranteed to return -1 and set
  83 .Va errno
  84 to
  85 .Er EBUSY
  86 if there are threads blocked on
  87 .Fa sem .