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

164 lines
5.4 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>setgid</title>
</head>
<body bgcolor="white">
<basefont size="3"> <a name="setgid"></a> <a name="tag_03_649"></a><!-- setgid -->
<!--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_649_01"></a>NAME</h4>
<blockquote>setgid - set-group-ID</blockquote>
<h4><a name="tag_03_649_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<p><code><tt>#include &lt;<a href="../basedefs/unistd.h.html">unistd.h</a>&gt;<br>
<br>
int setgid(gid_t</tt> <i>gid</i><tt>);<br>
</tt></code></p>
</blockquote>
<h4><a name="tag_03_649_03"></a>DESCRIPTION</h4>
<blockquote>
<p>If the process has appropriate privileges, <i>setgid</i>() shall set the real group ID, effective group ID, and the saved
set-group-ID of the calling process to <i>gid</i>.</p>
<p>If the process does not have appropriate privileges, but <i>gid</i> is equal to the real group ID or the saved set-group-ID,
<i>setgid</i>() shall set the effective group ID to <i>gid</i>; the real group ID and saved set-group-ID shall remain
unchanged.</p>
<p>The <i>setgid</i>() function shall not affect the supplementary group list in any way.</p>
<p>Any supplementary group IDs of the calling process shall remain unchanged.</p>
</blockquote>
<h4><a name="tag_03_649_04"></a>RETURN VALUE</h4>
<blockquote>
<p>Upon successful completion, 0 is returned. Otherwise, -1 shall be returned and <i>errno</i> set to indicate the error.</p>
</blockquote>
<h4><a name="tag_03_649_05"></a>ERRORS</h4>
<blockquote>
<p>The <i>setgid</i>() function shall fail if:</p>
<dl compact>
<dt>[EINVAL]</dt>
<dd>The value of the <i>gid</i> argument is invalid and is not supported by the implementation.</dd>
<dt>[EPERM]</dt>
<dd>The process does not have appropriate privileges and <i>gid</i> does not match the real group ID or the saved
set-group-ID.</dd>
</dl>
</blockquote>
<hr>
<div class="box"><em>The following sections are informative.</em></div>
<h4><a name="tag_03_649_06"></a>EXAMPLES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_649_07"></a>APPLICATION USAGE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_649_08"></a>RATIONALE</h4>
<blockquote>
<p>Refer to the RATIONALE section in <a href="setuid.html"><i>setuid</i>()</a> .</p>
</blockquote>
<h4><a name="tag_03_649_09"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_649_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=
"setregid.html"><i>setregid</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/sys/types.h.html"><i>&lt;sys/types.h&gt;</i></a>, <a href="../basedefs/unistd.h.html"><i>&lt;unistd.h&gt;</i></a></p>
</blockquote>
<h4><a name="tag_03_649_11"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 1. Derived from Issue 1 of the SVID.</p>
</blockquote>
<h4><a name="tag_03_649_12"></a>Issue 6</h4>
<blockquote>
<p>In the SYNOPSIS, the optional include of the <a href="../basedefs/sys/types.h.html"><i>&lt;sys/types.h&gt;</i></a> header is
removed.</p>
<p>The following new requirements on POSIX implementations derive from alignment with the Single UNIX Specification:</p>
<ul>
<li>
<p>The requirement to include <a href="../basedefs/sys/types.h.html"><i>&lt;sys/types.h&gt;</i></a> has been removed. Although <a
href="../basedefs/sys/types.h.html"><i>&lt;sys/types.h&gt;</i></a> was required for conforming implementations of previous POSIX
specifications, it was not required for UNIX applications.</p>
</li>
<li>
<p>Functionality associated with _POSIX_SAVED_IDS is now mandated. This is a FIPS requirement.</p>
</li>
</ul>
<p>The following changes were made to align with the IEEE&nbsp;P1003.1a draft standard:</p>
<ul>
<li>
<p>The effects of <i>setgid</i>() in processes without appropriate privileges are changed.</p>
</li>
<li>
<p>A requirement that the supplementary group list is not affected is added.</p>
</li>
</ul>
</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>