xref: /netbsd/lib/libc/termios/tcgetsid.3 (revision c4a72b64)
1.\"	$NetBSD: tcgetsid.3,v 1.3 2002/10/01 18:11:45 wiz Exp $
2.\"
3.\" Copyright (c) 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"	@(#)tcgetpgrp.3	8.1 (Berkeley) 6/4/93
35.\"
36.Dd February 13, 1998
37.Dt TCGETSID 3
38.Os
39.Sh NAME
40.Nm tcgetsid
41.Nd get session ID associated with a controlling terminal
42.Sh LIBRARY
43.Lb libc
44.Sh SYNOPSIS
45.Fd #include \*[Lt]sys/types.h\*[Gt]
46.Fd #include \*[Lt]unistd.h\*[Gt]
47.Ft pid_t
48.Fn tcgetsid "int fd"
49.Sh DESCRIPTION
50The
51.Nm tcgetsid
52function returns the value of the session ID associated with the specified
53controlling terminal device.
54The session ID is defined as the process group ID of the session leader.
55.Sh ERRORS
56If an error occurs,
57.Nm tcgetsid
58returns -1 and the global variable
59.Va errno
60is set to indicate the error, as follows:
61.Bl -tag -width Er
62.It Bq Er EBADF
63The
64.Fa fd
65argument is not a valid file descriptor.
66.It Bq Er ENOTTY
67The calling process does not have a controlling terminal or the
68underlying terminal device represented by
69.Fa fd
70is not the controlling terminal.
71.El
72.Sh SEE ALSO
73.Xr getsid 2 ,
74.Xr setsid 2 ,
75.Xr tcgetpgrp 3
76.Sh STANDARDS
77The
78.Nm tcgetsid
79function conforms to
80.St -xpg4.2 .
81