xref: /illumos-gate/usr/src/man/man3c/sched_getparam.3c (revision 2c5ec7a875dcd76853e6618614e990f1e8cdd56d)

Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions 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.

This notice shall appear on any product containing this material.

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Copyright 1989 AT&T
Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved.
Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.

SCHED_GETPARAM 3C "Apr 1, 2008"
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(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
MT-Level MT-Safe
Standard See standards(5).
SEE ALSO

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