share/man/man3c/sched_get_priority_max.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright 1989 AT&T
  44 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved.
  45 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
  46 .\"
  47 .TH SCHED_GET_PRIORITY_MAX 3C "Apr 1, 2008"
  48 .SH NAME
  49 sched_get_priority_max, sched_get_priority_min \- get scheduling parameter
  50 limits
  51 .SH SYNOPSIS
  52 .LP
  53 .nf
  54 #include <sched.h>
  55
  56 \fBint\fR \fBsched_get_priority_max\fR(\fBint\fR \fIpolicy\fR);
  57 .fi
  58
  59 .LP
  60 .nf
  61 \fBint\fR \fBsched_get_priority_min\fR(\fBint\fR \fIpolicy\fR);
  62 .fi
  63
  64 .SH DESCRIPTION
  65 .sp
  66 .LP
  67 The \fBsched_get_priority_max()\fR and \fBsched_get_priority_min()\fR functions
  68 return the appropriate maximum or minimum, respectfully, for the scheduling
  69 policy specified by \fIpolicy\fR.
  70 .sp
  71 .LP
  72 The value of \fIpolicy\fR is one of the scheduling policy values defined in
  73 <\fBsched.h\fR>.
  74 .SH RETURN VALUES
  75 .sp
  76 .LP
  77 If successful, the \fBsched_get_priority_max()\fR and
  78 \fBsched_get_priority_min()\fR functions return the appropriate maximum or
  79 minimum priority values, respectively. If unsuccessful, they return \fB\(mi1\fR
  80 and set \fBerrno\fR to indicate the error.
  81 .SH ERRORS
  82 .sp
  83 .LP
  84 The  \fBsched_get_priority_max()\fR and \fBsched_get_priority_min()\fR
  85 functions will fail if:
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fBEINVAL\fR\fR
  90 .ad
  91 .RS 10n
  92 The value of the \fIpolicy\fR parameter does not represent a defined scheduling
  93 policy.
  94 .RE
  95
  96 .SH ATTRIBUTES
  97 .sp
  98 .LP
  99 See \fBattributes\fR(5) for descriptions of the following attributes:
 100 .sp
 101
 102 .sp
 103 .TS
 104 box;
 105 c | c
 106 l | l .
 107 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 108 _
 109 Interface Stability     Committed
 110 _
 111 MT-Level        MT-Safe
 112 _
 113 Standard        See \fBstandards\fR(5).
 114 .TE
 115
 116 .SH SEE ALSO
 117 .sp
 118 .LP
 119 \fBlibrt\fR(3LIB), \fBsched.h\fR(3HEAD), \fBsched_getparam\fR(3C),
 120 \fBsched_setparam\fR(3C), \fBsched_getscheduler\fR(3C),
 121 \fBsched_rr_get_interval\fR(3C), \fBsched_setscheduler\fR(3C),
 122 \fBtime.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)