5.3.1.7.7. insert¶
配列へ指定した番号(インデックス)に要素を追加します。
5.3.1.7.7.1. 引数¶
引数名 | 型 | 配列/リスト | 説明 |
---|---|---|---|
array | (任意) | 配列 | |
index | integer | 配列 | 追加を行う要素の番号(インデックス)を1つ以上指定してください。
|
value | (任意) | 配列 | 追加する要素を指定してください。
追加する要素の型は、追加先に指定した配列の型と合わせてください。
追加対象の配列と型が異なる場合、自動的な型変換を試みます。型変換が行えなかった場合は例外が発生します。
|
コラム
インデックスについて
引数2で指定するインデックスは、指定された配列の先頭から順に絶対位置で処理されます。
例として、要素インデックスに「1」、および、「3」が指定されていた場合、関数は初めにインデックス「1」が示す位置に要素を追加します。
そして、要素が追加された後の配列に対して、改めてインデックス「3」が示す位置に要素を追加します。
コラム
インデックスと追加する要素の数について
追加を行う要素のインデックスと、追加する要素の数が合わない場合、関数の処理数(追加数)は少ない方に統一されます。
例として、追加インデックスが3つ、追加する要素が2つ指定された場合、関数は要素インデックスの2つ目までを処理し、3つ目のインデックスについては無視します。
5.3.1.7.7.2. 戻り値¶
型 | 配列/リスト | 説明 |
---|---|---|
(任意) | 配列 | 指定した要素が追加された配列が返却されます。
戻り値の配列の型は、引数1の配列の型と同じです。
|