Files
doc-fr/reference/sockets/functions/socket-last-error.xml
George Peter Banyard b7784c08a3 Apply commit 14dc7c47365f2b71f6c907a5ba5bccf42534d5a9
Generate sockets methodsynopses based on stubs
2021-01-12 05:58:45 +00:00

136 lines
3.7 KiB
XML
Executable File

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 14dc7c47365f2b71f6c907a5ba5bccf42534d5a9 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.socket-last-error" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>socket_last_error</refname>
<refpurpose>Lit la dernière erreur générée par un socket</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>socket_last_error</methodname>
<methodparam choice="opt"><type class="union"><type>Socket</type><type>null</type></type><parameter>socket</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Si une instance de <classname>Socket</classname> est passée à cette fonction, la dernière erreur
qui aura été générée par ce socket sera retourné. Si <parameter>socket</parameter>
est &null;, le dernier code d'erreur généré est retourné.
Ce comportement est particulièrement pratique pour des fonctions comme
<function>socket_create</function> qui ne retournent pas de socket
en cas d'échec, et <function>socket_select</function> qui peut
échouer sans raison directement liée au socket. Le code d'erreur
peut être transmis à <function>socket_strerror</function> qui retourne
un message d'erreur lisible.
</para>
<para>
Si aucune erreur n'est survenue, ou si l'erreur a été
supprimée avec la fonction <function>socket_clear_error</function>,
cette fonction retournera <literal>0</literal>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>socket</parameter></term>
<listitem>
<para>
Une instance de <classname>Socket</classname> créée par
<function>socket_create</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne le code erreur associé au socket.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&sockets.changelog.socket-param;
<row>
<entry>8.0.0</entry>
<entry>
<parameter>socket</parameter> est désormais nullable.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>socket_last_error</function></title>
<programlisting role="php">
<![CDATA[
<?php
$socket = @socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
if ($socket === false) {
$errorcode = socket_last_error();
$errormsg = socket_strerror($errorcode);
die("Impossible de créer le socket : [$errorcode] $errormsg");
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
<function>socket_last_error</function> n'efface pas le code d'erreur. Utilisez
plutôt la fonction <function>socket_clear_error</function> pour cela.
</para>
</note>
</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
-->