MACROMEDIA COLDFUSION MX 61-CFML User manual

CFML Quick Reference

Trademarks

Afterburner, AppletAce, Attain, Attain Enterprise Learning System,

Attain Essentials, Attain Objects for Dreamweaver, Authorware,

Authorware Attain, Authorware Interactive Studio, Authorware Star,

Authorware Synergy, Backstage, Backstage Designer, Backstage Desktop

Studio, Backstage Enterprise Studio, Backstage Internet Studio,

ColdFusion, Design in Motion, Director, Director Multimedia Studio,

Doc Around the Clock, Dreamweaver, Dreamweaver Attain, Drumbeat,

Drumbeat 2000, Extreme 3D, Fireworks, Flash, Fontographer,

FreeHand, FreeHand Graphics Studio, Generator, Generator Developer's

Studio, Generator Dynamic Graphics Server, JRun, Knowledge Objects,

Knowledge Stream, Knowledge Track, Lingo, Live Effects, Macromedia,

Macromedia M Logo & Design, Macromedia Flash, Macromedia Xres,

Macromind, Macromind Action, MAGIC, Mediamaker, Object

Authoring, Power Applets, Priority Access, Roundtrip HTML, Scriptlets,

SoundEdit, ShockRave, Shockmachine, Shockwave, Shockwave Remote,

Shockwave Internet Studio, Showcase, Tools to Power Your Ideas,

Universal Media, Virtuoso, Web Design 101, Whirlwind and Xtra are

trademarks of Macromedia, Inc. and may be registered in the United

States or in other jurisdictions including internationally. Other product

names, logos, designs, titles, words or phrases mentioned within this

publication may be trademarks, servicemarks, or tradenames of

Macromedia, Inc. or other entities and may be registered in certain

jurisdictions including internationally.

This product includes code licensed from RSA Data Security.

This guide contains links to third-party websites that are not under the

control of Macromedia, and Macromedia is not responsible for the

content on any linked site. If you access a third-party website mentioned

in this guide, then you do so at your own risk. Macromedia provides

these links only as a convenience, and the inclusion of the link does not

imply that Macromedia endorses or accepts any responsibility for the

content on those third-party sites.

Apple Disclaimer

APPLE COMPUTER, INC. MAKES NO WARRANTIES, EITHER EXPRESS

OR IMPLIED, REGARDING THE ENCLOSED COMPUTER SOFTWARE

PACKAGE, ITS MERCHANTABILITY OR ITS FITNESS FOR ANY

PARTICULAR PURPOSE. THE EXCLUSION OF IMPLIED WARRANTIES

IS NOT PERMITTED BY SOME STATES. THE ABOVE EXCLUSION MAY

NOT APPLY TO YOU. THIS WARRANTY PROVIDES YOU WITH

SPECIFIC LEGAL RIGHTS. THERE MAY BE OTHER RIGHTS THAT YOU

MAY HAVE WHICH VARY FROM STATE TO STATE.

manual may not be copied, photocopied, reproduced, translated, or

converted to any electronic or machine-readable form in whole or in part

without prior written approval of Macromedia, Inc.

Part number: ZCF61M400

Project Management: Randy Nielsen

Editing: Linda Adler

First Edition: May 2002

Second Edition: August 2003

Macromedia, Inc.

600 Townsend St.

San Francisco, CA 94103

CFML Quick Reference 3

CONTENTS

CFML tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

CFML functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Array functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Authentication functions . . . . . . . . . . . . . . . . . . . . . . . . . 20

Conversion functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Date and time functions . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Decision functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Display and formatting functions . . . . . . . . . . . . . . . . . . . 22

Dynamic evaluation functions . . . . . . . . . . . . . . . . . . . . . 22

Extensibility functions . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Full-text search functions . . . . . . . . . . . . . . . . . . . . . . . . . 23

International functions . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

List functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Mathematical functions . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Other functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Query functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

String functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Structure functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

System functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

XML functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

ColdFusion variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Variable scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Caller scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Client variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Server variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Application and session variables . . . . . . . . . . . . . . . . . . . 28

Custom tag variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Request variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Form variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

ColdFusion tag-specific variables . . . . . . . . . . . . . . . . . . . . 29

