summaryrefslogtreecommitdiffstats
path: root/man3/pthread_equal.3
blob: 8777e682b85314b19eafcb6cad5f6bc7421f2a1d (plain) (blame)
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
'\" t
.\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
.\"     <mtk.manpages@gmail.com>
.\"
.\" SPDX-License-Identifier: Linux-man-pages-copyleft
.\"
.TH pthread_equal 3 (date) "Linux man-pages (unreleased)"
.SH NAME
pthread_equal \- compare thread IDs
.SH LIBRARY
POSIX threads library
.RI ( libpthread ", " \-lpthread )
.SH SYNOPSIS
.nf
.B #include <pthread.h>
.PP
.BI "int pthread_equal(pthread_t " t1 ", pthread_t " t2 );
.fi
.SH DESCRIPTION
The
.BR pthread_equal ()
function compares two thread identifiers.
.SH RETURN VALUE
If the two thread IDs are equal,
.BR pthread_equal ()
returns a nonzero value; otherwise, it returns 0.
.SH ERRORS
This function always succeeds.
.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
.ad l
.nh
.TS
allbox;
lbx lb lb
l l l.
Interface	Attribute	Value
T{
.BR pthread_equal ()
T}	Thread safety	MT-Safe
.TE
.hy
.ad
.sp 1
.SH STANDARDS
POSIX.1-2008.
.SH HISTORY
POSIX.1-2001.
.SH NOTES
The
.BR pthread_equal ()
function is necessary because thread IDs should be considered opaque:
there is no portable way for applications to directly compare two
.I pthread_t
values.
.SH SEE ALSO
.BR pthread_create (3),
.BR pthread_self (3),
.BR pthreads (7)