original/man3/pthread_equal.3

   1 .\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
   2 .\"     <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   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.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .TH PTHREAD_EQUAL 3 2014-05-23 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 pthread_equal \- compare thread IDs
  29 .SH SYNOPSIS
  30 .nf
  31 .B #include <pthread.h>
  32
  33 .BI "int pthread_equal(pthread_t " t1 ", pthread_t " t2 );
  34 .sp
  35 Compile and link with \fI\-pthread\fP.
  36 .fi
  37 .SH DESCRIPTION
  38 The
  39 .BR pthread_equal ()
  40 function compares two thread identifiers.
  41 .SH RETURN VALUE
  42 If the two thread IDs are equal,
  43 .BR pthread_equal ()
  44 returns a nonzero value; otherwise, it returns 0.
  45 .SH ERRORS
  46 This function always succeeds.
  47 .SH ATTRIBUTES
  48 .SS Multithreading (see pthreads(7))
  49 The
  50 .BR pthread_equal ()
  51 function is thread-safe.
  52 .SH CONFORMING TO
  53 POSIX.1-2001.
  54 .SH NOTES
  55 The
  56 .BR pthread_equal ()
  57 function is necessary because thread IDs should be considered opaque:
  58 there is no portable way for applications to directly compare two
  59 .I pthread_t
  60 values.
  61 .SH SEE ALSO
  62 .BR pthread_create (3),
  63 .BR pthread_self (3),
  64 .BR pthreads (7)
  65 .SH COLOPHON
  66 This page is part of release 3.79 of the Linux
  67 .I man-pages
  68 project.
  69 A description of the project,
  70 information about reporting bugs,
  71 and the latest version of this page,
  72 can be found at
  73 \%http://www.kernel.org/doc/man\-pages/.