php-doc-en/reference/network/functions/long2ip.xml
Christoph Michael Becker 2ea9e6fea1 Improve wording
Patch provided by david@php.net.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@346018 c90b9560-bf6c-de11-be94-00142212c4b1
2018-11-19 13:14:01 +00:00

109 lines
2.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.long2ip" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>long2ip</refname>
<refpurpose>Converts an long integer address into a string in (IPv4) Internet standard dotted format</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>long2ip</methodname>
<methodparam><type>int</type><parameter>proper_address</parameter></methodparam>
</methodsynopsis>
<para>
The function <function>long2ip</function> generates an Internet address
in dotted format (i.e.: aaa.bbb.ccc.ddd) from the long integer
representation.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>proper_address</parameter></term>
<listitem>
<para>
A proper address representation in long integer.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the Internet IP address as a string.
</para>
</refsect1>
<refsect1 role="changelog"><!-- {{{ -->
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>7.1.0</entry>
<entry>
The parameter type of <parameter>proper_address</parameter> has been
changed from <type>string</type> to <type>integer</type>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1><!-- }}} -->
<refsect1 role="notes"><!-- {{{ -->
&reftitle.notes;
<note>
<para>
On 32-bit architectures, casting integer representations of IP addresses
from <type>string</type> to <type>integer</type> will not give
correct results for numbers which exceed <constant>PHP_INT_MAX</constant>.
</para>
</note>
</refsect1><!-- }}} -->
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ip2long</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
-->