socket-last-error.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e50e79746736dbdfbabe9bd3566793b3ddf38f58 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi -->
<refentry xml:id="function.socket-last-error" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>socket_last_error</refname>
  <refpurpose>ソケットの直近のエラーを返す</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>
   <classname>Socket</classname> クラスのインスタンスをこの関数に渡すと、この特定のソケットに発生した
   直近のエラーが返されます。<parameter>socket</parameter> が &null; の場合、
   直近にエラーを発生したソケット関数のエラーコードが返されます。
   後者は、失敗した場合にソケットを返さない
   <function>socket_create</function> のような関数や
   特定のソケットに直接関係ない理由で失敗する可能性がある
   <function>socket_select</function> で特に有用です。
   このエラーコードは、指定したエラーコードを表す文字列を得るために
   <function>socket_strerror</function> に渡すものとしても適しています。
  </para>
  <para>
   エラーが発生していない場合や
   <function>socket_clear_error</function> でクリアされた後である場合は、
   この関数は <literal>0</literal> を返します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>socket</parameter></term>
     <listitem>
      <para>
       <function>socket_create</function> で作成した <classname>Socket</classname> クラスのインスタンス。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   この関数は、ソケットのエラーコードを返します。
  </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> は、nullable になりました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><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("ソケットを作成できません: [$errorcode] $errormsg");
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    <function>socket_last_error</function> はエラーコードをクリアしません。
    クリアするには <function>socket_clear_error</function>
    を使用してください。
   </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
-->