php-doc-en/reference/math/functions/dechex.xml
Adam Harvey ca01897d64 Fix doc bug (dechex may convert numbers up to PHP_INT_MAX) by clarifying
that PHP treats the parameter as an unsigned int, and working through some of
the implications of that from a userland perspective.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@327571 c90b9560-bf6c-de11-be94-00142212c4b1
2012-09-10 01:54:11 +00:00

131 lines
3.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.dechex" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>dechex</refname>
<refpurpose>Decimal to hexadecimal</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>dechex</methodname>
<methodparam><type>int</type><parameter>number</parameter></methodparam>
</methodsynopsis>
<para>
Returns a string containing a hexadecimal representation of the given
unsigned <parameter>number</parameter> argument.
</para>
<para>
The largest number that can be converted is
<constant>PHP_INT_MAX</constant><literal> * 2 + 1</literal> (or
<literal>-1</literal>): on 32-bit platforms, this will be
<literal>4294967295</literal> in decimal, which results in
<function>dechex</function> returning <literal>ffffffff</literal>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>number</parameter></term>
<listitem>
<para>
The decimal value to convert.
</para>
<para>
As PHP's <type>integer</type> type is signed, but
<function>dechex</function> deals with unsigned integers, negative
integers will be treated as though they were unsigned.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Hexadecimal string representation of <parameter>number</parameter>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>dechex</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
echo dechex(10) . "\n";
echo dechex(47);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
a
2f
]]>
</screen>
</example>
</para>
<para>
<example>
<title><function>dechex</function> example with large integers</title>
<programlisting role="php">
<![CDATA[
<?php
// The output below assumes a 32-bit platform.
// Note that the output is the same for all values.
echo dechex(-1)."\n";
echo dechex(PHP_INT_MAX * 2 + 1)."\n";
echo dechex(pow(2, 32) - 1)."\n";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
ffffffff
ffffffff
ffffffff
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>hexdec</function></member>
<member><function>decbin</function></member>
<member><function>decoct</function></member>
<member><function>base_convert</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
-->