sys/sem_close.2

   1 .\"     $Darwin$
   2 .\"
   3 .\" Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
   4 .\"
   5 .\" @APPLE_LICENSE_HEADER_START@
   6 .\"
   7 .\" The contents of this file constitute Original Code as defined in and
   8 .\" are subject to the Apple Public Source License Version 1.1 (the
   9 .\" "License").  You may not use this file except in compliance with the
  10 .\" License.  Please obtain a copy of the License at
  11 .\" http://www.apple.com/publicsource and read it before using this file.
  12 .\"
  13 .\" This Original Code and all software distributed under the License are
  14 .\" distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15 .\" EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16 .\" INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17 .\" FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  18 .\" License for the specific language governing rights and limitations
  19 .\" under the License.
  20 .\"
  21 .\" @APPLE_LICENSE_HEADER_END@
  22 .\"
  23 .Dd June 8, 2000
  24 .Dt SEM_CLOSE 2
  25 .Os Darwin
  26 .Sh NAME
  27 .Nm sem_close
  28 .Nd close a named semaphore
  29 .Sh SYNOPSIS
  30 .Fd #include <semaphore.h>
  31 .Ft int
  32 .Fn sem_close "sem_t *sem"
  33 .Sh DESCRIPTION
  34 The system resources associated with the named semaphore referenced by
  35 .Fa sem
  36 are deallocated and the descriptor is invalidated.
  37 .Pp
  38 If successful,
  39 .Fn sem_close
  40 will return 0.  Otherwise, -1 is returned and
  41 .Va errno
  42 is set.
  43 .Sh ERRORS
  44 .Fn sem_close
  45 succeeds unless:
  46 .Bl -tag -width Er
  47 .It Bq Er EINVAL
  48 .Fa sem
  49 is not a valid semaphore descriptor.
  50 .El
  51 .Sh SEE ALSO
  52 .Xr sem_init 2 ,
  53 .Xr sem_open 2 ,
  54 .Xr sem_unlink 2 ,
  55 .Xr semctl 2 ,
  56 .Xr semget 2 ,
  57 .Xr semop 2
  58 .Sh HISTORY
  59 .Fn sem_close
  60 is specified in the POSIX Realtime Extension (1003.1b-1993/1003.1i-1995).