LISTBOX Get array
LISTBOX Get array ( {* ;} object ; arrType ) : Pointer
| Parameter | Type | Description | |
|---|---|---|---|
| * | Operator | → | If specified, object is an object name (string) If omitted, object is a variable |
| object | any | → | Object name (if * is specified) or Variable (if * is omitted) |
| arrType | Integer | → | Type of array |
| Function result | Pointer | ← | Pointer to array associated with property |
This command is not thread-safe, it cannot be used in preemptive code.
Description
Note: This command only works with array type list boxes.
The LISTBOX Get array command returns a pointer to the arrType array of the list box or list box column designated by the object and * parameters.
Style, color, background color or row control arrays can be associated with array type list boxes or (except for row control arrays) with the columns of array type list boxes, using the Property list in Design mode or using the LISTBOX SET ARRAY command.
Passing the optional * parameter indicates that the object parameter is an object name (string). If you do not pass this parameter, it indicates that the object parameter is a variable. In this case, you pass a variable reference instead of a string. You can designate a list box or a list box column in the object parameter.
In arrType, pass the type of array for the property you want to get. You can use one of the following constants, available in the "List Box" theme:
| Constant | Type | Value |
|---|---|---|
| lk background color array | Integer | 1 |
| lk control array | Integer | 3 |
| lk font color array | Integer | 0 |
| lk row height array | Integer | 4 |
| lk style array | Integer | 2 |
The command returns one of the following values:
- Is nil pointer if no array for the requested property is associated with the column or the list box.
- a pointer to the array of the requested property, defined by the user.
- a pointer to the array of the requested property, defined dynamically when calling the LISTBOX SET ROW COLOR or LISTBOX SET ROW FONT STYLE command.
Example
Typical examples of use:
vPtr:=LISTBOX Get array(*;"MyLB";lk font color array)
// returns a pointer to the font color array
// associated with the "MyLB" list box
vPtr:=LISTBOX Get array(*;"Col4";lk style array)
// returns a pointer to the font style array
// associated with the columns of the "Col4" list box