posix-ctermid.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: f8854f6a6a7907720ed8ec8657a2f466a82c0394 Maintainer: seros Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.posix-ctermid" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>posix_ctermid</refname>
  <refpurpose>Obtener el nombre de la ruta del terminal controlador</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>
   Genera un <type>string</type> que es el nombre de la ruta del terminal
   controlador actual para el proceso. En caso de error se establecerá a errno,
   que puede ser comprobado usando <function>posix_get_last_error</function>
  </para>
 </refsect1>

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

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   En caso de terminación exitosa, devuelve un <type>string</type> del nombre de ruta del
   terminal controlador actual. De otro modo devuelve &false; y se establece
   errno, que puede ser comprobado con <function>posix_get_last_error</function>.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>posix_ctermid</function></title>
    <para>
     Este ejemplo mostrará la ruta del TTY actual.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
echo "Esto ejecutándome desde ".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
-->