Core Function BinaryLen - 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 at 01:59, 28 July 2014

2014-07-28T01:59:31Z

← Older revision		Revision as of 01:59, 28 July 2014
Line 1:		Line 1:
	<pre>		<pre>
−	BinaryLen( <binary-array> )	+	BinaryLen( <binary-array>, <newLen>, <fillWith> )
	</pre>		</pre>

Line 6:		Line 6:

	Returns the number of bytes in a binary variable.		Returns the number of bytes in a binary variable.
		+
		+	Or increase it's capacity for bytes by using the second parameter.

	=== Parameters ===		=== Parameters ===
Line 11:		Line 13:
	==== binary-array ====		==== binary-array ====

−	The binary variable to ~~evaluate~~.	+	The binary variable to check its size.
		+
		+	==== newLen ====
		+
		+	Optional; If provided the Binary variable data array will be expanded to this new size.
		+
		+	Note - new lengths below the size of the current length are totally ignored and do nothing.
		+
		+	==== fillWith ====
		+
		+	Optional; The byte to fill in new bytes with if using the newLen
		+
		+	Default: 0x00

	=== Return Value ===		=== Return Value ===
		+
		+	==== If using only one parameter ====

	Success: Returns the length of the binary data in bytes.		Success: Returns the length of the binary data in bytes.
		+
		+	Failure: Returns -1.
		+
		+	==== If using the newLen parameter ====
		+
		+	Success: Returns true.

	Failure: Returns -1.		Failure: Returns -1.
Line 21:		Line 43:
	=== Remarks ===		=== Remarks ===

−	UBound works just as good for this.	+	UBound works just as good for this if you only wish to see its current size.

	=== Example ===		=== Example ===
Line 35:		Line 57:
	$String = Unpack("A*", $binary, 3);		$String = Unpack("A*", $binary, 3);
	println("Full string: " . $String);		println("Full string: " . $String);
		+	</syntaxhighlight>
		+
		+	Example of setting the length
		+
		+	<syntaxhighlight lang="sputnik">
		+	// Make a binary of "Hello"
		+	my $a = Pack("A*", "Hello");
		+	// Print it
		+	say BinaryExpand($a);
		+	// Expand its size
		+	BinaryLen($a, 11);
		+	// Write more data
		+	$a[5] = @' ';
		+	$a[6] = @'w';
		+	$a[7] = @'o';
		+	$a[8] = @'r';
		+	$a[9] = @'l';
		+	$a[10] = @'d';
		+	// Print it
		+	say BinaryExpand($a);
		+	// Prints:
		+	// 48 65 6C 6C 6F -- -- -- -- -- -- -- -- -- -- -- Hello
		+	// 48 65 6C 6C 6F 20 77 6F 72 6C 64 -- -- -- -- -- Hello world
		+	</syntaxhighlight>
		+
		+	Example of setting the length and fill with
		+
		+	<syntaxhighlight lang="sputnik">
		+	// Make a binary of "Hello"
		+	my $a = Pack("A*", "Hello");
		+	// Print it
		+	say BinaryExpand($a);
		+	// Expand its size
		+	BinaryLen($a, 100, 0x4A);
		+	// Print it
		+	say BinaryExpand($a);
		+	// Prints:
		+	// 48 65 6C 6C 6F -- -- -- -- -- -- -- -- -- -- -- Hello
		+	// 48 65 6C 6C 6F 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A HelloJJJJJJJJJJJ
		+	// 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A JJJJJJJJJJJJJJJJ
		+	// 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A JJJJJJJJJJJJJJJJ
		+	// 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A JJJJJJJJJJJJJJJJ
		+	// 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A JJJJJJJJJJJJJJJJ
		+	// 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A 4A JJJJJJJJJJJJJJJJ
		+	// 4A 4A 4A 4A -- -- -- -- -- -- -- -- -- -- -- -- JJJJ
	</syntaxhighlight>		</syntaxhighlight>

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

UberFoX: /* Example */

2013-09-27T14:21:47Z

Example

← Older revision		Revision as of 14:21, 27 September 2013
Line 33:		Line 33:
	println( "Byte: " . $i . " \| Hex: " . Hex($i) . " \| Char: " . Chr($i) );		println( "Byte: " . $i . " \| Hex: " . Hex($i) . " \| Char: " . Chr($i) );
	}		}
−	$String = Unpack("z0", $binary);	+	$String = Unpack("A*", $binary, 3);
	println("Full string: " . $String);		println("Full string: " . $String);
	</syntaxhighlight>		</syntaxhighlight>

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

UberFoX: /* Example */

2011-11-19T17:21:23Z

Example

← Older revision		Revision as of 17:21, 19 November 2011
Line 26:		Line 26:

	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">
−	$binary = BinaryHex("48656c6c6f20576f726c6421")	+	$binary = BinaryHex("48656c6c6f20576f726c6421");
−	println( "Binary HEX: '" . BinaryStr($binary, ",") . "'" )	+	println( "Binary HEX: '" . BinaryStr($binary, ",") . "'" );
−	println("The binary size is: " . BinaryLen($binary) )	+	println("The binary size is: " . BinaryLen($binary) );
−	~~For $i In~~ $binary	+	Foreach ($binary as $i)
−	println( "Byte: " . $i . " \| Hex: " . Hex($i) . " \| Char: " . Chr($i) )	+	{
−	~~Next~~	+	println( "Byte: " . $i . " \| Hex: " . Hex($i) . " \| Char: " . Chr($i) );
−	$String = Unpack("z0", $binary)	+	}
−	println("Full string: " . $String)	+	$String = Unpack("z0", $binary);
		+	println("Full string: " . $String);
	</syntaxhighlight>		</syntaxhighlight>

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

UberFoX: Created page with "

 BinaryLen(  )

=== Description === Returns the number of bytes in a binary variable. === Parameters === ==== binary-array ==== The binary variable ..."

2011-11-12T00:45:13Z

Created page with "<pre> BinaryLen( <binary-array> ) </pre> === Description === Returns the number of bytes in a binary variable. === Parameters === ==== binary-array ==== The binary variable ..."

New page

<pre>
BinaryLen( <binary-array> )
</pre>

=== Description ===

Returns the number of bytes in a binary variable.

=== Parameters ===

==== binary-array ====

The binary variable to evaluate.

=== Return Value ===

Success: Returns the length of the binary data in bytes.

Failure: Returns -1.

=== Remarks ===

UBound works just as good for this.

=== Example ===

<syntaxhighlight lang="sputnik">
$binary = BinaryHex("48656c6c6f20576f726c6421")
println( "Binary HEX: '" . BinaryStr($binary, ",") . "'" )
println("The binary size is: " . BinaryLen($binary) )
For $i In $binary
println( "Byte: " . $i . " | Hex: " . Hex($i) . " | Char: " . Chr($i) )
Next
$String = Unpack("z0", $binary)
println("Full string: " . $String)
</syntaxhighlight>

[[Category:Core Function]]