CFLib.org – Common Function Library Project

Throw([Type][, Message][, Detail][, ErrorCode][, ExtendedInfo][, Object])

Last updated October 15, 2002

author

Raymond Camden

Version: 1 | Requires: CF6 | Library: CFMLLib

Description:
Mimics the CFTHROW tag.

Return Values:
Does not return a value.

Example:

<cfscript>
x = 1;
try {
	if(x lt 9) throw("BadValue","X is less than 9","X is less than 9 and this is bad because....",9900);
	} catch("BadValue" e) {
		dump(e);
	} catch("Any" e) {
		// you won't see this
		writeOutput("Unknown error");
	}
</cfscript>

Parameters:

Name Description Required
Type Type for exception. No
Message Message for exception. No
Detail Detail for exception. No
ErrorCode Error code for exception. No
ExtendedInfo Extended Information for exception. No
Object Object to throw. No

Full UDF Source:

<!---
 Mimics the CFTHROW tag.
 
 @param Type 	 Type for exception. (Optional)
 @param Message 	 Message for exception. (Optional)
 @param Detail 	 Detail for exception. (Optional)
 @param ErrorCode 	 Error code for exception. (Optional)
 @param ExtendedInfo 	 Extended Information for exception. (Optional)
 @param Object 	 Object to throw. (Optional)
 @return Does not return a value. 
 @author Raymond Camden (ray@camdenfamily.com) 
 @version 1, October 15, 2002 
--->
<cffunction name="throw" output="false" returnType="void" hint="CFML Throw wrapper">
	<cfargument name="type" type="string" required="false" default="Application" hint="Type for Exception">
	<cfargument name="message" type="string" required="false" default="" hint="Message for Exception">
	<cfargument name="detail" type="string" required="false" default="" hint="Detail for Exception">
	<cfargument name="errorCode" type="string" required="false" default="" hint="Error Code for Exception">
	<cfargument name="extendedInfo" type="string" required="false" default="" hint="Extended Info for Exception">
	<cfargument name="object" type="any" hint="Object for Exception">
	
	<cfif not isDefined("object")>
		<cfthrow type="#type#" message="#message#" detail="#detail#" errorCode="#errorCode#" extendedInfo="#extendedInfo#">
	<cfelse>
		<cfthrow object="#object#">
	</cfif>
	
</cffunction>
blog comments powered by Disqus

Search CFLib.org


Latest Additions

Kevin Cotton added
date2ExcelDate
May 5, 2016

Raymond Camden added
CapFirst
April 25, 2016

Chris Wigginton added
loremIpsum
January 18, 2016

Gary Stanton added
calculateArrival...
November 19, 2015

Sebastiaan Naafs - van Dijk added
getDaysInQuarter
November 13, 2015

Created by Raymond Camden / Design by Justin Johnson