str = List_GetFullText(sListVarName)

 

This macro function is used to get all the elements of a list as a string where each string is separated by a return.

 

Bulk Search for Text

 

One use of List_GetFullText is to search for a sub-string anywhere in the text of a list without looping through its entries.

 

The simplistic example below checks whether '20322' occurs anywhere in that text; it does not establish that an entry has exactly that holidays set ID as its name. To find an exact name, use List_LocateName.

// load the list of country names override
List_LoadFromFile(sListCountryNameOverrides, sFileCountryNames, true)
sFullText = List_GetFullText(sListCountryNameOverrides)
if Pos('20322', sFullText) > 0
   // the string 20322 is somewhere in sListCountryNameOverrides
   // ...
endif

Assignment between Lists

 

Another use of the function List_GetFullText is to quickly copy the text contents of one list into another.

// copy the contents of sListA into sListB
sFullText = List_GetFullText(sListA)
List_SetFullText(sListB, sFullText)

Note, however, that copying the full text of one list to another only copies the text (the strings parts of the list) and that none of the numbers will be copied over (their value will be 0 for each of the entries of the target list).

 

Creation and Destruction of Lists

 

When using lists, don't forget to use the function List_Create to create your list at the top of the macro, and then the function List_Destroy to destroy it at the end of the macro.

 

See also: list macro functions.

 

---

Topic 178400, last updated on 10-Oct-2026