cfoutput

Description

Displays the results of a database query or other operation.

Syntax

<cfoutput 
  query = "query_name"
  group = "query_column"
  groupCaseSensitive = "Yes" or "No"
  startRow = "start_row"
  maxRows = "max_rows_output">
</cfoutput>

History

New in ColdFusion MX: On Windows, if the cfdirectory tag action = "list", the tag does not return the directory entries "." (dot) or ".." (double dot), which represent "the current directory" and "the parent directory." (In earlier releases, it returned all the entries.)

CFML code such as the following, which was acceptable in ColdFusion 5, might cause incorrect output in ColdFusion MX:

<cfdirectory action = "list" directory="c:\" name="foo">

Files in c:\<br>
<cfoutput query="foo" startrow=3>
  #name#<br>
</cfoutput>

CFML code such as the following, which was acceptable in ColdFusion 5, is acceptable in ColdFusion MX, although it is unnecessary:

<cfdirectory directory="c:\" name="foo">

Files in c:\<br>
<cfoutput query="foo" 
  <cfif NOT foo.name is "." AND NOT foo.name is ".."> 
    #name#<br>
  </cfif>
</cfoutput>

Attributes

Attribute Req/Opt Default Description

query
Optional

Name of cfquery from which to draw data for output section.

group
Optional

Query column to use when you group sets of records. Use if you retrieved a record set ordered on a query column. For example, if a record set is ordered on "Customer_ID" in the cfquery tag, you can group the output on "Customer_ID." Case-sensitive. Eliminates adjacent duplicates when data is sorted.

groupCaseSensitive
Optional
Yes
Boolean. Whether to group by case. If the query attribute specifies a query object that was generated by a case-insensitive SQL query. To keep record set intact, set to "No".

startRow
Optional
1
Row from which to start output.

maxRows
Optional

Maximum number of rows to display.

Attribute	Req/Opt	Default	Description
query	Optional		Name of `cfquery` from which to draw data for output section.
group	Optional		Query column to use when you group sets of records. Use if you retrieved a record set ordered on a query column. For example, if a record set is ordered on "`Customer_ID`" in the `cfquery` tag, you can group the output on "`Customer_ID`." Case-sensitive. Eliminates adjacent duplicates when data is sorted.
groupCaseSensitive	Optional	Yes	Boolean. Whether to group by case. If the query attribute specifies a query object that was generated by a case-insensitive SQL query. To keep record set intact, set to "`No`".
startRow	Optional	1	Row from which to start output.
maxRows	Optional		Maximum number of rows to display.

Usage

To nest cfoutput blocks, you must specify the group and query attributes at the top-most level, and the group attribute for each inner block except the innermost cfoutput block.

This tag requires an end tag.

Example

<!--- run a sample query --->
<cfquery name = "GetCourses" dataSource = "cfsnippets">
  SELECT Dept_ID, CorName, CorLevel
  FROM courseList
  ORDER by Dept_ID, CorLevel, CorName
</cfquery>
<h3>cfoutput Example</h3>
<p>cfoutput tells ColdFusion Server to begin processing, and then 
to hand back control of page rendering to the web server.
<p>For example, to show today's date, you could write #DateFormat("#Now()#"). 
If you enclosed that expression in cfoutput, the result would be
<cfoutput>#DateFormat(Now())#</cfoutput>.

<p>In addition, cfoutput may be used to show the results of a query 
operation, or only a partial result, as shown:

<p>There are <cfoutput>#getCourses.recordCount#</cfoutput> total records 
in our query. Using the maxRows parameter, we are limiting our 
display to 4 rows.
<p><cfoutput query = "GetCourses" maxRows = 4>
  <PRE>#Dept_ID#  #CorName#  #CorLevel#</PRE>
  </cfoutput>

<p>cfoutput can also show the results of a more complex expression,
such as getting the day of the week from today's date. We first
extract the integer representing the Day of the Week from
the server function Now() and then apply the result to
the DayofWeekAsString function:

<br>Today is #DayofWeekAsString(DayofWeek(Now()))#
<br>Today is <cfoutput>#DayofWeekAsString(DayofWeek(Now()))#</cfoutput>