Core Function Unpack - Revision history

UberFoX: 1 revision

2015-06-14T12:38:10Z

1 revision

← Older revision

Revision as of 12:38, 14 June 2015

UberFoX: 1 revision

2014-08-11T21:40:30Z

1 revision

← Older revision

Revision as of 21:40, 11 August 2014

UberFoX: /* data/binary-array */

2013-09-26T23:34:28Z

data/binary-array

← Older revision		Revision as of 23:34, 26 September 2013
Line 28:		Line 28:

	You can read/write binary data to/from strings as often as you like and it will not make the string become Unicode it will act as pure ASCII the only time that will ever change is if you explicitly write a character value over 255 to one of the strings characters.		You can read/write binary data to/from strings as often as you like and it will not make the string become Unicode it will act as pure ASCII the only time that will ever change is if you explicitly write a character value over 255 to one of the strings characters.
		+
		+	To force a string to be ASCII you could use [[Core Function BinaryFromStr\|BinaryFromStr( )]].

	==== flag ====		==== flag ====

UberFoX: /* data/binary-array */

2013-09-26T21:22:56Z

data/binary-array

← Older revision		Revision as of 21:22, 26 September 2013
Line 24:		Line 24:

	A variable that will be converted to a binary array.		A variable that will be converted to a binary array.
		+
		+	If you provide a string to this parameter it will be converted to bytes using either ASCII or UNICODE depending on the values the strings characters contain for example none of the strings characters go higher than 255 you will get pure ASCII bytes of the string (so it will be same length as the string). However if some of the strings characters have a numeric code higher than 255 they will be considered Unicode and you will get more than one byte for each character that goes over the 255 limit, Which could be a big problem as the bytes you will get will not be the same size you was expecting.
		+
		+	You can read/write binary data to/from strings as often as you like and it will not make the string become Unicode it will act as pure ASCII the only time that will ever change is if you explicitly write a character value over 255 to one of the strings characters.

	==== flag ====		==== flag ====

UberFoX: /* Remarks */

2013-09-26T15:04:02Z

Remarks

← Older revision		Revision as of 15:04, 26 September 2013
Line 53:		Line 53:
	=== Remarks ===		=== Remarks ===

−	~~None~~.	+	Be aware that if you do not name an element, it will use an index like 0 1 2 3 4. If you do not name more than one element, Unlike PHP Sputnik will insert the items into the array similar to Push() so you will get element 0 1 2 3 4 etc rather than everything replacing the element at index 1.
		+
		+	Also PHP users must note Sputnik returns an array starting at index 0 where as PHP starts at index 1 this may be a cause for confusion.

	=== Example ===		=== Example ===

UberFoX: /* flag */

2013-09-26T14:09:44Z

flag

← Older revision		Revision as of 14:09, 26 September 2013
Line 35:		Line 35:
	2 = Force return of single item as is (string, int, float etc) regardless if (key) etc was used		2 = Force return of single item as is (string, int, float etc) regardless if (key) etc was used

−	~~Basically set it to~~ 0 ~~to get~~ the array ~~or single item if applicable, 1 to return a string regardless of what content~~ is (~~such as int~~)~~, 2 to~~ return ~~the first object intact~~ (~~no string conversion)~~ and ~~finally 3 to force it to be~~ an array ~~no matter what.~~	+	3 = Return an associative array (same as 0) UNLESS there is only one item in the array and the key is numeric (not named) then it will return just that single item only (and not return an array)

	Default: 0		Default: 0

UberFoX at 14:01, 26 September 2013

2013-09-26T14:01:46Z

← Older revision		Revision as of 14:01, 26 September 2013
Line 1:		Line 1:
	<pre>		<pre>
−	Unpack( <~~expression~~>, <binary-array~~/string~~>, <flag> )	+	Unpack( <format>, <data/binary-array>, <flag> )
	</pre>		</pre>

	=== Description ===		=== Description ===

−	Unpack data from a binary array	+	Unpack data from a binary array

−	~~==== expression ====~~	+	Unpacks from a binary array into a normal array according to the given format.

−	The ~~format string to use~~.	+	The unpacked data is stored in an associative array.

−	==== binary-array~~/string~~ ====	+	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.
		+
		+	==== format ====
		+
		+	See [[Core Function Pack\|Pack( )]] for an explanation of the format codes.
		+
		+	==== data/binary-array ====

	An binary array of bytes such as one produced by the Pack function.		An binary array of bytes such as one produced by the Pack function.
Line 17:		Line 23:
	OR		OR

