Go to main content

man pages section 3: Basic Library Functions

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

sched_getparam(3C)

Name

sched_getparam - get scheduling parameters

Synopsis

#include <sched.h>

int sched_getparam(pid_t pid, struct sched_param *param);

Description

The sched_getparam() function returns the scheduling parameters of a process specified by pid in the sched_param structure pointed to by param. The only required member of param is sched_priority.

If a process specified by pid exists and if the calling process has permission, the scheduling parameters for the process whose process ID is equal to pid will be returned.

If pid is 0, the scheduling parameters for the calling process will be returned. The behavior of the sched_getparam() function is unspecified if the value of pid is negative.

Return Values

Upon successful completion, the sched_getparam() function returns 0. If the call to sched_getparam() is unsuccessful, the function returns −1 and sets errno to indicate the error.

Errors

The sched_getparam() function will fail if:

EPERM

The requesting process does not have permission to obtain the scheduling parameters of the specified process.

ESRCH

No process can be found corresponding to that specified by pid.

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
MT-Safe
Standard

See Also

sched_getscheduler(3C), sched_setparam(3C), sched_setscheduler(3C), sched.h(3HEAD), librt(3LIB), attributes(7), standards(7)