Files
oldlinux-files/Ref-docs/POSIX/susv3/functions/sched_getparam.html
2024-02-19 00:21:47 -05:00

140 lines
4.7 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="generator" content="HTML Tidy, see www.w3.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
<title>sched_getparam</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
</script>
<basefont size="3"> <a name="sched_getparam"></a> <a name="tag_03_619"></a><!-- sched_getparam -->
<!--header start-->
<center><font size="2">The Open Group Base Specifications Issue 6<br>
IEEE Std 1003.1-2001<br>
Copyright &copy; 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
<!--header end-->
<hr size="2" noshade>
<h4><a name="tag_03_619_01"></a>NAME</h4>
<blockquote>sched_getparam - get scheduling parameters (<b>REALTIME</b>)</blockquote>
<h4><a name="tag_03_619_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<div class="box"><code><tt><sup>[<a href="javascript:open_code('PS')">PS</a>]</sup> <img src="../images/opt-start.gif" alt=
"[Option Start]" border="0"> #include &lt;<a href="../basedefs/sched.h.html">sched.h</a>&gt;<br>
<br>
int sched_getparam(pid_t</tt> <i>pid</i><tt>, struct sched_param *</tt><i>param</i><tt>); <img src="../images/opt-end.gif" alt=
"[Option End]" border="0"></tt></code></div>
<tt><br>
</tt></blockquote>
<h4><a name="tag_03_619_03"></a>DESCRIPTION</h4>
<blockquote>
<p>The <i>sched_getparam</i>() function shall return the scheduling parameters of a process specified by <i>pid</i> in the
<b>sched_param</b> structure pointed to by <i>param</i>.</p>
<p>If a process specified by <i>pid</i> exists, and if the calling process has permission, the scheduling parameters for the
process whose process ID is equal to <i>pid</i> shall be returned.</p>
<p>If <i>pid</i> is zero, the scheduling parameters for the calling process shall be returned. The behavior of the
<i>sched_getparam</i>() function is unspecified if the value of <i>pid</i> is negative.</p>
</blockquote>
<h4><a name="tag_03_619_04"></a>RETURN VALUE</h4>
<blockquote>
<p>Upon successful completion, the <i>sched_getparam</i>() function shall return zero. If the call to <i>sched_getparam</i>() is
unsuccessful, the function shall return a value of -1 and set <i>errno</i> to indicate the error.</p>
</blockquote>
<h4><a name="tag_03_619_05"></a>ERRORS</h4>
<blockquote>
<p>The <i>sched_getparam</i>() function shall fail if:</p>
<dl compact>
<dt>[EPERM]</dt>
<dd>The requesting process does not have permission to obtain the scheduling parameters of the specified process.</dd>
<dt>[ESRCH]</dt>
<dd>No process can be found corresponding to that specified by <i>pid</i>.</dd>
</dl>
</blockquote>
<hr>
<div class="box"><em>The following sections are informative.</em></div>
<h4><a name="tag_03_619_06"></a>EXAMPLES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_619_07"></a>APPLICATION USAGE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_619_08"></a>RATIONALE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_619_09"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_619_10"></a>SEE ALSO</h4>
<blockquote>
<p><a href="sched_getscheduler.html"><i>sched_getscheduler</i>()</a> , <a href="sched_setparam.html"><i>sched_setparam</i>()</a> ,
<a href="sched_setscheduler.html"><i>sched_setscheduler</i>()</a> , the Base Definitions volume of IEEE&nbsp;Std&nbsp;1003.1-2001,
<a href="../basedefs/sched.h.html"><i>&lt;sched.h&gt;</i></a></p>
</blockquote>
<h4><a name="tag_03_619_11"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 5. Included for alignment with the POSIX Realtime Extension.</p>
</blockquote>
<h4><a name="tag_03_619_12"></a>Issue 6</h4>
<blockquote>
<p>The <i>sched_getparam</i>() function is marked as part of the Process Scheduling option.</p>
<p>The [ENOSYS] error condition has been removed as stubs need not be provided if an implementation does not support the Process
Scheduling option.</p>
</blockquote>
<div class="box"><em>End of informative text.</em></div>
<hr>
<hr size="2" noshade>
<center><font size="2"><!--footer start-->
UNIX &reg; is a registered Trademark of The Open Group.<br>
POSIX &reg; is a registered Trademark of The IEEE.<br>
[ <a href="../mindex.html">Main Index</a> | <a href="../basedefs/contents.html">XBD</a> | <a href=
"../utilities/contents.html">XCU</a> | <a href="../functions/contents.html">XSH</a> | <a href="../xrat/contents.html">XRAT</a>
]</font></center>
<!--footer end-->
<hr size="2" noshade>
</body>
</html>