<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Get path name of controlling terminal</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.posix-access.html">posix_access</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.posix-errno.html">posix_errno</a></div>
<div class="up"><a href="ref.posix.html">POSIX Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.posix-ctermid" class="refentry">
<div class="refnamediv">
<h1 class="refname">posix_ctermid</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">posix_ctermid</span> — <span class="dc-title">Get path name of controlling terminal</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.posix-ctermid-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>posix_ctermid</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Generates a <span class="type"><a href="language.types.string.html" class="type string">string</a></span> which is the pathname for the current
controlling terminal for the process. On error this will set errno,
which can be checked using <span class="function"><a href="function.posix-get-last-error.html" class="function">posix_get_last_error()</a></span>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.posix-ctermid-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Upon successful completion, returns <span class="type"><a href="language.types.string.html" class="type string">string</a></span> of the pathname to
the current controlling terminal. Otherwise <strong><code>FALSE</code></strong> is returned and errno
is set, which can be checked with <span class="function"><a href="function.posix-get-last-error.html" class="function">posix_get_last_error()</a></span>.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.posix-ctermid-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3649">
<p><strong>Example #1 <span class="function"><strong>posix_ctermid()</strong></span> example</strong></p>
<div class="example-contents"><p>
This example will display the path to the current TTY.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">"I am running from "</span><span style="color: #007700">.</span><span style="color: #0000BB">posix_ctermid</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.posix-ctermid-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.posix-ttyname.html" class="function" rel="rdfs-seeAlso">posix_ttyname()</a> - Determine terminal device name</span></li>
<li class="member"> <span class="function"><a href="function.posix-get-last-error.html" class="function" rel="rdfs-seeAlso">posix_get_last_error()</a> - Retrieve the error number set by the last posix function that failed</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.posix-access.html">posix_access</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.posix-errno.html">posix_errno</a></div>
<div class="up"><a href="ref.posix.html">POSIX Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
