Files
oldlinux-files/study/Ref-docs/POSIX/susv3/functions/ptsname.html
2024-02-19 00:25:23 -05:00

127 lines
4.3 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>ptsname</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
</script>
<basefont size="3"> <a name="ptsname"></a> <a name="tag_03_578"></a><!-- ptsname -->
<!--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_578_01"></a>NAME</h4>
<blockquote>ptsname - get name of the slave pseudo-terminal device</blockquote>
<h4><a name="tag_03_578_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/stdlib.h.html">stdlib.h</a>&gt;<br>
<br>
char *ptsname(int</tt> <i>fildes</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_578_03"></a>DESCRIPTION</h4>
<blockquote>
<p>The <i>ptsname</i>() function shall return the name of the slave pseudo-terminal device associated with a master pseudo-terminal
device. The <i>fildes</i> argument is a file descriptor that refers to the master device. The <i>ptsname</i>() function shall
return a pointer to a string containing the pathname of the corresponding slave device.</p>
<p>The <i>ptsname</i>() function need not be reentrant. A function that is not required to be reentrant is not required to be
thread-safe.</p>
</blockquote>
<h4><a name="tag_03_578_04"></a>RETURN VALUE</h4>
<blockquote>
<p>Upon successful completion, <i>ptsname</i>() shall return a pointer to a string which is the name of the pseudo-terminal slave
device. Upon failure, <i>ptsname</i>() shall return a null pointer. This could occur if <i>fildes</i> is an invalid file descriptor
or if the slave device name does not exist in the file system.</p>
</blockquote>
<h4><a name="tag_03_578_05"></a>ERRORS</h4>
<blockquote>
<p>No errors are defined.</p>
</blockquote>
<hr>
<div class="box"><em>The following sections are informative.</em></div>
<h4><a name="tag_03_578_06"></a>EXAMPLES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_578_07"></a>APPLICATION USAGE</h4>
<blockquote>
<p>The value returned may point to a static data area that is overwritten by each call to <i>ptsname</i>().</p>
</blockquote>
<h4><a name="tag_03_578_08"></a>RATIONALE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_578_09"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_578_10"></a>SEE ALSO</h4>
<blockquote>
<p><a href="grantpt.html"><i>grantpt</i>()</a> , <a href="open.html"><i>open</i>()</a> , <a href=
"ttyname.html"><i>ttyname</i>()</a> , <a href="unlockpt.html"><i>unlockpt</i>()</a> , the Base Definitions volume of
IEEE&nbsp;Std&nbsp;1003.1-2001, <a href="../basedefs/stdlib.h.html"><i>&lt;stdlib.h&gt;</i></a></p>
</blockquote>
<h4><a name="tag_03_578_11"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 4, Version 2.</p>
</blockquote>
<h4><a name="tag_03_578_12"></a>Issue 5</h4>
<blockquote>
<p>Moved from X/OPEN UNIX extension to BASE.</p>
<p>A note indicating that this function need not be reentrant is added to the DESCRIPTION.</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>