unpack
Unpack data from binary string
&reftitle.description;
arrayunpack
stringformat
stringdata
Unpacks from a binary string into an array according to the given
format.
The unpacked data is stored in an associative array. To
accomplish this you have to name the different format codes and
separate them by a slash /. If a repeater argument is present,
then each of the array keys will have a sequence number behind
the given name.
&reftitle.parameters;
format
See pack for an explanation of the format codes.
data
The packed data.
&reftitle.returnvalues;
Returns an associative array containing unpacked elements of binary
string.
&reftitle.changelog;
&Version;
&Description;
5.5.0
Changes were made to bring this function into line with Perl:
The "a" code now retains trailing NULL bytes.
The "A" code now strips all trailing ASCII whitespace (spaces, tabs,
newlines, carriage returns, and NULL bytes).
The "Z" code was added for NULL-padded strings, and removes trailing
NULL bytes.
&reftitle.examples;
unpack example
]]>
&example.outputs;
4
[int] => 160
)
]]>
unpack example with a repeater
]]>
&example.outputs;
4
[chars2] => 0
[int] => 40960
)
]]>
&reftitle.notes;
Note that PHP internally stores integral values as signed. If you
unpack a large unsigned long and it is of the same size as PHP
internally stored values the result will be a negative number
even though unsigned unpacking was specified.
If you do not name an element, numeric indices starting from 1 are used.
Be aware that if you have more than one unnamed element, some data is
overwritten because the numbering restarts from 1 for each element.
unpack example with unnamed keys
]]>
&example.outputs;
int(160)
[2]=>
int(66)
}
]]>
Note that the
first value from the c specifier is
overwritten by the first value from the n
specifier.
&reftitle.seealso;
pack