ListGet
Synopsis
ListGet(list[,position[,default]])
引数
list | 有効なリストとして評価される式。Caché list は、ListBuild、または ListFromString を使用して作成するか、List を使用して別のリストから抽出する必要があります。 |
position | オプション — 要素の位置を指定する 1 から始まる整数 |
default | オプション — リスト要素が未定義の値を持つときに、返り値を作成する式 |
概要
ListGet は、指定されたリストの要求された要素を返します。position の値が、存在しないメンバを参照する場合や、値が未定義の要素を指定する場合は、default で指定した値が返されます。
ListGet 関数は、List 関数の引数が 1 つおよび 2 つの形式とまったく同じですが、List が <NULL VALUE> エラーを発生する条件下では、ListGet は既定値を返します。<NULL VALUE> エラーを返す条件に関する詳細は、"List" 関数の説明を参照してください。
引数
position
対象のリスト要素を指定する整数。省略する場合、関数はリストの先頭要素を既定で調べます。position の値が -1 の場合、ListGet は、リストの最後の要素を調べます。
default
要素に値がないときに返す既定値を指定します。例えば、要素の省略 (1,,3) や、未定義の変数 (1,x,3) などです。default は、空 (長さがゼロ) の文字列値に対しては返されません。default 引数を省略すると、長さゼロの文字列を既定値とします。
例
以下の例は ListGet 関数の使用法を示しています。
myList = ListBuild("Red","Blue",,"Yellow")
Println ListGet(myList) ' prints Red
Println ListGet(myList,2,"White") ' prints Blue
Println ListGet(myList,3,"White") ' prints White
以下の例は、未定義の値と空の文字列値の違いを示しています。
myList = ListBuild("Red","",,"Yellow")
Println "Empty: ",ListGet(myList,2,"White") ' prints empty string
Println "Default: ",ListGet(myList,3,"White") ' prints White
関連項目
-
List 関数
-
ListBuild 関数
-
ListExists 関数
-
ListFind 関数
-
ListLength 関数
-
ListNext 関数
-
ListSame 関数
-
ListToString 関数
-
ListValid 関数