The Open Group Base Specifications Issue 6
IEEE Std 1003.1, 2004 Edition
Copyright © 2001-2004 The IEEE and The Open Group, All Rights reserved.

#### NAME

> clock_getcpuclockid - access a process CPU-time clock (ADVANCED REALTIME)

#### SYNOPSIS

> ``[CPT] #include <time.h>
> int clock_getcpuclockid(pid_t` pid`, clockid_t *`clock_id`);``
> `
> `

#### DESCRIPTION

> The clock_getcpuclockid() function shall return the clock ID of the CPU-time clock of the process specified by pid. If the process described by pid exists and the calling process has permission, the clock ID of this clock shall be returned in clock_id.

> If pid is zero, the clock_getcpuclockid() function shall return the clock ID of the CPU-time clock of the process making the call, in clock_id.

> The conditions under which one process has permission to obtain the CPU-time clock ID of other processes are implementation-defined.

#### RETURN VALUE

> Upon successful completion, clock_getcpuclockid() shall return zero; otherwise, an error number shall be returned to indicate the error.

#### ERRORS

> The clock_getcpuclockid() function shall fail if:

> [EPERM]
>   The requesting process does not have permission to access the CPU-time clock for the process.

> The clock_getcpuclockid() function may fail if:

> [ESRCH]
>   No process can be found corresponding to the process specified by pid.

The following sections are informative.

#### EXAMPLES

> None.

#### APPLICATION USAGE

> The clock_getcpuclockid() function is part of the Process CPU-Time Clocks option and need not be provided on all implementations.

#### RATIONALE

> None.

#### FUTURE DIRECTIONS

> None.

#### SEE ALSO

> clock_getres(), timer_create(), the Base Definitions volume of IEEE Std 1003.1-2001, <time.h>

#### CHANGE HISTORY

> First released in Issue 6. Derived from IEEE Std 1003.1d-1999.

> In the SYNOPSIS, the inclusion of <sys/types.h> is no longer required.

End of informative text.

UNIX ® is a registered Trademark of The Open Group.
POSIX ® is a registered Trademark of The IEEE.
[ Main Index | XBD | XCU | XSH | XRAT ]