man-pages/man3/ptsname.3.html
2021-03-31 01:06:50 +01:00

241 lines
5.0 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of PTSNAME</TITLE>
</HEAD><BODY>
<H1>PTSNAME</H1>
Section: Linux Programmer's Manual (3)<BR>Updated: 2017-09-15<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
ptsname, ptsname_r - get the name of the slave pseudoterminal
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>#include &lt;<A HREF="file:///usr/include/stdlib.h">stdlib.h</A>&gt;</B>
<P>
<B>char *ptsname(int </B><I>fd</I><B>);</B>
<BR>
<B>int ptsname_r(int </B><I>fd</I><B>, char *</B><I>buf</I><B>, size_t </B><I>buflen</I><B>);</B>
<P>
Feature Test Macro Requirements for glibc (see
<B><A HREF="/cgi-bin/man/man2html?7+feature_test_macros">feature_test_macros</A></B>(7)):
<P>
<B>ptsname</B>():
<BR>
<DL COMPACT><DT id="1"><DD>
Since glibc 2.24:
<BR>&nbsp;&nbsp;&nbsp;&nbsp;_XOPEN_SOURCE&nbsp;&gt;=&nbsp;500&nbsp;||
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(_XOPEN_SOURCE&nbsp;&amp;&amp;&nbsp;_XOPEN_SOURCE_EXTENDED)
<BR>
Glibc 2.23 and earlier:
<BR>&nbsp;&nbsp;&nbsp;&nbsp;_XOPEN_SOURCE
</DL>
<P>
<B>ptsname_r</B>():
<BR>&nbsp;&nbsp;&nbsp;&nbsp;_GNU_SOURCE
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
The
<B>ptsname</B>()
function returns the name of the slave pseudoterminal device
corresponding to the master referred to by
<I>fd</I>.
<P>
The
<B>ptsname_r</B>()
function is the reentrant equivalent of
<B>ptsname</B>().
It returns the name of the slave pseudoterminal device as a
null-terminated string in the buffer pointed to by
<I>buf</I>.
The
<I>buflen</I>
argument specifies the number of bytes available in
<I>buf</I>.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
On success,
<B>ptsname</B>()
returns a pointer to a string in static storage which will be
overwritten by subsequent calls.
This pointer must not be freed.
On failure, NULL is returned.
<P>
On success,
<B>ptsname_r</B>()
returns 0.
On failure, a nonzero value is returned
and
<I>errno</I>
is set to indicate the error.
<A NAME="lbAF">&nbsp;</A>
<H2>ERRORS</H2>
<DL COMPACT>
<DT id="2"><B>EINVAL</B>
<DD>
(<B>ptsname_r</B>()
only)
<I>buf</I>
is NULL.
(This error is returned only for
glibc 2.25 and earlier.)
<DT id="3"><B>ENOTTY</B>
<DD>
<I>fd</I>
does not refer to a pseudoterminal master device.
<DT id="4"><B>ERANGE</B>
<DD>
(<B>ptsname_r</B>()
only)
<I>buf</I>
is too small.
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>VERSIONS</H2>
<B>ptsname</B>()
is provided in glibc since version 2.1.
<A NAME="lbAH">&nbsp;</A>
<H2>ATTRIBUTES</H2>
For an explanation of the terms used in this section, see
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
<TABLE BORDER>
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
<TR VALIGN=top><TD>
<B>ptsname</B>()
</TD><TD>Thread safety</TD><TD>MT-Unsafe race:ptsname<BR></TD></TR>
<TR VALIGN=top><TD>
<B>ptsname_r</B>()
</TD><TD>Thread safety</TD><TD>MT-Safe<BR></TD></TR>
</TABLE>
<A NAME="lbAI">&nbsp;</A>
<H2>CONFORMING TO</H2>
<B>ptsname</B>():
<BR>&nbsp;POSIX.1-2001,&nbsp;POSIX.1-2008.
<P>
<B>ptsname</B>()
is part of the UNIX 98 pseudoterminal support (see
<B><A HREF="/cgi-bin/man/man2html?4+pts">pts</A></B>(4)).
<P>
<B>ptsname_r</B>()
is a Linux extension, that is proposed for inclusion
in the next major revision of POSIX.1 (Issue 8).
A version of this function is documented on Tru64 and HP-UX, but
on those implementations, -1 is returned on error, with
<I>errno</I>
set to indicate the error.
Avoid using this function in portable programs.
<A NAME="lbAJ">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?3+grantpt">grantpt</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+posix_openpt">posix_openpt</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+ttyname">ttyname</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+unlockpt">unlockpt</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?4+pts">pts</A></B>(4),
<B><A HREF="/cgi-bin/man/man2html?7+pty">pty</A></B>(7)
<A NAME="lbAK">&nbsp;</A>
<H2>COLOPHON</H2>
This page is part of release 5.05 of the Linux
<I>man-pages</I>
project.
A description of the project,
information about reporting bugs,
and the latest version of this page,
can be found at
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="5"><A HREF="#lbAB">NAME</A><DD>
<DT id="6"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="7"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="8"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT id="9"><A HREF="#lbAF">ERRORS</A><DD>
<DT id="10"><A HREF="#lbAG">VERSIONS</A><DD>
<DT id="11"><A HREF="#lbAH">ATTRIBUTES</A><DD>
<DT id="12"><A HREF="#lbAI">CONFORMING TO</A><DD>
<DT id="13"><A HREF="#lbAJ">SEE ALSO</A><DD>
<DT id="14"><A HREF="#lbAK">COLOPHON</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:53 GMT, March 31, 2021
</BODY>
</HTML>