summaryrefslogtreecommitdiffstats
path: root/man3p/sched_getparam.3p
diff options
context:
space:
mode:
Diffstat (limited to 'man3p/sched_getparam.3p')
-rw-r--r--man3p/sched_getparam.3p75
1 files changed, 75 insertions, 0 deletions
diff --git a/man3p/sched_getparam.3p b/man3p/sched_getparam.3p
new file mode 100644
index 000000000..9b03cfcf7
--- /dev/null
+++ b/man3p/sched_getparam.3p
@@ -0,0 +1,75 @@
+.\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved
+.TH "SCHED_GETPARAM" P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual"
+.\" sched_getparam
+.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 .