posix-ctermid.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.posix-ctermid" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>posix_ctermid</refname>
  <refpurpose>Get path name of controlling terminal</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>posix_ctermid</methodname>
   <void/>
  </methodsynopsis>
  <para>
   Generates a <type>string</type> which is the pathname for the current 
   controlling terminal for the process.  On error this will set errno, 
   which can be checked using <function>posix_get_last_error</function>
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Upon successful completion, returns <type>string</type> of the pathname to 
   the current controlling terminal.  Otherwise &false; is returned and errno
   is set, which can be checked with <function>posix_get_last_error</function>.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>posix_ctermid</function> example</title>
    <para>
     This example will display the path to the current TTY.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
echo "I am running from ".posix_ctermid();
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>posix_ttyname</function></member>
    <member><function>posix_get_last_error</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->