ColdFusion query variables . . . . . . . . . . . . . . . . . . . . . . . . 30

CFCATCH variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

CFDIRECTORY variables . . . . . . . . . . . . . . . . . . . . . . . . 30

CFERROR variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

CFFILE ACTION=Upload variables . . . . . . . . . . . . . . . . 31

CFFTP error variables . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

CFFTP ReturnValue variable . . . . . . . . . . . . . . . . . . . . . . 31

CFFTP query object columns . . . . . . . . . . . . . . . . . . . . . 31

CFHTTP variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

CFLDAP variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

CFPOP variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

CFQUERY and CFSTOREDPROC variables . . . . . . . . . 32

CFREGISTRY variables . . . . . . . . . . . . . . . . . . . . . . . . . . 33

CFSEARCH variables . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

4 CFML Quick Reference

Standard CGI variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

CFML Quick Reference 5

CFML tags

cfabort

<cfabort

showError = "error_message">

cfapplet

<cfapplet

appletSource = "applet_name"

name = "form_variable_name"

height = "height_in_pixels"

width = "width_in_pixels"

vSpace = "space_above_and_below_in_pixels"

hSpace = "space_on_each_side_in_pixels"

align = "alignment_option"

notSupported = "message_to_display_for_nonJava_browser"

param_1 = "applet_parameter_name"

param_2 = "applet_parameter_name"

param_n = "applet_parameter_name">

cfapplication

<cfapplication

name = "application_name"

loginStorage = "cookie" or "session"

clientManagement = "Yes" or "No"

clientStorage = "datasource_name" or "Registry" or

"Cookie"

setClientCookies = "Yes" or "No"

sessionManagement = "Yes" or "No"

sessionTimeout = #CreateTimeSpan(days, hours, minutes,

seconds)#

applicationTimeout = #CreateTimeSpan(days, hours,

minutes, seconds)#

setDomainCookies = "Yes" or "No">

cfargument

<cfargument

name="string"

type="data type"

required="Yes or No"

default="default value"

displayname="descriptive name"

hint="extended description">

cfassociate

<cfassociate

baseTag = "base_tag_name"

dataCollection = "collection_name">

cfbreak

cfcache

<cfcache

action = "action"

directory = "directory_name"

timespan = "value"

expireURL = "wildcarded_URL_reference"

username = "username"

password = "password"

port = "port_number"

protocol = "protocol">

cfcase

<cfcase

value = "value or delimited set of values"

delimiters = "delimiter characters">

cfcatch

Exception processing code here

</cfcatch>

cfchart

<cfchart

format = "flash, jpg, png"

chartHeight = "integer number of pixels"

chartWidth = "integer number of pixels"

scaleFrom = "integer minimum value"

scaleTo = "integer maximum value"

showXGridlines = "yes" or "no"

showYGridlines = "yes" or "no"

gridlines = "integer number of lines"

seriesPlacement = "default, cluster, stacked, percent"

foregroundColor = "Hex value or Web color"

6 CFML Quick Reference

dataBackgroundColor = "Hex value or Web color"

showBorder = "yes" or "no"

font = "font name"

fontSize = "integer font size"

fontBold = "yes" or "no"

fontItalic = "yes" or "no"

labelFormat = "number, currency, percent, date"

xAxisTitle = "title text"

yAxisTitle = "title text"

xAxisType = "scale or category"

yAxisType = "scale or category"

sortXAxis = "yes/no"

show3D = "yes" or "no"

xOffset = "number between -1 and 1"

yOffset = "number between -1 and 1"

rotated = "yes/no"

showLegend = "yes/no"

tipStyle = "MouseDown, MouseOver, none"

tipBGColor = "hex value or web color"

showMarkers = "yes" or "no"

markerSize = "integer number of pixels"

pieSliceStyle = "solid, sliced"

url = "onClick destination page"

name = "String"

</cfchart>

cfchartdata

<cfchartdata

item = "text"

value = "number">

cfchartseries

<cfchartseries

type="type"

query="queryName"

itemColumn="queryColumn"

valueColumn="queryColumn"

seriesLabel="Label Text"

seriesColor="Hex value or Web color"

paintStyle="plain, raise, shade, light"

