~ubuntu-branches/ubuntu/precise/manpages-posix/precise

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
.\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved 
.TH "SIGISMEMBER" P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\" sigismember 
.SH NAME
sigismember \- test for a signal in a signal set
.SH SYNOPSIS
.LP
\fB#include <signal.h>
.br
.sp
int sigismember(const sigset_t *\fP\fIset\fP\fB, int\fP \fIsigno\fP\fB);
\fP
\fB
.br
\fP
.SH DESCRIPTION
.LP
The \fIsigismember\fP() function shall test whether the signal specified
by \fIsigno\fP is a member of the set pointed to by
\fIset\fP.
.LP
Applications should call either \fIsigemptyset\fP() or \fIsigfillset\fP()
at least once for each object of type \fBsigset_t\fP 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\fP(),
\fIsigaction\fP(), \fIsigaddset\fP(), \fIsigdelset\fP(),
\fIsigismember\fP(), \fIsigpending\fP(), \fIsigprocmask\fP(), \fIsigsuspend\fP(),
\fIsigtimedwait\fP(), \fIsigwait\fP(), or \fIsigwaitinfo\fP(), the
results are undefined.
.SH RETURN VALUE
.LP
Upon successful completion, \fIsigismember\fP() 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 \fIerrno\fP to
indicate the error.
.SH ERRORS
.LP
The \fIsigismember\fP() function may fail if:
.TP 7
.B EINVAL
The \fIsigno\fP argument is not a valid signal number, or is an unsupported
signal number.
.sp
.LP
\fIThe following sections are informative.\fP
.SH EXAMPLES
.LP
None.
.SH APPLICATION USAGE
.LP
None.
.SH RATIONALE
.LP
None.
.SH FUTURE DIRECTIONS
.LP
None.
.SH SEE ALSO
.LP
\fISignal Concepts\fP , \fIsigaction\fP() , \fIsigaddset\fP() , \fIsigdelset\fP()
, \fIsigfillset\fP() , \fIsigemptyset\fP() , \fIsigpending\fP() ,
\fIsigprocmask\fP() , \fIsigsuspend\fP() , the Base Definitions volume
of IEEE\ Std\ 1003.1-2001, \fI<signal.h>\fP
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 6, Copyright (C) 2001-2003 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 .