usr/src/man/man3c/pthread_equal.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright 1991, 1992, 1994, The X/Open Company Ltd.
  44 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  45 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
  46 .\"
  47 .TH PTHREAD_EQUAL 3C "Mar 23, 2005"
  48 .SH NAME
  49 pthread_equal \- compare thread IDs
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 cc -mt [ \fIflag\fR... ] \fIfile\fR... -lpthread [ \fIlibrary\fR... ]
  54 #include <pthread.h>
  55
  56 \fBint\fR \fBpthread_equal\fR(\fBpthread_t\fR \fIt1\fR, \fBpthread_t\fR \fIt2\fR);
  57 .fi
  58
  59 .SH DESCRIPTION
  60 .sp
  61 .LP
  62 The \fBpthread_equal()\fR function compares the thread \fBIDs\fR \fIt1\fR and
  63 \fIt2\fR.
  64 .SH RETURN VALUES
  65 .sp
  66 .LP
  67 The \fBpthread_equal()\fR function returns a non-zero value if \fIt1\fR and
  68 \fIt2\fR are equal. Otherwise,  \fB0\fR is returned.
  69 .sp
  70 .LP
  71 If  \fIt1\fR or \fIt2\fR is an invalid thread  \fBID,\fR the behavior is
  72 undefined.
  73 .SH ERRORS
  74 .sp
  75 .LP
  76 No errors are defined.
  77 .SH ATTRIBUTES
  78 .sp
  79 .LP
  80 See \fBattributes\fR(5) for descriptions of the following attributes:
  81 .sp
  82
  83 .sp
  84 .TS
  85 box;
  86 c | c
  87 l | l .
  88 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  89 _
  90 Interface Stability     Standard
  91 _
  92 MT-Level        MT-Safe
  93 .TE
  94
  95 .SH SEE ALSO
  96 .sp
  97 .LP
  98 \fBpthread_create\fR(3C), \fBpthread_self\fR(3C), \fBattributes\fR(5),
  99 \fBstandards\fR(5)
 100 .SH NOTES
 101 .sp
 102 .LP
 103 Solaris thread \fBIDs\fR do not require an equivalent function because the
 104 \fBthread_t\fR structure is an unsigned int.