Use the cfdump tag to get the elements, variables, and values of most kinds of ColdFusion objects. Useful for debugging. You can display the contents of simple and complex variables, objects, components, user-defined functions, and other elements.
Debugging tags, Variable manipulation tags
<cfdump var = "#variable#
" expand = "yes|no" format = "text|html
" hide = "columns|keys
" keys = "number of keys to display for structures
" label = "text
" metainfo = yes|no" output = "browser|console|file" show = "columns|keys
" showUDFs = "yes|no" top = "number of rows
|number of levels
">
cfcookie, cfparam, cfsavecontent, cfschedule, cfset, cftimer, cfwddx
Attribute |
Req/Opt |
Default |
Description |
---|---|---|---|
var |
Required |
|
Variable to display. Enclose a variable name in number signs. These kinds of variables yield meaningful cfdump output:
|
expand |
Optional |
yes |
|
format |
Optional |
text |
Use with the output attribute to specify whether to save the results of a cfdump to a file in text or HTML format. |
hide |
Optional |
all |
For a query, this is a column name or a comma-delimited list of column names. For a structure, this is a key or a comma-delimited list of keys. If you specify a structure element that doesn't exist, ColdFusion ignores it and does not generate an error. |
keys |
Optional |
9999 |
For a structure, the number of keys to display. |
label |
Optional |
|
A string; header for the dump output. Ignored if the value of the var attribute is a simple types. |
metainfo |
Optional |
yes |
For use with queries only. Includes information about the query in the cfdump results, including whether the query was cached, the execution time, and the SQL. You must specify metainfo="no" to exclude this information from the query result. |
output |
Optional |
browser |
Where to send the results of cfdump. The following values are valid:
The filename should include the full pathname of the file. You can specify an absolute path, or a path that is relative to the ColdFusion temporary directory. You can use the GetTempDirectory() function to determine the ColdFusion temporary directory. |
show |
Optional |
all |
For a query, this is a column name or a comma-delimited list of column names. For a structure, this is a key or a comma-delimited list of keys. |
showUDFs |
Optional |
yes |
|
top |
Optional |
9999 |
The number of rows to display. For a structure, this is the number of nested levels to display. |
The expand/contract display capability is useful when working with large structures, such as XML document objects, structures, and arrays.
To display a construct, use code such as the following, in which myDoc is a variable of type XmlDocument:
<cfif IsXmlDoc(mydoc) is "yes"> <cfdump var="#mydoc#"> </cfif>
The tag output is color-coded according to data type.
If a table cell is empty, this tag displays "[empty string]".
<!--- This example shows how to use this tag to display the CGI scope as a structure: ---> <cfdump var="#cgi#">
<!--- This displays information about file objects. ---> <cfscript> myfile = FileOpen("c:\temp\test1.txt", "read"); </cfscript> myfile refers to: <cfdump var="#myfile.filepath#">