ARRAYINSERTAT  
説明

配列に値を挿入します。新しいデータの位置と同じインデックス値、または新しいデータより大きなインデックス値を持つ配列要素は、インデックス値が 1 ずつ増やされます。配列の長さは、1 つだけ長くなります。

 
戻り値

正常に完了した場合は true

 
カテゴリ

配列関数

 
関数のシンタックス
ArrayInsertAt(array, position, value)
 
関連項目

ArrayDeleteAt、『ColdFusion MX 開発ガイド』の第35章の「XML および WDDX の使用」 の「XML オブジェクトの管理に使用する関数」

 
ヒストリ

ColdFusion MX:

  • 動作の変更 : この関数は、XML オブジェクトに使用できます。
  • 返される例外の変更 : この関数は、InvalidArrayIndexException エラーを返します。
 
パラメータ

 
使用方法

ArrayInsert() 関数を多次元配列に適用するには、array パラメータ内の最後のインデックスを除くすべてのインデックスを指定する必要があります。たとえば、次のコードは myarray[2][4] に要素を挿入します。

<cfset ArrayInsertAt(myarray[2], 4, "test")>
 
発生エラー

この関数で、位置 0 に要素を挿入しようとした場合、または array サイズよりも大きい値を position に指定した場合、InvalidArrayIndexException エラーが返されます。

 
<h3>ArrayInsertAt の例</h3><p>
<!--- 新しい配列を作成 --->
<cfset DaysArray = ArrayNew(1)>
<!--- 1 つまたは 2 つの要素を挿入 --->
<cfset DaysArray[1] = "Monday">
<cfset DaysArray[2] = "Tuesday">
<cfset DaysArray[3] = "Thursday">
<!--- 位置 3 の前に要素を追加 --->
<p>位置 3 の前に要素を追加してください。
   <cfoutput>#ArrayInsertAt(DaysArray,3,"Wednesday")#</cfoutput>
<p>ここで、配列をリストとして出力してください。
<cfoutput>#ArrayToList(DaysArray)#</cfoutput>
<!--- 配列の要素が 4 つになりました。要素 3 の "Thursday" が 4 番めの要素になりました。 --->
ARRAY  
配列の名前です。
POSITION  
値を挿入するインデックス位置です。
VALUE  
挿入する値です。