original/man3/sem_getvalue.3

   1 '\" t
   2 .\" Hey Emacs! This file is -*- nroff -*- source.
   3 .\"
   4 .\" Copyright (C) 2006 Michael Kerrisk <mtk.manpages@gmail.com>
   5 .\"
   6 .\" Permission is granted to make and distribute verbatim copies of this
   7 .\" manual provided the copyright notice and this permission notice are
   8 .\" preserved on all copies.
   9 .\"
  10 .\" Permission is granted to copy and distribute modified versions of this
  11 .\" manual under the conditions for verbatim copying, provided that the
  12 .\" entire resulting derived work is distributed under the terms of a
  13 .\" permission notice identical to this one.
  14 .\"
  15 .\" Since the Linux kernel and libraries are constantly changing, this
  16 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  17 .\" responsibility for errors or omissions, or for damages resulting from
  18 .\" the use of the information contained herein.  The author(s) may not
  19 .\" have taken the same level of care in the production of this manual,
  20 .\" which is licensed free of charge, as they might when working
  21 .\" professionally.
  22 .\"
  23 .\" Formatted or processed versions of this manual, if unaccompanied by
  24 .\" the source, must acknowledge the copyright and authors of this work.
  25 .\"
  26 .TH SEM_GETVALUE 3 2006-03-25 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 sem_getvalue \- get the value of a semaphore
  29 .SH SYNOPSIS
  30 .nf
  31 .B #include <semaphore.h>
  32 .sp
  33 .BI "int sem_getvalue(sem_t *" sem ", int *" sval );
  34 .fi
  35 .sp
  36 Link with \fI\-lrt\fP or \fI\-pthread\fP.
  37 .SH DESCRIPTION
  38 .BR sem_getvalue ()
  39 places the current value of the semaphore pointed to
  40 .I sem
  41 into the integer pointed to by
  42 .IR sval .
  43
  44 If one or more processes or threads are blocked
  45 waiting to lock the semaphore with
  46 .BR sem_wait (3),
  47 POSIX.1-2001 permits two possibilities for the value returned in
  48 .IR sval :
  49 either 0 is returned;
  50 or a negative number whose absolute value is the count
  51 of the number of processes and threads currently blocked in
  52 .BR sem_wait (3).
  53 Linux adopts the former behavior.
  54 .SH RETURN VALUE
  55 .BR sem_getvalue ()
  56 returns 0 on success;
  57 on error, \-1 is returned and
  58 .I errno
  59 is set to indicate the error.
  60 .SH ERRORS
  61 .TP
  62 .B EINVAL
  63 .I sem
  64 is not a valid semaphore.
  65 .SH CONFORMING TO
  66 POSIX.1-2001.
  67 .SH NOTES
  68 The value of the semaphore may already have changed by the time
  69 .BR sem_getvalue ()
  70 returns.
  71 .SH "SEE ALSO"
  72 .BR sem_post (3),
  73 .BR sem_wait (3),
  74 .BR sem_overview (7)