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