SHIP:Sail:subString

Function	Returns	Introduced	Description
subString	String	v2.0	Returns the substring of a string starting at an index and (optionally) ending at an index.

See Also:

• Sail Home
• Sail Functions
• Sail String Functions
• charAt, codepointAt, indexOf, subStr, toString

Prototype

String subString(String s, Integer start);

String subString(String s, Integer start, Integer end);

Parameters/Return Value

Parameter	Data Type	Description
s	String	Original string
start	Integer	Starting index (0 is the first character in a string)
end	Integer	Ending index (exclusive)
Return	String	the substring requested

Detailed Description

The subString function is aligned with its JavaScript subString cousin, and returns a number characters from within in a string, starting at a specified offset and ending at a specified offset, not including the ending character. The total number of characters is no more than (end - begin).

If the end is specified less than the start, the arguments are swapped.

The resulting string will be empty (zero length) if any of the following conditions are true:

• the original string has no length
• the start index is equal to the end index

If the end index is unspecified, all characters in the original string from the start index onwards will be returned; this form is identical in operation to subStr(start);.

Examples

Example	Result	Notes
subString("hello", 1);	"ello"	unspecified length means return the rest of the string
subString("hello", 0, 1);	"h"
subString("hello", 0, 0);	"h"
subString("hello", 1, -1);	""	end index is less than start index
subString("hello", 10, 2);	""	start index is beyond the length of the original string
subString("hello", -1, 1);	"h"	start index negative is the same as start index 0