Blame man3/tcgetsid.3

Packit 7cfc04
.\" Copyright (C) 2002 Andries Brouwer <aeb@cwi.nl>
Packit 7cfc04
.\"
Packit 7cfc04
.\" %%%LICENSE_START(VERBATIM)
Packit 7cfc04
.\" Permission is granted to make and distribute verbatim copies of this
Packit 7cfc04
.\" manual provided the copyright notice and this permission notice are
Packit 7cfc04
.\" preserved on all copies.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Permission is granted to copy and distribute modified versions of this
Packit 7cfc04
.\" manual under the conditions for verbatim copying, provided that the
Packit 7cfc04
.\" entire resulting derived work is distributed under the terms of a
Packit 7cfc04
.\" permission notice identical to this one.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Since the Linux kernel and libraries are constantly changing, this
Packit 7cfc04
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
Packit 7cfc04
.\" responsibility for errors or omissions, or for damages resulting from
Packit 7cfc04
.\" the use of the information contained herein.  The author(s) may not
Packit 7cfc04
.\" have taken the same level of care in the production of this manual,
Packit 7cfc04
.\" which is licensed free of charge, as they might when working
Packit 7cfc04
.\" professionally.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Formatted or processed versions of this manual, if unaccompanied by
Packit 7cfc04
.\" the source, must acknowledge the copyright and authors of this work.
Packit 7cfc04
.\" %%%LICENSE_END
Packit 7cfc04
.\"
Packit 7cfc04
.TH TCGETSID 3 2015-08-08 "GNU" "Linux Programmer's Manual"
Packit 7cfc04
.SH NAME
Packit 7cfc04
tcgetsid \- get session ID
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.BR "#define _XOPEN_SOURCE 500" "        /* See feature_test_macros(7) */"
Packit 7cfc04
.br
Packit 7cfc04
.B "#include <termios.h>"
Packit 7cfc04
.PP
Packit 7cfc04
.BI "pid_t tcgetsid(int " fd );
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
The function
Packit 7cfc04
.BR tcgetsid ()
Packit 7cfc04
returns the session ID of the current session that has the
Packit 7cfc04
terminal associated to
Packit 7cfc04
.I fd
Packit 7cfc04
as controlling terminal.
Packit 7cfc04
This terminal must be the controlling terminal of the calling process.
Packit 7cfc04
.SH RETURN VALUE
Packit 7cfc04
When
Packit 7cfc04
.I fd
Packit 7cfc04
refers to the controlling terminal of our session,
Packit 7cfc04
the function
Packit 7cfc04
.BR tcgetsid ()
Packit 7cfc04
will return the session ID of this session.
Packit 7cfc04
Otherwise, \-1 is returned, and
Packit 7cfc04
.I errno
Packit 7cfc04
is set appropriately.
Packit 7cfc04
.SH ERRORS
Packit 7cfc04
.TP
Packit 7cfc04
.B EBADF
Packit 7cfc04
.I fd
Packit 7cfc04
is not a valid file descriptor.
Packit 7cfc04
.TP
Packit 7cfc04
.B ENOTTY
Packit 7cfc04
The calling process does not have a controlling terminal, or
Packit 7cfc04
it has one but it is not described by
Packit 7cfc04
.IR fd .
Packit 7cfc04
.SH VERSIONS
Packit 7cfc04
.BR tcgetsid ()
Packit 7cfc04
is provided in glibc since version 2.1.
Packit 7cfc04
.SH ATTRIBUTES
Packit 7cfc04
For an explanation of the terms used in this section, see
Packit 7cfc04
.BR attributes (7).
Packit 7cfc04
.TS
Packit 7cfc04
allbox;
Packit 7cfc04
lb lb lb
Packit 7cfc04
l l l.
Packit 7cfc04
Interface	Attribute	Value
Packit 7cfc04
T{
Packit 7cfc04
.BR tcgetsid ()
Packit 7cfc04
T}	Thread safety	MT-Safe
Packit 7cfc04
.TE
Packit 7cfc04
.SH CONFORMING TO
Packit 7cfc04
POSIX.1-2001, POSIX.1-2008.
Packit 7cfc04
.SH NOTES
Packit 7cfc04
This function is implemented via the
Packit 7cfc04
.B TIOCGSID
Packit 7cfc04
.BR ioctl (2),
Packit 7cfc04
present
Packit 7cfc04
since Linux 2.1.71.
Packit 7cfc04
.SH SEE ALSO
Packit 7cfc04
.BR getsid (2)
Packit 7cfc04
.SH COLOPHON
Packit 7cfc04
This page is part of release 4.15 of the Linux
Packit 7cfc04
.I man-pages
Packit 7cfc04
project.
Packit 7cfc04
A description of the project,
Packit 7cfc04
information about reporting bugs,
Packit 7cfc04
and the latest version of this page,
Packit 7cfc04
can be found at
Packit 7cfc04
\%https://www.kernel.org/doc/man\-pages/.