Merge branch 'vendor/FILE'
[dragonfly.git] / lib / libpthread / pthread_self.3
1 .\" Copyright (c) 1996 John Birrell <jb@cimlogic.com.au>.
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by John Birrell.
15 .\" 4. Neither the name of the author nor the names of any co-contributors
16 .\"    may be used to endorse or promote products derived from this software
17 .\"    without specific prior written permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .\" SUCH DAMAGE.
30 .\"
31 .\" $FreeBSD: src/share/man/man3/pthread_self.3,v 1.14 2007/10/22 10:08:01 ru Exp $
32 .\" $DragonFly: src/lib/libc_r/man/pthread_self.3,v 1.2 2003/06/17 04:26:48 dillon Exp $
33 .\"
34 .Dd July 10, 2009
35 .Dt PTHREAD_SELF 3
36 .Os
37 .Sh NAME
38 .Nm pthread_self
39 .Nd get the calling thread's ID
40 .Sh LIBRARY
41 .Lb libpthread
42 .Sh SYNOPSIS
43 .In pthread.h
44 .Ft pthread_t
45 .Fn pthread_self "void"
46 .Sh DESCRIPTION
47 The
48 .Fn pthread_self
49 function returns the thread ID of the calling thread.
50 .Sh RETURN VALUES
51 The
52 .Fn pthread_self
53 function returns the thread ID of the calling thread.
54 .Sh ERRORS
55 None.
56 .Sh SEE ALSO
57 .Xr pthread_create 3 ,
58 .Xr pthread_equal 3
59 .Sh STANDARDS
60 The
61 .Fn pthread_self
62 function conforms to
63 .St -p1003.1-96 .