xref: /freebsd/lib/libsys/sigpending.2 (revision 783d3ff6)
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.Dd September 6, 2013
32.Dt SIGPENDING 2
33.Os
34.Sh NAME
35.Nm sigpending
36.Nd get pending signals
37.Sh LIBRARY
38.Lb libc
39.Sh SYNOPSIS
40.In signal.h
41.Ft int
42.Fn sigpending "sigset_t *set"
43.Sh DESCRIPTION
44The
45.Fn sigpending
46system call returns a mask of the signals pending for delivery
47to the calling thread or the calling process in the location indicated by
48.Fa set .
49Signals may be pending because they are currently masked,
50or transiently before delivery (although the latter case is not
51normally detectable).
52.Sh RETURN VALUES
53.Rv -std sigpending
54.Sh ERRORS
55The
56.Fn sigpending
57system call
58will fail if:
59.Bl -tag -width Er
60.It Bq Er EFAULT
61The
62.Fa set
63argument specified an invalid address.
64.El
65.Sh SEE ALSO
66.Xr sigaction 2 ,
67.Xr sigprocmask 2 ,
68.Xr sigsuspend 2 ,
69.Xr sigsetops 3
70.Sh STANDARDS
71The
72.Fn sigpending
73system call is expected to conform to
74.St -p1003.1-90 .
75