xref: /freebsd/share/man/man3/pthread_equal.3 (revision 0f7d684755aefbcfd70b45d24efc2d39bc505c4c)
10f7d6847SJulian Elischer.\" Copyright (c) 1996 John Birrell <jb@cimlogic.com.au>.
20f7d6847SJulian Elischer.\" All rights reserved.
30f7d6847SJulian Elischer.\"
40f7d6847SJulian Elischer.\" Redistribution and use in source and binary forms, with or without
50f7d6847SJulian Elischer.\" modification, are permitted provided that the following conditions
60f7d6847SJulian Elischer.\" are met:
70f7d6847SJulian Elischer.\" 1. Redistributions of source code must retain the above copyright
80f7d6847SJulian Elischer.\"    notice, this list of conditions and the following disclaimer.
90f7d6847SJulian Elischer.\" 2. Redistributions in binary form must reproduce the above copyright
100f7d6847SJulian Elischer.\"    notice, this list of conditions and the following disclaimer in the
110f7d6847SJulian Elischer.\"    documentation and/or other materials provided with the distribution.
120f7d6847SJulian Elischer.\" 3. All advertising materials mentioning features or use of this software
130f7d6847SJulian Elischer.\"    must display the following acknowledgement:
140f7d6847SJulian Elischer.\"	This product includes software developed by John Birrell.
150f7d6847SJulian Elischer.\" 4. Neither the name of the author nor the names of any co-contributors
160f7d6847SJulian Elischer.\"    may be used to endorse or promote products derived from this software
170f7d6847SJulian Elischer.\"    without specific prior written permission.
180f7d6847SJulian Elischer.\"
190f7d6847SJulian Elischer.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
200f7d6847SJulian Elischer.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
210f7d6847SJulian Elischer.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
220f7d6847SJulian Elischer.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
230f7d6847SJulian Elischer.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
240f7d6847SJulian Elischer.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
250f7d6847SJulian Elischer.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
260f7d6847SJulian Elischer.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
270f7d6847SJulian Elischer.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
280f7d6847SJulian Elischer.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
290f7d6847SJulian Elischer.\" SUCH DAMAGE.
300f7d6847SJulian Elischer.\"
310f7d6847SJulian Elischer.Dd April 4, 1996
320f7d6847SJulian Elischer.Dt PTHREAD_EQUAL 3
330f7d6847SJulian Elischer.Os BSD 4
340f7d6847SJulian Elischer.Sh NAME
350f7d6847SJulian Elischer.Nm pthread_equal
360f7d6847SJulian Elischer.Nd compare thread IDs
370f7d6847SJulian Elischer.Sh SYNOPSIS
380f7d6847SJulian Elischer.Fd #include <pthread.h>
390f7d6847SJulian Elischer.Ft int
400f7d6847SJulian Elischer.Fn pthread_equal "pthread_t t1" "pthread_t t2"
410f7d6847SJulian Elischer.Sh DESCRIPTION
420f7d6847SJulian ElischerThe
430f7d6847SJulian Elischer.Fn pthread_equal
440f7d6847SJulian Elischerfunction compares the thread IDs
450f7d6847SJulian Elischer.Fa t1
460f7d6847SJulian Elischerand
470f7d6847SJulian Elischer.Fa t2 .
480f7d6847SJulian Elischer.Sh RETURN VALUES
490f7d6847SJulian ElischerThe
500f7d6847SJulian Elischer.Fn pthread_equal
510f7d6847SJulian Elischerfunction will non-zero if the thread IDs
520f7d6847SJulian Elischer.Fa t1
530f7d6847SJulian Elischerand
540f7d6847SJulian Elischer.Fa t2
550f7d6847SJulian Elischercorrespond to the same thread, otherwise it will return zero.
560f7d6847SJulian Elischer.Sh ERRORS
570f7d6847SJulian ElischerNone.
580f7d6847SJulian Elischer.Pp
590f7d6847SJulian Elischer.Sh SEE ALSO
600f7d6847SJulian Elischer.Xr pthread_create 3 ,
610f7d6847SJulian Elischer.Xr pthread_exit 3
620f7d6847SJulian Elischer.Sh STANDARDS
630f7d6847SJulian Elischer.Fn pthread_equal
640f7d6847SJulian Elischeris expected to conform to IEEE
650f7d6847SJulian Elischer.Pq Dq Tn POSIX
660f7d6847SJulian ElischerStd 1003.1c when it is published.
67