Load list
Load list ( listName ) : Integer
| Parameter | Type | Description | |
|---|---|---|---|
| listName | Text | → | Name of a list created in the Design environment List Editor |
| Function result | Integer | ← | List reference number of newly created list |
This command is not thread-safe, it cannot be used in preemptive code.
Description
Load list creates a new hierarchical list whose contents are copied from the list and whose name you pass in listName. It then returns the list reference number to the newly created list.
To find out the lists specified in the database, use the LIST OF CHOICE LISTS command.
To make sure that the list specified by listName exists, use the Is a list function.
Note that the new list is a copy of the list defined in the Design environment. Consequently, any modifications made to the new list will not affect the list defined in the Design environment. Conversely, any subsequent modifications made to the list defined in the Design environment will not affect the list that you just created.
If you modify the newly created list and want to permanently save the changes, call SAVE LIST.
Remember to call CLEAR LIST in order to delete the newly created list when you have finished with it. Otherwise, it will stay in memory until the end of the working session or until the process in which it was created ends or is aborted.
Tip: If you associate a list with a form object (hierarchical list, tab control, or hierarchical pop-up menu) using the Choice List property in the Property List window, you do not need to call Load list or CLEAR LIST from the method of the object. 4D loads and clears the list automatically for you.
Example
You create a database for the international market and you need to switch to different languages while using the database. In a form, you present a hierarchical list, named hlList, that proposes a list of standard options. In the Design environment, you have prepared various lists, such as “Std Options US” for the English version, “Std Options FR” for the French version, “Std Options SP” for the Spanish version, and so on. In addition, you maintain an interprocess variable, named ◊gsCurrentLanguage, where you store a 2-character language code, such as “US” for the English version, “FR” for the French version, “SP” for the Spanish version, and so on. To make sure that your list will always be loaded using the current selected language, you can write:
// hlList Hierarchical List Object Method
Case of
:(FORM Event=On Load)
var hlList : Integer
hlList:=Load list("Std Options"+◊gsCurrentLanguage)
:(FORM Event=On Unload)
CLEAR LIST(hlList;*)
End case