markerStyle="style"

colorlist = "list">

</cfchartseries>

cfcol

<cfcol

header = "column_header_text"

width = "number_indicating_width_of_column"

align = "Left" or "Right" or "Center"

text = "column_text">

cfcollection

<cfcollection

action = "action"

collection = "collection_name"

path = "path_to_verity_collection"

language = "language"

name = "queryname" >

cfcomponent

<cfcomponent

extends ="anotherComponent"

output = "yes" or "no"

displayname = "text string">

hint = "text string">

variable declarations

...

</cffunction>

...

</cffunction>

</cfcomponent>

cfcontent

<cfcontent

type = "file_type"

deleteFile = "Yes" or "No"

file = "filename"

reset = "Yes" or "No">starting with a drive letter and a

colon, or a forward or backward slash

CFML Quick Reference 7

cfcookie

<cfcookie

name = "cookie_name"

value = "text"

expires = "period"

secure = "Yes" or "No"

path = "url"

domain = ".domain">

cfdefaultcase

cfdirectory

<cfdirectory

action = "directory action"

directory = "directory name"

name = "query name"

filter = "list filter"

mode = "permission"

sort = "sort specification"

newDirectory = "new directory name">

cfdump

<cfdump

var = "#variable#"

expand = "Yes or No"

label = "text">

cfelse

HTML and CFML tags

HTML and CFML tags

HTML and CFML tags

</cfif>

cfelseif

HTML and CFML tags

HTML and CFML tags

HTML and CFML tags

</cfif>

cferror

<cferror

type = "a type"

template = "template_path"

mailTo = "email_address"

exception = "exception_type">

cfexecute

<cfexecute

name = " ApplicationName "

arguments = "CommandLine Arguments"

outputFile = "Output file name"

variable = "variable name"

timeout = "Timeout interval">

...

</cfexecute>

cfexit

<cfexit

method = "method">

cffile

<cffile

action = "append"

file = "full_path_name"

output = "string"

addNewLine = "Yes" or "No"

attributes = "file_attributes_list"

mode = "mode"

charset = "charset_option" >

<cffile

action = "copy"

source = "full_path_name"

destination = "full_path_name"

mode = "mode"

attributes = "file_attributes_list">

<cffile

action = "delete"

file = "full_path_name">

8 CFML Quick Reference

<cffile

action = "move"

source = "full_path_name"

destination = "full_path_name"

mode = "mode"

attributes = "file_attributes_list"

charset = "charset_option">

<cffile

action = "read"

file = "full_path_name"

variable = "var_name"

charset = "charset_option" >

<cffile

action = "readBinary"

file = "full_path_name"

variable = "var_name">

<cffile

action = "rename"

source = "full_path_name"

destination = "path_name"

mode = "mode"

attributes = "file_attributes_list">

<cffile

action = "upload"

fileField = "formfield"

destination = "full_path_name"

nameConflict = "behavior"

accept = "mime_type/file_type"

mode = "permission"

attributes = "file_attribute_or_list">

<cffile

action = "write"

file = "full_path_name"

output = "content"

mode = "permission"

addNewLine = "Yes" or "No"

attributes = "file_attributes_list"

charset = "charset_option" >

cfflush

<cfflush

interval = "integer number of bytes">

cfform

<cfform

name = "name"

action = "form_action"

preserveData = "Yes" or "No"

onSubmit = "javascript"

target = "window_name"

encType = "type"

passThrough = "HTML_attribute(s)"

codeBase = "URL"

archive = "URL"

scriptSrc = "path"

standard HTML attributes>

...

</cfform>

cfftp

cfftp: Opening and closing FTP server connections

<cfftp

action = "action"

username = "name"

password = "password"

server = "server"

timeout = "timeout in seconds"

port = "port"

connection = "name"

proxyServer = "proxy server"

retryCount = "number"

stopOnError = "Yes" or "No"

passive = "Yes" or "No">

cfftp: Connection: file and directory operations

<cfftp

action = "action"

username = "name"

password = "password"

name = "query_name"

server = "server"

ASCIIExtensionList = "extensions"

transferMode = "mode"

failIfExists = "Yes" or "No"

CFML Quick Reference 9

directory = "directory name"

localFile = "filename"

remoteFile = "filename"

