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

132 lines
4.2 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>getsid</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
</script>
<basefont size="3"> <a name="getsid"></a> <a name="tag_03_250"></a><!-- getsid -->
<!--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_250_01"></a>NAME</h4>
<blockquote>getsid - get the process group ID of a session leader</blockquote>
<h4><a name="tag_03_250_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>
pid_t getsid(pid_t</tt> <i>pid</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_250_03"></a>DESCRIPTION</h4>
<blockquote>
<p>The <i>getsid</i>() function shall obtain the process group ID of the process that is the session leader of the process
specified by <i>pid</i>. If <i>pid</i> is (<b>pid_t</b>)0, it specifies the calling process.</p>
</blockquote>
<h4><a name="tag_03_250_04"></a>RETURN VALUE</h4>
<blockquote>
<p>Upon successful completion, <i>getsid</i>() shall return the process group ID of the session leader of the specified process.
Otherwise, it shall return (<b>pid_t</b>)-1 and set <i>errno</i> to indicate the error.</p>
</blockquote>
<h4><a name="tag_03_250_05"></a>ERRORS</h4>
<blockquote>
<p>The <i>getsid</i>() function shall fail if:</p>
<dl compact>
<dt>[EPERM]</dt>
<dd>The process specified by <i>pid</i> is not in the same session as the calling process, and the implementation does not allow
access to the process group ID of the session leader of that process from the calling process.</dd>
<dt>[ESRCH]</dt>
<dd>There is no process with a process ID equal to <i>pid</i>.</dd>
</dl>
</blockquote>
<hr>
<div class="box"><em>The following sections are informative.</em></div>
<h4><a name="tag_03_250_06"></a>EXAMPLES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_250_07"></a>APPLICATION USAGE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_250_08"></a>RATIONALE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_250_09"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_250_10"></a>SEE ALSO</h4>
<blockquote>
<p><a href="exec.html"><i><a href="../functions/exec.html">exec</a></i>()</a> , <a href="fork.html"><i>fork</i>()</a> , <a href=
"getpid.html"><i>getpid</i>()</a> , <a href="getpgid.html"><i>getpgid</i>()</a> , <a href="setpgid.html"><i>setpgid</i>()</a> , <a
href="setsid.html"><i>setsid</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_250_11"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 4, Version 2.</p>
</blockquote>
<h4><a name="tag_03_250_12"></a>Issue 5</h4>
<blockquote>
<p>Moved from X/OPEN UNIX extension to BASE.</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>