summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3p/sigismember.3p
blob: 0bc53d4e0837f90488e75dc491e6235659d6fbbf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
'\" et
.TH SIGISMEMBER "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\"
.SH PROLOG
This manual page is part of the POSIX Programmer's Manual.
The Linux implementation of this interface may differ (consult
the corresponding Linux manual page for details of Linux behavior),
or the interface may not be implemented on Linux.
.\"
.SH NAME
sigismember
\(em test for a signal in a signal set
.SH SYNOPSIS
.LP
.nf
#include <signal.h>
.P
int sigismember(const sigset_t *\fIset\fP, int \fIsigno\fP);
.fi
.SH DESCRIPTION
The
\fIsigismember\fR()
function shall test whether the signal specified by
.IR signo
is a member of the set pointed to by
.IR set .
.P
Applications should call either
\fIsigemptyset\fR()
or
\fIsigfillset\fR()
at least once for each object of type
.BR sigset_t
prior to any other use of that object. If such an object is not
initialized in this way, but is nonetheless supplied as an argument to
any of
\fIpthread_sigmask\fR(),
\fIsigaction\fR(),
\fIsigaddset\fR(),
\fIsigdelset\fR(),
\fIsigismember\fR(),
\fIsigpending\fR(),
\fIsigprocmask\fR(),
\fIsigsuspend\fR(),
\fIsigtimedwait\fR(),
\fIsigwait\fR(),
or
\fIsigwaitinfo\fR(),
the results are undefined.
.SH "RETURN VALUE"
Upon successful completion,
\fIsigismember\fR()
shall return 1 if the specified signal is a member of the specified set,
or 0 if it is not. Otherwise, it shall return \-1 and set
.IR errno
to indicate the error.
.SH ERRORS
The
\fIsigismember\fR()
function may fail if:
.TP
.BR EINVAL
The
.IR signo
argument is not a valid signal number, or is an unsupported signal
number.
.LP
.IR "The following sections are informative."
.SH EXAMPLES
None.
.SH "APPLICATION USAGE"
None.
.SH RATIONALE
None.
.SH "FUTURE DIRECTIONS"
None.
.SH "SEE ALSO"
.IR "Section 2.4" ", " "Signal Concepts",
.IR "\fIpthread_sigmask\fR\^(\|)",
.IR "\fIsigaction\fR\^(\|)",
.IR "\fIsigaddset\fR\^(\|)",
.IR "\fIsigdelset\fR\^(\|)",
.IR "\fIsigfillset\fR\^(\|)",
.IR "\fIsigemptyset\fR\^(\|)",
.IR "\fIsigpending\fR\^(\|)",
.IR "\fIsigsuspend\fR\^(\|)"
.P
The Base Definitions volume of POSIX.1\(hy2017,
.IR "\fB<signal.h>\fP"
.\"
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1-2017, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 7, 2018 Edition,
Copyright (C) 2018 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group.
In the event of any discrepancy between this version and the original IEEE and
The Open Group Standard, the original IEEE and The Open Group Standard
is the referee document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html .
.PP
Any typographical or formatting errors that appear
in this page are most likely
to have been introduced during the conversion of the source files to
man page format. To report such errors, see
https://www.kernel.org/doc/man-pages/reporting_bugs.html .