Core Function Sub - Revision history

UberFoX: /* Remarks */

2015-06-14T13:56:45Z

Remarks

← Older revision		Revision as of 13:56, 14 June 2015
Line 45:		Line 45:
	=== Remarks ===		=== Remarks ===

−	Sub() works almost identical with only one change instead of taking the start position + length it takes a start position + end position this is useful for any functions that return start+end positions such as find() etc.	+	Sub() works almost identical to SubStr() with only one change instead of taking the start position + length it takes a start position + end position this is useful for any functions that return start+end positions such as find() etc.

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

UberFoX: 1 revision

2015-06-14T12:37:47Z

1 revision

← Older revision

Revision as of 12:37, 14 June 2015

UberFoX: 1 revision

2014-08-11T21:41:08Z

1 revision

← Older revision

Revision as of 21:41, 11 August 2014

UberFoX: /* Example */

2014-08-10T04:09:56Z

Example

← Older revision		Revision as of 04:09, 10 August 2014
Line 52:		Line 52:

	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">
−	$var = Sub("I am a string", 2, 4);	+	$var = Sub("I am a string", 2, 3);
	MsgBox("2 chars extracted from position 2 are: $var");		MsgBox("2 chars extracted from position 2 are: $var");
		+	// am
	</syntaxhighlight>		</syntaxhighlight>

UberFoX: /* end */

2014-08-09T18:08:05Z

end

← Older revision		Revision as of 18:08, 9 August 2014
Line 25:		Line 25:
	Optional; The character position to end.		Optional; The character position to end.

−	If end is given and is negative, ~~then that many characters will be omitted from the~~ end of string.	+	If end is given and is negative, an end of -1 refers to the last character in a string, -2 to the previous one, and so on.

	(Note - If you wish to extract a number of characters instead of from start to end position you should see SubStr())		(Note - If you wish to extract a number of characters instead of from start to end position you should see SubStr())

UberFoX at 09:07, 9 August 2014

2014-08-09T09:07:45Z

← Older revision		Revision as of 09:07, 9 August 2014
Line 45:		Line 45:
	=== Remarks ===		=== Remarks ===

−	ub() works almost identical with only one change instead of taking the start position + length it takes a start position + end position this is useful for any functions that return start+end positions such as find() etc.	+	Sub() works almost identical with only one change instead of taking the start position + length it takes a start position + end position this is useful for any functions that return start+end positions such as find() etc.

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

UberFoX: /* Example */

2014-08-09T08:41:24Z

Example

← Older revision		Revision as of 08:41, 9 August 2014
Line 62:		Line 62:
	say Sub("UberFoX", -4, -3); // Prints rF		say Sub("UberFoX", -4, -3); // Prints rF
	</syntaxhighlight>		</syntaxhighlight>
−

	More		More

UberFoX: /* Example */

2014-08-09T08:41:19Z

Example

← Older revision		Revision as of 08:41, 9 August 2014
Line 61:		Line 61:
	say Sub("UberFoX", -3); // Prints FoX		say Sub("UberFoX", -3); // Prints FoX
	say Sub("UberFoX", -4, -3); // Prints rF		say Sub("UberFoX", -4, -3); // Prints rF
		+	</syntaxhighlight>
		+
		+
		+	More
		+
		+	<syntaxhighlight lang="sputnik">
		+	my $s = "Hello Corona user";
		+	say( sub($s, 6) );// -- Corona user
		+	say( sub($s, 6, 8) );// -- Cor
		+	say( sub($s, -11) );// -- Corona user
		+	say( sub($s, -11, 11) );// -- Corona
		+	say( sub($s, -11, -6) );// -- Corona
	</syntaxhighlight>		</syntaxhighlight>

UberFoX: Created page with "

 Sub( , , ,  )

=== Description === Return part of a string or replace it === Parameters === ==== expression ==== The express..."

2014-08-06T19:47:38Z

Created page with "<pre> Sub( <expression>, <start>, <end>, <replacement> ) </pre> === Description === Return part of a string or replace it === Parameters === ==== expression ==== The express..."

New page

<pre>
Sub( <expression>, <start>, <end>, <replacement> )
</pre>

=== Description ===

Return part of a string or replace it

=== Parameters ===

==== expression ====

The expression to evaluate.

==== start ====

The character position to start. (0 = first character)

OR

If the start is a negative value the character position will work backwards from the length of the string.

==== end ====

Optional; The character position to end.

If end is given and is negative, then that many characters will be omitted from the end of string.

(Note - If you wish to extract a number of characters instead of from start to end position you should see SubStr())

==== replacement ====

Optional; If you set this parameter the substring will be replaced instead of returned so you will receive a new string with the substring replaced with the replacement text.

If you use the ->> you can force the original string to be modified see example below.

If the replacement and the part to be replaced are the same size it wont even need to reconstruct the string it can just edit it directly in ram.

=== Return Value ===

Success: Returns the extracted string.

Failure: Returns an empty string.

=== Remarks ===

ub() works almost identical with only one change instead of taking the start position + length it takes a start position + end position this is useful for any functions that return start+end positions such as find() etc.

=== Example ===

Basic example

<syntaxhighlight lang="sputnik">
$var = Sub("I am a string", 2, 4);
MsgBox("2 chars extracted from position 2 are: $var");
</syntaxhighlight>

Example using Start as a negative number

<syntaxhighlight lang="sputnik">
say Sub("UberFoX", -3); // Prints FoX
say Sub("UberFoX", -4, -3); // Prints rF
</syntaxhighlight>

Using replacement and returning a new string

<syntaxhighlight lang="sputnik">
$str = "UberCat!";
print Sub($str, 4, 6, "FoX");
# Prints
# UberFoX!
</syntaxhighlight>

Using replacement and modifying the original string in place

<syntaxhighlight lang="sputnik">
# Normally when you do replacement on Sub it returns the string
# with the changes made to it and leaves the original unchanged
# but when you use ->> you can force the original to be changed
# and have the replaced part returned instead example
$str = "UberCat!";
print "String: $str\n";
$rep = $str->>Sub(4, 6, "FoX");
print "Replaced: $rep\n";
print "String: $str\n";
# String: UberCat!
# Replaced: Cat
# String: UberFoX!
</syntaxhighlight>

Example of using an array as the second param

<syntaxhighlight lang="sputnik">
// Get a string
my $s = "the quick brown fox";
// Find a word that ends in a number
my List ( $Start, $End ) = find($s, "quick");
my $arr = array($Start, $End);
say Sub($s, $arr); // Prints "quick"

# Slghtly better than doing Sub($str, $arr[0], $arr[1]);
</syntaxhighlight>

A pattern example

<syntaxhighlight lang="sputnik">
// Get a string
my $s = "The quick12 dog";
// Find a word that ends in a number
my List ( $Start, $End ) = find($s, "%a+(%d+)");
// Print it using its start+end position
say Sub($s, $Start, $End);
// Prints
// quick12
</syntaxhighlight>

[[Category:Core Function]]