This version is out of date, covering development from v5.0.0 to v5.12.2. It is maintained here only for inbound reference links from elsewhere.

Jump to the current version of aTbRef.

Tinderbox Icon


Operator Type: 

Operator Scope of Action: 

Operator Purpose: 

Operator First Added: 

Operator Altered: 

 Function   [other Function type actions]

 Item   [operators of similar scope]

 Data manipulation   [other Data manipulation operators]

 Already in v5.0.0



Where "data" is a string literal, string attribute or expression evaluating to a string.

Where start is the zero-based position to start the substring. Negative start values are not supported, though String.substring() does so and may be used instead.

Where length is the length of the returned string. If not specified, the entire string from (or back from) start is returned.

Extracts a substring of data. For example:


returns "t", while


returns "es". All arguments are evaluated; if the designated characters don't exist, an empty string is return.

Note that in expressions like


the value of $Name is not changed.

Possible relevant notes (via "Similar Notes" feature):

A Tinderbox Reference File : Actions & Rules : Operators : Full Operator List : substr(data,start[,length])