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

150 lines
5.3 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>setregid</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
</script>
<basefont size="3"> <a name="setregid"></a> <a name="tag_03_663"></a><!-- setregid -->
<!--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_663_01"></a>NAME</h4>
<blockquote>setregid - set real and effective group IDs</blockquote>
<h4><a name="tag_03_663_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<div class="box"><code><tt><sup>[<a href="javascript:open_code('XSI')">XSI</a>]</sup> <img src="../images/opt-start.gif" alt=
"[Option Start]" border="0"> #include &lt;<a href="../basedefs/unistd.h.html">unistd.h</a>&gt;<br>
<br>
int setregid(gid_t</tt> <i>rgid</i><tt>, gid_t</tt> <i>egid</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_663_03"></a>DESCRIPTION</h4>
<blockquote>
<p>The <i>setregid</i>() function shall set the real and effective group IDs of the calling process.</p>
<p>If <i>rgid</i> is -1, the real group ID shall not be changed; if <i>egid</i> is -1, the effective group ID shall not be
changed.</p>
<p>The real and effective group IDs may be set to different values in the same call.</p>
<p>Only a process with appropriate privileges can set the real group ID and the effective group ID to any valid value.</p>
<p>A non-privileged process can set either the real group ID to the saved set-group-ID from one of the <i><a href=
"../functions/exec.html">exec</a></i> family of functions, or the effective group ID to the saved set-group-ID or the real group
ID.</p>
<p>Any supplementary group IDs of the calling process remain unchanged.</p>
</blockquote>
<h4><a name="tag_03_663_04"></a>RETURN VALUE</h4>
<blockquote>
<p>Upon successful completion, 0 shall be returned. Otherwise, -1 shall be returned and <i>errno</i> set to indicate the error, and
neither of the group IDs are changed.</p>
</blockquote>
<h4><a name="tag_03_663_05"></a>ERRORS</h4>
<blockquote>
<p>The <i>setregid</i>() function shall fail if:</p>
<dl compact>
<dt>[EINVAL]</dt>
<dd>The value of the <i>rgid</i> or <i>egid</i> argument is invalid or out-of-range.</dd>
<dt>[EPERM]</dt>
<dd>The process does not have appropriate privileges and a change other than changing the real group ID to the saved set-group-ID,
or changing the effective group ID to the real group ID or the saved set-group-ID, was requested.</dd>
</dl>
</blockquote>
<hr>
<div class="box"><em>The following sections are informative.</em></div>
<h4><a name="tag_03_663_06"></a>EXAMPLES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_663_07"></a>APPLICATION USAGE</h4>
<blockquote>
<p>If a set-group-ID process sets its effective group ID to its real group ID, it can still set its effective group ID back to the
saved set-group-ID.</p>
</blockquote>
<h4><a name="tag_03_663_08"></a>RATIONALE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_663_09"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_663_10"></a>SEE ALSO</h4>
<blockquote>
<p><a href="exec.html"><i><a href="../functions/exec.html">exec</a></i>()</a> , <a href="getegid.html"><i>getegid</i>()</a> , <a
href="geteuid.html"><i>geteuid</i>()</a> , <a href="getgid.html"><i>getgid</i>()</a> , <a href="getuid.html"><i>getuid</i>()</a> ,
<a href="setegid.html"><i>setegid</i>()</a> , <a href="seteuid.html"><i>seteuid</i>()</a> , <a href=
"setgid.html"><i>setgid</i>()</a> , <a href="setreuid.html"><i>setreuid</i>()</a> , <a href="setuid.html"><i>setuid</i>()</a> , the
Base Definitions volume of IEEE&nbsp;Std&nbsp;1003.1-2001, <a href="../basedefs/unistd.h.html"><i>&lt;unistd.h&gt;</i></a></p>
</blockquote>
<h4><a name="tag_03_663_11"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 4, Version 2.</p>
</blockquote>
<h4><a name="tag_03_663_12"></a>Issue 5</h4>
<blockquote>
<p>Moved from X/OPEN UNIX extension to BASE.</p>
<p>The DESCRIPTION is updated to indicate that the saved set-group-ID can be set by any of the <i><a href=
"../functions/exec.html">exec</a></i> family of functions, not just <a href="../functions/execve.html"><i>execve</i>()</a>.</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>