GET LIST ITEM PARAMETER
GET LIST ITEM PARAMETER ( {* ;} list ; itemRef | * ; selector ; value )
| Parameter | Type | Description | |
|---|---|---|---|
| * | Operator | → | If specified, list is an object name (string) If omitted, list is a list reference number |
| list | Integer, Text | → | List reference number (if * omitted) or Name of list type object (if * passed) |
| itemRef | * | Longint, Operator | → | Item reference number or 0 for the last item appended to the list or * for the current list item |
| selector | Text | → | Parameter constant |
| value | Text, Boolean, Real | ← | Current value of parameter |
This command is not thread-safe, it cannot be used in preemptive code.
Description
The GET LIST ITEM PARAMETER command is used to find out the current value of the selector parameter for the itemRef item of the hierarchical list whose reference or object name is passed in the list parameter.
If you pass the first optional * parameter, you indicate that the list parameter is an object name (string) corresponding to a representation of the list in the form. If you do not pass this parameter, you indicate that the list parameter is a hierarchical list reference (ListRef). If you only use a single representation of the list or work with structural items (the second*** is omitted), you can use either syntax. Conversely, if you use several representations of the same list and the second * is passed, the syntax based on the object name is required since each representation can have its own current item.
Note: If you use the @ character in the object name of the list and the form contains several lists that match this name, the GET LIST ITEM PARAMETER command will be applied to the first object whose name corresponds.
You can pass a reference number in itemRef. If this number does not correspond to an item in the list, the command does nothing. You can also pass 0 in itemRef to indicate the last item added to the list (using APPEND TO LIST).
Lastly, you can pass * in itemRef: in this case, the command is applied to the current item of the list. If several items are selected manually, the current item is the last one that was selected. If no item is selected, the command does nothing.
In selector, you can pass the Additional text or Associated standard action constants (found in the “Hierarchical Lists” theme) or any custom value. For more information about the selector and value parameters, please refer to the description of the SET LIST ITEM PARAMETER command.
See also
Hierarchical Lists
SET LIST ITEM PARAMETER