NAME

sched_getparam - get scheduling parameters (REALTIME)

SYNOPSIS

[PS] #include <sched.h>

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

DESCRIPTION

The sched_getparam() function shall return the scheduling parameters of a process specified by pid in the sched_param structure pointed to by param.

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 shall be returned.

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

RETURN VALUE

Upon successful completion, the sched_getparam() function shall return zero. If the call to sched_getparam() is unsuccessful, the function shall return a value of -1 and set errno to indicate the error.

ERRORS

The sched_getparam() function shall 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.

EXAMPLES

None.

APPLICATION USAGE

None.

RATIONALE

None.

FUTURE DIRECTIONS

None.

SEE ALSO

sched_getscheduler(), sched_setparam(), sched_setscheduler(), the Base Definitions volume of IEEE Std 1003.1-2001, <sched.h>

CHANGE HISTORY

First released in Issue 5. Included for alignment with the POSIX Realtime Extension.

Issue 6

The sched_getparam() function is marked as part of the Process Scheduling option.

The [ENOSYS] error condition has been removed as stubs need not be provided if an implementation does not support the Process Scheduling option.