CFARGUMENT |
説明 コンポーネント定義内にパラメータ定義を作成します。また、関数の引数を定義します。cffunction タグ内で使用します。
カテゴリ 拡張タグ
シンタックス
    <cfargument
       name="string"
       type="data type"
       required="yes"、"no"
       default="default value"
       displayname="descriptive name"
       hint="extended description"   >
関連項目 cfcomponent、cffunction、cfinvoke、cfinvokeargument、cfobject、cfproperty、cfreturn
使用方法 このタグは cffunction タグ内に指定する必要があり、cffunction タグ本文の中で他のどのタグよりも前に置く必要があります。 メソッドの呼び出し時に渡される引数は、メソッド本文から次のようにアクセスできます。 省略型のシンタックスの場合 : #myargument# (この例では、引数 myargument にアクセスします) 引数スコープを配列として使用する場合 : #arguments[1]# (この例では、cffunction 内で最初に定義されている引数にアクセスします。) 引数スコープを構造体として使用する場合 : #arguments.myargument# (この例では、配列内の引数 myargument にアクセスします。)
例
    <!--- この例では、コース番号のパラメータを受け取ってそのコースの説明を返す関数を定義しています。 --->
    <cffunction name="getDescription">
       <!--- 引数を定義する --->
       <cfargument name="Course_Number" type="numeric" required="true">
       <!--- 引数を使用して、データベースからコース説明を取得する --->
       <cfquery name="Description" datasource="cfdocexamples">
          SELECT Descript
          FROM Courses
          WHERE Number = '#Course_Number#'
       </cfquery>
       <!--- この関数から返される変数を指定する --->
       <cfreturn Description.Descript>
    </cffunction>

NAME |
| 必須
文字列です。引数名を指定します。

TYPE |
| オプション
Default value: "any" タイプ名の文字列です。引数のデータタイプを指定します。 any array binary boolean date guid: この引数は xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx という形式の UUID または GUID でなければなりません。x は 16 進数の 1 文字 (0 ～ 9、A ～ F) を表します。 numeric query string struct uuid: この引数は xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx という形式の ColdFusion UUID でなければなりません。x は 16 進数の 1 文字 (0 ～ 9、A ～ F) を表します。 variableName: ColdFusion 変数のネーミング規則に従った形式の文字列 xml: XML オブジェクトと XML 文字列 コンポーネント名: type 属性の値が上記のどれにも当てはまらない場合、ColdFusion はそれを ColdFusion コンポーネントの名前として扱います。関数を実行したときに、渡された引数が指定の名前を持つ CFC でない場合はエラーになります。

REQUIRED |
| オプション
Default value: "no" メモ : Web サービスとして呼び出される場合は、定義方法に関係なく、すべての引数が必要です。 コンポーネントメソッドを実行するためにパラメータが必要かどうかを指定します。default 属性を指定した場合、パラメータは必須ではありません。 true または "yes" false または "no"

DEFAULT |
| オプション
引数が渡されない場合に、デフォルトの引数値を指定します。

DISPLAYNAME |
| オプション
Default value: "name 属性の値" CFC メソッドのパラメータの場合にのみ意味があります。イントロスペクションを使用して CFC についての情報を示すときに表示される値です。

HINT |
| オプション
CFC メソッドのパラメータの場合にのみ意味があります。イントロスペクションを使用して CFC についての情報を示すときに表示されるテキストです。hint 属性の値は、パラメータ説明行の中で displayname 属性値の後に表示されます。この属性は、パラメータの目的を説明するのに役立ちます。