MACROMEDIA COLFUSION MX 7-CFML User manual

COLDFUSION®MX 7

CFML Quick Reference

Trademarks

1 Step RoboPDF, ActiveEdit, ActiveTest, Authorware, Blue Sky Software,

Blue Sky, Breeze, Breezo, Captivate, Central, ColdFusion, Contribute,

Database Explorer, Director, Dreamweaver, Fireworks, Flash, FlashCast,

FlashHelp, Flash Lite, FlashPaper, Flex, Flex Builder, Fontographer,

FreeHand, Generator, HomeSite, JRun, MacRecorder, Macromedia,

MXML, RoboEngine, RoboHelp, RoboInfo, RoboPDF, Roundtrip,

Roundtrip HTML, Shockwave, SoundEdit, Studio MX, UltraDev, and

WebHelp are either registered trademarks or 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,

service marks, or trade names of Macromedia, Inc. or other entities and

may be registered in certain jurisdictions including internationally.This

product includes code licensed from RSA Data Security.

Third-Party Information

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.

Pending. This manual may not be copied, photocopied, reproduced,

translated, or converted to any electronic or machine-readable form

in whole or in part without written approval from Macromedia, Inc.

Notwithstanding the foregoing, the owner or authorized user of a

valid copy of the software with which this manual was provided may

print out one copy of this manual from an electronic version of this

manual for the sole purpose of such owner or authorized user

learning to use such software, provided that no part of this manual

may be printed out, reproduced, distributed, resold, or transmitted

for any other purposes, including, without limitation, commercial

purposes, such as selling copies of this documentation or providing

paid-for support services. Part Number ZCF70M300

Project Management: Randy Nielsen

Editing: Linda Adler

Production Management: Patrice O’Neill

Media Design and Production: John Francis, Adam Barnett

Special thanks to Sawako Gensure, Seungmin Lee, Takashi Koto,

Nozomi Kugita, Masayo Noda, Hiroshi Okugawa, Bowne Global

Solutions

First Edition: January 2005

Macromedia, Inc.

600 Townsend St.

San Francisco, CA 94103

CFML Quick Reference 3

CONTENTS

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

CFML functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Array functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Conversion functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Date and time functions . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Decision functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Display and formatting functions . . . . . . . . . . . . . . . . . . . 26

Dynamic evaluation functions . . . . . . . . . . . . . . . . . . . . . 26

Extensibility functions . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

International functions . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

List functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Mathematical functions . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Other functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Query functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Security functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

String functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Structure functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

System functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

XML functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Gateway interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Methods to implement . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

IM Gateway CFC incoming message methods . . . . . . . . . 32

IM Gateway message sending commands . . . . . . . . . . . . . 32

Application.cfc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Methods to implement . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

ColdFusion variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Variable scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Caller scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Client variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Server variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Application and session variables . . . . . . . . . . . . . . . . . . . 33

Custom tag variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Request variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Form variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

ColdFusion tag-specific variables . . . . . . . . . . . . . . . . . . . . . 34

ColdFusion query variables . . . . . . . . . . . . . . . . . . . . . . . . 34

CFCATCH variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

CFDIRECTORY variables . . . . . . . . . . . . . . . . . . . . . . . . 35

CFERROR variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

CFFILE ACTION=Upload variables . . . . . . . . . . . . . . . . 35

CFFTP error variables . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

CFFTP ReturnValue variable . . . . . . . . . . . . . . . . . . . . . . 36

CFFTP query object columns . . . . . . . . . . . . . . . . . . . . . 36

CFHTTP variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

CFLDAP variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

4 CFML Quick Reference

CFPOP variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

CFQUERY and CFSTOREDPROC variables . . . . . . . . . 37

CFREGISTRY variables . . . . . . . . . . . . . . . . . . . . . . . . . . 37

CFSEARCH variables . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Standard CGI variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

CGI environment variables . . . . . . . . . . . . . . . . . . . . . . . . . 38

CGI server variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

CGI client variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

CGI client certificate variables . . . . . . . . . . . . . . . . . . . . . 38

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"

scriptProtect = "none", "all", or list>

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

<cfassociate

baseTag = "base_tag_name"

dataCollection = "collection_name">

cfcache

<cfcache

action = "action"

directory = "directory_name"

timespan = "value"

expireURL = "wildcarded_URL_reference"

username = "username"

password = "password"

port = "port_number"

protocol = "protocol">

cfcalendar

<cfcalendar

name = "name of calendar"

height = "height"

width = "width"

selectedDate = "date"

mask = "returned date format"

startRange = "first disabled date"

endRange = "last disabled date"

disabled = "true", "false", or no attribute value

mask = "character pattern"

dayNames = "days-of-the-week labels"

