Files
2024-08-23 06:57:20 +01:00

151 lines
3.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c4ac6c0cfa04e2d7910b0f0aeb2004f49081620b Maintainer: Fan2Shrek Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.net-get-interfaces" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>net_get_interfaces</refname>
<refpurpose>Renvoie les interfaces réseau</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>net_get_interfaces</methodname>
<void/>
</methodsynopsis>
<para>
Renvoie une énumération des interfaces réseau (adaptateurs) sur la machine locale.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Renvoie un &array; associatif où la clé est le nom de l'interface
et la valeur un tableau associatif des attributs de l'interface,
&return.falseforfailure;.
</para>
<para>
Chaque tableau associatif d'interface contient :
<table>
<title>Attributs d'Interface</title>
<tgroup cols="2">
<thead>
<row>
<entry>&Name;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>description</entry>
<entry>
Une valeur de chaîne optionnelle pour la description de l'interface.
Windows seulement.
</entry>
</row>
<row>
<entry>mac</entry>
<entry>
Une valeur de chaîne optionnelle pour l'adresse MAC de l'interface.
Windows seulement.
</entry>
</row>
<row>
<entry>mtu</entry>
<entry>
Une valeur entière pour l'unité de transmission maximale (MTU) de l'interface.
Windows seulement.
</entry>
</row>
<row>
<entry>unicast</entry>
<entry>
Un tableau d'arrays associatifs, voir les attributs Unicast ci-dessous.
</entry>
</row>
<row>
<entry>up</entry>
<entry>
Un booléen pour l'état (on/off) de l'interface.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
<table>
<title>Attributs d'Unicast</title>
<tgroup cols="2">
<thead>
<row>
<entry>&Name;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>flags</entry>
<entry>
Une valeur entière.
</entry>
</row>
<row>
<entry>family</entry>
<entry>
Une valeur entière.
</entry>
</row>
<row>
<entry>address</entry>
<entry>
Une valeur de chaîne pour l'adresse en IPv4 ou IPv6.
</entry>
</row>
<row>
<entry>netmask</entry>
<entry>
Une valeur de chaîne pour le masque de sous-réseau en IPv4 ou IPv6.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Emet une erreur <constant>E_WARNING</constant> en cas d'échec pour obtenir les informations de l'interface.
</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
-->