xref: /freebsd/share/man/man3/pthread_equal.3 (revision 6b3455a7665208c366849f0b2b3bc916fb97516e)
1.\" Copyright (c) 1996 John Birrell <jb@cimlogic.com.au>.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by John Birrell.
15.\" 4. Neither the name of the author nor the names of any co-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 JOHN BIRRELL 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.\" $FreeBSD$
32.\"
33.Dd April 4, 1996
34.Dt PTHREAD_EQUAL 3
35.Os
36.Sh NAME
37.Nm pthread_equal
38.Nd compare thread IDs
39.Sh LIBRARY
40.Lb libc_r
41.Lb libpthread
42.Lb libthr
43.Sh SYNOPSIS
44.In pthread.h
45.Ft int
46.Fn pthread_equal "pthread_t t1" "pthread_t t2"
47.Sh DESCRIPTION
48The
49.Fn pthread_equal
50function compares the thread IDs
51.Fa t1
52and
53.Fa t2 .
54.Sh RETURN VALUES
55The
56.Fn pthread_equal
57function will return non-zero if the thread IDs
58.Fa t1
59and
60.Fa t2
61correspond to the same thread, otherwise it will return zero.
62.Sh ERRORS
63None.
64.Sh SEE ALSO
65.Xr pthread_create 3 ,
66.Xr pthread_exit 3
67.Sh STANDARDS
68The
69.Fn pthread_equal
70function conforms to
71.St -p1003.1-96 .
72