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

126 lines
4.1 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>pthread_equal</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
</script>
<basefont size="3"> <a name="pthread_equal"></a> <a name="tag_03_527"></a><!-- pthread_equal -->
<!--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_527_01"></a>NAME</h4>
<blockquote>pthread_equal - compare thread IDs</blockquote>
<h4><a name="tag_03_527_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<div class="box"><code><tt><sup>[<a href="javascript:open_code('THR')">THR</a>]</sup> <img src="../images/opt-start.gif" alt=
"[Option Start]" border="0"> #include &lt;<a href="../basedefs/pthread.h.html">pthread.h</a>&gt;<br>
<br>
int pthread_equal(pthread_t</tt> <i>t1</i><tt>, pthread_t</tt> <i>t2</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_527_03"></a>DESCRIPTION</h4>
<blockquote>
<p>This function shall compare the thread IDs <i>t1</i> and <i>t2</i>.</p>
</blockquote>
<h4><a name="tag_03_527_04"></a>RETURN VALUE</h4>
<blockquote>
<p>The <i>pthread_equal</i>() function shall return a non-zero value if <i>t1</i> and <i>t2</i> are equal; otherwise, zero shall be
returned.</p>
<p>If either <i>t1</i> or <i>t2</i> are not valid thread IDs, the behavior is undefined.</p>
</blockquote>
<h4><a name="tag_03_527_05"></a>ERRORS</h4>
<blockquote>
<p>No errors are defined.</p>
<p>The <i>pthread_equal</i>() function shall not return an error code of [EINTR].</p>
</blockquote>
<hr>
<div class="box"><em>The following sections are informative.</em></div>
<h4><a name="tag_03_527_06"></a>EXAMPLES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_527_07"></a>APPLICATION USAGE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_527_08"></a>RATIONALE</h4>
<blockquote>
<p>Implementations may choose to define a thread ID as a structure. This allows additional flexibility and robustness over using an
<b>int</b>. For example, a thread ID could include a sequence number that allows detection of &quot;dangling IDs&quot; (copies of a thread
ID that has been detached). Since the C language does not support comparison on structure types, the <i>pthread_equal</i>()
function is provided to compare thread IDs.</p>
</blockquote>
<h4><a name="tag_03_527_09"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_527_10"></a>SEE ALSO</h4>
<blockquote>
<p><a href="pthread_create.html"><i>pthread_create</i>()</a> , <a href="pthread_self.html"><i>pthread_self</i>()</a> , the Base
Definitions volume of IEEE&nbsp;Std&nbsp;1003.1-2001, <a href="../basedefs/pthread.h.html"><i>&lt;pthread.h&gt;</i></a></p>
</blockquote>
<h4><a name="tag_03_527_11"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 5. Included for alignment with the POSIX Threads Extension.</p>
</blockquote>
<h4><a name="tag_03_527_12"></a>Issue 6</h4>
<blockquote>
<p>The <i>pthread_equal</i>() function is marked as part of the Threads option.</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>