|
1
by Francesco Paolo Lovergine
rules: linking manpages-posix not manpages. |
1 |
.\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved |
|
2
by Francesco Paolo Lovergine
* Alligned to linux main manpages edition. |
2 |
.TH "SCHED_GETPARAM" P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual" |
|
1
by Francesco Paolo Lovergine
rules: linking manpages-posix not manpages. |
3 |
.\" sched_getparam |
4 |
.SH NAME |
|
5 |
sched_getparam \- get scheduling parameters (\fBREALTIME\fP) |
|
6 |
.SH SYNOPSIS |
|
7 |
.LP
|
|
8 |
\fB#include <sched.h>
|
|
9 |
.br
|
|
10 |
.sp
|
|
11 |
int sched_getparam(pid_t\fP \fIpid\fP\fB, struct sched_param *\fP\fIparam\fP\fB); |
|
12 |
\fP
|
|
13 |
\fB
|
|
14 |
.br
|
|
15 |
\fP
|
|
16 |
.SH DESCRIPTION |
|
17 |
.LP
|
|
18 |
The \fIsched_getparam\fP() function shall return the scheduling parameters |
|
19 |
of a process specified by \fIpid\fP in the |
|
20 |
\fBsched_param\fP structure pointed to by \fIparam\fP. |
|
21 |
.LP
|
|
22 |
If a process specified by \fIpid\fP exists, and if the calling process |
|
23 |
has permission, the scheduling parameters for the |
|
24 |
process whose process ID is equal to \fIpid\fP shall be returned. |
|
25 |
.LP
|
|
26 |
If \fIpid\fP is zero, the scheduling parameters for the calling process |
|
27 |
shall be returned. The behavior of the |
|
28 |
\fIsched_getparam\fP() function is unspecified if the value of \fIpid\fP |
|
29 |
is negative. |
|
30 |
.SH RETURN VALUE |
|
31 |
.LP
|
|
32 |
Upon successful completion, the \fIsched_getparam\fP() function shall |
|
33 |
return zero. If the call to \fIsched_getparam\fP() is |
|
34 |
unsuccessful, the function shall return a value of -1 and set \fIerrno\fP |
|
35 |
to indicate the error. |
|
36 |
.SH ERRORS |
|
37 |
.LP
|
|
38 |
The \fIsched_getparam\fP() function shall fail if: |
|
39 |
.TP 7 |
|
40 |
.B EPERM |
|
41 |
The requesting process does not have permission to obtain the scheduling |
|
42 |
parameters of the specified process. |
|
43 |
.TP 7 |
|
44 |
.B ESRCH |
|
45 |
No process can be found corresponding to that specified by \fIpid\fP. |
|
46 |
.sp
|
|
47 |
.LP
|
|
48 |
\fIThe following sections are informative.\fP |
|
49 |
.SH EXAMPLES |
|
50 |
.LP
|
|
51 |
None. |
|
52 |
.SH APPLICATION USAGE |
|
53 |
.LP
|
|
54 |
None. |
|
55 |
.SH RATIONALE |
|
56 |
.LP
|
|
57 |
None. |
|
58 |
.SH FUTURE DIRECTIONS |
|
59 |
.LP
|
|
60 |
None. |
|
61 |
.SH SEE ALSO |
|
62 |
.LP
|
|
63 |
\fIsched_getscheduler\fP() , \fIsched_setparam\fP() , |
|
64 |
\fIsched_setscheduler\fP() , the Base Definitions volume of IEEE\ Std\ 1003.1-2001, |
|
65 |
\fI<sched.h>\fP |
|
66 |
.SH COPYRIGHT |
|
67 |
Portions of this text are reprinted and reproduced in electronic form |
|
68 |
from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology |
|
69 |
-- Portable Operating System Interface (POSIX), The Open Group Base |
|
70 |
Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of |
|
71 |
Electrical and Electronics Engineers, Inc and The Open Group. In the |
|
72 |
event of any discrepancy between this version and the original IEEE and |
|
73 |
The Open Group Standard, the original IEEE and The Open Group Standard |
|
74 |
is the referee document. The original Standard can be obtained online at |
|
75 |
http://www.opengroup.org/unix/online.html . |