Description

Similar to the function callStackGet except that it returns a string representation of the call stack.

History

ColdFusion 10: Added this function.

Syntax

callStackDump(destination__)

Parameters

Parameter

Description

destination

Optional parameter that takes one of the following values:

  • console
  • browser: This is the default destination.
  • file: If you do not provide the complete path to the file, the file is written to the temp directory as determined by the function getTempDirectory.

Usage

Callstack is a snapshot of all function calls or invocations. For your ColdFusion application, callstack provides the template name, line number, and if applicable, the function name.The feature is helpful in scenarios where you want to track the recursive calls that you made.

Example

In this example, the factorial of a number is computed. The example is similar to the example for CallStackGet except that the function used here is callStackDump.callfact.cfm

<cftry> 
<cfinclude template="fact.cfm"> 
<cfcatch type="any"> 
<cfoutput> 
#cfcatch.message# 
<br>#cfcatch.detail# 
<br> 
</cfoutput> 
</cfcatch> 
</cftry>

fact.cfm

<cffunction name="factorial" hint="returns the factorial of a number" output="true"> 
<cfargument name="n" required="yes" type="numeric" hint="The number for which the factorial is returned"/> 
<cfif n eq 1> 
<Cfset callStackDump()> 
<cfreturn 1> 
<cfelse> 
<Cfset callStackDump()> 
<cfreturn n * factorial(n - 1)> 
</cfif> 
</cffunction> 
<cfoutput> Factorial of 5 - #factorial(5)#</cfoutput>

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy