Vicon Shogun banner

Description

Extracts a sub-string from the end of another string.

Extracts the last (right-most) count characters from "string". If count is greater than the length of "string", the entire string is returned.

Functional area

String

Command syntax

Syntax

strRight "string" count

Arguments

NameTypeRequiredComments
stringstringyesString to extract sub-string from.
countintegeryesThe number of characters to extract from string, counting from the right.

Flags

None

Return value

string

Returns the sub-string from "string"

Examples

// Extract some substrings
string $str = "This is some text";
string $subStr;

// Extract the last 9 characters
$subStr = `strRight $str 9`;
print $subStr;
// Should be "some text"

// Extract the last 17 characters
$subStr = `strRight $str 17`;
print $subStr;
// Should be same as $str

Additional information

Related commands