lib/libc/sys/sigpending.2

   1 .\"     $NetBSD: sigpending.2,v 1.15 2008/10/24 15:40:21 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to Berkeley by
   7 .\" Berkeley Software Design, Inc.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\" 3. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\"
  33 .\"     @(#)sigpending.2        8.3 (Berkeley) 1/12/94
  34 .\"
  35 .Dd October 24, 2008
  36 .Dt SIGPENDING 2
  37 .Os
  38 .Sh NAME
  39 .Nm sigpending
  40 .Nd get pending signals
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In signal.h
  45 .Ft int
  46 .Fn sigpending "sigset_t *set"
  47 .Sh DESCRIPTION
  48 The
  49 .Nm sigpending
  50 function returns a mask of the signals pending for delivery
  51 to the calling process in the location indicated by
  52 .Fa set .
  53 Signals may be pending because they are currently masked,
  54 or they are in transition before delivery (although the latter case is not
  55 normally detectable).
  56 .Sh RETURN VALUES
  57 A 0 value indicates that the call succeeded.
  58 A \-1 return value indicates an error occurred and
  59 .Va errno
  60 is set to indicate the reason.
  61 .Sh ERRORS
  62 .Fn sigpending
  63 will fail if:
  64 .Bl -tag -width Er
  65 .It Bq Er EFAULT
  66 .Fa set
  67 specifies an invalid address.
  68 .El
  69 .Sh SEE ALSO
  70 .Xr sigaction 2 ,
  71 .Xr sigprocmask 2 ,
  72 .Xr signal 7
  73 .Sh STANDARDS
  74 The
  75 .Nm sigpending
  76 function conforms to
  77 .St -p1003.1-90 .