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

<refentry xml:id="function.unpack" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>unpack</refname>

<refpurpose>Entpackt die Daten einer binäre Zeichenkette</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>array</type><type>false</type></type><methodname>unpack</methodname>

<methodparam><type>string</type><parameter>format</parameter></methodparam>

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

<methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>

</methodsynopsis>

<para>

Überträgt die Daten einer binäre Zeichenkette in ein Array unter

Berücksichtigung des Parameters <parameter>format</parameter>.

</para>

<para>

Die entpackten Daten werden in einem assoziativen Array abgebildet. Hierzu

müssen die verschiedenen Format-Codes benannt und mit "/" getrennt werden.

Wenn ein sich wiederholendes Argument existiert, werden die Array-Schlüssel

durchnummeriert, indem ihnen eine Zahl angehängt wird.

</para>

<para>

Änderungen wurden durchgeführt, um diese Funktion in Übereinstimmung mit

Perl zu bringen:

<simplelist>

<member>

Der Code "a" erhält nun abschließende NULL Bytes.

</member>

<member>

Der Code "A" entfernt nun alle abschließenden ASCII Whitespaces

(Leerzeichen, Tabs, Zeilenvorschübe, Wagenrückläufe und NULL Bytes).

</member>

<member>

Der Code "Z" wurde für mit NULL aufgefüllte Zeichenketten hinzugefügt,

und entfernt abschließende NULL Bytes.

</member>

</simplelist>

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>format</parameter></term>

<listitem>

<para>

Die Format-Codes werden unter <function>pack</function> näher

erläutert.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>string</parameter></term>

<listitem>

<para>

Die gepackten Daten.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>offset</parameter></term>

<listitem>

<para>

Der Offset, an dem das Entpacken beginnt.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Gibt ein assoziatives Array zurück, das die entpackten Elemente als binäre

Zeichenkette enthält. &return.falseforfailure;

</para>

</refsect1>

<refsect1 role="changelog"><!-- {{{ -->

&reftitle.changelog;

<para>

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>7.2.0</entry>

<entry>

<type>float</type>- und <type>double</type>-Typen unterstützen sowohl

Big-Endian als auch Little-Endian.

</entry>

</row>

<row>

<entry>7.1.0</entry>

<entry>

Der optionale <parameter>offset</parameter> wurde hinzugefügt.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</para>

</refsect1><!-- }}} -->

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title><function>unpack</function>-Beispiel</title>

<programlisting role="php">

</programlisting>

&example.outputs;

<screen>

</screen>

</example>

</para>

<para>

<example>

<title><function>unpack</function>-Beispiel mit Wiederholer</title>

<programlisting role="php">

</programlisting>

&example.outputs;

<screen>

</screen>

</example>

</para>

</refsect1>

<refsect1 role="notes">

&reftitle.notes;

<caution>

<para>

Beachten Sie, dass PHP Integer-Werte intern mit Vorzeichen speichert. Wenn

Sie einen großen vorzeichenlosen Longwert entpacken und er von der selben

Größe ist, die PHP für dessen Speicherung verwendet, wird das Ergebnis ein

negativer Wert sein (auch wenn Sie dieses als vorzeichenlos zu entpacken

angegeben haben).

</para>

</caution>

<caution>

<para>

Wird ein Element nicht benannt, dann werden numerische Indizes beginnend

mit <literal>1</literal> verwendet. Es ist zu berücksichtigen, dass im

Falle mehrerer unbenannter Elemente ein Teil der Daten überschrieben wird,

da die Nummerierung für jedes Element wieder bei <literal>1</literal>

beginnt.

</para>

<para>

<example>

<title><function>unpack</function>-Beispiel mit unbenannten Schlüsseln</title>

<programlisting role="php">

</programlisting>

&example.outputs;

<screen>

</screen>

<para>

Es ist zu beachten, dass der erste Wert vom Symbol <literal>c</literal>

mit dem Wert vom Symbol <literal>n</literal> überschrieben wurde.

</para>

</example>

</para>

</caution>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>pack</function></member>

</simplelist>

</para>

</refsect1>

</refentry>