collection.remove( )

4D v19.8


collection.remove ( index {; howMany} ) -> 戻り値

引数	型	説明
index	倍長整数	削除を開始する要素
howMany	倍長整数	削除する要素の個数、省略時は1要素を削除
戻り値	コレクション	要素が削除された元のコレクション

説明

collection.remove( ) ファクションはコレクション内でindex 引数で指定された位置から一つまた複数の要素を削除し、編集されたコレクションを返します。

注: このコマンドは元のコレクションを変更します。

index 引数には、コレクションから削除したい要素の位置を渡します。警告: コレクションの要素は0 番から数え始めるという点に注意してください。index 引数の位置がコレクションのlength より大きい場合、実際の開始インデックスがコレクションのlength に設定されます。

index 引数が負の値の場合、index:=index+length として再計算されます(つまりコレクションの終端からのオフセットであるとみなされます)。
計算された値が負の値の場合、index 引数は0 に設定されます。
計算された値がコレクションのlenghth より大きい場合、index 引数はlength の長さに設定されます。

howMany 引数には、index 引数の位置から削除する要素の個数を渡します。howMany 引数が省略された場合、1つの要素のみが削除されます。

空のコレクションから要素を削除しようとした場合、ファンクションは何もしません(エラーは生成されません)。

例題

 C_COLLECTION($col)

 $col:=New collection("a";"b";"c";"d";"e";"f";"g";"h")

 $col.remove(3) // $col=["a","b","c","e","f","g","h"]

 $col.remove(3;2) // $col=["a","b","c","g","h"]

 $col.remove(-8;1) // $col=["b","c","g","h"]

 $col.remove(-3;1) // $col=["b","g","h"]

参照

collection.clear( )