Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page properties
hiddentrue



Status
Tech review

Status
colourGreen
titledone

Style guide

Status
colourGreen
titledone

Status
titletodo
Status
colourYellow
titleReady for review
Status
colourGreen
titledone
Status
colourRed
titleflagged



Page properties
hiddentrue


Short description

Returns values stored in a text list variable.

Output

Status
subtletrue
titletext list

Available since

Status
subtletrue
colourBlue
title2.6.0




UI Text Box
sizemedium
typeinfo

This function returns the value values stored in a text list variable, which was previously created using the setStringList() function.


Code Block
languagebash
titleSyntax
linenumberstrue
getStringList(variableName) #Output: Text list


UI Expand
titleExamples


Expression parserDescription


Code Block
languagebash
linenumberstrue
getStringList("myStringList")


This example returns the value stored in "myStringList", e.g.:

["Hello","World"]



UI Expand
titleAdditional information

Parameters used in this function

ParameterInput (data type)Description
variableName

Status
subtletrue
titletext

The name of the stored variable.



UI Expand
titleOutput

This function returns a

Status
subtletrue
titletext list


UI Text Box
typetip

To return the value you must have created the variable before, using the setStringList() function within the same expression.