php-doc-en/reference/posix/functions/posix-isatty.xml
Logan Buesching b675574126 Committing accepted patch for POSIX functions. This includes documentation
for many of the undocumented POSIX functions and adds examples to previously
documented functions.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@234861 c90b9560-bf6c-de11-be94-00142212c4b1
2007-05-03 18:03:24 +00:00

74 lines
1.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry id="function.posix-isatty">
<refnamediv>
<refname>posix_isatty</refname>
<refpurpose>Determine if a file descriptor is an interactive terminal</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>posix_isatty</methodname>
<methodparam><type>int</type><parameter>fd</parameter></methodparam>
</methodsynopsis>
<para>
Determines if the file descriptor <parameter>fd</parameter> refers to a valid
terminal type device.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>fd</parameter></term>
<listitem>
<para>
The file descriptor.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if <parameter>fd</parameter> is an open descriptor connected
to a terminal and &false; otherwise.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>posix_ttyname</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:"../../../../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
-->