LISTBOX Get array
LISTBOX Get array ( {* ;} object ; arrType ) -> 戻り値
| 引数 | 型 | 説明 | |
|---|---|---|---|
| * | 演算子 | → | 指定時:objectはオブジェクト名(文字列)省略時:objectは変数 |
| object | any | → | オブジェクト名(* 指定時)、または変数(* 省略時) |
| arrType | Integer | → | 配列のタイプ |
| 戻り値 | Pointer | ← | プロパティに関連付けられた配列へのポインター |
このコマンドはスレッドセーフではないため、プリエンプティブなコードには使えません。
説明
注: このコマンドは配列型のリストボックスに対してのみ有効です。
LISTBOX Get arrayコマンドは、 object と * によって指定されたリストボックスまたはリストボックスコラムの配列へのポインターをarrType 配列に返します。
スタイル、カラー、背景色、または行管理配列は、デザインモードのプロパティリスト、あるいは LISTBOX SET ARRAY コマンドを使用することで、配列型のリストボックス、または (行管理配列以外のみ) 配列型リストボックスのカラムと関連付けすることができます。
任意の * 演算子を渡した場合、 object 引数でオブジェクト名を文字列で指定します。省略時には object 引数で変数を指定します。対象がリストボックスなのか列なのかを、 object 引数で指定します。
arrType 引数には、取得したいプロパティの配列の型を渡します。 "List Box" テーマ内にある以下の定数を使用することができます。
| 定数 | 型 | 値 |
|---|---|---|
| lk background color array | 倍長整数 | 1 |
| lk control array | 倍長整数 | 3 |
| lk font color array | 倍長整数 | 0 |
| lk row height array | 倍長整数 | 4 |
| lk style array | 倍長整数 | 2 |
戻り値は以下のどれかになります:
- 要求されたプロパティの配列がそのリストボックスまたは列に関連付けされていない場合、Is nil pointerが返ってきます。
- ユーザーによって定義されたプロパティの配列へのポインター
- LISTBOX SET ROW COLOR や LISTBOX SET ROW FONT STYLE コマンドを使用して設定されたプロパティの配列へのポインター
例題
典型的な使用例:
vPtr:=LISTBOX Get array(*;"MyLB";lk font color array)
// "MyLB" というリストボックスに関連付けされた
// フォントカラー配列を返します。
vPtr:=LISTBOX Get array(*;"Col4";lk style array)
// "Col4" リストボックスの列に関連付けされた
// フォントスタイル配列を返します。