<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<refentry xml:id="function.ini-parse-quantity" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>ini_parse_quantity</refname>

<refpurpose>Get interpreted size from ini shorthand syntax</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>int</type><methodname>ini_parse_quantity</methodname>

<methodparam><type>string</type><parameter>shorthand</parameter></methodparam>

</methodsynopsis>

<para>

Returns the interpreted size in bytes on success from an <link linkend="faq.using.shorthandbytes">ini shorthand</link>.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>shorthand</parameter></term>

<listitem>

<para>

Ini shorthand to parse, must be a number followed by an optional multiplier.

The following multipliers are supported: <literal>k</literal>/<literal>K</literal> (<literal>1024</literal>),

<literal>m</literal>/<literal>M</literal> (<literal>1048576</literal>),

<literal>g</literal>/<literal>G</literal> (<literal>1073741824</literal>).

The number can be a decimal, hex (prefixed with <literal>0x</literal> or <literal>0X</literal>),

octal (prefixed with <literal>0o</literal>, <literal>0O</literal> or <literal>0</literal>) or binary (prefixed with

<literal>0b</literal> or <literal>0B</literal>)

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Returns the interpreted size in bytes as an &integer;.

</para>

</refsect1>

<refsect1 role="errors">

&reftitle.errors;

<para>

If the value cannot be parsed, or an invalid multiplier is used, an <constant>E_WARNING</constant> is raised.

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>A few <function>ini_parse_quantity</function> examples</title>

<programlisting role="php">

<![CDATA[

<?php

var_dump(ini_parse_quantity('1024'));

var_dump(ini_parse_quantity('1024M'));

var_dump(ini_parse_quantity('512K'));

var_dump(ini_parse_quantity('0xFFk'));

var_dump(ini_parse_quantity('0b1010k'));

var_dump(ini_parse_quantity('0o1024'));

var_dump(ini_parse_quantity('01024'));

var_dump(ini_parse_quantity('Foobar'));

var_dump(ini_parse_quantity('10F'));

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

int(1024)

int(1073741824)

int(524288)

int(261120)

int(10240)

int(532)

int(532)

Warning: Invalid quantity "Foobar": no valid leading digits, interpreting as "0" for backwards compatibility

int(0)

Warning: Invalid quantity "10F": unknown multiplier "F", interpreting as "10" for backwards compatibility

int(10)

]]>

</screen>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<simplelist>

<member><function>ini_get</function></member>

</simplelist>

</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

-->