Available Tags and Functions
Tags
cfthread
CFTHREAD is a new tag for creating threads.
name
String
false
Optional. The name of the thread
attributecollection
Struct
false
Optional. The name of the thread
priority
Numeric
false
Optional. The name of the thread
cfjoin
CFJOIN is a new tag for creating threads.
thread
String
true
Required. The name of the thread
cfinterrupt
CFINTERRUPT is a new tag for creating threads.
thread
String
true
Required. The name of the thread
cfassert
CFASSERT is a new CFML tag introduced by BlueDragon
that can be used as a testing tool to enhance the
reliability and robustness of your applications.
The concept of using assertions is frequently found
in more advanced languages, and it’s critical to
effective unit-testing of your applications.
cfbase
CFBASE is a CFML tag introduced by BlueDragon that is
primarily intended for use in BlueDragon for J2EE Servers.
The CFBASE tag can be used to create an absolute URL that
serves as the base for resolving relative URLs within a
CFML page (such as in IMG tags). The absolute URL created
by the CFBASE tag includes the J2EE web application context
path. See the document Deploying CFML on Application J2EE
Application Servers for a detailed discussion of CFBASE.
cfcachecontent
CFCACHECONTENT is a new tag introduced by BlueDragon to cache
blocks of html for a given time without having to regenerate
it every time. While it may seem a melding of CFSAVECONTENT and
CFCACHE, this tag is more powerful as it can cache not only
in memory but to a database table as well.
Additionally, flushing of the cache is enhanced as well, with
two available attributes: CACHENAME and GROUP. GROUP allows you
to gather together cached elements and treat them as a single
logical unit. For example, you may wish to cache various elements
for a given user, but should that user change something, you can
flush and clear all their cached elements in a single operation.
action
String
true
Operation to perform; possible operations are CACHE, FLUSH,
FLUSHGROUP, FLUSHALL, STATS and RESET:
CACHE – Default value. Caches the data within the tag
FLUSH - Flushes cached items designated using the given
CACHENAME. All items cached with this CACHENAME are
removed
FLUSHGROUP - Flushes cached items designated using the given
GROUP. All items cached with this GROUP are removed
FLUSHALL - Flushes the entire cache, including all data in the
database cache
STATS - This will return a structure, CFCACHECONTENT, with two
fields, MISSES and HITS, which detail the number of
times requests have found data using the cache and the
number of times requests called for a cached result to
be generated. This gives you an indi-cation of how
efficient your cache is performing
RESET - resets the HIT and MISS counts to zero, for all
GROUP/CACHENAMEs or individ-ual ones.
cachename
String
false
Required for ACTION=CACHE. The name to be given for the item
being cached, which should be unique across all GROUPs.
group
String
false
A name given to group cached results together. It defaults to
the name of the server, as determined in cgi.server_name.
cachedwithin
String
false
Used with ACTION=CACHE. The maximum time to maintain this cached
result. If the cached data is found to be older than this when a
request attempts to use the cached result, the cached content
will be regenerated. Specified using #CreateTimeSpan()#.
cfcontinue
The new CFCONTINUE tag works similarly to CFBREAK in that it can
only be used within the body of a CFLOOP tag (it cannot be used
in a CFOUTPUT QUERY loop.) CFBREAK terminates execution of the
current iteration of the CFLOOP body and continues execution after
the closing CFLOOP tag. CFCONTINUE, on the other hand, terminates
execution of the current iteration of the CFLOOP body and continues
execution of the next iteration of the CFLOOP body from the opening
CFLOOP tag.
cfdebugger
Creates a debug trace for the currently executing template in the
specified log file.
logfile
String
true
Absolute path to the file where the trace log should be stored.
cfforward
CFFORWARD is a tag introduced by BlueDragon that allows you to do a
“server-side redi-rect” to another CFML page, or in some BlueDragon
editions a Java servlet or JavaServer Page (JSP), or in the .NET
edition an ASP.NET page. In a “client-side redirect,” which is
done using the CFLOCATION tag, a response is sent to the browser
telling it to send in a new request for a specified URL. In
contrast, CFFORWARD processing is handled com-pletely on the server.
page
String
true
Relative URI where the request should be redirected.
cfimage
CFIMAGE is a tag introduced by BlueDragon that allows
you to modify an existing GIF or JPEG image file to produce
a new image file that is resized and/or has a text label
added to the image. Variables returned by this tag provide
information about the new image file.
action
String
false
The action to be taken by the CFIMAGE tag. The value INFO
populates the CFIMAGE variables with information about the image
file specified by the srcFile attrib-ute without modifying the
image. The value of EDIT creates a new image file by resizing
and/or adding a text label to the source image file. Defaults to
EDIT.
srcfile
String
true
The file name of the source image file that is to be modified.
Can be either a full physical path or a relative path (see the
URIDirectory attribute).
destfile
String
false
Required if ACTION=EDIT, Optional if ACTION=INFO. The file name
of the new image file to be created by the CFIMAGE tag. Can be
either a full physical path or a relative path (see the
URIDirectory attribute).
type
String
false
The image file type, either GIF or JPEG. If this attribute is
not specified, the CFIMAGE tag attempts to determine the image
type based on the file name extension.
width
String
false
The width of the new image, can be specified either in pixels or
as a percentage of the source image width. Defaults to “100%”.
height
String
false
The height of the new image, can be specified either in pixels
or as a percentage of the source image height. Defaults to
“100%”.
fontsize
Numeric
false
An integer value that specified the font size of the text label
to be added to the image. Defaults to 12.
fontcolor
String
false
Specifies the font color of the text label to be added to the
image. Accepts any value that is valid for use in the FONT tag.
Defaults to “black”.
text
String
false
The text label to add to the image.
position
String
false
The position of the text label to add to the image; valid valued
are “north” and “south”. Defaults to “south”.
nameconflict
String
false
Indicates the behavior of the CFIMAGE tag when the file
specified by destFile already exists. Valid values are ERROR,
which generates a runtime error; SKIP, which causes the CFIMAGE
tag to do nothing without generating an error; OVERWRITE, to
over-write the existing image; and, MAKEUNIQUE, which causes
CFIMAGE to create a new unique file name for the new image file.
Defaults to ERROR.
uridirectory
String
false
If YES, relative paths specified in srcFile and destFile are
calculated from the web server document root directory. If NO,
relative paths are calculated as relative to the current file.
Defaults to NO.
cfimap
action
String
false
The action to perform
service
String
false
The type of service you are connecting to
connection
String
false
A name for the connection so you can interact with it in your
code.
server
String
false
The server name or IP address of the server
username
String
false
The username to use for authentication.
password
String
false
The password to use for authentication
folder
String
false
The name of a folder to work with. Must be a fully qualified
folder name on the IMAP server.
name
String
false
The name of the variable to create when returning resultsets
messageid
String
false
The id of the message to work with.
attachmentsuri
String
false
The uri of the folder where attachments should be stored.
messagelist
String
false
The list of message IDs to mark as read.
flagname
String
false
The flag to set on a message.
destfolder
String
false
The folder to move the message to
oldfolder
String
false
The folder to rename
newfolder
String
false
The new name for the folder.
cfmapping
Allows for the creation of mappings at the page or application level.
logicalpath
String
true
The name of the mapping to create. Should start with /
relativepath
String
false
The relative path on the server to the mapped directory.
e.g. /WEB-INF/map1 or ../../map1
directorypath
String
false
The fully qualified path to the mapped directory.
cfpause
Causes page execution to pause for the specified number of seconds
interval
Numeric
true
The number of seconds to pause for. Must be an integer.
cfthrottle
CFTHROTTLE is a new tag introduced by BlueDragon to help respond to
requests that are coming in too quickly from a given host/client. Rogue
spiders, bad software etc can cripple a server with repeated requests.
This tag is designed to track such requests in a given a window of time
and give you the opportunity to deny or redirect their requests.
action
Numeric
true
The action to take
Available values are:
THROTTLE – Default value. Enable throttle processing
FLUSH - Flushes entire historical table of throttle processing
STATUS - Returns a CFML variable, CFTHROTTLE, which is an array of
structures detailing each item that is currently being
tracked by CFTHROTTLE. Allows creation of a status page.
SET - Sets the size of the window for tracking. Defaults to 100, for
the last 100 items to be tracked; can be overriden by passing
a new value using the optional HISTORY attribute.
history
Numeric
false
Sets the size of the window for tracking. Defaults to 100, for the
last 100 items being tracked.
token
String
false
The string used to track repeated requests. In most instances you
will track the client ip address, and this is the default if not
specified. You may choose to use the CGI.HTTP_USER_AGENT variable to
track, for instance, when re-quests from certain search engines are
visiting your site too often in a given period of time.
hitThreshold
String
false
The maximum number of times a unique TOKEN value can be used by
requests being monitored in the time period specified by
HITTIMEPERIOD. If the number is exceeded, then the request is
flagged as excessive and a candidate to be throttled. Defaults to 5.
hitTimePeriod
String
false
The time period, expressed in milliseconds, where if a successive
number of requests (determined by HITTHRESHHOLD) are received
sharing the given TOKEN, the request will be deemed excessive.
Defaults to 10000 (10 seconds).
minHitTime
String
false
The time period, expressed in milliseconds, where if successive
requests (regardless of the TOKEN) are received, the request will be
deemed excessive. Defaults to 500 (one half second).
cfxmlrpc
Allows invocation of XML-RPC services
server
String
true
The full URL to the XML-RPC server
method
String
true
The name of the method to invoke.
params
Array
true
An array containing parameters for the method.
cfzip
CFZIP is a new tag introduced by BlueDragon to assist in creating,
extracting, and listing the contents of compressed (zip) files.
action
String
false
The action to be taken by the CFZIP tag. The value CREATE creates a
zip file from the file(s) specified by the source attribute. The
value of EXTRACT extracts a file(s) from a zipfile to the named
DESTINATION. The value of LIST creates a query resultset describing
the contents of the zip file. Defaults to CREATE.
zipfile
String
true
The name of the zipfile to create, extract, or list.
source
String
false
The path to a file, or directory in which to find files, to be added
to the zipfile. (To name multiple directories or files, use
CFZIPPARAM.)
recurse
boolean
false
Used with ACTION=CREATE. Indicates whether the subdirectories in the
SOURCE directory be included.  Defaults to 60 seconds.
compressionLevel
Numeric
false
A numeric in the range 0-9 (inclusive) that specifies the level of
compression with 0 meaning no compression and 9 being the maximum.
Defaults to 8.
newPath
String
false
If the item specified in SOURCE is a file then this attribute can be
used to specify a replacement path. If the SOURCE item is a
directory then this is ignored.
prefix
String
false
A prefix that will be prepended to the path of files in the created
zipfile
variable
String
false
The name of the variable where the result of the zipfile contents
listing will appear (as a query result set)
destination
String
false
The directory to which the zip file will be extracted.
flatten
boolean
false
Whether the directory structure of the zip file will be maintained
in the directory to which the zipfile contents are extracted.
Defaults to true.
cfzipparam
The CFZIPPARAM tag can be used to embed references to multiple
files/directories during the process of creating a zip file. It is to be
used only with CFZIP ACTION=”create”.
source
String
true
The path to a file, or directory in which to find files, to be added
to the zipfile.
recurse
boolean
false
Used with ACTION=CREATE. Indicates whether the subdirectories in the
SOURCE directory be included. Defaults to YES.
filter
boolean
false
Specify a filter for the given SOURCE directory e.g. *.gif (similar
to the cfdirectory filter attribute)
newPath
String
false
If the item specified in SOURCE is a file then this attribute can be
used to specify a replacement path. If the SOURCE item is a
directory then this is ignored.
prefix
String
false
A prefix that will be prepended to the path of files in the created
zipfile
cfabort
Stops the processing of a CFML page at the tag location.
CFML returns everything that was processed before the
tag. The tag is often used with conditional logic to stop
processing a page when a condition occurs.
showerror
String
false
Error to display, in a standard CFML error page,
when tag executes
cfapplication
Defines the scope of a CFML application; enables and
disables storage of Client variables; specifies the Client
variable storage mechanism; enables Session variables; and
sets Application variable timeouts.
name
String
false
Name of application. Up to 64 characters
loginstorage
String
false
clientmanagement
boolean
false
enables client variables
clientstorage
String
false
How client variables are stored
* datasource_name: in ODBC or native data source.
You must create storage repository in the
Administrator.
* registry: in the system registry.
* cookie: on client computer in a cookie. Scalable.
If client disables cookies in the browser, client
variables do not work
setclientcookies
boolean
false
No: CFML does not automatically send CFID and CFTOKEN
cookies to client browser; you must manually code CFID and
CFTOKEN on the URL for every page that uses Session or
Client variables
sessionmanagement
boolean
false
enables session variables
sessiontimeout
Timespan
false
Lifespan of session variables. CreateTimeSpan function and
values in days, hours, minutes, and seconds, separated by
commas
applicationtimeout
Timespan
false
Lifespan of application variables. CreateTimeSpan function
and values in days, hours, minutes, and seconds, separated
by commas.
setdomaincookies
boolean
false
Yes: Sets CFID and CFTOKEN cookies for a domain (not a host)
Required, for applications running on clusters.
cfargument
Creates a parameter definition within a component definition.
Defines a function argument. Used within a cffunction tag.
name
variableName
true
An argument name.
type
String
false
a type name; data type of the argument.
required
boolean
false
Whether the parameter is required to execute the component
method.
default
String
false
If no argument is passed, specifies a default argument
value.
displayname
String
false
Meaningful only for CFC method parameters. A value to be
displayed when using introspection to show information
about the CFC.
hint
String
false
Meaningful only for CFC method parameters. Text to be
displayed when using introspection to show information
about the CFC. The hint attribute value follows the
displayname attribute value in the parameter description
line. This attribute can be useful for describing the
purpose of the parameter
cfassociate
Allows subtag data to be saved with a base tag. Applies only
to custom tags.
basetag
String
true
Base tag name
datacollection
String
false
Structure in which base tag stores subtag data
cfbreak
Used within a cfloop tag. Breaks out of a loop.
cfcache
Stores a copy of a page on the server and/or client computer,
to improve page rendering performance. To do this, the tag
creates temporary files that contain the static HTML returned
from a CFML page.
Use this tag if it is not necessary to get dynamic content each
time a user accesses a page.
You can use this tag for simple URLs and for URLs that contain
URL parameters.
action
String
false
* cache: server-side and client-side caching.
* flush: refresh cached page(s).
* clientcache: browser-side caching only. To cache a personalized
page, use this option.
* servercache: server-side caching only. Not recommended.
* optimal: same as "cache".
directory
String
false
Absolute path of cache directory.
Timespan
Timespan
false
Absolute path of cache directory.
expireurl
String
false
Used with action = "flush". A URL reference. CFML
matches it against the mappings in the specified cache
directory. Can include wildcards. For example:
"*/view.cfm?id=*".
username
String
false
A username
password
String
false
A password
port
Numeric
false
Remote port to which to connect
protocol
String
false
Protocol that is used to create URL from cache.
cachedirectory
String
false
This attribute is deprecated.
Specifies the fully qualified path of the directory
where pages are to be cached. The default is the directory
of the current page.
cfcase
Used only inside the cfswitch tag body. Contains code to
execute when the expression specified in the cfswitch tag has
one or more specific values.
value
String
true
The value or values that the expression attribute of the
cfswitch tag must match. To specify multiple matching
values, separate the values with the delimiter character.
The value or values must be simple constants or constant
expressions, not variables.
delimiters
String
false
Specifies the delimiter character or characters that
separate multiple values to match. If you specify multiple
delimiter characters, you can use any of them to separate
the values to be matched.
cfcatch
Used inside a cftry tag. Together, they catch and process
exceptions in CFML pages. Exceptions are events that
disrupt the normal flow of instructions in a CFML page,
such as failed database operations, missing include files, and
developer-specified events.
cfcol
Defines table column header, width, alignment, and text. Used
within a cftable tag.
header
String
true
Column header text. To use this attribute, you must also
use the cftable colHeaders attribute.
width
Numeric
false
Column width. If the length of data displayed exceeds this
value, data is truncated to fit. To avoid this, use an
HTML table tag.
align
String
false
Column alignment
text
String
true
Double-quotation mark-delimited text; determines what to
display. Rules: same as for cfoutput sections. You can
embed hyperlinks, image references, and input controls
cfcollection
Creates, registers, and administers Verity search engine
collections.
A collection that is created with the cfcollection tag is
internal. A collection created any other way is external.
A collection that is registered with CFML using the
cfcollection tag or registered with the K2 Server by editing
the k2server.ini file is registered. Other collections are
unregistered.
action
String
true
create: registers the collection with CFML.
- If the collection is present: creates a map to it
- If the collection is not present: creates it
delete: unregisters a collection.
- If the collection was registered with action = create:
deletes its directories
- If the collection was registered and mapped: does not
delete collection directories
optimize: optimizes the structure and contents of the
collection for searching; recovers space.
list: returns a query result set, named from the name
attribute value, of the attributes of the collections
that are registered by CFML and K2 Server.
map: creates a map to the collection. It is not necessary
to specify this value.
repair: fixes data corruption in a collection.
collection
String
false
A collection name. The name can include spaces
path
String
false
Absolute path to a Verity collection.
name
variableName
false
Name for the query results returned by the list action.
wait
boolean
false
Indicates whether page processing should be halted while the
operation executes.
Default value is true.
cfcomponent
Creates and defines a component object; encloses functionality
that you build in CFML and enclose within cffunction tags.
This tag contains one or more cffunction tags that define
methods. Code within the body of this tag, other than
cffunction tags, is executed when the component is
instantiated.
extends
String
false
Name of parent component from which to inherit methods and
properties.
output
boolean
false
Specifies whether constructor code in the component can
generate HTML output; does not affect output in the body
of cffunction tags in the component.
displayname
String
false
A string to be displayed when using introspection to show
information about the CFC. The information appears on the
heading, following the component name.
hint
String
false
Text to be displayed when using introspection to show
information about the CFC. The hint attribute value
appears below the component name heading. This attribute
can be useful for describing the purpose of the parameter.
name
String
false
Name for the component
cfcontent
Does either or both of the following:
* Sets the MIME content encoding header for the current page
* Sends the contents of a file from the server as the page
output
type
String
false
The MIME content type of the page, optionally followed by
a semicolon and the character encoding. By default,
CFML sends pages as text/html content type in
the UTF-8 character encoding.
output
String
false
Variable to use as the output for the page.
deletefile
boolean
false
Applies only if you specify a file with the file attribute.
Yes: deletes the file on the server after sending its
contents to the client.
No: leaves the file on the server.
file
String
false
Name of file whose contents will be the page output. When
using CFML in a distributed configuration, the file
attribute must refer to a path on the system on which the
web server runs. When you use this attribute, any other
output on the current CFML page is ignored; only the
contents of the file is sent to the client.
reset
boolean
false
The reset and file attributes are mutually exclusive.
If you specify a file, this attribute has no effect.
Yes: discards output that precedes call to cfcontent
No: preserves output that precedes call to cfcontent. In
this case all output is sent with the specified type.
cfcookie
Defines web browser cookie variables, including expiration and
security options.
name
variableName
true
Name of cookie variable. CFML converts cookie names
to all-uppercase. Cookie names set using this tag can
include any printable ASCII characters except commas,
semicolons or white space characters.
value
String
false
Value to assign to cookie variable. Must be a string or
variable that can be stored as a string.
expires
Object
false
Expiration of cookie variable.
* The default: the cookie expires when the user closes the
browser, that is, the cookie is "session only".
* A date or date/time object (for example, 10/09/97)
* A number of days (for example, 10, or 100)
* now: deletes cookie from client cookie.txt file
(but does not delete the corresponding variable the
Cookie scope of the active page).
* never: The cookie expires in 30 years from the time it
was created (effectively never in web years).
secure
boolean
false
If browser does not support Secure Sockets Layer (SSL)
security, the cookie is not sent. To use the cookie, the
page must be accessed using the https protocol.
path
String
false
URL, within a domain, to which the cookie applies;
typically a directory. Only pages in this path can use the
cookie. By default, all pages on the server that set the
cookie can access the cookie.
path = "/services/login"
domain
String
false
Domain in which cookie is valid and to which cookie content
can be sent from the user's system. By default, the cookie
is only available to the server that set it. Use this
attribute to make the cookie available to other servers.
Must start with a period. If the value is a subdomain, the
valid domain is all domain names that end with this string.
This attribute sets the available subdomains on the site
upon which the cookie can be used.
cfdefaultcase
Used only inside the cfswitch tag body. Contains code to
execute when the expression specified in the cfswitch tag does
not match any of the values specified by preceeding cfcase tags.
cfdirectory
Manages interactions with directories.
Different combos cause different attributes to be
required.
directory
String
true
Absolute pathname of directory against which to perform
action.
name
variableName
true
Name for output record set.
filter
String
true
File extension filter applied to returned names. For
example: *.cfm. One filter can be applied.
mode
String
false
Applies only to UNIX and Linux. Permissions. Octal values
of Unix chmod command. Assigned to owner, group, and
other, respectively.
sort
String
false
Query column(s) by which to sort directory listing.
Delimited list of columns from query output.
newdirectory
String
false
New name for directory.
cfdump
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.
var
Object
false
Variable to display. Enclose a variable name in pound
signs.
label
String
false
A string; header for the dump output.
version
String
false
BlueDragon’s dump can show all the records in a query resultset,
as well as expanded information about XML objects. This is
controlled with an optional VERSION attribute, which takes two
values: LONG and SHORT.
The default for query result sets is LONG. It applies to CFDUMP both
with and without use of the VAR attribute, as described above.
In the SHORT version, a dump of query result set will not show the
actual records from the query, but will show other useful
information about the query (records found, execution time, SQL
string, etc.).
The dump of an XML object will work similarly to the long and short
versions available in ColdFusion MX. Whereas in ColdFusion MX, you
would click on the displayed XML object to cause it to switch
between short and long versions, in BlueDragon you choose the
alternative using the VERSION attribute. The default is SHORT.
Currently, only query result sets and XML documents are affected by
the VERSION attribute, and it has no effect for other variable types
(they can be dumped, but the result is not varied by specification
of the VERSION attribute).
Similarly, the VERSION attribute setting does not affect query
resultsets or XML documents that are contained within another
variable or structure being dumped. They use their respective
defaults.
cfelse
Used as the last control block in a cfif tag block to handle
any case not identified by the cfif tag or a cfelseif tag.
cfelseif
Used as a control block in a cfif tag block to handle any case
not identified by the cfif tag or a cfelseif tag.
cferror
Displays a custom HTML page when an error occurs. This lets
you maintain a consistent look and feel among an application's
functional and error pages
type
String
true
Type of error that the custom error page handles. The type
also determines how CFML handles the error page. For
more information, see Specifying a custom error page in
Developing CFML MX Applications.
exception: a exception of the type specified by the
exception attribute.
validation: errors recognized by sever-side type
validation.
request: any encountered error.
monitor: deprecated.
template
String
true
Relative path to the custom error page.
(A CFML page was formerly called a template.)
mailto
String
false
An E-mail address. This attribute is available on the
error page as the variable error.mailto. CFML does
not automatically send anything to this address.
exception
String
false
Type of exception that the tag handles:
application: application exceptions
database: database exceptions
template: CFML page exceptions
security: security exceptions
object: object exceptions
missingInclude: missing include file exceptions
expression: expression exceptions
lock: lock exceptions
custom_type: developer-defined exceptions, defined in the
cfthrow tag
any: all exception types
cfexecute
Executes a CFML developer-specified process on a server
computer.
name
String
true
Absolute path of the application to execute.
On Windows, you must specify an extension; for example,
C:\myapp.exe.
arguments
Object
false
Command-line variables passed to application. If specified
as string, it is processed as follows:
* Windows: passed to process control subsystem for parsing.
* UNIX: tokenized into an array of arguments. The default
token separator is a space; you can delimit arguments
that have embedded spaces with double quotation marks.
If passed as array, it is processed as follows:
* Windows: elements are concatenated into a string of
tokens, separated by spaces. Passed to process control
subsystem for parsing.
* UNIX: elements are copied into an array of exec()
arguments
outputfile
String
false
File to which to direct program output. If no outputfile or
variable attribute is specified, output is displayed on
the page from which it was called.
If not an absolute path (starting a with a drive letter and
a colon, or a forward or backward slash), it is relative
to the CFML temporary directory, which is returned
by the GetTempDirectory function.
variable
variableName
false
Variable in which to put program output. If no outputfile
or variable attribute is specified, output is displayed on
page from which it was called.
timeout
Numeric
false
Length of time, in seconds, that CFML waits for
output from the spawned program.
cfexit
This tag aborts processing of the currently executing CFML
custom tag, exits the page within the currently executing CFML
custom tag, or re-executes a section of code within the
currently executing CFML custom tag.
method
String
false
exittag: aborts processing of currently executing tag
exittemplate: exits page of currently executing tag
loop: reexecutes body of currently executing tag
cffile
Manages interactions with server files.
Different combonations cause different attributes to be
required.
action
String
true
Type of file manipulation that the tag performs.
file
String
true
Pathname of the file.
mode
String
false
Applies only to UNIX and Linux. Permissions. Octal values
of Unix chmod command. Assigned to owner, group, and
other, respectively.
output
String
true
String to add to the file
addnewline
boolean
false
Yes: appends newline character to text written to file
attributes
String
false
Applies to Windows. A comma-delimited list of attributes
to set on the file.
If omitted, the file's attributes are maintained.
charset
String
false
The character encoding in which the file contents is
encoded.
For more information on character encodings, see:
www.w3.org/International/O-charset.html.
source
String
true
Pathname of the file (durring copy).
destination
String
true
Pathname of a directory or file on web server
(durring copy).
variable
variableName
true
Name of variable to contain contents of text file.
filefield
String
true
Name of form field used to select the file.
Do not use pound signs (#) to specify the field name.
nameconflict
String
false
Action to take if filename is the same as that of a file
in the directory.
accept
String
true
Limits the MIME types to accept. Comma-delimited list. For
example, to permit JPG and Microsoft Word file uploads:
accept = "image/jpg, application/msword"
cfflush
Flushes currently available data to the client.
interval
Numeric
false
Flushes output each time this number of bytes becomes
available. HTML headers, and data that is already
available when the tag is executed, are omitted from the
count.
cfform
Builds a form with CFML custom control tags; these provide
more functionality than standard HTML form input elements.
name
String
false
A name for the form.
action
String
false
Name of CFML page to execute when the form is
submitted for processing.
method
String
false
The method the browser uses to send the form data
to the server:
- post: Send the data using the HTTP post method,
This method sends the data in a separate message
to the server.
- get: Send the data using the HTTP get method,
which puts the form field contents in the URL
query string.
preservedata
boolean
false
When the cfform action attribute posts back to the same
page as the form, this determines whether to override the
control values with the submitted values.
- false: values specified in the control tag attributes are used
- true: corresponding submitted values are used
onload
String
false
JavaScript to execute when the form loads.
onsubmit
String
false
JavaScript function to execute after input validation. Use
for preprocessing data before form is submitted
codebase
String
false
URL of downloadable JRE plug-in (for Internet Explorer only).
Default: /CFIDE/classes/cf-j2re-win.cab
archive
String
false
URL of downloadable Java classes for CFML controls.
Default: /CFIDE/classes/cfapplets.jar
scriptsrc
String
false
Lets the user control the URL of the script file; useful
if you do not keep the file in the /cfide directory.
style
String
false
CSS Style passed through to <FORM>.
onreset
String
false
JavaScript to execute when the user clicks a reset button.
enctype
String
false
MIME type passed through to <FORM>.
id
String
false
HTML id passed through to <FORM>.
target
String
false
Target window or frame passed through to <FORM>.
class
String
false
Form CSS class passed through to <FORM>.
passthrough
String
false
Passes arbitrary attribute-value pairs to the HTML code
that is generated for the tag. You can use either of the
following formats:
passthrough="title=""myTitle"""
passthrough='title="mytitle"'
enablecab
String
false
This attribute is deprecated.
cfftp
Lets users implement File Transfer Protocol (FTP) operations.
action
String
true
FTP operation to perform.
open: create an FTP connection
close: terminate an FTP connection
username
String
false
Overrides username specified in ODBC setup.
password
String
false
Overrides password specified in ODBC setup.
server
String
false
FTP server to which to connect; for example,
ftp.myserver.com
timeout
Numeric
false
Value in seconds for the timeout of all operations,
including individual data request operations.
port
Numeric
false
Remote port to which to connect
connection
variableName
false
Name of the FTP connection. If you specify the username,
password, and server attributes, and if no connection
exists for them, CFML creates one. Calls to cfftp
with the same connection name reuse the connection.
proxyserver
String
false
The proxy server required to access the URL.
retrycount
Numeric
false
Number of retries until failure is reported.
stoponerror
boolean
false
Yes: halts processing, displays an appropriate error.
No: populates the error variables
passive
boolean
false
Yes: enable passive mode
asciiextensionist
String
false
Delimited list of file extensions that force ASCII
transfer mode, if transferMode = "auto".
transfermode
String
false
ASCII FTP transfer mode
Binary FTP transfer mode
Auto FTP transfer mode
failifexists
boolean
false
Yes: if a local file with same name exists, getFile fails
directory
String
false
Directory on which to perform an operation
localfile
String
false
Name of the file on the local file system
remotefile
String
false
Name of the file on the FTP server file system.
item
String
false
Object of these actions: file or directory.
existing
String
false
Current name of the file or directory on the remote server.
new
String
false
New name of file or directory on the remote server
name
variableName
false
Query name of directory listing.
cffunction
Defines a function that you can call in CFML. Required to
defined CFML component methods.
name
String
true
A string; a component method that is used within the
cfcomponent tag.
returntype
String
false
String; a type name; data type of the function return value
Required for a web service; Optional, otherwise.
roles
String
false
A comma-delimited list of CFML security roles that
can invoke the method. Only users who are logged in with
the specified roles can execute the function. If this
attribute is omitted, all users can invoke the method
access
String
false
The client security context from which the method can be
invoked:
private: available only to the component that declares the
method and any components that extend the component in
which it is defined
package: available only to the component that declares the
method, components that extend the component, or any
other components in the package
public: available to a locally executing page or component
method
remote: available to a locally or remotely executing page
or component method, or a remote client through a URL,
Flash, or a web service. To publish the function as a
web service, this option is required.
output
boolean
false
Specifies under which conditions the function can generate
HTML output.
displayname
String
false
Meaningful only for CFC method parameters. A value to be
displayed in parentheses following the function name when
using introspection to show information about the CFC
hint
String
false
Meaningful only for CFC method parameters. Text to be
displayed when using introspection to show information
about the CFC. The hint attribute value follows the syntax
line in the function description
description
String
false
Supplies a short text description of the function.
cfheader
Generates custom HTTP response headers to return to the client.
name
String
true
Header name
Required if statusCode not specified
value
String
false
HTTP header value
charset
String
false
The character encoding in which to encode the header value.
For more information on character encodings, see:
www.w3.org/International/O-charset.html.
statuscode
Numeric
false
HTTP status code
Required if name not specified
statustext
String
false
Explains status code
cfhtmlhead
Writes text to the head section of a generated HTML page. It is
useful for embedding JavaScript code, or putting other HTML
tags, such as meta, link, title, or base in an HTML page
header.
text
String
true
Text to add to the <head> area of an HTML page.
cfhttp
Generates an HTTP request and handles the response from the
server.
URL
URL
true
Address of the resource on the server which will handle
the request. The URL must include the hostname or IP
address.
If you do not specify the transaction protocol (http:// or
https://), CFML defaults to http.
If you specify a port number in this attribute, it
overrides any port attribute value.
The cfhttppparam tag URL attribute appends query string
attribute-value pairs to the URL.
port
Numeric
false
Port number on the server to which to send the request.
A port value in the url attribute overrides this value.
(default: http 80 - https 443)
method
String
false
* GET Requests information from the server. Any data that
the server requires to identify the requested
information must be in the URL or in cfhttp type="URL"
tags.
* POST Sends information to the server for processing.
Requires one or more cfhttpparam tags. Often used for
submitting form-like data.
* PUT Requests the server to store the message body at the
specified URL. Use this method to send files to the
server.
* DELETE Requests the server to delete the specified URL.
* HEAD Identical to the GET method, but the server does
not send a message body in the response. Use this
method for testing hypertext links for validity and
accessibility, determining the type or modification
time of a document, or determining the type of server.
* TRACE Requests that the server echo the received HTTP
headers back to the sender in the response body. Trace
requests cannot have bodies. This method enables the
CFML application to see what is being received
at the server, and use that data for testing or
diagnostic information.
* OPTIONS A request for information about the
communication options available for the server or the
specified URL. This method enables the CFML
application to determine the options and requirements
associated with a URL, or the capabilities of a server,
without requesting any additional activity by the
server.
proxyserver
String
false
The proxy server required to access the URL.
proxyport
Numeric
false
The port to use on The proxy server.
proxyuser
String
false
The user ID to send to the proxy server.
proxypassword
String
false
The user's password on the proxy server.
username
String
false
A username. May be required by server.
password
String
false
A password. May be required by server
useragent
String
false
Text to put in the user agent request header. Used to
identify the request client software. Can make the
CFML application appear to be a browser.
charset
String
false
TThe character encoding of the request, including the URL
query string and form or file data, and the response.
For more information on character encodings, see:
www.w3.org/International/O-charset.html.
resolveurl
boolean
false
No does not resolve URLs in the response body. As a result,
any relative URL links in the response body do not work.
Yes resolves URLs in the response body to absolute URLs,
including the port number, so that links in a retrieved
page remain functional.
throwonerror
boolean
false
Yes if the server returns an error response code, throws
an exception that can be caught using the cftry and
cfcatch or CFML error pages.
No does not throw an exception if an error response is
returned. In this case, your application can use the
cfhttp.StatusCode variable to determine if there was
an error and its cause.
redirect
boolean
false
If the response header includes a Location field,
determines whether to redirect execution to the URL
specified in the field.
timeout
Numeric
false
Value, in seconds of the maximum time the request can take.
If the timeout passes without a response, CFML
considers the request to have failed.
getasbinary
String
false
* No If CFML does not recognize the response body
type as text, convert it to a CFML object.
* Auto If CFML does not recognize the response body
type as text, convert it to CFML Binary type data.
* Yes Always convert the response body content into
CFML Binary type data, even if CFML
recognizes the response body type as text.
delimiter
String
false
Sepcifies a character that separates quiery columns.
name
String
false
Tells ColdFusion to create a query object with the given
name from the returned HTTP response body.
columns
String
false
The column names for the query, separated by commas, with no
spaces. Column names must start with a letter. The remaining
characters can be letters, numbers, or underscore
characters (_).
If there are no column name headers in the response,
specify this attribute to identify the column names.
If you specify this attribute, and the firstrowasHeader
attribute is True (the default), the column names specified
by this attribute replace the first line of the response.
You can use this behavior to replace the column names
retrieved by the request with your own names.
If a duplicate column heading is encountered in either this
attribute or in the column names from the response,
ColdFusion appends an underscore to the name to make it
unique.
If the number of columns specified by this attribute does
not equal the number of columns in the HTTP response body,
ColdFusion generates an error.
firstrowasheaders
boolean
false
Determines how ColdFusion processes the first row of the
query record set:
* yes: processes the first row as column heads. If you
specify a columns attribute, ColdFusion ignores the
first row of the file.
* no: processes the first row as data. If you do not
specify a columns attribute, ColdFusion generates column
names by appending numbers to the word "column"; for
example, "column_1".
delimiter
String
false
A character that separates query columns. The response
body must use this character to separate the query columns.
textqualifier
String
false
A character that, optionally, specifies the start and end
of a text column. This character must surround any text
fields in the response body that contain the delimiter
character as part of the field value.
To include this character in column text, escape it by
using two characters in place of one. For example, if the
qualifier is a double-quotation mark, escape it as "".
cfhttpparam
Allowed inside cfhttp tag bodies only. Required for cfhttp POST
operations. Optional for all others. Specifies parameters to
build an HTTP request.
type
String
true
Information type
* Header: The parameter specifies an HTTP header.
(ColdFusion does not URL encode the header)
* Body: Specifies the body of the HTTP request.
(ColdFusion does not URL encode the body contents)
* XML: Identifies the request as having a content-type of
text/xml. Specifies that the value attribute contains
the body of the HTTP request. Used to send XML to the
destination URL. CFML does not URL encode the XML
data.
* CGI: Specifies an HTTP header. CFML URL encodes
the header by default.
* File: Tells CFML to send the contents of the
specified file. CFML does not URL encode the
file contents
* URL: Specifies a URL query string name-value pair to
append to the cfhttp url attribute. CFML URL
encodes the query string.
* FormField: Specifies a form field to send. CFML
URL encodes the Form field by default.
* Cookie: Specifies a cookie to send as an HTTP header.
CFML URL encodes the cookie.
name
String
false
Variable name for data that is passed. Ignored for Body
and XML types. For File type, specifies the filename to
send in the request.
value
String
false
Value of the data that is sent. Ignored for File type. The
value must contain string data or data that CFML can
convert to a string for all type attributes except Body.
Body types can have string or binary values.
file
String
false
Applies to File type; ignored for all other types. The
absolute path to the file that is sent in the request body.
encoded
boolean
false
Applies to FormField and CGI types; ignored for all other
types. Specifies whether to URLEncode the form field or
header.
mimetype
String
false
Applies to File type; invalid for all other types.
Specifies the MIME media type of the file contents.
The content type can include an identifier for the
character encoding of the file; for example, text/html;
charset=ISO-8859-1 indicates that the file is HTML text in
the ISO Latin-1 character encoding.
cfif
Creates simple and compound conditional statements in CFML.
Tests an expression, variable, function return value, or
string. Used, optionally, with the cfelse and cfelseif tags.
cfimport
You can use the cfimport tag to import either of the following:
* All CFML pages in a directory, as a tag custom tag
library.
* A Java Server Page (JSP) tag library. A JSP tag library is a
packaged set of tag handlers that conform to the JSP 1.1 tag
extension API.
taglib
String
true
Tag library URI. The path must be relative to the web root
(and start with /), the current page location, or a
directory specified in the Administrator CFML
mappings page.
A directory in which custom CFML tags are stored. In
this case, all the cfm pages in this directory are treated
as custom tags in a tag library.
A path to a JAR in a web-application; for example,
"/WEB-INF/lib/sometags.jar"
A path to a tag library descriptor; for example,
"/sometags.tld"
Note: You must put JSP custom tag libraries in the
/WEB-IN/lib directory. This limitation does not apply to
CFML pages.
prefix
String
true
Prefix by which to access the imported custom CFML tags JSP
tags.
If you import a CFML custom tag directory and specify an
empty value, "", for this attribute, you can call the
custom tags without using a prefix. You must specify and
use a prefix for a JSP tag library.
cfinclude
Embeds references to CFML pages in CFML. You can embed
cfinclude tags recursively. For another way to encapsulate
CFML, see cfmodule. (A CFML page was formerly sometimes
called a CFML template or a template.)
template
String
false
A logical path to a CFML page.
page
String
false
The relative URI to a page.
cfindex
Populates a Verity search engine collection with an index of
documents on a file system or of CFML query result sets.
A collection must exist before it can be populated.
collection
String
true
Name of a collection that is registered by CFML; for
example, "personnel"
Name and absolute path of a collection that is not
registered by CFML; for example:
"e:\collections\personnel"
action
String
false
- update: updates a collection and adds key to the index.
- delete: removes collection documents as specified by
the key attribute.
- purge: deletes all of the documents in a collection.
Causes the collection to be taken offline, preventing
searches.
- refresh: deletes all of the documents in a collection,
and then performs an update.
type
String
false
file: using the key attribute value of the query result as
input, applies action value to filenames or filepaths.
path: using the key attribute value of the query result as
input, applies action to filenames or filepaths that
pass the extensions filter
custom: If action = "update" or "delete": applies action to
custom entities in query results.
website: Indicates that a spidering operation should be undertaken
title
String
false
* Title for collection
* Query column name for type and a valid query name
Permits searching collections by title or displaying a
separate title from the key
key
String
false
* Absolute path and filename, if type = "file"
* Absolute path, if type = "path"
* A query column name (typically, the primary key column
name), if type = "custom"
* A query column name, if type = any other value
* A URI for the entry page for the website to spider if
type = "website"
This attribute is required for the actions listed, unless
you intend for its value to be an empty string.
body
String
false
* ASCII text to index
* Query column name(s), if name is specified in query
You can specify columns in a delimited list. For example:
"emp_name, dept_name, location"
custom1
String
false
Custom field in which you can store data during an indexing
operation. Specify a query column name for type, and a
query name.
custom2
String
false
Custom field in which you can store data during an indexing
operation. Specify a query column name for type, and a
query name.
urlpath
URL
false
If type="file" or "path", specifies the URL path. When the
collection is searched with cfsearch, this pathname is
prefixed to filenames and returned as the url attribute.
extensions
String
false
Delimited list of file extensions that CFML uses to
index files, if type = "Path".
"*." returns files with no extension.
For example: the following code returns files with a
listed extension or no extension:
extensions = ".htm, .html, .cfm, .cfml, "*."
query
String
false
Query against which collection is generated
recurse
boolean
false
Yes: if type = "path", directories below the path
specified in key are included in indexing operation
status
String
false
The name of the structure into which ColdFusion MX
returns status information.
wait
boolean
false
Indicates whether or not page processing should be
halted until the indexing operation has completed.
Default value is true.
cfinput
Used within the cfform tag, to place radio buttons, check boxes,
or text boxes on a form. Provides input validation for the
specified control type.
name
String
true
Name for form input element.
id
String
false
ID for form input element.
type
String
false
text: creates a text entry box control
radio: creates a radio button control
checkbox: creates a check box control
password: creates a password entry control
style
String
false
Style for form input element.
class
String
false
Stylesheet class for form input element.
validate
String
false
date: verifies format mm/dd/yy.
eurodate: verifies date format dd/mm/yyyy.
time: verifies time format hh:mm:ss.
float: verifies floating point format.
integer: verifies integer format.
telephone: verifies telephone format ###-###-####. The
separator can be a blank. Area code and exchange must
begin with digit 1 - 9.
zipcode: verifies, in U.S. formats only, 5- or 9-digit
format #####-####. The separator can be a blank.
creditcard: strips blanks and dashes; verifies number using
mod10 algorithm. Number must have 13-16 digits.
social_security_number: verifies format ###-##-####. The
separator can be a blank.
regular_expression: matches input against pattern
attribute.
message
String
false
Message text to display if validation fails
range
String
false
Minimum and maximum value range, separated by a comma. If
type = "text" or "password", this applies only to numeric
data.
maxlength
Numeric
false
Maximum length of text entered, if type=text or password.
pattern
Regex
false
JavaScript regular expression pattern to validate input.
ColdFusion uses this attribute only if you specify regex
in the validate attribute. Omit leading and trailing slashes.
onvalidate
String
false
Custom JavaScript function to validate user input. The form
object, input object, and input object values are passed
to the routine, which should return True if validation
succeeds, and False otherwise. If used, the validate
attribute is ignored.
onerror
String
false
Custom JavaScript function to execute if validation fails.
size
Numeric
false
Size of input control. Ignored, if type=radio or checkbox.
value
String
false
Initial value for form input element.
checked
boolean
false
Selects a control. No value is required. Applies if
type=radio or checkbox.
Default: false
passthrough
String
false
Passes one or more arbitrary attribute-value pairs to the
HTML code that is generated for the tag. You can use either
of the following formats to include the quotation marks
around the attribute value:
passthrough="ID=""myID"""
passthrough='ID="myID"'
The second format, which surrounds all the attribute-value
pairs to be passed through in single quotation marks is
clearer, particularly when you pass multiple HTML
attributes.
cfinsert
Inserts records in data sources from data in a CFML form
or form Scope.
datasource
String
true
Data source; contains table.
dbtype
String
false
Type of database to connect to.
connectstring
String
false
Connection string for dynamic datasources.
This only works on .NET
tablename
String
true
Table in which to insert form fields.
ORACLE drivers: must be uppercase.
Sybase driver: case-sensitive. Must be the same case used
when table was created
tableowner
String
false
For data sources that support table ownership (such as SQL
Server, Oracle, and Sybase SQL Anywhere), use this field to
specify the owner of the table.
tablequalifier
String
false
For data sources that support table qualifiers, use this
field to specify qualifier for table. The purpose of table
qualifiers varies among drivers. For SQL Server and
Oracle, qualifier refers to name of database that contains
table. For Intersolv dBASE driver, qualifier refers to
directory where DBF files are located.
username
String
false
Overrides username specified in ODBC setup.
password
String
false
Overrides password specified in ODBC setup.
formfields
String
false
Comma-delimited list of form fields to insert. If not
specified, all fields in the form are included.
If a form field is not matched by a column name in the
database, CFML throws an error.
The database table key field must be present in the form.
It may be hidden.
cfinvoke
Does either of the following:
* Invokes a component method from within a CFML page or
component.
* Invokes a web service.
Different attribute combonations make some attributes required
at sometimes and not at others.
component
String
false
String or component object; a reference to a component, or
component to instantiate.
method
String
true
Name of a method. For a web service, the name of an
operation.
returnvariable
variableName
false
Name of a variable for the invocation result.
argumentcollection
String
false
Name of a structure; associative array of arguments to pass
to the method.
username
String
false
Overrides username specified in Administrator > Web Services
password
String
false
Overrides passowrd specified in Administrator > Web Services
webservice
URL
false
The URL of the WSDL file for the web service.
timeout
Numeric
false
The timeout for the web service request, in seconds
proxyserver
String
false
The proxy server required to access the webservice URL.
proxyport
Numeric
false
The port to use on The proxy server.
proxyuser
String
false
The user ID to send to the proxy server.
proxypassword
String
false
The user's password on the proxy server.
cfinvokeargument
Passes the name and value of a parameter to a component method
or a web service. This tag is used within the cfinvoke tag.
name
String
true
Argument name
value
String
true
Argument value
cfldap
Provides an interface to a Lightweight Directory Access Protocol
(LDAP) directory server, such as the Netscape Directory Server.
server
String
true
Host name or IP address of LDAP server.
port
Numeric
false
Port of the LDAP server (default 389).
username
String
false
The User ID. Required if secure = "CFSSL_BASIC"
password
String
false
Password that corresponds to user name.
If secure = "CFSSL_BASIC", V2 encrypts the password before
transmission.
action
String
false
* query: returns LDAP entry information only. Requires name,
start, and attributes attributes.
* add: adds LDAP entries to LDAP server. Requires attributes
attribute.
* modify: modifies LDAP entries, except distinguished name dn
attribute, on LDAP server. Requires dn. See modifyType attribute.
* modifyDN: modifies distinguished name attribute for LDAP
entries on LDAP server. Requires dn.
* delete: deletes LDAP entries on an LDAP server. Requires dn.
name
String
false
Required if action = "Query"
Name of LDAP query. The tag validates the value.
timeout
Numeric
false
Maximum length of time, in seconds, to wait for LDAP processing.
Default 60000
maxrows
Numeric
false
Maximum number of entries for LDAP queries.
start
Numeric
false
Required if action = "Query"
Distinguished name of entry to be used to start a search.
scope
String
false
Scope of search, from entry specified in start attribute for
action = "Query".
* oneLevel: entries one level below entry.
* base: only the entry.
* subtree: entry and all levels below it.
attributes
String
false
Required if action = "Query", "Add", "ModifyDN", or "Modify"
For queries: comma-delimited list of attributes to return. For
queries, to get all attributes, specify "*".
If action = "add" or "modify", you can specify a list of update
columns. Separate attributes with a semicolon.
If action = "ModifyDN", CFML passes attributes to the
LDAP server without syntax checking.
filter
String
false
Search criteria for action = "Query".
List attributes in the form:
"(attribute operator value)" Example: "(sn = Smith)"
sort
String
false
Attribute(s) by which to sort query results. Use a comma
delimiter.
sortcontrol
String
false
Default asc
* nocase: case-insensitive sort
* asc: ascending (a to z) case-sensitive sort
* desc: descending (z to a) case-sensitive sort
You can enter a combination of sort types; for example,
sortControl = "nocase, asc".
dn
String
false
Distinguished name, for update action. Example:
"cn = Bob Jensen, o = Ace Industry, c = US"
startrow
Numeric
false
Used with action = "query". First row of LDAP query to insert
into a CFML query.
modifytype
String
false
Default replace
How to process an attribute in a multi-value list.
* add: appends it to any attributes
* delete: deletes it from the set of attributes
* replace: replaces it with specified attributes
You cannot add an attribute that is already present or that is
empty.
rebind
boolean
false
* Yes: attempt to rebind referral callback and reissue query by
referred address using original credentials.
* No: referred connections are anonymous
referral
Numeric
false
Number of hops allowed in a referral. A value of 0 disables
referred addresses for LDAP; no data is returned.
secure
String
false
Security to employ, and required information. One option:
* CFSSL_BASIC
"CFSSL_BASIC" provides V2 SSL encryption
and server authentication.
separator
String
false
Default , (a comma)
Delimiter to separate attribute values of multi-value
attributes. Used by query, add, and modify actions, and by
cfldap to output multi-value attributes.
For example, if $ (dollar sign), the attributes attribute could
be "objectclass = top$person", where the first value of
objectclass is top, and the second value is person. This avoids
confusion if values include commas.
delimiter
String
false
Separator between attribute name-value pairs. Use this
attribute if:
* the attributes attribute specifies more than one item, or
* an attribute contains the default delimiter (semicolon). For
example: mgrpmsgrejecttext;lang-en
Used by query, add, and modify actions, and by cfldap to output
multi-value attributes.
For example, if $ (dollar sign), you could specify
"cn = Double Tree Inn$street = 1111 Elm; Suite 100 where the
semicolon is part of the street value.
cflocation
Stops execution of the current page and opens a CFML page or HTML file.
URL
String
true
URL of HTML file or CFML page to open.
addtoken
boolean
false
clientManagement must be enabled (see cfapplication).
cflock
Ensures the integrity of shared data. Instantiates the
following kinds of locks:
* Exclusive allows single-thread access to the CFML constructs
* Read-only allows multiple requests to access CFML constructs
timeout
Numeric
true
Maximum length of time, in seconds, to wait to obtain a
lock. If lock is obtained, tag execution continues.
Otherwise, behavior depends on throwOnTimeout attribute
value.
scope
String
false
Lock scope. Mutually exclusive with the name attribute.
Lock name. Only one request in the specified scope can
execute the code within this tag (or within any other
cflock tag with the same lock scope scope) at a time.
name
String
false
Lock name. Mutually exclusive with the scope attribute.
Only one request can execute the code within a cflock tag
with a given name at a time. Cannot be an empty string.
throwontimeout
boolean
false
How timeout conditions are handled.
type
String
false
readOnly: lets more than one request read shared data.
exclusive: lets one request read or write shared data.
cflog
Writes a message to a log file.
text
String
true
Message text to log.
log
String
false
If you omit the file attribute, writes messages to standard
log file. Ignored, if you specify file attribute.
Application: writes to Application.log, normally used for
application-specific messages.
Scheduler: writes to Scheduler.log, normally used to log
the execution of scheduled tasks.
file
String
false
Message file. Specify only the main part of the filename.
For example, to log to the Testing.log file, specify
"Testing".
The file must be located in the default log directory. You
cannot specify a directory path. If the file does not
exist, it is created automatically, with the suffix .log.
type
String
false
Type (severity) of the message
application
boolean
false
log application name, if it is specified in a cfapplication
tag.
cflogin
A container for user login and authentication code. CFML
runs the code in this tag if a user is not already logged in.
You put code in the tag that authenticates the user and
identifies the user with a set of roles. Used with cfloginuser
tag.
idletimeout
Numeric
false
Time interval with no keyboard activity after which
CFML logs the user off. Seconds.
applicationtoken
String
false
Unique application identifier. Limits the login validity to
one application, as specified by the cfapplication tag.
cookiedomain
String
false
Domain of the cookie that is used to mark a user as logged
in. Use this attribute to enable a user login cookie to
work with multiple clustered servers in the same domain.
cfloginuser
Identifies an authenticated user to CFML. Specifies the
user ID and roles. Used within a cflogin tag.
name
String
true
A username.
password
String
true
A user password.
roles
String
true
A comma-delimited list of role identifiers.
CFML processes spaces in a list element as part of
the element.
cflogout
Logs the current user out. Removes knowledge of the user ID,
password, and roles from the server. If you do not use this
tag, the user is automatically logged out when the session
ends.
cfloop
Different items are required based on loop type. Items listed
as required may not be depending on your loop type.
Loop forms:
[query] [condition] [index + from + to ] [index + list]
[collection + item ]
index
String
false
Index value. CFML sets it to from value and
increments or decrements by step value, until it equals to
value.
to
Numeric
false
Beginning value of index.
from
Numeric
false
Ending value of index.
step
Numeric
false
Ending value of index.
condition
boolean
false
Condition that controls the loop.
query
String
false
Query that controls the loop.
startrow
Numeric
false
First row of query that is included in the loop.
endrow
Numeric
false
Last row of query that is included in the loop.
list
String
false
A list, variable, or filename; contains a list
delimiters
String
false
Character(s) that separates items in list
collection
Object
false
The collection attribute is used with the item attribute.
often to loop over a structure
item
String
false
The item attribute is used with the collection attribute.
often to loop over a structure
cfmail
Sends an e-mail message that optionally contains query output,
using an SMTP server.
to
String
true
Message recipient e-mail addresses.
from
String
true
E-mail message sender:
imapconnection
String
false
Name of an imap connection to use
cc
String
false
Address(es) to which to copy the message
bcc
String
false
Address(es) to which to copy the message, without listing
them in the message header.
subject
String
true
Message subject. Can be dynamically generated.
replyto
String
false
Address(es) to which the recipient is directed to send
replies.
failto
String
false
Address to which mailing systems should send delivery
failure notifications. Sets the mail envelope reverse-path
value.
username
String
false
A user name to send to SMTP servers that require
authentication. Requires a password attribute
password
String
false
A password to send to SMTP servers that require
authentication. Requires a username attribute.
wraptext
Numeric
false
Specifies the maximum line length, in characters of the
mail text. If a line has more than the specified number of
characters, replaces the last white space character, such
as a tab or space, preceding the specified position with
a line break. If there are no white space characters,
inserts a line break at the specified position. A common
value for this attribute is 72.
charset
String
false
The character encoding in which the part text is encoded.
For more information on character encodings, see:
www.w3.org/International/O-charset.html.
type
String
false
The MIME media type of the part. Can be a can be valid MIME
media type
mimeattach
String
false
Path of file to attach to message. Attached file is
MIME-encoded. CFML attempts to determine the MIME
type of the file; use the cfmailparam tag to send an
attachement and specify the MIME type.
query
String
false
Name of cfquery from which to draw data for message(s).
Use this attribute to send more than one message, or to
send query results within a message.
group
String
false
Query column to use when you group sets of records to send
as a message. For example, to send a set of billing
statements to a customer, group on "Customer_ID."
Case-sensitive. Eliminates adjacent duplicates when data is
sorted by the specified field.
groupcasesensitive
boolean
false
Whether to consider case when using the group attribute. To
group on case-sensitive records, set this attribute to Yes.
startrow
Numeric
false
Row in a query to start from.
maxrows
Numeric
false
Maximum number of messages to send when looping over a
query.
server
String
false
SMTP server address, or (Enterprise edition only) a
comma-delimited list of server addresses, to use for
sending messages. At least one server must be specified
here or in the CFML MX Administrator. A value here
overrides the Administrator. A value that includes a port
specification overrides the port attribute. See the Usage
section for details.
port
Numeric
false
TCP/IP port on which SMTP server listens for requests
(normally 25). A value here overrides the Administrator.
mailerid
String
false
Mailer ID to be passed in X-Mailer SMTP header, which
identifies the mailer application.
timeout
Numeric
false
Number of seconds to wait before timing out connection to
SMTP server. A value here overrides the Administrator.
debug
boolean
false
* Yes: sends debugging output to standard output. By
default, if the console window is unavailable, ColdFusion
sends output to cf_root\runtime\logs\coldfusion-out.log on
server configurations. On J2EE configurations, with JRun,
the default location is jrun_home/logs/servername-out.log.
* No: does not generate debugging output.
cfmailparam
Attaches a file or adds a header to an e-mail message. Can only
be used in the cfmail tag. You can use more than one
cfmailparam tag within a cfmail tag.
file
String
true
Attaches file to a message. Mutually exclusive with name
attribute. The file is MIME encoded before sending.
type
String
false
The MIME media type of the part. Can be a can be valid MIME
media type
name
String
true
Name of header. Case-insensitive. Mutually exclusive with
file attribute.
The values listed are from rfc2822
value
String
false
Value of the header.
contentID
String
false
The Identifier for the attached file. This ID should
be globally unique and is used to identify the file in
an IMG or other tag in the mail body that references
the file content.
disposition
String
false
How the attached file is to be handled. Can be one
of the following:
- attachment: present the file as an attachment
- inline: display the file contents in the message
cfmailpart
Specifies one part of a multipart e-mail message. Can only be
used in the cfmail tag. You can use more than one cfmailpart
tag within a cfmail tag.
type
String
true
The MIME media type of the part. Can be a can be valid MIME
media type
wraptext
Numeric
false
Specifies the maximum line length, in characters of the
mail text. If a line has more than the specified number of
characters, replaces the last white space character, such
as a tab or space, preceding the specified position with a
line break. If there are no white space characters,
inserts a line break at the specified position. A common
value for this attribute is 72.
charset
String
false
The character encoding in which the part text is encoded.
For more information on character encodings, see:
www.w3.org/International/O-charset.html.
cfmodule
Invokes a custom tag for use in CFML application pages.
This tag processes custom tag name conflicts.
template
String
false
Mutually exclusive with the name attribute. A path to the
page that implements the tag.
Relative path: expanded from the current page
Absolute path: expanded using CFML mapping
A physical path is not valid.
name
String
false
Mutually exclusive with the template attribute. A custom
tag name, in the form "Name.Name.Name..." Identifies
subdirectory, under the CFML tag root directory,
that contains custom tag page. For example (Windows format):
<cfmodule name = "superduper.Forums40.GetUserOptions">
This identifies the page GetUserOptions.cfm in the
directory CustomTags\superduper\Forums40 under the
CFML root directory.
attributecollection
Struct
false
A collection of key-value pairs that represent
attribute names and values. You can specify multiple
key-value pairs. You can specify this attribute only
once.
cfobject
Creates a CFML object, of a specified type.
The tag syntax depends on the object type. Some types use the
type attribute; others do not.
cfobjectcache
Flushes the query cache.
action
String
true
clear: Clears queries from the cache in the Application
scope
cfoutput
Displays output that can contain the results of processing
CFML variables and functions. Can loop over the results
of a database query.
query
String
false
Name of cfquery from which to draw data for output section.
group
String
false
Query column to use to group sets of records. Eliminates
adjacent duplicate rows when data is sorted. Use if you
retrieved a record set ordered on one or more a query
columns. For example, if a record set is ordered on
"Customer_ID" in the cfquery tag, you can group the output
on "Customer_ID."
groupcasesensitive
boolean
false
Whether to consider the case in grouping rows.
startrow
Numeric
false
Row from which to start output.
maxrows
Numeric
false
Maximum number of rows to display.
cfparam
Tests for a parameter's existence, tests its data type, and, if
a default value is not assigned, optionally provides one.
name
variableName
true
Name of parameter to test (such as "client.email" or
"cookie.backgroundColor"). If omitted, and if the
parameter does not exist, an error is thrown.
type
String
false
The valid format for the data; one of the following.
* any: any type of value.
* array: an array of values.
* binary: a binary value.
* boolean: a Boolean value: yes, no, true, false, or a number.
* date or time: a date-time value.
* guid: a Universally Unique Identifier of the form
"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" where 'X' is a hexadecimal
number.
* numeric: a numeric value
* query: a query object.
* string: a string value or single character.
* struct: a structure.
* UUID: a ColdFusion Universally Unique Identifier, formatted
'XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXX', where 'X' is a hexadecimal
number. See CreateUUID.
* variableName: a string formatted according to ColdFusion variable
naming conventions.
default
Object
false
Value to set parameter to if it does not exist. Any
expression used for the default attribute is evaluated,
even if the parameter exists.
The result is not assigned if the parameter exists,
but if the expression has side effects, they still occur.
cfpop
Retrieves or deletes e-mail messages from a POP mail server.
server
String
true
POP server identifier:
A host name; for example, "biff.upperlip.com"
An IP address; for example, "<IP_ADDRESS>"
port
Numeric
false
POP port
username
String
false
Overrides username.
password
String
false
Overrides password
action
String
false
getHeaderOnly: returns message header information only
getAll: returns message header information, message text,
and attachments if attachmentPath is specified
delete: deletes messages on POP server
name
variableName
false
Name for query object that contains the retrieved message
information.
messagenumber
Numeric
false
Message number or comma-delimited list of message numbers
to get or delete. Invalid message numbers are ignored.
Ignored if uid is specified.
uid
String
false
UID or a comma-delimited list of UIDs to get or delete.
Invalid UIDs are ignored.
attachmentpath
String
false
If action="getAll", specifies a directory in which to save
any attachments. If the directory does not exist,
CFML creates it.
If you omit this attribute, CFML does not save any
attachments. If you specify a relative path, the path root
is the CFML temporary directory, which is returned by
the GetTempDirectory function.
timeout
Numeric
false
Maximum time, in seconds, to wait for mail processing
maxrows
Numeric
false
Number of messages to return or delete, starting with the
number in startRow. Ignored if messageNumber or uid is
specified.
startrow
Numeric
false
First row number to get or delete. Ignored if messageNumber
or uid is specified.
generateuniquefilenames
boolean
false
Yes: Generate unique filenames for files attached to an
e-mail message, to avoid naming conflicts when files are
saved
cfprocessingdirective
Provides the following insformation to CFML on how to
process the current page:
* Specifies whether to remove excess whitespace character from
CFML generated content in the tag body.
* Identifies the character encoding (character set) of the page
contents.
suppresswhitespace
boolean
false
Boolean; whether to suppress white space characters within
the cfprocessingdirective block that are generated by CFML
tags and often do not affect HTML appearance. Does not
affect any white space in HTML code.
pageencoding
String
false
A string literal; cannot be a variable. Identifies the
character encoding of the current CFML page. This attribute
affects the entire page, not just the cfprocessing tag body.
The value may be enclosed in single or double quotation
marks, or none.
For more information on character encodings, see:
www.w3.org/International/O-charset.html.
cfprocparam
Defines stored procedure parameters. This tag is nested within
a cfstoredproc tag.
type
String
false
in: The parameter is used to send data to the database
system only. Passes the parameter by value.
out: The parameter is used to receive data from the
database system only. Passes the parameter as a bound
variable.
inout: The parameter is used to send and receive data.
Passes the parameter as a bound variable.
variable
String
false
CFML variable name; references the value that the
output parameter has after the stored procedure is called.
value
String
false
Value that CFML passes to the stored procedure.
cfsqltype
String
true
SQL type to which the parameter (any type) is bound.
CFML supports the following values, where the last
element of the name corresponds to the SQL data type.
Different database systems might support different subsets
of this list. See your DBMS documentation for information
on supported parameter types.
maxlength
Numeric
false
Maximum length of a string or character IN or INOUT value
attribute. A maxLength of 0 allows any length. The
maxLength attribute is not required when specifying
type=out.
scale
Numeric
false
Number of decimal places in numeric parameter. A scale of 0
allows any number of decimal places.
null
boolean
false
Whether the parameter is passed in as a null value. Not
used with OUT type parameters.
cfprocresult
Associates a query object with a result set returned by a
stored procedure. Other CFML tags, such as cfoutput and
cftable, use this query object to access the result set. This
tag is nested within a cfstoredproc tag.
name
variableName
true
Name for the query result set.
resultset
Numeric
false
Names one result set, if stored procedure returns more than
one.
maxrows
Numeric
false
Maximum number of rows returned in result set.
cfproperty
Defines properties of a CFML component (CFC). Used to
create complex data types for web services. The attributes of
this tag are exposed as component metadata and are subject to
inheritance rules.
name
String
true
A string; a property name. Must be a static value.
type
String
false
A string; identifies the property data type
required
boolean
false
Whether the parameter is required
default
Object
false
If no property value is set when the component is used for
a web service, specifies a default value.
If this attribute is present, the required attribute must
be set to "no" or not specified.
displayname
String
false
A value to be displayed when using introspection to show
information about the CFC. The value appears in parentheses
following the property name.
hint
String
false
Text to be displayed when using introspection to show
information about the CFC. This attribute can be useful
for describing the purpose of the parameter.
cfquery
Passes queries or SQL statements to a data source.
It is recommended that you use the cfqueryparam tag within
every cfquery tag, to help secure your databases from
unauthorized users
name
variableName
false
Name of query. Used in page to reference query record set.
Must begin with a letter. Can include letters, numbers,
and underscores.
datasource
String
false
Name of data source from which query gets data.
connectstring
String
false
Connection string for dynamic datasource.
Only available on .NET
dbtype
String
false
query. Use this value to specify the results of a query as
input
dynamic. Use this to create a dynamic data source on .NET
username
String
false
Overrides username in data source setup.
password
String
false
Overrides password in data source setup.
maxrows
Numeric
false
Maximum number of rows to return in record set.
-1 returns all records.
blockfactor
Numeric
false
Maximum rows to get at a time from server. Range: 1 - 100.
Might not be supported by some database systems.
timeout
Numeric
false
Maximum number of seconds that each action of a query is
permitted to execute before returning an error. The
cumulative time may exceed this value.
For JDBC statements, CFML sets this attribute. For
other drivers, check driver documentation.
cachedafter
DateTime
false
Date value (for example, April 16, 1999, 4-16-99). If date
of original query is after this date, CFML uses
cached query data. To use cached data, current query must
use same SQL statement, data source, query name, user name,
password.
A date/time object is in the range 100 AD-9999 AD.
When specifying a date value as a string, you must enclose
it in quotation marks.
cachedwithin
Timespan
false
Timespan, using the CreateTimeSpan function. If original
query date falls within the time span, cached query data is
used. CreateTimeSpan defines a period from the present,
back. Takes effect only if query caching is enabled in the
Administrator.
To use cached data, the current query must use the same SQL
statement, data source, query name, user name, and password.
cacheduntilchange
boolean
false
Only supported on .NET with SQL Server 2005.
debug
boolean
false
Yes: If debugging is enabled, but the Administrator
Database Activity option is not enabled, displays SQL
submitted to datasource and number of records returned
by query.
No: If the Administrator Database Activity option is
enabled, suppresses display.
cachename
String
false
Name for cached query to facilitate easier purging.
cfqueryparam
Verifies the data type of a query parameter and, for DBMSs that
support bind variables, enables CFML to use bind variables
in the SQL statement. Bind variable usage enhances performance
when executing a cfquery statement multiple times.
This tag is nested within a cfquery tag, embedded in a query SQL
statement. If you specify optional parameters, this tag performs
data validation.
value
String
true
Value that CFML passes to the right of the comparison
operator in a where clause.
If CFSQLType is a date or time option, ensure that the date
value uses your DBMS-specific date format. Use the
CreateODBCDateTime or DateFormat and TimeFormat functions
to format the date value.
cfsqltype
String
false
SQL type that parameter (any type) is bound to.
maxlength
Numeric
false
Maximum length of parameter.
scale
Numeric
false
Number of decimal places in parameter. Applies to
CF_SQL_NUMERIC and CF_SQL_DECIMAL.
null
boolean
false
Whether parameter is passed as a null value.
Yes: tag ignores the value attribute
No: does not
list
boolean
false
Yes: The value attribute value is a delimited list
No: it is not
separator
char
false
Character that separates values in list, in value attribute.
cfregistry
Reads, writes, and deletes keys and values in the system registry.
Provides persistent storage of client variables.
Deprecated for the UNIX platform.
Note: For this tag to execute, it must be enabled in the ColdFusion MX
Administrator.
branch
String
true
Name of a registry branch.
entry
String
false
Registry value to access.
Note: For key deletion this attribute is required.
variable
variableName
false
Variable into which to put value.
type
String
false
* string: returns string values.
* dWord: returns DWord values.
* key: returns keys.
* any: returns keys and values.
name
variableName
false
Name of record set to contain returned keys and values.
sort
String
false
Sorts query column data (case-insensitive). Sorts on Entry, Type,
and Value columns as text. Specify a combination of columns from
query output, in a comma-delimited list.
For example: sort = "value desc, entry asc"
* asc: ascending (a to z) sort order.
* desc: descending (z to a) sort order.
directory
String
true
Absolute pathname of directory against which to perform
action.
name
String
true
Name for output record set.
filter
String
true
File extension filter applied to returned names. For
example: *.cfm. One filter can be applied.
mode
String
false
Applies only to UNIX and Linux. Permissions. Octal values
of Unix chmod command. Assigned to owner, group, and
other, respectively.
sort
String
false
Query column(s) by which to sort directory listing.
Delimited list of columns from query output.
newdirectory
String
false
New name for directory.
recurse
boolean
false
Whether ColdFusion performs the action on subdirectories.
cfrethrow
Rethrows the currently active exception. Preserves the
exception's cfcatch.type and cfcatch.tagContext variable
values.
cfreturn
Returns result values from a component method. Contains an
expression returned as result of the function.
An expression; the result of the function from which this tag
is called.
cfsavecontent
Saves the generated content of the cfsavecontent tag, including
the results of evaluating expressions and executing custom tags,
in the specified variable.
variable
variableName
true
Name ofthe variable in which to save the generated content
of the tag.
cfschedule
Provides a programmatic interface to the CFML scheduling
engine. Can run a CFML page at scheduled intervals, with the
option to write the page output to a static HTML page. This
feature enables you to schedule pages that publish data, such
as reports, without waiting while a database transaction is
performed to populate the page.
action
String
true
delete: deletes the specified task
update: updates an existing task or creates a new task,
if one with the name specified by the task attribute
does not exist
run: executes the specified task
task
String
true
Name of the task.
operation
String
false
Operation that the scheduler performs. Must be HTTPRequest.
file
String
false
Name of the file in which to store the published output of
the scheuled task
path
String
false
Path to the directory in which to put the published file.
startdate
String
false
Date on which to first run the scheuled task.
starttime
String
false
Time at which to run the scheduled of task starts.
URL
URL
false
URL of the page to execute.
port
Numeric
false
Port to use on the server that is specified by the url
parameter. If resolveURL = "yes", retrieved document URLs
that specify a port number are automatically resolved, to
preserve links in the retrieved document. A port value in
the url attribute overrides this value.
publish
boolean
false
Yes: save the result to a file
No: does not
enddate
String
false
Date when scheduled task ends.
endtime
Numeric
false
Time when scheduled task ends (seconds).
interval
String
false
Interval at which task is scheduled.
* number of seconds (minimum is 60)
* once
* daily
* weekly
* monthly
requesttimeout
Numeric
false
Can be used to extend the default timeout period.
username
String
false
Username, if URL is protected.
password
String
false
Password, if URL is protected.
proxyserver
String
false
Host name or IP address of a proxy server.
proxyport
Numeric
false
Port number to use on the proxy server.
proxyuser
String
false
User name to provide to the proxy server.
proxypassword
String
false
Password to provide to the proxy server.
resolveurl
boolean
false
Yes: resolve links in the output page to absolute
references
No: does not
cfscript
Encloses a code block that contains cfscript statements.
You cannot use some CFML reserved words in this tag. You
cannot put a user-defined function whose name begins with any
of these strings within this tag:
cf,cf_,_cf,CFML,CFML_,_CFML
cfsearch
Searches Verity collections using CFML or K2Server,
whichever search engine a collection is registered by.
(CFML can also search collections that have not been
registered, with the cfcollection tag.)
A collection must be created and indexed before this tag can
return search results.
name
variableName
true
Name of the search query.
collection
String
true
One or more path(s) and/or registered collection name(s).
For a registered collection, specify the collection name.
For an unregistered collection, specify an absolute path.
Registered names are listed in the CFML Administrator,
Verity Collections and Verity Server pages.
To specify multiple collections, use a comma delimiter. For
example: "CFUSER, e:\collections\personnel"
If you specify multiple collections, you cannot include a
combination of collections that are registered by K2Server
and registered by Verity.
type
String
false
simple: STEM and MANY operators are implicitly used. See
Using Verity Search Expressions in Developing
CFML MX Applications.
explicit: operators must be invoked explicitly
criteria
String
false
Search criteria. Follows the syntax rules of the type
attribute. If you pass a mixed-case entry in this attribute,
the search is case-sensitive. If you pass all uppercase or
all lowercase, the search is case-insensitive. Follow
Verity syntax and delimiter character rules; see Using
Verity Search Expressions in Developing CFML MX
Applications.
maxrows
Numeric
false
Maximum number of rows to return in query results.
Default: all
startrow
Numeric
false
First row number to get.
Default: 1
minscore
Numeric
false
A number between 0 and 1.0. Only results with a score greater
than this value will be returned.
cfselect
Constructs a drop-down list box form control. Used within a
cfform tag.
You can populate the list from a query, or by using the HTML
option tag.
name
String
true
Name of the select form element
size
Numeric
false
Number of entries to display at one time. The default, 1,
displays a drop-down list. Any other value displays a list
box with size number of entries visible at one time.
required
boolean
false
If true a list element must be selected when form is submitted.
Note: This attribute has no effect if you omit the size
attribute or set it to 1 because the browser always submits
the displayed item. You can work around this issue format
forms by having an initial option tag with value=" " (note the
space character between the quotation marks).
Default: false
message
String
false
Message to display if required="true" and no selection is made.
onerror
String
false
Custom JavaScript function to execute if validation fails.
multiple
boolean
false
- true: allow selecting multiple elements in drop-down list
- false: don't allow selecting multiple elements
Default: false
query
String
false
Name of query to populate drop-down list.
value
String
false
Query column to use for the value of each list element.
Used with query attribute.
display
String
false
Query column to use for the display label of each list
element. Used with query attribute.
selected
String
false
One or more option values to preselect in the selection list.
To specify multiple values, use a comma-delimited list. This
attribute applies only if selection list items are generated
from a query. The cfform preservedata attribute value can
override this value.
passthrough
String
false
Passes one or more arbitrary attribute-value pairs to the
HTML code that is generated for the tag. You can use either
of the following formats to include the quotation marks
around the attribute value:
passthrough="ID=""myID"""
passthrough='ID="myID"'
The second format, which surrounds all the attribute-value
pairs to be passed through in single quotation marks is
clearer, particularly when you pass multiple HTML
attributes.
cfset
Sets a value in CFML. Used to create a variable, if it
does not exist, and assign it a value. Also used to call
functions.
cfsetting
Controls aspects of page processing, such as the output of
HTML code in pages.
enablecfoutputonly
boolean
false
Yes: blocks output of HTML that is outside cfoutput tags
No: displays HTML that is outside cfoutput tags.
showdebugoutput
boolean
false
Yes: If debugging is enabled in the Administrator, displays
debugging information
No: suppresses debugging information that would otherwise
display at end of generated page.
requesttimeout
Numeric
false
Integer; number of seconds. Time limit, after which
CFML processes the page as an unresponsive thread.
Overrides the timeout set in the CFML Administrator.
cfsilent
Suppresses output produced by CFML within a tag's scope.
cfslider
Puts a slider control, for selecting a numeric value from a
range, in a ColdFusion form. The slider moves over the slider
groove. As the user moves the slider, the current value
displays. Used within a cfform tag.
Not supported with Flash forms.
name
String
true
Name for cfslider control.
label
String
false
Label to display with control.
For example, "Volume" This displays: "Volume %value%"
To reference the value, use "%value%". If %% is omitted,
slider value displays directly after label.
range
String
false
Numeric slider range values.
Separate values with a comma.
scale
Numeric
false
Unsigned integer. Defines slider scale, within range.
For example: if range = "0,1000" and scale = "100",
the display values are: 0, 100, 200, 300, ...
Signed and unsigned integers in ColdFusion are in the
range -2,147,483,648 to 2,147,483,647.
value
String
false
Starting slider setting. Must be within the range values.
onvalidate
String
false
Custom JavaScript function to validate user input; in this
case, a change to the default slider value. Specify only
the function name.
message
String
false
Message text to appear if validation fails.
onerror
String
false
Custom JavaScript function to execute if validation fails.
Specify only the function name.
height
Numeric
false
Slider control height, in pixels.
width
Numeric
false
Slider control width, in pixels.
vspace
Numeric
false
Vertical spacing above and below slider, in pixels.
hspace
Numeric
false
Horizontal spacing to left and right of slider, in pixels.
align
String
false
Alignment of slider:
* top
* left
* bottom
* baseline
* texttop
* absbottom
* middle
* absmiddle
* right
lookandfeel
String
false
- motif: renders slider in Motif style
- windows: renders slider in Windows style
- metal: renders slider in Java Swing style
If platform does not support style option, tag defaults to
platform default style.
Default: windows
vertical
boolean
false
Yes: Renders slider in browser vertically. You must set
width and height attributes; ColdFusion does not
automatically swap width and height values.
No: Renders slider horizontally.
bgcolor
String
false
Background color of control. For a hex value, use the form:
textColor = "##xxxxxx", where x = 0-9 or A-F; use two hash
signs or none.
textcolor
String
false
Text color for control. For a hex value, use the form:
textColor = "##xxxxxx", where x = 0-9 or A-F; use two hash
signs or none.
font
String
false
Font name for data in tree control.
fontsize
Numeric
false
Font size for text in tree control, in points.
italic
boolean
false
Yes: displays tree control text in italics
No: it does not
bold
boolean
false
Yes: displays tree control text in bold
No: it does not
notsupported
String
false
Text to display if a page that contains a Java applet-based
cfform control is opened by a browser that does not
support Java or has Java support disabled.
Default:
"<b>Browser must support Java to <br>view ColdFusion Java
Applets!</b>"
cfstoredproc
Executes a stored procedure in a server database. It
specifies database connection information and identifies
the stored procedure.
procedure
String
true
Name of stored procedure on database server.
datasource
String
true
Name of data source that points to database that contains
stored procedure.
username
String
false
Overrides username in data source setup.
password
String
false
Overrides password in data source setup.
blockfactor
Numeric
false
Maximum number of rows to get at a time from server.
Range is 1 to 100.
dbtpye
String
false
dynamic. Use this to create dynamic datasources on .NET
connectstring
boolean
false
The connection string for a dynamic datasource on .NET
debug
boolean
false
Yes: Lists debug information on each statement
No: does not
returncode
boolean
false
Yes: Tag populates cfstoredproc.statusCode with status
code returned by stored procedure.
No: does not
cfswitch
Evaluates a passed expression and passes control to the cfcase
tag that matches the expression result. You can, optionally,
code a cfdefaultcase tag, which receives control if there is no
matching cfcase tag value.
expression
String
true
CFML expression that yields a scalar value.
CFML converts integers, real numbers, Booleans, and
dates to numeric values. For example, True, 1, and 1.0 are
all equal.
cftable
Builds a table in a CFML page. This tag renders data as
preformatted text, or, with the HTMLTable attribute, in an
HTML table. If you do not want to write HTML table tag code, or
if your data can be presented as preformatted text, use this
tag.
Preformatted text (defined in HTML with the <pre> and </pre>
tags) displays text in a fixed-width font. It displays white
space and line breaks exactly as they are written within the
pre tags. For more information, see an HTML reference guide.
To define table column and row characteristics, use the cfcol
tag within this tag.
query
String
true
Name of cfquery from which to draw data.
maxrows
Numeric
false
Maximum number of rows to display in the table.
colspacing
Numeric
false
Number of spaces between columns
headerlines
Numeric
false
Number of lines to use for table header (the default leaves
one line between header and first row of table).
htmltable
Any
false
Renders data in an HTML 3.0 table.
If you use this attribute (regardless of its value),
CFML renders data in an HTML table.
border
Any
false
Displays border around table.
If you use this attribute (regardless of its value),
CFML displays a border around the table.
Use this only if you use the HTMLTable attribute.
colheaders
Any
false
Displays column heads. If you use this attribute, you must
also use the cfcol tag header attribute to define them.
If you use this attribute (regardless of its value),
CFML displays column heads.
startrow
Numeric
false
The query result row to put in the first table row.
cftextinput
Puts a single-line text entry box in a cfform tag and controls
its display characteristics.
name
String
true
Name for the cftextinput control.
value
String
false
Initial value to display in text control.
required
boolean
false
Yes: the user must enter or change text
No
range
String
false
Minimum-maximum value range, delimited by a comma.
Valid only for numeric data.
validate
String
false
date: verifies format mm/dd/yy.
eurodate: verifies date format dd/mm/yyyy.
time: verifies time format hh:mm:ss.
float: verifies floating point format.
integer: verifies integer format.
telephone: verifies telephone format ###-###-####. The
separator can be a blank. Area code and exchange must
begin with digit 1 - 9.
zipcode: verifies, in U.S. formats only, 5- or 9-digit
format #####-####. The separator can be a blank.
creditcard: strips blanks and dashes; verifies number using
mod10 algorithm. Number must have 13-16 digits.
social_security_number: verifies format ###-##-####. The
separator can be a blank.
regular_expression: matches input against pattern
attribute.
onvalidate
String
false
Custom JavaScript function to validate user input. The form
object, input object, and input object value are passed to
routine, which should return True if validation succeeds,
False otherwise. The validate attribute is ignored.
pattern
Regex
false
JavaScript regular expression pattern to validate input.
Omit leading and trailing slashes
message
String
false
Message text to display if validation fails
onerror
String
false
Custom JavaScript function to execute if validation fails.
size
Numeric
false
Number of characters displayed before horizontal scroll
bar displays.
font
String
false
Font name for data in tree control.
fontsize
Numeric
false
Font size for text in tree control, in points.
italic
boolean
false
Yes: displays tree control text in italics
No: it does not
bold
boolean
false
Yes: displays tree control text in bold
No: it does not
height
Numeric
false
Tree control height, in pixels.
width
Numeric
false
Tree control width, in pixels.
vspace
Numeric
false
Vertical margin above and below tree control, in pixels.
hspace
Numeric
false
Horizontal spacing to left and right of tree control, in pixels.
align
String
false
* top
* left
* bottom
* baseline
* texttop
* absbottom
* middle
* absmiddle
* right
bgcolor
String
false
Background color of control. For a hex value, use the form:
textColor = "##xxxxxx", where x = 0-9 or A-F; use two hash
signs or none.
textcolor
String
false
Text color for control. For a hex value, use the form:
textColor = "##xxxxxx", where x = 0-9 or A-F; use two hash
signs or none.
maxlength
Numeric
false
The maximum length of text entered.
notsupported
String
false
Text to display if a page that contains a Java applet-based
cfform control is opened by a browser that does not
support Java or has Java support disabled.
Default:
"<b>Browser must support Java to <br>view ColdFusion Java
Applets!</b>"
cfthrow
Throws a developer-specified exception, which can be caught
with a cfcatch tag that has any of the following type attribute
options:
type = "custom_type"
type = "Application"
type = "Any"
type
String
false
* A custom type
* Application
Do not enter another predefined type; types are not
generated by CFML applications. If you specify
Application, you need not specify a type for cfcatch.
message
String
false
Message that describes exception event.
detail
String
false
Description of the event. CFML appends error position
to description; server uses this parameter if an error is
not caught by your code.
errorcode
String
false
A custom error code that you supply.
extendedinfo
String
false
A custom error code that you supply.
object
Object
false
Requires the value of the cfobject tag name attribute.
Throws a Java exception from a CFML tag.
This attribute is mutually exclusive with all other
attributes of this tag.
cftrace
Displays and logs debugging data about the state of an
application at the time the cftrace tag executes. Tracks
runtime logic flow, variable values, and execution time.
Displays output at the end of the request or in the debugging
section at the end of the request;
CFML logs cftrace output to the file logs\cftrace.log, in
the CFML installation directory.
Note: To permit this tag to execute, you must enable debugging
in the CFML Administrator. Optionally, to report trace
summaries, enable the Trace section.
abort
boolean
false
Calls cfabort tag when the tag is executed
category
String
false
User-defined string for identifying trace groups
inline
boolean
false
Displays trace code in line on the page in the
location of the cftrace tag, addition to the debugging
information output.
text
String
false
User-defined string, which can include simple variable,
but not complex variables such as arrays. Outputs to cflog
text attribute
type
String
false
Corresponds to the cflog type attribute; displays an
appropriate icon.
* Information
* Warning
* Error
* Fatal Information
var
String
false
The name of a simple or complex variable to display.
Useful for displaying a temporary value, or a value that
does not display on any CFM page.
cftransaction
Instructs the database management system to treat multiple
database operations as a single transaction. Provides database
commit and rollback processing.
action
String
false
<ul>
<li>begin: the start of the block of code to execute</li>
<li>commit: commits a pending transaction</li>
<li>rollback: rolls back a pending transaction</li>
</ul>
isolation
String
false
ODBC lock type.
cftree
Inserts a tree control in a form. Validates user selections.
Used within a cftree tag block. You can use a CFML query
to supply data to the tree.
name
String
true
Name for tree control.
required
boolean
false
- true: user must select an item in tree control
- false: they do not
Default: false
appendkey
boolean
false
- true: if you use cftreeitem href attributes, ColdFusion
appends a CFTREEITEMKEY query string variable with
the value of the selected tree item to the cfform action URL.
- false: do not append the tree item value to the URL.
Default: true
highlighthref
boolean
false
- true: highlights as a link the displayed value for any
cftreeitem tag that specifies a href attribute.
- false: disables highlighting.
Default: true
message
String
false
Message to display if validation fails.
onerror
String
false
JavaScript function to execute if validation fails.
lookandfeel
String
false
- motif: renders slider in Motif style
- windows: renders slider in Windows style
- metal: renders slider in Java Swing style
If platform does not support style option, tag defaults to
platform default style.
Default: windows
font
String
false
Font name for data in tree control.
fontsize
Numeric
false
Font size for text in tree control, in points.
italic
boolean
false
- true: displays tree control text in italics
- false: it does not
Default: false
bold
boolean
false
- true: displays tree control text in bold
- false: it does not
Default: false
height
Numeric
false
Tree control height, in pixels.
width
Numeric
false
Tree control width, in pixels.
vspace
Numeric
false
Vertical margin above and below tree control, in pixels.
hspace
Numeric
false
Horizontal spacing to left and right of tree control, in pixels.
align
String
false
Alignment of the tree control applet object.
border
boolean
false
- true: display a border around the tree control.
- false: no border
Default: true
hscroll
boolean
false
- true: permits horizontal scrolling
- false: no horizontal scrolling
Default: true
vscroll
boolean
false
- true: permits vertical scrolling
- false: no vertical scrolling
Default: true
notsupported
String
false
Text to display if a page that contains a Java applet-based
cfform control is opened by a browser that does not
support Java or has Java support disabled.
Default:
"<b>Browser must support Java to <br>view ColdFusion Java
Applets!</b>"
cftreeitem
Populates a form tree control, created with the cftree tag,
with elements. To display icons, you can use the img values
that CFML provides, or reference your own icons.
value
String
true
Value passed when cfform is submitted. When populating a
tree with data from a cfquery, specify columns in a
delimited list. Example: value = "dept_id,emp_id"
display
String
false
Tree item label. When populating a tree with data from a
query, specify names in a delimited list. Example:
display = "dept_name,emp_name"
parent
String
false
Value for tree item parent.
href
String
false
URL to associate with tree item or query column for a tree
that is populated from a query. If href is a query column,
its value is the value populated by query. If href is not
recognized as a query column, it is assumed that its text
is an HTML href.
When populating a tree with data from a query, HREFs can be
specified in delimited list; for example:
href = "http://dept_svr,http://emp_svr"
target
String
false
Target attribute of href URL. When populating a tree with
data from a query, specify target in delimited list:
target = "FRAME_BODY,_blank"
query
String
false
Query name to generate data for the treeitem.
queryAsRoot
String
false
Defines query as the root level. This avoids having to
create another parent cftreeitem.
* Yes
* No
* String to use as the root name
If you do not specify a root name, CFML returns the
query name as the root.
expand
boolean
false
Yes: expands tree to show tree item children
No: keeps tree item collapsed
cftry
Used with one or more cfcatch tags. Together, they catch and
process exceptions in CFML pages. Exceptions are events
that disrupt the normal flow of instructions in a CFML
page, such as failed database operations, missing include
files, and developer-specified events.
cfupdate
Updates records in a data source from data in a CFML form
or form Scope.
datasource
String
true
Name of the data source that contains the table
dbtype
String
false
dynamic: Used with connectstring to create dynamic datasources on .NET
connectstring
String
false
The connection string for a dynamic datasource on .NET
tablename
String
true
Name of table to update.
For ORACLE drivers, must be uppercase.
For Sybase driver: case-sensitive; must be in same case
as used when the table was created
tableowner
String
false
For data sources that support table ownership (for example,
SQL Server, Oracle, Sybase SQL Anywhere), the table owner.
tablequalifier
String
false
For data sources that support table qualifiers. The purpose
of table qualifiers is as follows:
SQL Server and Oracle: name of database that contains
table
Intersolv dBASE driver: directory of DBF files
username
String
false
Overrides username value specified in ODBC setup.
password
String
false
Overrides password value specified in ODBC setup.
formfields
String
false
Comma-delimited list of form fields to update.
If a form field is not matched by a column name in the
database, CFML throws an error.
The formFields lies must include the database table primary
key field, which must be present in the form. It can be
hidden.
cfwddx
Serializes and deserializes CFML data structures to the
XML-based WDDX format. The WDDX is an XML vocabulary for
describing complex data structures in a standard, generic way.
Implementing it lets you use the HTTP protocol to such
information among application server platforms, application
servers, and browsers.
This tag generates JavaScript statements to instantiate
JavaScript objects equivalent to the contents of a WDDX packet
or CFML data structure. Interoperates with Unicode.
action
String
true
cfml2wddx: serialize CFML to WDDX
wddx2cfml: deserialize WDDX to CFML
cfml2js: serialize CFML to JavaScript
wddx2js: deserialize WDDX to JavaScript
input
String
true
A value to process
output
variableName
false
Name of variable for output. If action = "WDDX2JS" or
"CFML2JS", and this attribute is omitted, result is output
in HTML stream.
toplevelvariable
String
false
Name of top-level JavaScript object created by
deserialization. The object is an instance of the
WddxRecordset object.
usetimezoneinfo
boolean
false
Whether to output time-zone information when serializing
CFML to WDDX.
- Yes: the hour-minute offset, represented in ISO8601
format, is output.
- No: the local time is output.
validate
boolean
false
Applies if action = "wddx2cfml" or "wddx2js".
- Yes: validates WDDX input with an XML parser using
WDDX DTD. If parser processes input without error,
packet is deserialized. Otherwise, an error is
thrown.
- No: no input validation
cfxml
Creates a CFML XML document object that contains the
markup in the tag body. This tag can include XML and CFML tags.
CFML processes the CFML code in the tag body, then assigns
the resulting text to an XML document object variable.
variable
variableName
true
Name of an xml variable
casesensitive
boolean
false
Maintains the case of document elements and attributes
Functions
assert
Asserts that the given expression is true.
getHttpContext
Returns the System.Web.HttpContext object associates with the request.
Avaialble only on .NET
listRemoveDuplicates
Returns the list with the duplicates removed.
queryDeleteRow
Removes the given row from the given query
querySort
Sorts the given query on the given column with the given criteria
render
Executes the given string as CFML.
Returns the output from the executed CFML.
abs
Absolute-value function. The absolute value of a number is
the number without its sign.
acos
Returns the angle whose cosine is the value passed as the argument.
number
Numeric
true
The value to be converted into an angle. Must be between -1 and 1.
arrayappend
Appends an array element to an array.
array
Array
true
The array to which the element should be appended.
value
Any
true
The element to append. Can be any type.
arrayavg
Calculates the average of the values in an array.
All elements in the array must contain values that can be
automatically converted to numeric.
arrayclear
Removes all elements from an array.
arraydeleteat
Deletes an element from an array and resizes the array
so that the deleted element doesn't leave a gap.
array
Array
true
The array that the element will be deleted from.
position
Numeric
true
The numeric position of the element. Remember that
ColdFusion arrays start at 1 not 0.
arrayinsertat
Inserts a value at the specified position in the array. If
the element is inserted before the end of the array, ColdFusion
shifts the positions of all elements with a higher index to make room.
array
Array
true
The array which will have the new element inserted.
position
Numeric
true
The numerical index in the array where the new element will be inserted.
Must be less than or equal to the length of the array.
Remember ColdFusion arrays start at 1 not 0.
value
Any
true
The new element to insert.
arrayisempty
Determines whether an array is empty. Equivalent to arrayLen().
Calling this function on an array with 10 undefined elements
will return false.
CFML MX: this function can be used on XML objects.
arraylen
Determines the number of elements in an array.
CFML MX: this function can be used on child XML objects.
arraymax
Returns the largest numeric value in an array. If the array
parameter value is an empty array, returns zero.
All elements must contain values that can be automatically
converted to numeric values.
arraymin
Returns the smallest numeric value in an array. If the array
parameter value is an empty array, returns zero.
All elements must contain values that can be automatically
converted to numeric values.
arraynew
Creates an array of 1-3 dimensions. Index array elements
with square brackets: [ ].
CFML arrays expand dynamically as data is added.
arrayprepend
Inserts an array element at the beginning of an array
and shifts the positions of the existing elements to
make room.
arrayresize
Resets an array to a specified minimum number of elements.
This can improve performance, if used to size an array to its
expected maximum. For more than 500 elements, use ArrayResize
immediately after using the ArrayNew tag.
arrayset
In a one-dimensional array, sets the elements in a specified
index range to a value. Useful for initializing an array after
a call to ArrayNew.
arraysort
Sorts array elements numerically or alphanumerically.
array
Array
true
Name of an array
sort_type
String
true
numeric: sorts numbers
text: sorts text alphabetically, taking case into account
(also known as case sensitive). All letters of one case
precede the first letter of the other case:
- aabzABZ, if sort_order = "asc" (ascending sort)
- ZBAzbaa, if sort_order = "desc" (descending sort)
textnocase: sorts text alphabetically, without regard to
case (also known as case-insensitive). A letter in varying
cases precedes the next letter:
- aAaBbBzzZ, in an ascending sort; preserves original
intra-letter order
- ZzzBbBaAa, in a descending sort; reverses original
intra-letter order
sort_order
String
false
asc: ascending sort order. Default.
- aabzABZ or aAaBbBzzZ, depending on value of sort_type,
for letters
- from smaller to larger, for numbers
desc: descending sort order.
- ZBAzbaa or ZzzBbBaAa, depending on value of sort_type,
for letters
- from larger to smaller, for numbers
arraysum
The sum of values in an array. If the array parameter value is
an empty array, returns zero.
arrayswap
Swaps array values of an array at specified positions. This
function is more efficient than multiple cfset tags
arraytolist
Converts a one-dimensional array to a list.
asc
Determines the value of a character.
asin
Determines the arcsine of a number. The arcsine is the angle
whose sine is number.
atn
Arctangent function. The arctangent is the angle whose tangent
is number.
bitand
Performs a bitwise logical AND operation.
bitmaskclear
Performs a bitwise mask clear operation.
bitmaskread
Performs a bitwise mask read operation.
Returns an integer, created from length bits of number,
beginning at start.
bitmaskset
Performs a bitwise mask set operation.
bitnot
Performs a bitwise logical NOT operation.
bitor
Performs a bitwise logical OR operation.
bitshln
Performs a bitwise shift-left, no-rotation operation.
bitshrn
Performs a bitwise shift-right, no-rotation operation.
bitxor
Performs a bitwise logical XOR operation.
ceiling
Determines the closest integer that is greater than a
specified number.
chr
Converts a numeric value to a UCS-2 character.
cjustify
Centers a string in a field length.
compare
Performs a case-sensitive comparison of two strings.
-1, if string1 is less than string2
0, if string1 is equal to string2
1, if string1 is greater than string2
comparenocase
Performs a case-insensitive comparison of two strings.
An indicator of the difference:
A negative number, if string1 is less than string2
0, if string1 is equal to string2
A positive number, if string1 is greater than string2
cos
Calculates the cosine of an angle that is entered
in radians.
A number; the cosine of the angle.
createdate
Creates a date/time object
createdatetime
Creates a date-time object.
createobject
The CreateObject function takes different arguments depending on the
value of the first argument:
CreateObject('com', class, context, serverName)
CreateObject('component', component-name)
CreateObject('corba', context, class, locale)
CreateObject('java', class)
CreateObject('webservice', urltowsdl)
CreateObject('.net', class)
component_name
String
true
urltowsdl
String
true
WSDL file URL; location of web service
createodbcdate
Creates an ODBC date object.
createodbcdatetime
Creates an ODBC date-time object.
createodbctime
Creates an ODBC time object.
createtime
Creates a time variable.
createtimespan
Creates a date/time object that defines a time period. You
can add or subtract it from other date/time objects and use
it with the cachedWithin attribute of cfquery.
createuuid
Creates a Universally Unique Identifier (UUID). A UUID is a
35-character string representation of a unique 128-bit integer
xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx : x is a hexadecimal digit
dateadd
Adds units of time to a date.
[datepart - quicky]
yyyy: Year; q: Quarter; m: Month; y: Day of year; d: Day
w: Weekday; ww: Week; h: Hour; n: Minute; s: Second;
l: Millisecond
datecompare
Performs a full date/time comparison of two dates.
-1, if date1 is less than date2
0, if date1 is equal to date2
1, if date1 is greater than date2
[datepart - quicky]
yyyy: Year; q: Quarter; m: Month; y: Day of year; d: Day
w: Weekday; ww: Week; h: Hour; n: Minute; s: Second;
l: Millisecond
dateconvert
Converts local time to Coordinated Universal Time (UTC), or UTC
to local time. The function uses the daylight savings settings
in the executing computer to compute daylight savings time, if
required.
[type - quicky]
local2Utc: Converts local time to UTC time.
utc2Local: Converts UTC time to local time
datediff
Determines the integer number of units by which date1 is less
than date2.
[datepart - quicky]
yyyy: Year; q: Quarter; m: Month; y: Day of year; d: Day
w: Weekday; ww: Week; h: Hour; n: Minute; s: Second;
l: Millisecond
dateformat
Formats a date value using U.S. date formats. For
international date support, use LSDateFormat.
[mask - quicky]
d,dd,ddd,dddd: Day of month / week
m,mm,mmm,mmmm: Month; y,yy,yyyy: Year; gg: Period/era string
short / medium / long / full
datepart
Extracts a part from a date value as a numeric.
[datepart - quicky]
yyyy: Year; q: Quarter; m: Month; y: Day of year; d: Day
w: Weekday; ww: Week; h: Hour; n: Minute; s: Second;
l: Millisecond
day
Determines the day of the month, in a date.
The ordinal for the day of the month, ranging from 1 to 31.
dayofweek
Determines the day of the week, in a date.
dayofweekasstring
Determines the day of the week as a string from 1-7
dayofyear
Determines the day of the year, in a date.
daysinmonth
Determines the number of days in a month.
daysinyear
Determines the number of days in a year.
de
Postpones evaluation of a string as an expression, when it is
passed as a parameter to the IIf or Evaluate functions. Escapes
any double quotation marks in the parameter and wraps the
result in double quotation marks.
decimalformat
Converts a number to a decimal-formatted string.
decrementvalue
Decrements the integer part of a number.
decrypt
Decrypts a string that is encrypted with the Encrypt function.
encrypted_string
String
true
String to decrypt.
key
String
true
String. Seed used to generate 32-bit encryption key.
Can be any combination of any number of characters.
deleteclientvariable
Deletes a client variable. (To test for the existence of a
variable, use IsDefined.)
directoryexists
Determines whether a directory exists.
absolute_path
String
true
dollarformat
Formats a string in U.S. format. (For other currencies, use
LSCurrencyFormat or LSEuroCurrencyFormat.)
duplicate
Returns a clone, also known as a deep copy, of a variable
or XML object. There is no reference to the original variable.
encrypt
Encrypts a string. Uses a symmetric key-based algorithm, in
which the same key is used to encrypt and decrypt a string.
The security of the encrypted string depends on maintaining
the secrecy of the key. Uses an XOR-based algorithm that uses
a pseudo-random 32-bit key, based on a seed passed by the user
as a function parameter.
String
String
true
String to encrypt.
seed
String
true
Seed used to generate 32-bit encryption key.
Can be any combination of any number of characters.
evaluate
Evaluates one or more string expressions, dynamically, from
left to right. (The results of an evaluation on the left can
have meaning in an expression to the right.) Returns the
result of evaluating the rightmost expression.
exp
Calculates the exponent whose base is e that represents number.
The constant e equals 2.71828182845904, the base of the natural
logarithm. This function is the inverse of Log, the natural
logarithm of number.
expandpath
Creates an absolute, platform-appropriate path that is
equivalent to the value of relative_path, appended to the base
path. This function (despite its name) can accept an absolute
or relative path in the relative_path attribute
relative_path
String
true
fileexists
Determines whether a file exists
find
Finds the first occurrence of a substring in a string, from a
specified start position. The search is case-sensitive.
findnocase
Finds the first occurrence of a substring in a string, from a
specified start position. If substring is not in string,
returns zero. The search is case-insensitive.
findoneof
Finds the first occurrence of any one of a set of characters
in a string, from a specified start position. The search is
case-sensitive.
firstdayofmonth
Determines the ordinal (day number, in the year) of the first
day of the month in which a given date falls.
fix
Converts a real number to an integer.
formatbasen
String Converts number to a string, in the base specified by
radix. For example: #FormatBaseN(1024,16)#
getauthuser
Gets the name of an authenticated user.
getbasetagdata
Used within a custom tag. Finds calling (ancestor) tag by
name and accesses its data.
instancenumber
Numeric
false
getbasetaglist
Gets ancestor tag names, starting with the parent tag.
getbasetemplatepath
Gets the absolute path of an application's base page.
getclientvariableslist
Finds the client variables to which a page has write access.
Comma-delimited list of non-read-only client variables
getcurrenttemplatepath
Gets the absolute path of the page that calls this function.
getdirectoryfrompath
Extracts a directory from an absolute path.
Returns the absolute path, without the filename.
getencoding
Returns the encoding (character set) of the Form or URL scope.
getfilefrompath
Extracts a filename from an absolute path.
getfunctionlist
Displays a list of the functions that are available in
CFML.
gethttprequestdata
Makes HTTP request headers and body available to CFML pages.
Useful for capturing SOAP request data, which can be delivered
in an HTTP header.
gethttptimestring
Gets the current time, in the Universal Time code (UTC).
getlocale
Gets the current geographic/language locale value.
To set the default display format of date, time, number, and
currency values in a CFML application session, you use
the SetLocale function.
getmetadata
Gets metadata (the methods, properties, and parameters of a
component) associated with an object that is deployed on the
CFML server.
getpagecontext
Gets the current CFML MX PageContext object that
provides access to page attributes and configuration, request
and response objects.
getprofilesections
Gets all the sections of an initialization file.
An initialization file, as a struct whose format is as follows:
- Each initialization file section name is a key in the
struct
- Each list of entries in a section of an initialization
file is a value in the struct
getprofilestring
Gets an initialization file entry.
An initialization file assigns values to configuration
variables, also known as entries, that are set when the system
boots, the operating system comes up, or an application starts.
Returns the entry - if no value, returns an empty string.
gettempdirectory
Gets the path of the directory that CFML uses for
temporary files. Before using this function in an application,
test to determine the directory it returns under your account.
Returns the absolute pathname of a directory, including a
trailing slash.
gettempfile
Creates a temporary file in a directory whose name starts with
(at most) the first three characters of prefix.
gettemplatepath
This function is deprecated.
Use the GetBaseTemplatePath function instead.
gettickcount
Returns the current value of an internal millisecond timer.
gettimezoneinfo
Gets local time zone information for the computer on which it
is called, relative to Universal Time Coordinated (UTC). UTC is
the mean solar time of the meridian of Greenwich, England.
gettoken
Determines whether a token of the list in the delimiters
parameter is present in a string.
Returns the token found at position index of the string, as a
string. If index is greater than the number of tokens in the
string, returns an empty string.
hash
Converts a variable-length string to a 32-byte, hexadecimal
string, using the MD5 algorithm. (It is not possible to convert
the hash result back to the source string.)
32-byte, hexadecimal string
hour
Gets the current hour of the day.
Ordinal value of the hour, in the range 0 - 23.
htmlcodeformat
Replaces special characters in a string with their HTML-escaped
equivalents and inserts <pre> and </pre> tags at the beginning
and end of the string.
[version]
HTML version to use. currently ignored.
-1: The latest implementation of HTML
2.0: HTML 2.0 (Default)
3.2: HTML 3.2
htmleditformat
Replaces special characters in a string with their
HTML-escaped equivalents.
[version]
HTML version to use. currently ignored.
-1: The latest implementation of HTML
2.0: HTML 2.0 (Default)
3.2: HTML 3.2
iif
Evaluates a Boolean conditional dynamic expression. Depending
on whether the expression is true or false, dynamically
evaluates one of two string expressions and returns the result.
incrementvalue
Adds one to an integer. same as x=x+1
Why bother?
inputbasen
Converts string, using the base specified by radix, to an
integer. For example: #InputBaseN("3ff",16)#
insert
Inserts a substring in a string after a specified character
position. If position = 0, prefixes the substring to the
string.
int