−	A ~~string to~~ be converted ~~into~~ a binary array ~~of bytes (z0 ASCII encoding)~~.	+	A variable that will be converted to a binary array.

	==== flag ====		==== flag ====
Line 23:		Line 29:
	Optional; Control what is returned options are:		Optional; Control what is returned options are:

−	0 = Return an array ~~(If there is more than one item or just return THAT item by itself (provided no (key) was used) not in an~~ array)	+	0 = Return an associative array containing unpacked elements of binary array

	1 = Return a string (Regardless of how many items are to be returned it will just append them)		1 = Return a string (Regardless of how many items are to be returned it will just append them)

	2 = Force return of single item as is (string, int, float etc) regardless if (key) etc was used		2 = Force return of single item as is (string, int, float etc) regardless if (key) etc was used
−
−	~~3 = Force return to be an array regardless of what it contains~~

	Basically set it to 0 to get the array or single item if applicable, 1 to return a string regardless of what content is (such as int), 2 to return the first object intact (no string conversion) and finally 3 to force it to be an array no matter what.		Basically set it to 0 to get the array or single item if applicable, 1 to return a string regardless of what content is (such as int), 2 to return the first object intact (no string conversion) and finally 3 to force it to be an array no matter what.
Line 37:		Line 41:
	=== Return Value ===		=== Return Value ===

−	Success: Returns the array of ~~data~~ (~~Only~~ if ~~its over 1 item, For single items (provided there was no (key) used) it will~~ return ~~the item such as string, int, float etc~~) ~~unless the flag is set to 1 then it will return a string regardless of what the item is or how many there are.~~	+	Success: Depends on flag see table below
		+
		+	<pre>
		+	Flag 0 = Return an associative array containing unpacked elements of binary array
		+	Flag 1 = Returns a string containing all the elements of the array joined together with no separator
		+	Flag 2 = Return the first element of the array (if one exists otherwise return null)
		+	</pre>

−	Failure: Returns null.	+	Failure: Returns null

	=== Remarks ===		=== Remarks ===

−	~~Go see [[Core Function Pack\|Pack( <expression>, <expressions> )]] for a list of formats and examples~~.	+	None.

	=== Example ===		=== Example ===

−	Go see [[Core Function Pack\|Pack( ~~<expression>, <expressions>~~ )]] for ~~a list of formats and~~ examples.	+	Go see [[Core Function Pack\|Pack( )]] for examples.

	[[Category:Core Function]]		[[Category:Core Function]]

UberFoX: /* flag */

2013-09-26T11:59:09Z

flag

← Older revision		Revision as of 11:59, 26 September 2013
Line 29:		Line 29:
	2 = Force return of single item as is (string, int, float etc) regardless if (key) etc was used		2 = Force return of single item as is (string, int, float etc) regardless if (key) etc was used

−	Basically set it to 0 to get the array or single item if applicable, 1 to return a string regardless of what content is (such as int) ~~and finally~~ 2 to return the first object intact (no string conversion).	+	3 = Force return to be an array regardless of what it contains
		+
		+	Basically set it to 0 to get the array or single item if applicable, 1 to return a string regardless of what content is (such as int), 2 to return the first object intact (no string conversion) and finally 3 to force it to be an array no matter what.

	Default: 0		Default: 0

UberFoX: /* flag */

2013-09-26T11:58:26Z

flag

← Older revision		Revision as of 11:58, 26 September 2013
Line 28:		Line 28:

	2 = Force return of single item as is (string, int, float etc) regardless if (key) etc was used		2 = Force return of single item as is (string, int, float etc) regardless if (key) etc was used
		+
		+	Basically set it to 0 to get the array or single item if applicable, 1 to return a string regardless of what content is (such as int) and finally 2 to return the first object intact (no string conversion).
		+
		+	Default: 0

	=== Return Value ===		=== Return Value ===

UberFoX: /* flag */

2013-09-26T11:56:05Z

flag

← Older revision		Revision as of 11:56, 26 September 2013
Line 23:		Line 23:
	Optional; Control what is returned options are:		Optional; Control what is returned options are:

−	0 = Return an array (If there is more than one item or just return THAT item by itself not in an array)	+	0 = Return an array (If there is more than one item or just return THAT item by itself (provided no (key) was used) not in an array)

	1 = Return a string (Regardless of how many items are to be returned it will just append them)		1 = Return a string (Regardless of how many items are to be returned it will just append them)
		+
		+	2 = Force return of single item as is (string, int, float etc) regardless if (key) etc was used

	=== Return Value ===		=== Return Value ===