xref: /netbsd/lib/libc/sys/sigpending.2 (revision bf9ec67e)
1.\"	$NetBSD: sigpending.2,v 1.9 2002/02/08 01:28:22 ross 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. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"	This product includes software developed by the University of
20.\"	California, Berkeley and its contributors.
21.\" 4. Neither the name of the University nor the names of its contributors
22.\"    may be used to endorse or promote products derived from this software
23.\"    without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35.\" SUCH DAMAGE.
36.\"
37.\"	@(#)sigpending.2	8.3 (Berkeley) 1/12/94
38.\"
39.Dd January 12, 1994
40.Dt SIGPENDING 2
41.Os
42.Sh NAME
43.Nm sigpending
44.Nd get pending signals
45.Sh LIBRARY
46.Lb libc
47.Sh SYNOPSIS
48.Fd #include \*[Lt]signal.h\*[Gt]
49.Ft int
50.Fn sigpending "sigset_t *set"
51.Sh DESCRIPTION
52The
53.Nm sigpending
54function returns a mask of the signals pending for delivery
55to the calling process in the location indicated by
56.Fa set .
57Signals may be pending because they are currently masked,
58or they are in transition before delivery (although the latter case is not
59normally detectable).
60.Sh RETURN VALUES
61A 0 value indicates that the call succeeded.  A \-1 return value
62indicates an error occurred and
63.Va errno
64is set to indicate the reason.
65.Sh ERRORS
66The
67.Nm sigpending
68function does not currently detect any errors.
69.Sh SEE ALSO
70.Xr sigaction 2 ,
71.Xr sigprocmask 2 ,
72.Xr signal 7
73.Sh STANDARDS
74The
75.Nm sigpending
76function conforms to
77.St -p1003.1-90 .
78