WriteDump()

Outputs the elements, variables and values of most kinds of CFML objects. Useful for debugging. You can display the contents of simple and complex variables, objects, components, user-defined functions, and other elements.

WriteDump( var=object, expand=boolean, format=string, hide=string, keys=numeric, label=string, metainfo=boolean, output=string, show=string, showUDFs=boolean, top=numeric, abort=boolean, eval=string );

Returns: void

Argument Description
var
object, optional

Variable to display.
expand
boolean, optional

expands views
format
string, optional

specify the output format of the dump, the following formats are supported:

  • simple: - a simple HTML output (no JavaScript or CSS)
  • text (default output="console"): plain text output (no HTML)
  • html (default output="browser"): regular output with HTML/CSS/JavaScript
  • classic: classic view with HTML/CSS/JavaScript
hide
string, optional

hide column or keys.
keys
numeric, optional

For a structure, number of keys to display.
label
string, optional

header for the dump output.
metainfo
boolean, optional

Includes information about the query in the cfdump results.
output
string, optional

Where to send the results:

  • console: the result is written to the console (System.out).
  • browser (default): the result is written to the browser response stream.
show
string, optional

show column or keys.
showUDFs
boolean, optional

show UDFs in cfdump output.
top
numeric, optional

The number of rows to display.
abort
boolean, optional

stops further processing of the request.
eval
string, optional

name of the variable to display, also used as label, when no label defined.

Examples

Simple example with writeDump

// You can dump any thing here. Easy to see the content of complex data type
writeDump(var=getTimeZoneInfo(), label='Tag label');

See also