sched_getparam (3p) - Linux Manuals

sched_getparam: get scheduling parameters (REALTIME)

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.

NAME

sched_getparam - get scheduling parameters (REALTIME)

SYNOPSIS

#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.

The following sections are informative.

EXAMPLES

None.

APPLICATION USAGE

None.

RATIONALE

None.

FUTURE DIRECTIONS

None.

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 .