The cftrace
tag takes the following attributes. All attributes are optional.
Attribute | Purpose |
---|---|
abort |
A Boolean value. If you specify True, ColdFusion stops processing the current request immediately after the tag. This attribute is the equivalent of placing a |
category |
A text string specifying a user-defined trace type category. This attribute lets you identify or process multiple trace lines by categories. For example, you could sort entries in a log according to the category. The You can include simple ColdFusion variables, but not arrays, structures, or objects, in the category text by enclosing the variable name in number signs (#). |
inline |
A Boolean value. If you specify True, ColdFusion displays trace output in-line in the page. The default is False. The Trace output also appears in a section in the debugging information display. |
text |
A text message describing this trace point. You can include simple ColdFusion variables, but not arrays, structures, or objects, in the text output by enclosing the variable name in number signs (#). |
type |
A ColdFusion logging severity type. The inline trace display and dockable.cfm output format show a symbol for each type. The default debugging output shows the type name, which is also used in the log file. The type name must be one of the following:
|
var |
The name of a single variable that you want displayed. This attribute can specify a simple variable, such as a string, or a complex variable, such as a structure name. Do not surround the variable name in number signs. Complex variables are displayed in inline output in You can use this attribute to display an internal variable that the page does not normally show, or an intermediate value of a variable before the page processes it further. To display a function return value, put the function inside the message. Do not use the function in the |
Note: If you specify inline trace output, and a cftrace
tag is inside a cfsilent
tag block, ColdFusion does not display the trace information in line, but does include it in the standard debugging display.
The following cftrace
tag displays the information shown in the example output and log entry in the About the cftrace tag section:
<cftrace abort="False" category="UDF End" inline = "True" text = "GetRecords UDF call has completed" var = "MyStatus">