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