mirror of
https://github.com/macintoshplus/doc-fr.git
synced 2026-03-26 01:42:09 +01:00
491 lines
11 KiB
XML
491 lines
11 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: a4fe8cf4c7712c4af6d2b0dc2e3d7090f53f4e21 Maintainer: yannick Status: ready -->
|
|
<!-- Reviewed: no -->
|
|
|
|
<refentry xml:id="function.eio-readdir" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>eio_readdir</refname>
|
|
<refpurpose>Lit le contenu d'un dossier</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>eio_readdir</methodname>
|
|
<methodparam><type>string</type><parameter>path</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>pri</parameter></methodparam>
|
|
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
|
|
<methodparam
|
|
choice="opt"><type>string</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Lit le contenu complet d'un dossier (via les appels systèmes
|
|
<literal>opendir</literal>, <literal>readdir</literal> et
|
|
<literal>closedir</literal>) et retourne soit les noms, soit un tableau
|
|
suivant la valeur de l'argument <parameter>flags</parameter>.
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>path</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Chemin du dossier.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>flags</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Combinaison de constantes <emphasis>EIO_READDIR_*</emphasis>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>pri</parameter></term>
|
|
<listitem>
|
|
&eio.request.pri.values;
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>callback</parameter></term>
|
|
<listitem>
|
|
&eio.callback.proto;
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>data</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Variables arbitraires à passer à la fonction de rappel
|
|
<parameter>callback</parameter>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
<function>eio_readdir</function> retourne la ressource demandée en cas
|
|
de succès,&return.falseforfailure;.
|
|
Définissez l'argument
|
|
<parameter>result</parameter> de la fonction de rappel
|
|
<parameter>callback</parameter> suivant le drapeau
|
|
<parameter>flags</parameter> utilisé :
|
|
</para>
|
|
|
|
<para>
|
|
<variablelist>
|
|
|
|
<!--{{{ EIO_READDIR_* -->
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_READDIR_DENTS</constant>
|
|
(&integer;)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Drapeau pour <function>eio_readdir</function>.
|
|
Si spécifié, l'argument de résultat de la fonction de rappel
|
|
devient un tableau contenant les clés suivantes :
|
|
<literal>'names'</literal> - tableau de noms de dossiers
|
|
<literal>'dents'</literal> - tableau de <literal>struct
|
|
eio_dirent</literal> - comme un tableau, mais contenant les clés spécifiques suivantes :
|
|
<literal>'name'</literal> - le nom du dossier ;
|
|
<literal>'type'</literal> - une des constantes <emphasis>EIO_DT_*</emphasis> ;
|
|
<literal>'inode'</literal> - le numbre d'inodes, si disponible, sinon ne sera pas spécifié ;
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_READDIR_DIRS_FIRST</constant>
|
|
(&integer;)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Lorsque ce drapeau est spécifié, les noms seront retournés dans un ordre
|
|
où les dossiers arrivent en premier, et ensuite dans un ordre de statut optimal.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_READDIR_STAT_ORDER</constant>
|
|
(&integer;)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Lorsque ce drapeau est spécifié, alors les noms seront retournés dans un
|
|
ordre suivant le statut <literal>stat</literal> de chaque nœud.
|
|
Si vous avez prévu d'appliquer la fonction <function>stat</function> a tous
|
|
les fichiers du dossier, il vous sera plus rapide d'utiliser ce drapeau.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_READDIR_FOUND_UNKNOWN</constant>
|
|
(&integer;)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<!--}}}-->
|
|
|
|
</variablelist>
|
|
</para>
|
|
|
|
<para>Types de nœud :
|
|
<variablelist>
|
|
|
|
<!--{{{ EIO_DT_* -->
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_UNKNOWN</constant>
|
|
(&integer;)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Un nœud de type inconnu (souvent le cas). Une utilisation de la fonction
|
|
<function>stat</function> est nécessaire.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_FIFO</constant>
|
|
(&integer;)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Un nœud de type FIFO
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_CHR</constant>
|
|
(&integer;)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Type de nœud
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_MPC</constant>
|
|
(&integer;)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Un nœud de type périphérique à caractères multiplexés (v7+coherent)
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_DIR</constant>
|
|
(&integer;)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Un nœud de type dossier
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_NAM</constant>
|
|
(&integer;)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Un nœud de type fichier nommé spécialement Xenix
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_BLK</constant>
|
|
(&integer;)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Type de nœud
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_MPB</constant>
|
|
(&integer;)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Bloc multiplexé du périphérique (v7+coherent)
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_REG</constant>
|
|
(&integer;)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Type de nœud
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_NWK</constant>
|
|
(&integer;)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_CMP</constant>
|
|
(&integer;)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Un nœud de type spécial du réseau HP-UX
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_LNK</constant>
|
|
(&integer;)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Un nœud de type lien
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_SOCK</constant>
|
|
(&integer;)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Un nœud de type socket
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_DOOR</constant>
|
|
(&integer;)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Un nœud de type Solaris door
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_WHT</constant>
|
|
(&integer;)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Type de nœud
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_MAX</constant>
|
|
(&integer;)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Valeur de type de nœud le plus haut possible
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<!--}}}-->
|
|
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title>Exemple avec <function>eio_readdir</function></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
/* Is called when eio_readdir() finishes */
|
|
function my_readdir_callback($data, $result) {
|
|
echo __FUNCTION__, " called\n";
|
|
echo "donnée : "; var_dump($data);
|
|
echo "résultat : "; var_dump($result);
|
|
echo "\n";
|
|
}
|
|
|
|
eio_readdir("/var/spool/news", EIO_READDIR_STAT_ORDER | EIO_READDIR_DIRS_FIRST,
|
|
EIO_PRI_DEFAULT, "my_readdir_callback");
|
|
eio_event_loop();
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
my_readdir_callback called
|
|
donnée : NULL
|
|
résultat : array(2) {
|
|
["names"]=>
|
|
array(7) {
|
|
[0]=>
|
|
string(7) "archive"
|
|
[1]=>
|
|
string(8) "articles"
|
|
[2]=>
|
|
string(8) "incoming"
|
|
[3]=>
|
|
string(7) "innfeed"
|
|
[4]=>
|
|
string(8) "outgoing"
|
|
[5]=>
|
|
string(8) "overview"
|
|
[6]=>
|
|
string(3) "tmp"
|
|
}
|
|
["dents"]=>
|
|
array(7) {
|
|
[0]=>
|
|
array(3)
|
|
{
|
|
["name"]=>
|
|
string(7)
|
|
"archive"
|
|
["type"]=>
|
|
int(4)
|
|
["inode"]=>
|
|
int(393265)
|
|
}
|
|
[1]=>
|
|
array(3)
|
|
{
|
|
["name"]=>
|
|
string(8)
|
|
"articles"
|
|
["type"]=>
|
|
int(4)
|
|
["inode"]=>
|
|
int(393266)
|
|
}
|
|
[2]=>
|
|
array(3)
|
|
{
|
|
["name"]=>
|
|
string(8)
|
|
"incoming"
|
|
["type"]=>
|
|
int(4)
|
|
["inode"]=>
|
|
int(393267)
|
|
}
|
|
[3]=>
|
|
array(3)
|
|
{
|
|
["name"]=>
|
|
string(7)
|
|
"innfeed"
|
|
["type"]=>
|
|
int(4)
|
|
["inode"]=>
|
|
int(393269)
|
|
}
|
|
[4]=>
|
|
array(3)
|
|
{
|
|
["name"]=>
|
|
string(8)
|
|
"outgoing"
|
|
["type"]=>
|
|
int(4)
|
|
["inode"]=>
|
|
int(393270)
|
|
}
|
|
[5]=>
|
|
array(3)
|
|
{
|
|
["name"]=>
|
|
string(8)
|
|
"overview"
|
|
["type"]=>
|
|
int(4)
|
|
["inode"]=>
|
|
int(393271)
|
|
}
|
|
[6]=>
|
|
array(3)
|
|
{
|
|
["name"]=>
|
|
string(3)
|
|
"tmp"
|
|
["type"]=>
|
|
int(4)
|
|
["inode"]=>
|
|
int(393272)
|
|
}
|
|
}
|
|
}
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</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
|
|
-->
|