]> git.ipfire.org Git - thirdparty/man-pages.git/blame - man3/pthread_equal.3
err.3: EXAMPLES: use EXIT_FAILURE rather than 1 as exit status
[thirdparty/man-pages.git] / man3 / pthread_equal.3
CommitLineData
8c80f3c6
MK
1.\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
2.\" <mtk.manpages@gmail.com>
3.\"
93015253 4.\" %%%LICENSE_START(VERBATIM)
8c80f3c6
MK
5.\" Permission is granted to make and distribute verbatim copies of this
6.\" manual provided the copyright notice and this permission notice are
7.\" preserved on all copies.
8.\"
9.\" Permission is granted to copy and distribute modified versions of this
10.\" manual under the conditions for verbatim copying, provided that the
11.\" entire resulting derived work is distributed under the terms of a
12.\" permission notice identical to this one.
13.\"
14.\" Since the Linux kernel and libraries are constantly changing, this
15.\" manual page may be incorrect or out-of-date. The author(s) assume no
16.\" responsibility for errors or omissions, or for damages resulting from
17.\" the use of the information contained herein. The author(s) may not
18.\" have taken the same level of care in the production of this manual,
19.\" which is licensed free of charge, as they might when working
20.\" professionally.
21.\"
22.\" Formatted or processed versions of this manual, if unaccompanied by
23.\" the source, must acknowledge the copyright and authors of this work.
4b72fb64 24.\" %%%LICENSE_END
8c80f3c6 25.\"
460495ca 26.TH PTHREAD_EQUAL 3 2015-08-08 "Linux" "Linux Programmer's Manual"
8c80f3c6 27.SH NAME
67ca98a7 28pthread_equal \- compare thread IDs
8c80f3c6
MK
29.SH SYNOPSIS
30.nf
31.B #include <pthread.h>
dbfe9c70 32.PP
8c80f3c6 33.BI "int pthread_equal(pthread_t " t1 ", pthread_t " t2 );
68e4db0a 34.PP
8c80f3c6 35Compile and link with \fI\-pthread\fP.
6030f2d8 36.fi
8c80f3c6
MK
37.SH DESCRIPTION
38The
39.BR pthread_equal ()
40function compares two thread identifiers.
41.SH RETURN VALUE
42If the two thread IDs are equal,
43.BR pthread_equal ()
c7094399 44returns a nonzero value; otherwise, it returns 0.
8c80f3c6
MK
45.SH ERRORS
46This function always succeeds.
6b0949f0 47.SH ATTRIBUTES
6333d7c3
PH
48For an explanation of the terms used in this section, see
49.BR attributes (7).
50.TS
51allbox;
52lb lb lb
53l l l.
54Interface Attribute Value
55T{
6b0949f0 56.BR pthread_equal ()
6333d7c3
PH
57T} Thread safety MT-Safe
58.TE
8c80f3c6 59.SH CONFORMING TO
10197a43 60POSIX.1-2001, POSIX.1-2008.
8c80f3c6
MK
61.SH NOTES
62The
63.BR pthread_equal ()
64function is necessary because thread IDs should be considered opaque:
65there is no portable way for applications to directly compare two
66.I pthread_t
67values.
68.SH SEE ALSO
69.BR pthread_create (3),
70.BR pthread_self (3),
71.BR pthreads (7)