User Guide

220 Chapter 2: ColdFusion Tags
cflocation
Description
Stops execution of the current page and opens a ColdFusion page or HTML file.
Category
Flow-control tags, Page processing tags
Syntax
<cflocation
url = "url"
addToken = "Yes" or "No">
See also
cfabort, cfbreak, cfexecute, cfexit, cfif, cfloop, cfswitch, cfthrow, cftry
Attributes
Usage
You might write a standard message or response in a file, and call it from several applications. You
could use this tag to redirect the users browser to the standard file.
This tag has no effect if you use it after the
cfflush tag on a page.
Example
<h3>cflocation Example</h3>
<p>This tag redirects the browser to a web resource; normally, you would
use this tag to go to a CF page or an HTML file on the same server.
The addToken attribute lets you send client information to the
target page.
<p>If you remove the comments, this code redirects you to CFDOCS home page:
<!--- <cflocation url = "http://localhost:8500/cfdocs/dochome.htm"
addToken = "No"> --->
Attribute Req/Opt Default Description
url Required URL of HTML file or CFML page to open.
addToken Optional clientManagement must be enabled (see cfapplication
on page 51).
Yes: appends client variable information to URL
No