Files
oldlinux-files/Ref-docs/POSIX/susv3/functions/pthread_getcpuclockid.html
2024-02-19 00:21:47 -05:00

126 lines
4.2 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="generator" content="HTML Tidy, see www.w3.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
<title>pthread_getcpuclockid</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
</script>
<basefont size="3"> <a name="pthread_getcpuclockid"></a> <a name="tag_03_530"></a><!-- pthread_getcpuclockid -->
<!--header start-->
<center><font size="2">The Open Group Base Specifications Issue 6<br>
IEEE Std 1003.1-2001<br>
Copyright &copy; 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
<!--header end-->
<hr size="2" noshade>
<h4><a name="tag_03_530_01"></a>NAME</h4>
<blockquote>pthread_getcpuclockid - access a thread CPU-time clock (<b>ADVANCED REALTIME THREADS</b>)</blockquote>
<h4><a name="tag_03_530_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<div class="box"><code><tt><sup>[<a href="javascript:open_code('THR TCT')">THR TCT</a>]</sup> <img src="../images/opt-start.gif" alt=
"[Option Start]" border="0"> #include &lt;<a href="../basedefs/pthread.h.html">pthread.h</a>&gt;<br>
#include &lt;<a href="../basedefs/time.h.html">time.h</a>&gt;<br>
<br>
int pthread_getcpuclockid(pthread_t</tt> <i>thread_id</i><tt>, clockid_t *</tt><i>clock_id</i><tt>); <img src=
"../images/opt-end.gif" alt="[Option End]" border="0"></tt></code></div>
<tt><br>
</tt></blockquote>
<h4><a name="tag_03_530_03"></a>DESCRIPTION</h4>
<blockquote>
<p>The <i>pthread_getcpuclockid</i>() function shall return in <i>clock_id</i> the clock ID of the CPU-time clock of the thread
specified by <i>thread_id</i>, if the thread specified by <i>thread_id</i> exists.</p>
</blockquote>
<h4><a name="tag_03_530_04"></a>RETURN VALUE</h4>
<blockquote>
<p>Upon successful completion, <i>pthread_getcpuclockid</i>() shall return zero; otherwise, an error number shall be returned to
indicate the error.</p>
</blockquote>
<h4><a name="tag_03_530_05"></a>ERRORS</h4>
<blockquote>
<p>The <i>pthread_getcpuclockid</i>() function may fail if:</p>
<dl compact>
<dt>[ESRCH]</dt>
<dd>The value specified by <i>thread_id</i> does not refer to an existing thread.</dd>
</dl>
</blockquote>
<hr>
<div class="box"><em>The following sections are informative.</em></div>
<h4><a name="tag_03_530_06"></a>EXAMPLES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_530_07"></a>APPLICATION USAGE</h4>
<blockquote>
<p>The <i>pthread_getcpuclockid</i>() function is part of the Thread CPU-Time Clocks option and need not be provided on all
implementations.</p>
</blockquote>
<h4><a name="tag_03_530_08"></a>RATIONALE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_530_09"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_530_10"></a>SEE ALSO</h4>
<blockquote>
<p><a href="clock_getcpuclockid.html"><i>clock_getcpuclockid</i>()</a> , <a href="clock_getres.html"><i>clock_getres</i>()</a> , <a
href="timer_create.html"><i>timer_create</i>()</a> , the Base Definitions volume of IEEE&nbsp;Std&nbsp;1003.1-2001, <a href=
"../basedefs/pthread.h.html"><i>&lt;pthread.h&gt;</i></a>, <a href="../basedefs/time.h.html"><i>&lt;time.h&gt;</i></a></p>
</blockquote>
<h4><a name="tag_03_530_11"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 6. Derived from IEEE&nbsp;Std&nbsp;1003.1d-1999.</p>
<p>In the SYNOPSIS, the inclusion of <a href="../basedefs/sys/types.h.html"><i>&lt;sys/types.h&gt;</i></a> is no longer
required.</p>
</blockquote>
<div class="box"><em>End of informative text.</em></div>
<hr>
<hr size="2" noshade>
<center><font size="2"><!--footer start-->
UNIX &reg; is a registered Trademark of The Open Group.<br>
POSIX &reg; is a registered Trademark of The IEEE.<br>
[ <a href="../mindex.html">Main Index</a> | <a href="../basedefs/contents.html">XBD</a> | <a href=
"../utilities/contents.html">XCU</a> | <a href="../functions/contents.html">XSH</a> | <a href="../xrat/contents.html">XRAT</a>
]</font></center>
<!--footer end-->
<hr size="2" noshade>
</body>
</html>