XenoGuard Documentation

Remove

Actions » Programming » String Operation » Truncate » Remove 

The action Remove deletes the number of character(s) according to the specified index and length values of the current string and stores the new 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 Remove 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]
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 (Removes the dash symbol from a variable):

This example deletes a character from the local License variable with Text as a data type.  The result after removing the character is then output via Write Text.


See other string truncate operations:

Substring
Trim Whitespace
Trim Whitespace at Start
Trim Whitespace at End
Split
Between