CFABORT  
説明

このタグの位置で ColdFusion ページの処理を停止します。ColdFusion によって、このタグの前に処理されたすべての内容が返されます。このタグはしばしば条件論理式と共に使用され、ある条件が発生した場合にページの処理を停止します。

 
カテゴリ

フロー制御タグ

 
シンタックス
<cfabort
   showError = "error_message">
 
関連項目

cfbreak、cfexecute、cfexit、cfif、cflocation、cfloop、cfswitch、cfthrow、cftry、『ColdFusion MX 開発ガイド』の第2章の「CFML の要素」 の「cfabort と cfexit」

 
使用方法

cfabort タグと cferror タグを共に使用すると、cfabort タグによりすぐに処理が停止され、cferror タグにより指定されたページに出力がリダイレクトされます。

このタグに showError 属性値が含まれない場合、タグに到達すると処理はすぐに停止され、ColdFusion により cfabort タグを含む行までのページコンテンツが返されます。

このタグを showError 属性と共に使用する一方で、cferror タグを使用してエラーページを定義しなかった場合は、cfabort タグに到達したときにページ処理が停止されます。また、showError 内のメッセージがクライアントに表示されます。

このタグを showError 属性と共に使用し、同時に cferror を使用してエラーページを定義すると、cferror タグで指定されたエラーページに出力がリダイレクトされます。

 

この例は、処理を停止するための cfabort の使用方法を示します。cfabort が使用されている 2 番めの例では、結果が表示されません。

<h3>例 A: 命令を自動的に完了させます。</h3>
<!--- 最初に変数を設定 --->
<cfset myVariable = 3>
<!--- ここで、この値を増分するためのループを実行 --->
<cfloop from = "1" to = "4" index = "Counter">
   <cfset myVariable = myVariable + 1>
</cfloop>

<cfoutput>
<p>   #Counter# 回のループで myVariable 変数の値を増分した結果 : 
#myVariable#
</cfoutput>

<h3>例 B: cfabort を使用して、showmessage 属性および cferror を使用する命令を停止します。</h3>
<!--- 変数をリセットし、cfabort が使用されたことを示します。 --->
<cfset myVariable = 3>
<!--- ここで、この値を増分するためのループを実行 --->
<cfloop from = "1" to = "4" index = "Counter">
<!--- 2 回めのループで cfabort に到達 --->
   <cfif Counter is 2>
   <!--- cferror 行を取り出し、CF エラーメッセージで処理された cfabort エラーを確認 --->
      <cferror type="request" template="request_err.cfm">
      <cfabort showerror="CFABORT は不適切な理由で呼び出されました。">
<!--- 処理が停止し、後続のオペレーションは行われません。--->
   <cfelse>
      <cfset myVariable = myVariable + 1>
   </cfif> 
</cfloop>

<cfoutput>
<p>#Counter# 回のループで myVariable 変数の値を増分した結果 : #myVariable#
</cfoutput>
SHOWERROR  
  オプション
 

タグの実行時に、標準の ColdFusion エラーページに表示するエラーです。