'\" et

.TH SCHED_GETPARAM "3P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"

.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

\(em get scheduling parameters

(\fBREALTIME\fP)

.SH SYNOPSIS

.LP

.nf

#include <sched.h>

.P

int sched_getparam(pid_t \fIpid\fP, struct sched_param *\fIparam\fP);

.fi

.SH DESCRIPTION

The

\fIsched_getparam\fR()

function shall return the scheduling parameters of a process specified by

.IR pid

in the

.BR sched_param

structure pointed to by

.IR param .

.P

If a process specified by

.IR pid

exists, and if the calling process has permission, the scheduling

parameters for the process whose process ID is equal to

.IR pid

shall be returned.

.P

If

.IR pid

is zero, the scheduling parameters for the calling process shall be

returned. The behavior of the

\fIsched_getparam\fR()

function is unspecified if the value of

.IR pid

is negative.

.SH "RETURN VALUE"

Upon successful completion, the

\fIsched_getparam\fR()

function shall return zero. If the call to

\fIsched_getparam\fR()

is unsuccessful, the function shall return a value of \(mi1 and set

.IR errno

to indicate the error.

.SH ERRORS

The

\fIsched_getparam\fR()

function shall fail if:

.TP

.BR EPERM

The requesting process does not have permission to obtain the

scheduling parameters of the specified process.

.TP

.BR ESRCH

No process can be found corresponding to that specified by

.IR pid .

.LP

.IR "The following sections are informative."

.SH EXAMPLES

None.

.SH "APPLICATION USAGE"

None.

.SH RATIONALE

None.

.SH "FUTURE DIRECTIONS"

None.

.SH "SEE ALSO"

.IR "\fIsched_getscheduler\fR\^(\|)",

.IR "\fIsched_setparam\fR\^(\|)",

.IR "\fIsched_setscheduler\fR\^(\|)"

.P

The Base Definitions volume of POSIX.1\(hy2008,

.IR "\fB<sched.h>\fP"

.SH COPYRIGHT

Portions of this text are reprinted and reproduced in electronic form

from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology

-- Portable Operating System Interface (POSIX), The Open Group Base

Specifications Issue 7, Copyright (C) 2013 by the Institute of

Electrical and Electronics Engineers, Inc and The Open Group.

(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) 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.unix.org/online.html .

Any typographical or formatting errors that appear

in this page are most likely

to have been introduced during the conversion of the source files to

man page format. To report such errors, see

https://www.kernel.org/doc/man-pages/reporting_bugs.html .