void = List_Sort(sListVarName)

This macro function sorts the entries of an existing list alphabetically by their strings. Associated numbers are not used in the sorting process.

➢Important: a call to List_Sort sorts the items of the list at the time it is called, but does not make the list "sorted". That is to say, if you add more items to your list, and you want the expanded list to be sorted, then you will need to call List_Sort again.

In the image, on the right, the various parts of a list are shown.

•Each element of a list contains a string and an associated integer.

•If the string contains an equal sign (=), then it is possible to access the text on the left as the name  and the text on the right as the value.

Consider the macro code below, which adds some entries to a list, calls List_Sort, and then calls various list functions to get back some information.

List_Clear(sListCountries)
// put some values in the list
List_Add(sListCountries, 'Egypt=Ägypten', 10133)     // item 1
List_Add(sListCountries, 'Albania=Albanien', 10165)  // item 2
List_Add(sListCountries, 'Algeria=Algerien', 10183)  // item 3
List_Add(sListCountries, 'Andorra=Andorra', 10167)   // item 4
List_Add(sListCountries, 'Armenia=Armenien', 10180)  // item 5
// sort the list
List_Sort(sListCountries)
// now get some information back from the list
sResult = List_GetString(sListCountries, 1) // 'Albania=Albanien' 
sResult = List_GetString(sListCountries, 2) // 'Algeria=Algerien' 
sResult = List_GetString(sListCountries, 3) // 'Andorra=Andorra' 
sResult = List_GetString(sListCountries, 4) // 'Armenia=Armenien' 
sResult = List_GetString(sListCountries, 5) // 'Egypt=Ägypten'

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 178365, last updated on 10-Oct-2026