usr/src/man/man3c/sched_get_priority_max.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_GET_PRIORITY_MAX 3C "Apr 1, 2008"
  13 .SH NAME
  14 sched_get_priority_max, sched_get_priority_min \- get scheduling parameter
  15 limits
  16 .SH SYNOPSIS
  17 .LP
  18 .nf
  19 #include <sched.h>
  20
  21 \fBint\fR \fBsched_get_priority_max\fR(\fBint\fR \fIpolicy\fR);
  22 .fi
  23
  24 .LP
  25 .nf
  26 \fBint\fR \fBsched_get_priority_min\fR(\fBint\fR \fIpolicy\fR);
  27 .fi
  28
  29 .SH DESCRIPTION
  30 .sp
  31 .LP
  32 The \fBsched_get_priority_max()\fR and \fBsched_get_priority_min()\fR functions
  33 return the appropriate maximum or minimum, respectfully, for the scheduling
  34 policy specified by \fIpolicy\fR.
  35 .sp
  36 .LP
  37 The value of \fIpolicy\fR is one of the scheduling policy values defined in
  38 <\fBsched.h\fR>.
  39 .SH RETURN VALUES
  40 .sp
  41 .LP
  42 If successful, the \fBsched_get_priority_max()\fR and
  43 \fBsched_get_priority_min()\fR functions return the appropriate maximum or
  44 minimum priority values, respectively. If unsuccessful, they return \fB\(mi1\fR
  45 and set \fBerrno\fR to indicate the error.
  46 .SH ERRORS
  47 .sp
  48 .LP
  49 The  \fBsched_get_priority_max()\fR and \fBsched_get_priority_min()\fR
  50 functions will fail if:
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fBEINVAL\fR\fR
  55 .ad
  56 .RS 10n
  57 The value of the \fIpolicy\fR parameter does not represent a defined scheduling
  58 policy.
  59 .RE
  60
  61 .SH ATTRIBUTES
  62 .sp
  63 .LP
  64 See \fBattributes\fR(5) for descriptions of the following attributes:
  65 .sp
  66
  67 .sp
  68 .TS
  69 box;
  70 c | c
  71 l | l .
  72 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  73 _
  74 Interface Stability     Committed
  75 _
  76 MT-Level        MT-Safe
  77 _
  78 Standard        See \fBstandards\fR(5).
  79 .TE
  80
  81 .SH SEE ALSO
  82 .sp
  83 .LP
  84 \fBlibrt\fR(3LIB), \fBsched.h\fR(3HEAD), \fBsched_getparam\fR(3C),
  85 \fBsched_setparam\fR(3C), \fBsched_getscheduler\fR(3C),
  86 \fBsched_rr_get_interval\fR(3C), \fBsched_setscheduler\fR(3C),
  87 \fBtime.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)