Plan 9 from Bell Labs’s /usr/web/sources/contrib/fgb/root/sys/lib/ape/man/3/sched_getparam

Copyright © 2021 Plan 9 Foundation.
Distributed under the MIT License.
Download the Plan 9 distribution.


.\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved 
.TH "SCHED_GETPARAM" 3P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\" sched_getparam 
.SH PROLOG
This manual page is part of the POSIX Programmer's Manual.
The Linux implementation of this interface may differ (consult
the corresponding Linux manual page for details of Linux behavior),
or the interface may not be implemented on Linux.
.SH NAME
sched_getparam \- get scheduling parameters (\fBREALTIME\fP)
.SH SYNOPSIS
.LP
\fB#include <sched.h>
.br
.sp
int sched_getparam(pid_t\fP \fIpid\fP\fB, struct sched_param *\fP\fIparam\fP\fB);
\fP
\fB
.br
\fP
.SH DESCRIPTION
.LP
The \fIsched_getparam\fP() function shall return the scheduling parameters
of a process specified by \fIpid\fP in the
\fBsched_param\fP structure pointed to by \fIparam\fP.
.LP
If a process specified by \fIpid\fP exists, and if the calling process
has permission, the scheduling parameters for the
process whose process ID is equal to \fIpid\fP shall be returned.
.LP
If \fIpid\fP is zero, the scheduling parameters for the calling process
shall be returned. The behavior of the
\fIsched_getparam\fP() function is unspecified if the value of \fIpid\fP
is negative.
.SH RETURN VALUE
.LP
Upon successful completion, the \fIsched_getparam\fP() function shall
return zero. If the call to \fIsched_getparam\fP() is
unsuccessful, the function shall return a value of -1 and set \fIerrno\fP
to indicate the error.
.SH ERRORS
.LP
The \fIsched_getparam\fP() function shall fail if:
.TP 7
.B EPERM
The requesting process does not have permission to obtain the scheduling
parameters of the specified process.
.TP 7
.B ESRCH
No process can be found corresponding to that specified by \fIpid\fP.
.sp
.LP
\fIThe following sections are informative.\fP
.SH EXAMPLES
.LP
None.
.SH APPLICATION USAGE
.LP
None.
.SH RATIONALE
.LP
None.
.SH FUTURE DIRECTIONS
.LP
None.
.SH SEE ALSO
.LP
\fIsched_getscheduler\fP(), \fIsched_setparam\fP(),
\fIsched_setscheduler\fP(), the Base Definitions volume of IEEE\ Std\ 1003.1-2001,
\fI<sched.h>\fP
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group. In the
event of any discrepancy between this version and the original IEEE and
The Open Group Standard, the original IEEE and The Open Group Standard
is the referee document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html .

Bell Labs OSI certified Powered by Plan 9

(Return to Plan 9 Home Page)

Copyright © 2021 Plan 9 Foundation. All Rights Reserved.
Comments to [email protected].