CFLib.org – Abort

Abort([showError])

Last updated October 16, 2002

Download UDF

author

Raymond Camden
Send Email

Version: 1 | Requires: ColdFusion MX | Library: CFMLLib

Rated 6 time(s). Average Rating: 3.2

Description:
Mimics the cfabort tag.

Return Values:
Does not return a value.

Example:

view plain print about

<cfscript>
x = 1;
//abort("Foo");
</cfscript>

<cfscript>
x = 1;
//abort("Foo");
</cfscript>

Parameters:

Name	Description	Required
showError	An error to throw.	No

Full UDF Source:

	
	
			
			
			
				
				view plain
				
				
				copy to clipboard
				
				
				
				
				print
				
				
				about
				ColdFISH is developed by Jason Delmore.  Source code and license information available at coldfish.riaforge.org.  Version 3.1.1
				
			<!---
 Mimics the cfabort tag.
 
 @param showError 	 An error to throw. (Optional)
 @return Does not return a value. 
 @author Raymond Camden (&#114;&#97;&#121;&#64;&#99;&#97;&#109;&#100;&#101;&#110;&#102;&#97;&#109;&#105;&#108;&#121;&#46;&#99;&#111;&#109;) 
 @version 1, October 16, 2002 
--->
<cffunction name="abort" output="false" returnType="void">
	<cfargument name="showError" type="string" required="false">
	<cfif isDefined("showError") and len(showError)>
		<cfthrow message="#showError#">
	</cfif>
	<cfabort>
</cffunction>
		<!---
 Mimics the cfabort tag.
 
 @param showError      An error to throw. (Optional)
 @return Does not return a value. 
 @author Raymond Camden (ray@camdenfamily.com) 
 @version 1, October 16, 2002 
--->
<cffunction name="abort" output="false" returnType="void">
    <cfargument name="showError" type="string" required="false">
    <cfif isDefined("showError") and len(showError)>
        <cfthrow message="#showError#">
    </cfif>
    <cfabort>
</cffunction>