Right

Returns the rightmost substring of a string

Syntax
	KeyPgDeclareDeclare KeyPgFunctionFunction Right ( KeyPgByrefByRef str KeyPgAsAs KeyPgConstQualifierConst KeyPgStringString, KeyPgByvalByVal n KeyPgAsAs KeyPgIntegerInteger ) 
	KeyPgAsAs KeyPgStringString
	KeyPgDeclareDeclare KeyPgFunctionFunction Right ( KeyPgByrefByRef str KeyPgAsAs KeyPgConstQualifierConst KeyPgWstringWString, KeyPgByvalByVal n KeyPgAsAs KeyPgIntegerInteger 
	) KeyPgAsAs KeyPgWstringWString

Usage
	result = Right[$]( str, n )

Parameters
	str
		The source string.
	n
		The substring length, in characters.

Return Value
	Returns the rightmost substring from str.

Description
	Returns the rightmost n characters starting from the right (end) of str. 
	If str is empty, then the null string ("") is returned. If n <= 0 then 
	the null string ("") is returned. If n > len(str) then the entire source 
	string is returned.

Example
	Dim text As String = "hello world"
	Print Right(text, 5)

	will produce the output:

	world

An Unicode example:

dim text as wstring*20
text = "&#1055;&#1088;&#1080;&#1074;&#1077;&#1090;, &#1084;&#1080;&#1088;!"
print right(text, 5) 'displays " &#1084;&#1080;&#1088;!"

Platform Differences
	* DOS does not support the wide-character string version of Right.

Dialect Differences
	* The string type suffix "$" is required in the CompilerOptlang-lang qb dialect.
	* The string type suffix "$" is optional in the CompilerOptlang-lang fblite dialect.
	* The string type suffix "$" is ignored in the CompilerOptlang-lang fb dialect, warn 
	  only with the CompilerOptw-w suffix compile option (or CompilerOptw-w pedantic compile 
	  option).

Differences from QB
	* QB does not support Unicode.

See also
	* KeyPgLeftLeft
	* KeyPgMidfunctionMid (Function)

