static/freebsd/man3/pthread_getcpuclockid.3 4.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

<table class="head">
  <tr>
    <td class="head-ltitle">PTHREAD_GETCPUCLOCKID(3)</td>
    <td class="head-vol">Library Functions Manual</td>
    <td class="head-rtitle">PTHREAD_GETCPUCLOCKID(3)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">pthread_getcpuclockid</code> &#x2014;
    <span class="Nd">access a thread CPU-time clock</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="LIBRARY"><a class="permalink" href="#LIBRARY">LIBRARY</a></h1>
<p class="Pp"><span class="Lb">POSIX Threads Library (libpthread,
    -lpthread)</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="In">#include
    &lt;<a class="In">pthread.h</a>&gt;</code>
  <br/>
  <code class="In">#include &lt;<a class="In">time.h</a>&gt;</code></p>
<p class="Pp"><var class="Ft">int</var>
  <br/>
  <code class="Fn">pthread_getcpuclockid</code>(<var class="Fa" style="white-space: nowrap;">pthread_t
    thread_id</var>, <var class="Fa" style="white-space: nowrap;">clockid_t
    *clock_id</var>);</p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The
    <a class="permalink" href="#pthread_getcpuclockid"><code class="Fn" id="pthread_getcpuclockid">pthread_getcpuclockid</code></a>()
    returns the clock ID of the CPU-time clock of the thread specified by
    <var class="Fa">thread_id</var>, if the thread described by
    <var class="Fa">thread_id</var> exists.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN
  VALUES</a></h1>
<p class="Pp">Upon successful completion,
    <code class="Fn">pthread_getcpuclockid</code>() returns zero; otherwise, an
    error number is returned to indicate the error.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="ERRORS"><a class="permalink" href="#ERRORS">ERRORS</a></h1>
<p class="Pp">The <code class="Fn">pthread_getcpuclockid</code>() function will
    fail if:</p>
<dl class="Bl-tag">
  <dt id="ESRCH">[<a class="permalink" href="#ESRCH"><code class="Er">ESRCH</code></a>]</dt>
  <dd>The value specified by <var class="Fa">thread_id</var> does not refer to
      an existing thread.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">clock_gettime(2)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="STANDARDS"><a class="permalink" href="#STANDARDS">STANDARDS</a></h1>
<p class="Pp">The <code class="Fn">pthread_getcpuclockid</code>() function
    conforms to <span class="St">IEEE Std 1003.1-2004
    (&#x201C;POSIX.1&#x201D;)</span>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<p class="Pp">The <code class="Fn">pthread_getcpuclockid</code>() function first
    appeared in <span class="Ux">FreeBSD 10.0</span>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp"><span class="An">David Xu</span>
    &lt;<a class="Mt" href="mailto:davidxu@FreeBSD.org">davidxu@FreeBSD.org</a>&gt;</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">August 21, 2012</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>