SubString

The SubString function returns part of the string that is in the first parameter.

This function returns the part of the source string that starts at the offset in the second parameter and continues for the number of characters specified in the third parameter. An empty string is returned when adding the length value to the offset extends past the end of the source string.

Return type

The function return type is: STRING

Function parameters

Table 1. SubString assignment function parameters
Parameter order Input variable type Parameter data type Required parameter Description
1 Data field STRING Yes The source string.
2 Constant INTEGER Yes The starting location of the substring to be returned from the source string. It is a zero-based offset into the source string.
3 Constant INTEGER No The number of characters to be returned from the source string. When this parameter is not provided, the function returns the substring that starts at the offset and ends at the end of the source string.