inet-pton.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0c9c2dd669fe9395eaa73d487fbd160f9057429a Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.inet-pton" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>inet_pton</refname>
  <refpurpose>人間が読める形式の IP アドレスを、パックされた in_addr 形式に変換する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>inet_pton</methodname>
   <methodparam><type>string</type><parameter>ip</parameter></methodparam>
  </methodsynopsis>
  <para>
   この関数は、人間が読める形式の IPv4 あるいは IPv6
   (PHP が IPv6 サポートを有効にしてビルドされている場合) のアドレスを
   32 ビットあるいは 128 ビットのバイナリ形式に変換します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>ip</parameter></term>
     <listitem>
      <para>
       可読形式の IPv4 アドレスあるいは IPv6 アドレス。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   指定した <parameter>ip</parameter> を
   <literal>in_addr</literal> 形式で表したものを返します。
   構文的に無効な <parameter>ip</parameter>
   (ドットのない IPv4 アドレスやコロンのない IPv6 アドレスなど)
   を指定した場合は &false; を返します。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>inet_pton</function> の例</title>
    <programlisting role="php">
 <![CDATA[
<?php
$in_addr = inet_pton('127.0.0.1');
 
$in6_addr = inet_pton('::1');
?>
]]>
    </programlisting>
   </example>   
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ip2long</function></member>
    <member><function>long2ip</function></member>
    <member><function>inet_ntop</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:"~/.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
-->