Share via

2.5.4.86 Right

  • Article

The Right function returns the last character or characters in a string.

ABNF:

 Right = val [val] sp ("1" / "2") ";RIGHT():129"

Required Arguments:

Name: Text

Type: vString

An argument that specifies the text string.

Optional Arguments:

Name: NumChars

Type: vSignedLong

An argument that specifies the number of characters to be returned. The default value is one.

Return Value:

Type: PtgStr1

This function returns a PtgStr1 containing the last NumChars characters of Text. If NumChars is less than zero or greater than the number of characters in Text, the function returns a PtgStr1 containing Text. If NumChars is equal to zero, the function returns a PtgStr1 containing an empty string.