1.\"	$NetBSD: pthread_getcpuclockid.3,v 1.4 2017/03/04 11:16:33 njoly Exp $
2.\"
3.\" Copyright (c) 2016 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Christos Zoulas.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd March 3, 2017
31.Dt PTHREAD_GETCPUCLOCKID 3
32.Os
33.Sh NAME
34.Nm pthread_getcpuclockid
35.Nd retrieve the clockid of the given thread
36.Sh LIBRARY
37.Lb libc
38.Sh SYNOPSIS
39.In pthread.h
40.Ft int
41.Fn pthread_getcpuclockid "pthread_t thread" "clockid_t *clock_id"
42.Sh DESCRIPTION
43The
44.Fn pthread_getcpuclockid
45function retrieves the
46.Fa clock_id
47for the specified
48.Fa thread .
49.Pp
50The
51.Xr clock_gettime 2
52function can be used with the returned
53.Fa clock_id
54to retrieve LWP times.
55.Sh RETURN VALUES
56On success the
57.Fn pthread_getcpuclockid
58function returns 0, placing the requested
59.Fa clock_id
60in the argument.
61Otherwise an error number will be returned.
62.Sh ERRORS
63These functions fail if:
64.Bl -tag -width Er
65.It Bq Er ESRCH
66No thread with this id was found.
67.El
68.Sh SEE ALSO
69.Xr clock_getcpuclockid2 2 ,
70.Xr clock_gettime 2
71.Sh STANDARDS
72The
73.Fn pthread_getcpuclockid
74function conforms to
75.St -p1003.1-2001 .
76extension.
77.Sh HISTORY
78The
79.Fn pthread_getcpuclockid
80function appeared in
81.Nx 8 .
82