monthNames = "month labels"

visible = "Yes" or "No"

enabled = "Yes" or "No"

tooltip = "Tip text"

onChange = "actionscript to invoke">

6 CFML Quick Reference

cfcase

<cfcase

value = "value or delimited set of values"

delimiters = "delimiter characters">

cfcatch

Exception processing code here

</cfcatch>

cfchart

Syntax 1

<!--- This syntax uses an XML file or string to specify the

chart style. --->

<cfchart

style = "XML string or filename">

</cfchart>

Syntax 2

<!--- This syntax uses the attributes of the cfchart tag to

specify the chart style. --->

<cfchart

backgroundColor = "Hex value or Web color"

chartHeight = "integer number of pixels"

chartWidth = "integer number of pixels"

dataBackgroundColor = "Hex value or Web color"

font = "font name"

fontBold = "yes" or "no"

fontItalic = "yes" or "no"

fontSize = "integer font size"

foregroundColor = "Hex value or Web color"

format = "flash" or "jpg" or "png"

gridlines = "integer number of lines"

labelFormat = "number, currency, percent, date"

markerSize = "integer number of pixels"

name = "String">

pieSliceStyle = "solid, sliced"

scaleFrom = "integer minimum value"

scaleTo = "integer maximum value"

seriesPlacement = "default, cluster, stacked, percent"

show3D = "yes" or "no"

showBorder = "yes" or "no"

showLegend = "yes" or "no"

showMarkers = "yes" or "no"

showXGridlines = "yes" or "no"

showYGridlines = "yes" or "no"

sortXAxis = "yes" or "no"

tipBGColor = "hex value or web color"

tipStyle = "MouseDown, MouseOver, none"

title = "title of chart"

url = "onClick destination page"

xAxisTitle = "title text"

xAxisType = "scale or category"

xOffset = "number between -1 and 1"

yAxisTitle = "title text"

yAxisType = "scale or category"

yOffset = "number between -1 and 1"

</cfchart>

cfchartdata

<cfchartdata

item = "text"

value = "number">

cfchartseries

<cfchartseries

colorlist = "list">

itemColumn="queryColumn"

markerStyle="style"

paintStyle="plain, raise, shade, light"

query="queryName"

seriesColor="Hex value or Web color"

seriesLabel="Label Text"

type="type"

valueColumn="queryColumn"

dataLabelStyle="style"

</cfchartseries>

cfcol

<cfcol

header = "column_header_text"

width = "number_indicating_width_of_column"

align = "left" or "right" or "center"

text = "column_text">

CFML Quick Reference 7

cfcollection

<cfcollection

action = "action"

collection = "collection_name"

path = "path_to_verity_collection"

language = "language"

name = "queryname"

categories = "yes" or "no">

cfcomponent

<cfcomponent

extends ="anotherComponent"

output = "yes" or "no"

style = "rpc" or "document"

namespace = "default service namespace"

serviceportname = "port element name"

porttypename = "porttype element name"

bindingname = "binding element name"

wsdlfile = "path to hard-coded wsdl file"

displayname = "text string">

hint = "text string">

Variable declarations

...

</cffunction>

...

</cffunction>

</cfcomponent>

cfcontent

<cfcontent

type = "file_type"

deleteFile = "yes" or "no"

file = "filename"

variable = "variablename"

reset = "yes" or "no">

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"

recurse = "yes" or "no">

cfdocument

<cfdocument

format = "PDF" or "FlashPaper"

filename = "filename"

overwrite = "yes" or "no"

name = "output variable name"

pagetype = "page type"

pageheight = "page height in inches"

pagewidth = "page width in inches"

orientation = "portrait/landscape"

margintop = "number"

marginbottom = "number"

marginleft = "number"

marginright = "number"

unit = "in" or "cm"

encryption = "128-bit" or "40-bit" or "none"

ownerpassword = "password"

userpassword = "password"

permissions = "permission list"

fontembed = "yes" or "no"

backgroundvisible = "yes" or "no"

scale = "percentage less than 100">

8 CFML Quick Reference

HTML and CFML code

</cfdocument>

cfdocumentitem

Syntax 1

Syntax 2

<cfdocumentitem

type = "header" or "footer">

Header/footer text

</cfdocumentitem>

</cfdocument>

cfdocumentsection

<cfdocumentsection

margintop = "number"

marginbottom = "number"

marginleft = "number"

marginright = "number">

HTML, CFML, and cfdocumentitem tags

</cfdocumentsection>

</cfdocument>

cfdump

<cfdump

var = "#variable#"

expand = "yes" or "no"

label = "text"

top = "number of rows or levels">

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 = "application name"

arguments = "command line arguments"

outputFile = "output filename"

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" >

CFML Quick Reference 9

<cffile

action = "copy"

source = "full_path_name"

