share/man/man2/getsid.2

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved  Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH GETSID 2 "Jan 22, 1996"
  11 .SH NAME
  12 getsid \- get process group ID of session leader
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <unistd.h>
  17
  18 \fBpid_t\fR \fBgetsid\fR(\fBpid_t\fR \fIpid\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBgetsid()\fR function obtains the process group \fBID\fR of the process
  25 that is the session leader of the process specified by \fIpid\fR.  If \fIpid\fR
  26 is \fB(pid_t)\|0\fR, it specifies the calling process.
  27 .SH RETURN VALUES
  28 .sp
  29 .LP
  30 Upon successful completion, \fBgetsid()\fR returns the process group \fBID\fR
  31 of the session leader of the specified process. Otherwise, it returns
  32 \fB(pid_t)\(mi1\fR and sets \fBerrno\fR to indicate the error.
  33 .SH ERRORS
  34 .sp
  35 .LP
  36 The \fBgetsid()\fR function will fail if:
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fBEPERM\fR\fR
  41 .ad
  42 .RS 9n
  43 The process specified by \fIpid\fR is not in the same session as the calling
  44 process, and the implementation does not allow access to the process group
  45 \fBID\fR of the session leader of that process from the calling process.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBESRCH\fR\fR
  52 .ad
  53 .RS 9n
  54 There is no process with a process \fBID\fR equal to \fIpid\fR.
  55 .RE
  56
  57 .SH ATTRIBUTES
  58 .sp
  59 .LP
  60 See \fBattributes\fR(5) for descriptions of the following attributes:
  61 .sp
  62
  63 .sp
  64 .TS
  65 box;
  66 c | c
  67 l | l .
  68 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  69 _
  70 Interface Stability     Standard
  71 .TE
  72
  73 .SH SEE ALSO
  74 .sp
  75 .LP
  76 \fBexec\fR(2), \fBfork\fR(2), \fBgetpid\fR(2), \fBgetpgid\fR(2),
  77 \fBsetpgid\fR(2), \fBsetsid\fR(2), \fBattributes\fR(5), \fBstandards\fR(5)