usr/src/man/man3c/sched_getparam.3c

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Copyright 1989 AT&T
   4 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved.
   5 .\" 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
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" 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 Sun OS 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.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" 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.
  10 .\" 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.
  11 .\" 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]
  12 .TH SCHED_GETPARAM 3C "Apr 1, 2008"
  13 .SH NAME
  14 sched_getparam \- get scheduling parameters
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 #include <sched.h>
  19
  20 \fBint\fR \fBsched_getparam\fR(\fBpid_t\fR \fIpid\fR, \fBstruct sched_param *\fR\fIparam\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 The \fBsched_getparam()\fR function returns the scheduling parameters of a
  27 process specified by \fIpid\fR in the \fBsched_param\fR structure pointed to by
  28 \fIparam\fR. The only required member of \fIparam\fR is \fIsched_priority\fR.
  29 .sp
  30 .LP
  31 If a process specified by \fIpid\fR exists and if the calling process has
  32 permission, the scheduling parameters for the process whose process ID is equal
  33 to \fIpid\fR will be returned.
  34 .sp
  35 .LP
  36 If \fIpid\fR is 0, the scheduling parameters for the calling process will be
  37 returned. The behavior of the \fBsched_getparam()\fR function is unspecified if
  38 the value of \fIpid\fR is negative.
  39 .SH RETURN VALUES
  40 .sp
  41 .LP
  42 Upon successful completion, the \fBsched_getparam()\fR function returns
  43 \fB0\fR. If the call to \fBsched_getparam()\fR is unsuccessful, the function
  44 returns \fB\(mi1\fR and sets \fBerrno\fR to indicate the error.
  45 .SH ERRORS
  46 .sp
  47 .LP
  48 The  \fBsched_getparam()\fR function will fail if:
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fBEPERM\fR\fR
  53 .ad
  54 .RS 9n
  55 The requesting process does not have permission to obtain the scheduling
  56 parameters of the specified process.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBESRCH\fR\fR
  63 .ad
  64 .RS 9n
  65 No process can be found corresponding to that specified by \fIpid\fR.
  66 .RE
  67
  68 .SH ATTRIBUTES
  69 .sp
  70 .LP
  71 See \fBattributes\fR(5) for descriptions of the following attributes:
  72 .sp
  73
  74 .sp
  75 .TS
  76 box;
  77 c | c
  78 l | l .
  79 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  80 _
  81 Interface Stability     Committed
  82 _
  83 MT-Level        MT-Safe
  84 _
  85 Standard        See \fBstandards\fR(5).
  86 .TE
  87
  88 .SH SEE ALSO
  89 .sp
  90 .LP
  91 \fBlibrt\fR(3LIB), \fBsched.h\fR(3HEAD), \fBsched_getscheduler\fR(3C),
  92 \fBsched_setparam\fR(3C), \fBsched_setscheduler\fR(3C), \fBattributes\fR(5),
  93 \fBstandards\fR(5)