item = "directory or file"

existing = "file or directory name"

new = "file or directory name"

proxyServer = "proxy server"

passive = "Yes" or "No">

cfftp action = "listDir"

<cfftp

action = "listDir"

</cfftp>

cffunction

<cffunction

name = "methodName"

returnType = "dataType"

roles = "securityRoles"

access = "methodAccess"

output = "yes" or "no"

displayName = "name"

Hint = "hint text">

cfgraph See cfchart

cfgraphdata See cfchartdata

cfgrid

<cfgrid

name = "name"

height = "integer"

width = "integer"

autoWidth = "Yes" or "No"

vSpace = "integer"

hSpace = "integer"

align = "value"

query = "query_name"

insert = "Yes" or "No"

delete = "Yes" or "No"

sort = "Yes" or "No"

font = "column_font"

fontSize = "size"

italic = "Yes" or "No"

bold = "Yes" or "No"

textColor = "web color"

href = "URL"

hrefKey = "column_name"

target = "URL_target"

appendKey = "Yes" or "No"

highlightHref = "Yes" or "No"

onValidate = "javascript_function"

onError = "text"

gridDataAlign = "position"

gridLines = "Yes" or "No"

rowHeight = "pixels"

rowHeaders = "Yes" or "No"

rowHeaderAlign = "position"

rowHeaderFont = "font_name"

rowHeaderFontSize = "size"

rowHeaderItalic = "Yes" or "No"

rowHeaderBold = "Yes" or "No"

rowHeaderTextColor = "web color"

colHeaders = "Yes" or "No"

colHeaderAlign = "position"

colHeaderFont = "font_name"

colHeaderFontSize = "size"

colHeaderItalic = "Yes" or "No"

colHeaderBold = "Yes" or "No"

colHeaderTextColor = "web color"

bgColor = "web color"

selectColor = "web color"

selectMode = "mode"

maxRows = "number"

notSupported = "text"

pictureBar = "Yes" or "No"

insertButton = "text"

deleteButton = "text"

sortAscendingButton = "text"

sortDescendingButton = "text">

</cfgrid>

10 CFML Quick Reference

cfgridcolumn

<cfgridcolumn

name = "column_name"

header = "header"

width = "column_width"

font = "column_font"

fontSize = "size"

italic = "Yes" or "No"

bold = "Yes" or "No"

textColor = "web color" or "expression"

bgColor = "web color" or "expression"

href = "URL"

hrefKey = "column_name"

target = "URL_target"

select = "Yes" or "No"

display = "Yes" or "No"

type = "type"

headerFont = "font_name"

headerFontSize = "size"

headerItalic = "Yes" or "No"

headerBold = "Yes" or "No"

headerTextColor = "web color"

dataAlign = "position"

headerAlign = "position"

numberFormat = "format"

values = "Comma separated strings and/or numeric range"

valuesDisplay = "Comma separated strings and/or numeric

range"

valuesDelimiter = "delimiter character">

cfgridrow

<cfgridrow

data = "col1, col2, ...">

cfgridupdate

<cfgridupdate

grid = "gridname"

dataSource = "data source name"

tableName = "table name"

username = "data source username"

password = "data source password"

tableOwner = "table owner"

tableQualifier = "qualifier"

keyOnly = "Yes" or "No">

cfheader

<cfheader

name = "header_name"

value = "header_value"

charset="charset">

<cfheader

statusCode = "status_code"

statusText = "status_text">

cfhtmlhead

<cfhtmlhead

text = "text">

cfhttp

<cfhttp

url = "server_URL"

port = "port_number"

method = "method_name"

proxyServer = "hostname"

proxyPort = "port_number"

proxyUser = "username"

proxyPassword = "password"

username = "username"

password = "password"

userAgent = "user_agent"

charset = "character encoding"

resolveURL = "yes" or "no"

throwOnError = "yes" or no"

redirect = "yes" or "no"

timeout = "timeout_period"

getasbinary = "yes or no"

multipart = "yes or no"

path = "path"

file = "filename"

name = "queryname"

columns = "query_columns"

firstrowasheaders = "yes" or "no"

Other manuals for COLDFUSION MX 61-CFML

This manual suits for next models

Table of contents

Other MACROMEDIA Software manuals

