XenoGuard Documentation

Substring

Actions » Programming » String Operation » Truncate » Substring 

The action Substring retrieves a specified string based on the given index and length value of the current string and stores the shortened string in Result of the result list.

[-] Hide
  1. Open the Programming node in the Workspace Explorer.
  2. Open the String Operation node.
  3. In the Truncate node, select the Substring action.

Parameters:

The action has the following input parameters:


name Description
Source String The string to be truncated.

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]
Start Index
The starting point for the string.

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]
Index Offset The position of the string to be displaced.

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]
Remove Length The length of character(s) to be removed.

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]

Warning An exception occurs when the Start Index value is less than zero or when the Index and Length values do not correspond to the actual string length to be retrieved.

Results:

The action returns the following results:


name
description
Result Contains the truncated string.

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter]

Example 1 (Retrieve a substring from a variable):

This example gets the last four (4) characters of the local Date variable with Text as a data typeThe result of truncating the specified string is then output via Write Text.


See other string truncate operations:

Remove
Trim Whitespace
Trim Whitespace at Start
Trim Whitespace at End
Split
Between