destination = "full_path_name"

mode = "mode"

attributes = "file_attributes_list">

<cffile

action = "delete"

file = "full_path_name">

<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">

result = "result_name"

<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"

method = "POST" or "GET"

format = "HTML" or "Flash" or "XML"

skin = "Flash or XSL skin"

style = "style specification"

preserveData = "yes" or "no"

onSubmit = "javascript"

scriptSrc = "path"

codeBase = "URL"

archive = "URL"

The following attributes are supported in Flash and XML only

width = "pixels or percent"

height = "pixels or percent"

The following attributes are supported in Flash only

onError = "ActionScript code"

wMode = "window" or "transparent" or "opaque"

accessible = "yes" or "no"

preloader = "yes" or "no"

timeout = "seconds"

10 CFML Quick Reference

The following attributes are supported in HTML and XML only

class = "form class"

enctype = "Internet media type"

id = "HTML id"

onload = "load event script"

onreset = "reset event script"

target = "target window or frame">

...

</cfform>

cfformgroup

<cfformgroup

type = "group type"

label = "label"

style = "style specification"

selectedIndex = "page number">

width = "pixels"

height = "pixels"

enabled = "Yes" or "No"

visible = "Yes" or "No"

OnChange = "ActionScript expression"

toolTip = "Tip text"

...ColdFusion forms controls

</cfformgroup>

<cfformgroup

type = "repeater"

query = "query object"

startrow = "row number"

maxrows = "integer">

...ColdFusion forms controls

</cfformgroup>

cfformitem

<cfformitem

type = "hrule, vrule, or spacer"

style = "style specification"

width = "pixels"

height = "pixels"

visible = "Yes" or "No"/>

<cfformitem

type= "html or text"

style = "style specification"

width = "pixels"

height = "pixels"

visible = "Yes" or "No"

enabled = "Yes" or "No"

tooltip = "Tip text"

bind = "bind expression">

...text

</cfformitem>

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"

directory = "directory name"

localFile = "filename"

remoteFile = "filename"

item = "directory or file"

existing = "file or directory name"

Other manuals for COLFUSION MX 7-CFML

This manual suits for next models

Table of contents

Other MACROMEDIA Software manuals

MACROMEDIA

MACROMEDIA FLASH 8-GETTING STARTED WITH FLASH LITE User manual

MACROMEDIA

MACROMEDIA FREEHAND MX 11 Mounting instructions

MACROMEDIA

MACROMEDIA FLASH 8-COMPONENTS LANGUAGE Service manual

MACROMEDIA

MACROMEDIA COLDFUSION 5-ADVANCED ADMINISTRATION User manual

MACROMEDIA

MACROMEDIA FLASH 8-DEVELOPING FLASH LITE 2.X User manual

MACROMEDIA

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

MACROMEDIA

MACROMEDIA DIRECTOR MX 2004-USING DIRECTOR Mounting instructions

MACROMEDIA

MACROMEDIA FLASH MEDIA SERVER 2-INSTALLING FLASH MEDIA SERVER... User manual

MACROMEDIA

MACROMEDIA FLEX-FLEX BUILDER Operation instructions

MACROMEDIA

MACROMEDIA COLDFUSION MX-CLUSTERCATS Mounting instructions

MACROMEDIA

MACROMEDIA FLASH MEDIA SERVER 2-CLIENT-SIDE ACTIONSCRIPT LANGUAGE REFERENCE FOR FLASH MEDIA SERVER... Service manual

MACROMEDIA

MACROMEDIA FLASH 8-LEARNING FLASH LITE 1.X ACTIONSCRIPT User manual

MACROMEDIA

MACROMEDIA FLASH 8-LEARNING ACTIONSCRIPT 2.0 IN FLASH User manual

MACROMEDIA

MACROMEDIA BREEZE-USING THE BREEZE PLUG-IN FOR MICROSOFT... Mounting instructions

MACROMEDIA

MACROMEDIA CONTRIBUTE-USING CONTRIBUTE Mounting instructions

MACROMEDIA

MACROMEDIA BREEZE 5 Operator's manual

MACROMEDIA

MACROMEDIA COLDFUSION 4.5-ADMINISTRING COLDFUSION... User manual

MACROMEDIA

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

MACROMEDIA

MACROMEDIA BREEZE 5 Quick setup guide

MACROMEDIA

MACROMEDIA BREEZE 5 User manual

MACROMEDIA

MACROMEDIA COLDFUSION MX 61 - CONFIGURING AND ADMINISTERING COLDFUSION... User manual

MACROMEDIA

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

MACROMEDIA

MACROMEDIA BREEZE-MANAGING EXTERNAL BREEZE REPORTS User manual

MACROMEDIA

MACROMEDIA CONTRIBUTE 3-DEPLOYING CONTRIBUTE 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