MACROMEDIA

MACROMEDIA FIREWORKS 8-USING FIREWORKS Mounting instructions

MACROMEDIA

MACROMEDIA COLFUSION MX 7-MIGRATING APPLICATIONS TO COLDFUSION MX... User manual

MACROMEDIA

MACROMEDIA COLDFUSION STUDIO 5-USING COLDFUSION 5... Mounting instructions

MACROMEDIA

MACROMEDIA BREEZE-USING THE BREEZE XML WEB SERVICES Mounting instructions

MACROMEDIA

MACROMEDIA FLEX-FLEX BUILDER Operation instructions

MACROMEDIA

MACROMEDIA COLFUSION MX 7-GETTING STARTED BUILDING COLDFUSION... User manual

MACROMEDIA

MACROMEDIA DIRECTOR MX 2004-GETTING STARTED WITH... User manual

MACROMEDIA

MACROMEDIA CONTRIBUTE 3 - DEPLOYING AND PUBLISHING... User manual

MACROMEDIA

MACROMEDIA FLEX - DEVELOPING COMPONENTS AND THEMES User manual

MACROMEDIA

MACROMEDIA DIRECTOR MX 2004-USING DIRECTOR Mounting instructions

MACROMEDIA

MACROMEDIA FLASH MEDIA SERVER 2-DEVELOPING MEDIA User manual

MACROMEDIA

MACROMEDIA FLASH REMOTING MX-USING FLASH REMOTING FOR FLASH MX 2004 ACTIONSCRIPT... Mounting instructions

MACROMEDIA

MACROMEDIA FLASH MX 2004-ACTIONSCRIPT LANGUAGE Service manual

MACROMEDIA

MACROMEDIA COLDFUSION 5-ADVANCED ADMINISTRATION User manual

MACROMEDIA

MACROMEDIA FLASH 8-INTRODUCTION TO FLASH LITE 2.X... Reference manual

MACROMEDIA

MACROMEDIA DIRECTOR MX 2004-USING DIRECTOR Mounting instructions

MACROMEDIA

MACROMEDIA FLASH 8-FLASH Service manual

MACROMEDIA

MACROMEDIA COLDFUSION 5 - INSTALING AND CONFIGURING... User manual

MACROMEDIA

MACROMEDIA CONTRIBUTE 3-CONTRIBUTE PUBLISHING SERVER User manual

MACROMEDIA

MACROMEDIA COLDFUSION MX 61-DEVELOPING COLDFUSION MX User manual

MACROMEDIA

MACROMEDIA FLASH MX PROFESSIONAL 2004 - FLASH LITE 1.1... Instruction Manual

MACROMEDIA

MACROMEDIA FLASH MEDIA SERVER 2-SERVER MANAGEMENT ACTIONSCRIPT... Service manual

MACROMEDIA

MACROMEDIA FLASH MX 2004 - FLASH LITE AUTHORING GUIDELINES FOR THE I-MODE... Instruction Manual

MACROMEDIA

MACROMEDIA FLASH MX 2004-FLASH JAVASCRIPT DICTIONARY User manual

Popular Software manuals by other brands

COMPRO

COMPRO COMPROFM manual

Muratec

Muratec OFFICEBRIDGE ONLINE user guide

Oracle

Oracle Contact Center Anywhere 8.1 installation guide

Adobe

Adobe 65007312 - Photoshop Lightroom Programmer's guide

Avaya

Avaya NULL One-X for RIM Blackberry user guide

HP ProLiant BL420c user guide

PS Audio

PS Audio PowerPlay Programming manual

Brady

Brady LOCKOUT PRO 3.0 Administrator's guide

Avaya

Avaya Interaction Center user guide

Texas Instruments

Texas Instruments TI-83 Plus Silver Edition Guide book

Novell

Novell GROUPWISE 8 - INTERNET AGENT manual

Oracle

Oracle Application 9i Configuration guide

Acer

Acer RDM user guide

Canon

Canon Vixia HF21 instruction manual

Canon

Canon ZR950 instruction manual

Samsung

Samsung Auto Backup user manual

Polycom

Polycom Vortex EF2201 Application note

Brocade Communications Systems

Brocade Communications Systems Brocade 8/12c user manual