Files
oldlinux-files/Ref-docs/POSIX/susv3/functions/sigismember.html
2024-02-19 00:21:47 -05:00

147 lines
5.5 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="generator" content="HTML Tidy, see www.w3.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
<title>sigismember</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
</script>
<basefont size="3"> <a name="sigismember"></a> <a name="tag_03_688"></a><!-- sigismember -->
<!--header start-->
<center><font size="2">The Open Group Base Specifications Issue 6<br>
IEEE Std 1003.1-2001<br>
Copyright &copy; 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
<!--header end-->
<hr size="2" noshade>
<h4><a name="tag_03_688_01"></a>NAME</h4>
<blockquote>sigismember - test for a signal in a signal set</blockquote>
<h4><a name="tag_03_688_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<div class="box"><code><tt><sup>[<a href="javascript:open_code('CX')">CX</a>]</sup> <img src="../images/opt-start.gif" alt=
"[Option Start]" border="0"> #include &lt;<a href="../basedefs/signal.h.html">signal.h</a>&gt;<br>
<br>
int sigismember(const sigset_t *</tt><i>set</i><tt>, int</tt> <i>signo</i><tt>); <img src="../images/opt-end.gif" alt=
"[Option End]" border="0"></tt></code></div>
<tt><br>
</tt></blockquote>
<h4><a name="tag_03_688_03"></a>DESCRIPTION</h4>
<blockquote>
<p>The <i>sigismember</i>() function shall test whether the signal specified by <i>signo</i> is a member of the set pointed to by
<i>set</i>.</p>
<p>Applications should call either <a href="../functions/sigemptyset.html"><i>sigemptyset</i>()</a> or <a href=
"../functions/sigfillset.html"><i>sigfillset</i>()</a> at least once for each object of type <b>sigset_t</b> 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 <a href=
"../functions/pthread_sigmask.html"><i>pthread_sigmask</i>()</a>, <a href="../functions/sigaction.html"><i>sigaction</i>()</a>, <a
href="../functions/sigaddset.html"><i>sigaddset</i>()</a>, <a href="../functions/sigdelset.html"><i>sigdelset</i>()</a>,
<i>sigismember</i>(), <a href="../functions/sigpending.html"><i>sigpending</i>()</a>, <a href=
"../functions/sigprocmask.html"><i>sigprocmask</i>()</a>, <a href="../functions/sigsuspend.html"><i>sigsuspend</i>()</a>, <a href=
"../functions/sigtimedwait.html"><i>sigtimedwait</i>()</a>, <a href="../functions/sigwait.html"><i>sigwait</i>()</a>, or <a href=
"../functions/sigwaitinfo.html"><i>sigwaitinfo</i>()</a>, the results are undefined.</p>
</blockquote>
<h4><a name="tag_03_688_04"></a>RETURN VALUE</h4>
<blockquote>
<p>Upon successful completion, <i>sigismember</i>() 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 <i>errno</i> to indicate the error.</p>
</blockquote>
<h4><a name="tag_03_688_05"></a>ERRORS</h4>
<blockquote>
<p>The <i>sigismember</i>() function may fail if:</p>
<dl compact>
<dt>[EINVAL]</dt>
<dd>The <i>signo</i> argument is not a valid signal number, or is an unsupported signal number.</dd>
</dl>
</blockquote>
<hr>
<div class="box"><em>The following sections are informative.</em></div>
<h4><a name="tag_03_688_06"></a>EXAMPLES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_688_07"></a>APPLICATION USAGE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_688_08"></a>RATIONALE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_688_09"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_688_10"></a>SEE ALSO</h4>
<blockquote>
<p><a href="xsh_chap02_04.html#tag_02_04"><i>Signal Concepts</i></a> , <a href="sigaction.html"><i>sigaction</i>()</a> , <a href=
"sigaddset.html"><i>sigaddset</i>()</a> , <a href="sigdelset.html"><i>sigdelset</i>()</a> , <a href=
"sigfillset.html"><i>sigfillset</i>()</a> , <a href="sigemptyset.html"><i>sigemptyset</i>()</a> , <a href=
"sigpending.html"><i>sigpending</i>()</a> , <a href="sigprocmask.html"><i>sigprocmask</i>()</a> , <a href=
"sigsuspend.html"><i>sigsuspend</i>()</a> , the Base Definitions volume of IEEE&nbsp;Std&nbsp;1003.1-2001, <a href=
"../basedefs/signal.h.html"><i>&lt;signal.h&gt;</i></a></p>
</blockquote>
<h4><a name="tag_03_688_11"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 3. Included for alignment with the POSIX.1-1988 standard.</p>
</blockquote>
<h4><a name="tag_03_688_12"></a>Issue 5</h4>
<blockquote>
<p>The last paragraph of the DESCRIPTION was included as an APPLICATION USAGE note in previous issues.</p>
</blockquote>
<h4><a name="tag_03_688_13"></a>Issue 6</h4>
<blockquote>
<p>The SYNOPSIS is marked CX since the presence of this function in the <a href=
"../basedefs/signal.h.html"><i>&lt;signal.h&gt;</i></a> header is an extension over the ISO&nbsp;C standard.</p>
</blockquote>
<div class="box"><em>End of informative text.</em></div>
<hr>
<hr size="2" noshade>
<center><font size="2"><!--footer start-->
UNIX &reg; is a registered Trademark of The Open Group.<br>
POSIX &reg; is a registered Trademark of The IEEE.<br>
[ <a href="../mindex.html">Main Index</a> | <a href="../basedefs/contents.html">XBD</a> | <a href=
"../utilities/contents.html">XCU</a> | <a href="../functions/contents.html">XSH</a> | <a href="../xrat/contents.html">XRAT</a>
]</font></center>
<!--footer end-->
<hr size="2" noshade>
</body>
</html>