New York University

Computer Science Department

Courant Institute of Mathematical Sciences

ColdFusion CFML Tags, Functions, and Variables

Course Title: Application Servers Course Number: g22.3033-011

Instructor: Jean-Claude Franchitti Session: 2

CFML Tags

CFABORT

CFAPPLET

<CFAPPLET APPLETSOURCE="applet_name"

NAME="form_variable_name"

HEIGHT="pixels"

WIDTH="pixels"

VSPACE="pixels"

HSPACE="pixels"

ALIGN="alignment"

NOTSUPPORTED="text"

param_1="value"

param_2="value"

param_n="value">

CFAPPLICATION

<CFAPPLICATION NAME="Name"

CLIENTMANAGEMENT="Yes/No"

CLIENTSTORAGE="Storage Type"

SETCLIENTCOOKIES="Yes/No"

SESSIONMANAGEMENT="Yes/No"

SESSIONTIMEOUT=#CreateTimeSpan(days,hours,

minutes, seconds)#

APPLICATIONTIMEOUT=#CreateTimeSpan(days,

hours, minutes, seconds)#>

CFASSOCIATE

<CFASSOCIATE BASETAG="tagname"

DATACOLLECTION="collectionname">

CFAUTHENTICATE

<CFAUTHENTICATE SECURITYCONTEXT="context"

USERNAME="user ID"

PASSWORD="password"

SETCOOKIE="yes/no"

THROWONFAILURE="yes/no">

CFBREAK

CFCACHE

<CFCACHE

ACTION="action"

PROTOCOL="protocol name"

TIMEOUT="timeout date-time"

DIRECTORY="directory name"

EXPIREURL="wildcarded URL reference"

PORT="port-number">

CFCOL

<CFCOL HEADER="text"

WIDTH="number"

ALIGN="position"

TEXT="text">

CFCOLLECTION

<CFCOLLECTION ACTION="action"

COLLECTION="collection"

PATH="implementation directory"

LANGUAGE="language">

CFCONTENT

<CFCONTENT TYPE="file_type"

DELETEFILE="Yes/No"

FILE="filename"

RESET="Yes/No">

CFCOOKIE

<CFCOOKIE NAME="cookie_name"

VALUE="text"

EXPIRES="period"

SECURE="Yes/No"

PATH="urls"

DOMAIN=".domain">

CFDIRECTORY

<CFDIRECTORY ACTION="directory action"

DIRECTORY="directory name"

NAME="query name"

FILTER="list filter"

MODE="permission"

SORT="sort specification"

NEWDIRECTORY="new directory name">

CFERROR

<CFERROR TYPE="err_type"

TEMPLATE="path"

MAILTO="email_address">

CFEXIT

CFFILE

<CFFILE ACTION="Upload"

FILEFIELD="formfield"

DESTINATION="full_path_name"

NAMECONFLICT="behavior"

ACCEPT="file_extension"

MODE="permission"

ATTRIBUTES="file_attributes">

<CFFILE ACTION="Move"

SOURCE="full_path_name"

DESTINATION="full_path_name"

ATTRIBUTES="file_attributes">

<CFFILE ACTION="Rename"

SOURCE="full_path_name"

DESTINATION="full_path_name"

ATTRIBUTES="file_attributes">

<CFFILE ACTION="Copy"

SOURCE="full_path_name"

DESTINATION="full_path_name"

ATTRIBUTES="file_attributes">

<CFFILE ACTION="Delete"

FILE="full_path_name">

<CFFILE ACTION="Read"

FILE="full_path_name"

VARIABLE="var_name">

<CFFILE ACTION="Write"

FILE="full_path_name"

OUTPUT="content"

MODE="permission"

ADDNEWLINE="Yes/No"

ATTRIBUTES="file_attributes">

<CFFILE ACTION="Append"

FILE="full_path_name"

OUTPUT="string"

ATTRIBUTES="file_attributes">

CFFORM

<CFFORM NAME="name"

ACTION="form_action"

ENABLECAB="Yes/No"

ONSUBMIT="javascript"

TARGET="window_name"

ENCTYPE="type"

PASSTHROUGH="HTML_attributes">

...

</CFFORM>

CFFTP

<CFFTP ACTION="action"

USERNAME="name"

PASSWORD="password"

SERVER="server"

TIMEOUT="timeout in seconds"

PORT="port"

CONNECTION="name"

AGENTNAME="name"

PROXYSERVER="proxyserver"

PROXYBYPASS="proxybypass"

RETRYCOUNT="number"

STOPONERROR="Yes/No">

<CFFTP

ACTION="action"

USERNAME="name"

PASSWORD="password"

NAME="query_name"

SERVER="server"

ASCIIEXTENSIONLIST="extensions"

TRANSFERMODE="mode"

FAILIFEXISTS="Yes/No"

DIRECTORY="directory name"

LOCALFILE="filename"

REMOTEFILE="filename"

ATTRIBUTES="file attributes"

ITEM="directory or file"

EXISTING="file or directory name"

NEW="file or directory name"

PROXYSERVER="proxyserver"

PROXYBYPASS="proxybypass">

CFGRID

<CFGRID NAME="name"

HEIGHT="integer"

WIDTH="integer"

VSPACE="integer"

HSPACE="integer"

ALIGN="value"

QUERY="query_name"

INSERT="Yes/No"

DELETE="Yes/No"

SORT="Yes/No"

FONT="column_font"

FONTSIZE="size"

ITALIC="Yes/No"

BOLD="Yes/No"

HREF="URL"

HREFKEY="column_name"

TARGET="URL_target"

APPENDKEY="Yes/No"

HIGHLIGHTHREF="Yes/No"

ONVALIDATE="javascript_function"

ONERROR="text"

GRIDDATAALIGN="position"

GRIDLINES="Yes/No"

ROWHEIGHT="pixels"

ROWHEADERS="Yes/No"

ROWHEADERALIGN="position"

ROWHEADERFONT="font_name"

ROWHEADERFONTSIZE="size"

ROWHEADERITALIC="Yes/No"

ROWHEADERBOLD="Yes/No"

ROWHEADERWIDTH="col_width"

COLHEADERS="Yes/No"

COLHEADERALIGN="position"

COLHEADERFONT="font_name"

COLHEADERFONTSIZE="size"

COLHEADERITALIC="Yes/No"

COLHEADERBOLD="Yes/No"

BGCOLOR="color"

SELECTCOLOR="color"

SELECTMODE="mode"

MAXROWS="number"

NOTSUPPORTED="text"

PICTUREBAR="Yes/No"

INSERTBUTTON="text"

DELETEBUTTON="text"

SORTASCENDINGBUTTON="text"

SORTDESCENDINGBUTTON="text">

</CFGRID>

CFGRIDCOLUMN

<CFGRIDCOLUMN NAME="column_name"

HEADER="header"

WIDTH="column_width"

FONT="column_font"

FONTSIZE="size"

ITALIC="Yes/No"

BOLD="Yes/No"

HREF="URL"

HREFKEY="column_name"

TARGET="URL_target"

SELECT="Yes/No"

DISPLAY="Yes/No"

TYPE="type"

HEADERFONT"font_name"

HEADERFONTSIZE="size"

HEADERITALIC="Yes/No"

HEADERBOLD="Yes/No"

DATAALIGN="position"

HEADERALIGN="position"

NUMBERFORMAT="format">

CFGRIDROW

CFGRIDUPDATE

<CFGRIDUPDATE GRID="gridname"

DATASOURCE="data source name"

DBTYPE="type"

DBSERVER="dbms"

DBNAME="database name"

TABLENAME="table name"

USERNAME="data source username"

PASSWORD="data source password"

TABLEOWNER="table owner"

TABLEQUALIFIER="qualifier"

PROVIDER="COMProvider"

PROVIDERDSN="datasource"

KEYONLY="Yes/No">

CFHEADER

<CFHEADER NAME="header_name"

VALUE="header_value">

CFHTMLHEAD

CFHTTP

<CFHTTP URL="hostname"

PORT="port_number"

METHOD="get_or_post"

USERNAME="username"

PASSWORD="password"

NAME="queryname"

COLUMNS="query_columns"

PATH="path"

FILE="filename"

DELIMITER="character"

TEXTQUALIFIER="character"

RESOLVEURL="Yes/No"

PROXYSERVER="hostname"

TIMEOUT="timeout_period">

</CFHTTP>

CFHTTPPARAM

<CFHTTPPARAM NAME="name"

TYPE="type"

VALUE="transaction type"

FILE="filename">

CFIF/CFELSEIF/CFELSE

HTML and CFML tags

HTML and CFML tags

HTML and CFML tags

</CFIF>

CFINCLUDE

CFINDEX

<CFINDEX COLLECTION="collection_name"

ACTION="action"

TYPE="type"

TITLE="title"

KEY="ID"

BODY="body"

CUSTOM1="custom_value"

CUSTOM2="custom_value"

URLPATH="URL"

EXTENSIONS="file_extensions"

QUERY="query_name"

RECURSE="Yes/No"

EXTERNAL="Yes/No"

LANGUAGE="language">

CFINPUT

<CFINPUT TYPE="input_type"

NAME="name"

VALUE="initial_value"

REQUIRED="Yes/No"

RANGE="min_value, max_value"

VALIDATE="data_type"

ONVALIDATE="javascript_function"

MESSAGE="validation_msg"

ONERROR="text"

SIZE="integer"

MAXLENGTH="integer"

CHECKED="Yes/No "

PASSTHROUGH="HTML_attributes " >

CFINSERT

<CFINSERT DATASOURCE="ds_name"

DBTYPE="type"

DBSERVER="dbms"

DBNAME="database name"

TABLENAME="tbl_name"

TABLEOWNER="owner"

TABLEQUALIFIER="tbl_qualifier"

USERNAME="username"

PASSWORD="password"

PROVIDER="COMProvider"

PROVIDERDSN="datasource"

FORMFIELDS="formfield1, formfield2, ...">

CFLDAP

<CFLDAP SERVER="server_name"

PORT="port_number"

USERNAME="name"

PASSWORD="password"

ACTION="action"

NAME="name"

TIMEOUT="seconds"

MAXROWS="number"

START="distinguished_name"

SCOPE="scope"

ATTRIBUTES="attribute, attribute"

FILTER="filter"

SORT="sort_order"

DN="distinguished_name"

STARTROW="row_number">

CFLOCATION

CFLOCK

<CFLOCK NAME="lockname"

TIMEOUT="timeout in seconds "

THROWONTIMEOUT="Yes/No"

TYPE="ReadOnly/Exclusive">

</CFLOCK>

CFLOOP

<CFLOOP INDEX="parameter_name"

FROM="beginning_value"

TO="ending_value"

STEP="increment">

...

HTML or CFML code to execute

...

</CFLOOP>

<CFLOOP QUERY="query_name"

STARTROW="row_num"

ENDROW="row_num">

<CFLOOP INDEX="index_name"

LIST="list_items"

DELIMITERS="item_delimiter">

</CFLOOP>

CFMAIL

<CFMAIL TO="recipient"

FROM="sender"

CC="copy_to"

SUBJECT="msg_subject"

TYPE="msg_type"

QUERY="query_name"

MAXROWS="max_msgs"

MIMEATTACH="path"

GROUP="query_column"

STARTROW="query_row"

SERVER="servername"

PORT="port_ID"

MAILERID="headerid"

TIMEOUT="seconds">

CFMODULE

<CFMODULE TEMPLATE="template"

NAME="tag_name"

ATTRIBUTECOLLECTION="collection_structure"

ATTRIBUTE_NAME1="value"

ATTRIBUTE_NAME2="value"

...>

CFOBJECT

<CFOBJECT TYPE="COM"

ACTION="action"

CLASS="program_ID"

NAME="text"

CONTEXT="context"

SERVER="server_name">

<CFOBJECT TYPE="CORBA"

CONTEXT="context"

CLASS="file or naming service"

NAME="text">

CFOUTPUT

<CFOUTPUT QUERY="query_name"

MAXROWS="max_rows_output"

GROUP="parameter"

STARTROW="start_row">

</CFOUTPUT>

CFPARAM

<CFPARAM NAME="param_name"

TYPE="data_type">

DEFAULT="value">

CFPOP

<CFPOP SERVER="servername"

PORT="port_number"

USERNAME="username"

PASSWORD="password"

ACTION="action"

NAME="queryname"

MESSAGENUMBER="number"

ATTACHMENTPATH="path"

TIMEOUT="seconds"

MAXROWS="number"

STARTROW="number">

CFPROCPARAM

<CFPROCPARAM TYPE="IN/OUT/INOUT"

VARIABLE="variable name"

DBVARNAME="DB variable name"

VALUE="parameter value"

CFSQLTYPE="parameter datatype"

MAXLENGTH="length"

SCALE="decimal places"

NULL="yes/no">

CFPROCRESULT

<CFPROCRESULT NAME="query_name"

RESULTSET="1-n"

MAXROWS="maxrows">

CFQUERY

<CFQUERY NAME="query_name"

DATASOURCE="ds_name"

DBTYPE="type"

DBSERVER="dbms"

DBNAME="database name"

USERNAME="username"

PASSWORD="password"

MAXROWS="number"

BLOCKFACTOR="blocksize"

TIMEOUT="milliseconds"

CACHEDAFTER="date"

CACHEDWITHIN="timespan"

PROVIDER="COMProvider"

PROVIDERDSN="datasource"

DEBUG="Yes/No">

SQL statements

</CFQUERY>

CFREGISTRY

<CFREGISTRY ACTION="GetAll"

BRANCH="branch"

TYPE="data type"

NAME="query name"

SORT="criteria">

<CFREGISTRY ACTION="Get"

BRANCH="branch"

ENTRY="key or value"

TYPE="data type"

VARIABLE="variable">

<CFREGISTRY ACTION="Set"

BRANCH="branch"

ENTRY="key or value"

TYPE="value type"

VALUE="data">

<CFREGISTRY ACTION="Delete"

BRANCH="branch"

ENTRY="keyorvalue">

CFREPORT

<CFREPORT REPORT="report_path"

ORDERBY="result_order"

USERNAME="username"

PASSWORD="password"

FORMULA="formula">

</CFREPORT>

CFSCHEDULE

<CFSCHEDULE ACTION="Update"

TASK="taskname"

OPERATION="HTTPRequest"

FILE="filename"

PATH="path_to_file"

STARTDATE="date"

STARTTIME="time"

URL="URL"

PUBLISH="Yes/No"

ENDDATE="date"

ENDTIME="time"

INTERVAL="seconds"

REQUESTTIMEOUT="seconds"

USERNAME="username"

PASSWORD="password"

RESOLVEURL="Yes/No"

PROXYSERVER="hostname">

CFSCRIPT

CFScript code goes here

</CFSCRIPT>

CFSEARCH

<CFSEARCH NAME="search_name"

COLLECTION="collection_name"

TYPE="criteria"

CRITERIA="search_expression"

MAXROWS="number"

STARTROW="row_number"

EXTERNAL="Yes/No"

LANGUAGE="language">

CFSELECT

<CFSELECT NAME="name"

REQUIRED="Yes/No"

MESSAGE="text"

ONERROR="text"

SIZE="integer"

MULTIPLE="Yes/No"

QUERY="queryname"

SELECTED="column_value"

VALUE="text"

DISPLAY="text"

PASSTHROUGH="HTML_attributes">

</CFSELECT>

CFSET

CFSETTING

<CFSETTING ENABLECFOUTPUTONLY="Yes/No"

SHOWDEBUGOUTPUT="Yes/No">

CFSLIDER

<CFSLIDER NAME="name"

LABEL="text"

REFRESHLABEL="Yes/No"

IMG="filename"

IMGSTYLE="style"

RANGE="min_value, max_value"

SCALE="uinteger"

VALUE="integer"

ONVALIDATE="script_name"

MESSAGE="text"

ONERROR="text"

HEIGHT="integer"

WIDTH="integer"

VSPACE="integer"

HSPACE="integer"

ALIGN="alignment"

GROOVECOLOR="color"

BGCOLOR="color"

TEXTCOLOR="color"

FONT="font_name"

FONTSIZE="integer"

ITALIC="Yes/No"

BOLD="Yes/No"

NOTSUPPORTED="text">

CFSTOREDPROC

<CFSTOREDPROC PROCEDURE="procedure name"

DATASOURCE="ds_name"

USERNAME="username"

PASSWORD="password"

DBSERVER="dbms"

DBNAME="database name"

BLOCKFACTOR="blocksize"

PROVIDER="COMProvider"

PROVIDERDSN="datasource"

DEBUG="Yes/No"

RETURNCODE="Yes/No">

CFSWITCH/CFCASE/CFDEFAULTCASE

HTML and CFML tags

</CFCASE>

additional <CFCASE></CFCASE> tags

HTML and CFML tags

</CFDEFAULTCASE>

</CFSWITCH>

CFTABLE

<CFTABLE QUERY="query_name"

MAXROWS="maxrows_table"

COLSPACING="number_of_spaces"

HEADERLINES="number_of_lines"

HTMLTABLE

BORDER

COLHEADERS

STARTROW="row_number">

</CFTABLE>

CFTEXTINPUT

<CFTEXTINPUT NAME="name"

VALUE="text"

REQUIRED="Yes/No"

RANGE="min_value, max_value"

VALIDATE="data_type"

ONVALIDATE="script_name"

MESSAGE="text"

ONERROR="text"

SIZE="integer"

FONT="font_name"

FONTSIZE="integer"

ITALIC="Yes/No"

BOLD="Yes/No"

HEIGHT="integer"

WIDTH="integer"

VSPACE="integer"

HSPACE="integer"

ALIGN="alignment"

BGCOLOR="color"

TEXTCOLOR="color"

MAXLENGTH="integer"

NOTSUPPORTED="text">

CFTHROW

<CFTHROW

TYPE="exception_type"

MESSAGE="message"

DETAIL="detail_description"

ERRORCODE="error_code"

EXTENDEDINFO="additional_information">

CFTRANSACTION

...

</CFTRANSACTION>

CFTREE

<CFTREE NAME="name"

REQUIRED="Yes/No"

DELIMITER="delimiter"

COMPLETEPATH="Yes/No"

APPENDKEY="Yes/No"

HIGHLIGHTHREF="Yes/No"

ONVALIDATE="script_name"

MESSAGE="text"

ONERROR="text"

FONT="font"

FONTSIZE="size"

ITALIC="Yes/No"

BOLD="Yes/No"

HEIGHT="integer"

WIDTH="integer"

VSPACE="integer"

HSPACE="integer"

ALIGN="alignment"

BORDER="Yes/No"

HSCROLL="Yes/No"

VSCROLL="Yes/No"

NOTSUPPORTED="text">

</CFTREE>

CFTREEITEM

<CFTREEITEM VALUE="text"

DISPLAY="text"

PARENT="parent_name"

IMG="filename"

IMGOPEN="filename"

HREF="URL"

TARGET="URL_target"

QUERY="queryname"

QUERYASROOT="Yes/No"

EXPAND="Yes/No">

CFTRY/CFCATCH

<CFTRY>

... Add code here

... Add exception processing code here

</CFCATCH>

... Additional CFCATCH blocks go here

</CFTRY>

CFUPDATE

<CFUPDATE DATASOURCE="ds_name"

DBTYPE="type"

DBSERVER="dbms"

DBNAME="database name"

TABLENAME="table_name"

TABLEOWNER="name"

TABLEQUALIFIER="qualifier"

USERNAME="username"

PASSWORD="password"

PROVIDER="COMProvider"

PROVIDERDSN="datasource"

FORMFIELDS="field_names">

CFWDDX

<CFWDDX ACTION="action"

INPUT="inputdata"

OUTPUT="resultvariablename"

TOPLEVELVARIABLE=

"toplevelvariablenameforjavascript"

USETIMEZONEINFO="Yes/No">

CFML Functions

Array functions

ArrayAppend(array, value)

ArrayAvg(array)

ArrayClear(array)

ArrayDeleteAt(array, position)

ArrayInsertAt(array, position, value)

ArrayIsEmpty(array)

ArrayLen(array)

ArrayMax(array)

ArrayMin(array)

ArrayNew(dimension)

ArrayPrepend(array, value)

ArrayResize(array, minimum_size)

ArraySet(array, start_pos, end_pos, value)

ArraySort(array, sort_type [, sort_order ])

ArraySum(array)

ArraySwap(array, position1, position2)

ArrayToList(array [, delimiter ])

IsArray(value [, number ])

ListToArray(list [, delimiter ])

Date and time functions

CreateDate(year, month, day)

CreateDateTime(year, month, day, hour, minute, second)

CreateODBCDate(date)

CreateODBCDateTime(date)

CreateODBCTime(date)

CreateTime(hour, minute, second)

CreateTimeSpan(days, hours, minutes, seconds)

DateAdd(datepart, number, date)

DateCompare(date1, date2 [, datePart])

DateConvert(conversion-type, date)

DateDiff(datepart, date1, date2)

DateFormat(date [, mask ])

DatePart(datepart, date)

Day(date)

DayOfWeek(date)

DayOfWeekAsString(day_of_week)

DayOfYear(date)

DaysInMonth(date)

Hour(date)

IsDate(string)

IsLeapYear(year)

IsNumericDate(number)

LSParseDateTime(date-time-string)

Minute(date)

Month(date)

MonthAsString(month_number)

Now()

ParseDateTime(date-time-string [, pop-conversion ] )

Quarter(date)

Second(date)

Week(date)

Year(date)

Decision functions

IsArray(value [, number ])

IsAuthenticated([security-context-name ])

IsAuthorized(resourcetype, resourcename [, action ])

IsBoolean(value)

IsDate(string)

IsDebugMode()

IsDefined("variable_name")

IsLeapYear(year)

IsNumeric(string)

IsNumericDate(number)

IsQuery(value)

IsSimpleValue(value)

IsStruct(variable )

LSIsCurrency(string)

LSIsDate(string)

LSIsNumeric(string)

Display and formatting functions

DateFormat(date [, mask ])

DecimalFormat(number)

DollarFormat(number)

FormatBaseN(number, radix)

HTMLCodeFormat(string [, version ])

HTMLEditFormat(string [, version ])

LSCurrencyFormat(number [, type ])

LSDateFormat(date [, mask ])

LSEuroCurrencyFormat(currency-number [, type ])

LSNumberFormat(number [, mask ])

LSTimeFormat(time [, mask ])

NumberFormat(number [, mask ])

ParagraphFormat(string)

PreserveSingleQuotes(variable)

TimeFormat(time [, mask ])

URLEncodedFormat(string)

YesNoFormat(value)

Dynamic evaluation functions

DE(string)

Evaluate(string_expression1 [, string_expression2

[, ... ] ] )

IIf(condition, string_expression1,

string_expression2)

SetVariable(name, value)

List functions

ArrayToList(array [, delimiter ])

ListAppend(list, value [, delimiters ])

ListChangeDelims(list, new_delimiter [, delimiters ])

ListContains(list, substring [, delimiters ])

ListContainsNoCase(list, substring [, delimiters ])

ListDeleteAt(list, position [, delimiters ])

ListFind(list, value [, delimiters ])

ListFindNoCase(list, value [, delimiters ])

ListFirst(list [, delimiters ])

ListGetAt(list, position [, delimiters ])

ListInsertAt(list, position, value [, delimiters ])

ListLast(list [, delimiters ])

ListLen(list [, delimiters ])

ListPrepend(list, value [, delimiters ])

ListQualify(list, qualifier [, delimiters ]

[, elements ])

ListRest(list [, delimiters ])

ListSetAt(list, position, value [, delimiters ])

ListSort(list, sort_type [, sort_order]

[, delimiter ])

ListToArray(list [, delimiter ])

ListValueCount(list, value [, delimiters ])

ListValueCountNoCase(list, value [, delimiters ])

International functions

DateConvert(conversion-type, date)

GetLocale()

GetTimeZoneInfo()

LSCurrencyFormat(number [, type ])

LSDateFormat(date [, mask ])

LSEuroCurrencyFormat(currency-number [, type ])

LSIsCurrency(string)

LSNumberFormat(number [, mask ])

LSParseCurrency(string)

LSParseDateTime(string)

LSParseEuroCurrency(currency-string)

LSParseNumber(string)

LSTimeFormat(time [, mask ])

SetLocale(new_locale)

Mathematical functions

Abs(number)

ACos(number)

ASin(number)

Atn(number)

BitAnd(number1, number2)

BitMaskClear(number, start, length)

BitMaskRead(number, start, length)

BitMaskSet(number, mask, start, length)

BitNot(number)

BitOr(number1, number2)

BitSHLN(number, count)

BitSHRN(number, count)

BitXor(number1, number2)

Ceiling(number)

Cos(number)

DecrementValue(number)

Exp(number)

Fix(number)

IncrementValue(number)

InputBaseN(string, radix)

Int(number)

Log(number)

Log10(number)

Max(number1, number2)

Min(number1, number2)

Pi()

Rand()

Randomize(number)

RandRange(number1, number2)

Round(number)

Sgn(number)

Sin(number)

Sqr(number)

Tan(number)

Query functions

IsQuery(value)

QueryAddColumn(query, column-name, array-name)

QueryAddRow(query [, number ])

QueryNew(columnlist)

QuerySetCell(query, column_name, value

[, row_number ])

QuotedValueList(query.column [, delimiter ])

ValueList(query.column [, delimiter ])

String functions

Asc(string)

Chr(number)

Cjustify(string, length)

Compare(string1, string2)

CompareNoCase(string1, string2)

DayOfWeekAsString(day_of_week)

FormatBaseN(number, radix)

Find(substring, string [, start ])

FindNoCase(substring, string [, start ])

FindOneOf(set, string [, start ])

GetToken(string, index [, delimiters ])

Insert(substring, string, position)

LCase(string)

Left(string, count)

Len(string)

ListValueCount(list, value [, delimiters ])

ListValueCountNoCase(list, value [, delimiters ])

LJustify(string, length)

LSParseCurrency(string)

LSParseDateTime(date-time-string)

LSParseEuroCurrency(currency-string)

LSParseNumber(string)

LTrim(string)

Mid(string, start, count)

MonthAsString(month_number)

ParseDateTime(string1 [, string2 ] )

REFind(reg_expression, string [, start ]

[, returnsubexpressions ] )

REFindNoCase(reg_expression, string [, start ]

[, returnsubexpressions ] )

RemoveChars(string, start, count)

RepeatString(string, count)

Replace(string, substring1, substring2 [, scope ])

ReplaceList(string, list1, list2)

ReplaceNoCase(string, substring1, substring2

[, scope ])

REReplace(string, reg_expression, substring

[, scope ])

REReplaceNoCase(string, reg_expression,

substring [, scope ])

Reverse(string)

Right(string, count)

RJustify(string, length)

RTrim(string)

SpanExcluding(string, set)

SpanIncluding(string, set)

StripCR(string)

Trim(string)

UCase(string)

Val(string)

Structure functions

IsStruct(variable )

StructClear(structure)

StructCopy(structure)

StructCount(structure)

StructDelete(structure, key [, indicatenotexisting ])

StructFind(structure, key)

StructInsert(structure, key, value

[, allowoverwrite ])

StructIsEmpty(structure)

StructKeyArray(structure)

StructKeyExists(structure, key)

StructKeyList(structure [, delimiter])

StructNew()

StructUpdate(structure, key, value)

System functions

DirectoryExists(absolute_path)

ExpandPath(relative_path)

FileExists(absolute_path)

GetBaseTemplatePath()

GetCurrentTemplatePath()

GetDirectoryFromPath(path)

GetFileFromPath(path)

GetProfileString(IniPath, Section, Entry)

GetTempDirectory()

GetTempFile(dir, prefix)

¹GetTemplatePath()

SetProfileString(IniPath, Section, Entry, Value)

Other functions

AuthenticatedUser()

AuthenticatedContext()

CreateUUID()

Decrypt(encrypted_string, key)

DeleteClientVariable("name")

Encrypt(string, key)

GetBaseTagData(tagname [, instancenumber ] )

GetBaseTagList()

GetClientVariablesList()

GetTickCount()

ParameterExists(parameter)

PreserveSingleQuotes(variable)

URLEncodedFormat(string)

WriteOutput(string)

ColdFusion Variables

ColdFusion returns a wide variety of variables, such as those returned in a CFDIRECTORY or CFFTP operation. Variables are usually referenced by "scoping" the variable according to its type, as in Session.varname, or Application.varname.

Variable scope

ColdFusion supports the Variables scope. Unscoped variables created with the CFSET tag acquire the Variables scope by default. For example, the variable created by:

can be referenced as:

#Variables.linguist#

Client variables

These client variables are read-only.

Client.CFID

Client.CFToken

Client.HitCount

Client.LastVisit

Client.TimeCreated

Client.URLToken

Server variables

Use the Server. prefix to reference server variables:

Server.ColdFusion.ProductName

Server.ColdFusion.ProductVersion

Server.ColdFusion.ProductLevel

Server.ColdFusion.SerialNumber

Server.ColdFusion.SupportedLocales

Server.OS.Name

Server.OS.AdditionalInformation

Server.OS.Version

Server.OS.BuildNumber

Application and session variables

Use CFAPPLICATION to enable application and session variables. Both application and session variables are stored in memory. They are referenced as:

Application.myvariable

Session.myvariable

Use CFLOCK to ensure that modifcations to shared data occur one after another. When you lock an application variable, specify the application name with the predefined variable:

Application.applicationName

When you lock a session variable, reference the session with the predefined variable:

Session.sessionID

There are also a few other predefined session variables:

Session.CFID

Session.CFToken

Session.URLToken

Custom tag variables

Any ColdFusion custom tag returns the following variables:

ThisTag.ExecutionMode

ThisTag.HasEndTag

ThisTag.GeneratedContent

ThisTag.AssocAttribs[index]

A custom tag can also set a Caller variable to provide information to the caller. The Caller variable is set as follows:

The calling page can access the variable with the <CFOUTPUT> tag:

<CFOUTPUT>#Caller.variable_name#</CFOUTPUT>

Request variable

Request variables store data that pertains to the processing of a single page request. Request variables allow you to store data in a structure that can be passed to nested tags, such as Custom Tags, and processed once.

Set a Request variable to provide information to nested tags. The Request variable is set as follows:

...

Each nested tag can access the variable with the <CFOUTPUT> tag:

<CFOUTPUT>#Request.field_name1#</CFOUTPUT>

Form variable

ColdFusion supports the Form variable FieldNames. FieldNames returns the names of the fields on a form. You can use it on the action page associated with a form.

Form.FieldNames

ColdFusion Tag-Specific Variables

A number of ColdFusion tags return data as variables. For example, the CFFILE tag returns file size information in the FileSize variable, referenced as CFFILE.FileSize.

The following tags return data that can be referenced in variables:

CFCATCH

CFDIRECTORY

CFERROR

CFFILE

CFFTP

CFHTTP

CFINDEX

CFLDAP

CFMAIL

CFPOP

CFQUERY

CFREGISTRY

CFSEARCH

ColdFusion query variables

Any ColdFusion tag that returns a query object supports the following variables:

queryname.CurrentRow

queryname.RecordCount

queryname.ColumnList

Where queryname is the value of the NAME attribute in each tag.

CFCATCH variables

Within a CFCATCH block, the properties of the active exception can be accessed as variables:

CFCATCH.Type

CFCATCH.Message

CFCATCH.Detail

CFCATCH.ErrNumber

CFCATCH.NativeErrorCode

CFCATCH.SQLState

CFCATCH.LockName

CFCATCH.LockOperation

CFCATCH.MissingFileName

CFCATCH.TagContext

CFCATCH.ErrorCode

CFCATCH.ExtendedInfo

CFDIRECTORY variables

When used with ACTION=LIST, CFDIRECTORY returns a query object. Queryname is the value of the NAME

attribute used in the CFDIRECTORY operation.

queryname.Name

queryname.Size

queryname.Type

queryname.DateLastModified

queryname.Attributes

queryname.Mode

CFERROR variables

When CFERROR generates an error page, the following error variables are available.

Error.Diagnostics

Error.MailTo

Error.DateTime

Error.Browser

Error.RemoteAddress

Error.HTTPReferer

Error.Template

Error.QueryString

Error.ValidationHeader

Error.InvalidFields

Error.ValidationFooter

CFFILE ACTION=Upload variables

File variables are read-only. Use the CFFILE. prefix to reference file variables: CFFILE.ClientDirectory. Note that although still supported, the File. prefix is deprecated in favor of the CFFILE. prefix.

CFFILE.AttemptedServerFile

CFFILE.ClientDirectory

CFFILE.ClientFile

CFFILE.ClientFileExt

CFFILE.ClientFileName

CFFILE.ContentSubType

CFFILE.ContentType

CFFILE.DateLastAccessed

CFFILE.FileExisted

CFFILE.FileSize

CFFILE.FileWasAppended

CFFILE.FileWasOverwritten

CFFILE.FileWasRenamed

CFFILE.FileWasSaved

CFFILE.OldFileSize

CFFILE.ServerDirectory

CFFILE.ServerFile

CFFILE.ServerFileExt

CFFILE.ServerFileName

CFFILE.TimeCreated

CFFILE.TimeLastModified

CFFTP error variables

When you use the CFFTP STOPONERROR attribute, three variables are populated.

CFFTP.Succeeded

CFFTP.ErrorCode

CFFTP.ErrorText

CFFTP ReturnValue variable

Some of the CFFTP file and directory operations provide a return value in the variable:

CFFTP.ReturnValue

The value of the CFFTP.ReturnValue variable is determined by the results of the ACTION attribute used in CFFTP. When you specify any of the following actions, CFFTP returns a value:

GetCurrentDir

GetCurrentURL

ExistsDir

ExistsFile

Exists

CFFTP query object columns

When you use CFFTP with the ListDir action, CFFTP returns a query object. Queryname is the value of the NAME attribute used in the CFFTP operation. Row is the row number for each file/directory entry returned by the ListDir operation. A separate row is created for each entry.

queryname.Name[row]

queryname.Path[row]

queryname.URL[row]

queryname.Length[row]

queryname.LastModified[row]

CFHTTP variables

CFHTTP GET operations can return text and binary files. Files are downloaded and the contents stored in a variable or file, depending on the MIME type.

CFHTTP.FileContent

CFHTTP.MimeType

CFLDAP variables

CFLDAP returns information about the LDAP query if ACTION=QUERY:

queryname.CurrentRow

queryname.RecordCount

queryname.ColumnList

CFPOP variables

CFPOP returns the following result columns, depending on the value of the ACTION attribute and the use of other attributes like ATTACHMENTPATH. Queryname is the value of the NAME attribute used in the CFPOP operation.

queryname.Date

queryname.From

queryname.Body

queryname.Header

queryname.MessageNumber

queryname.ReplyTo

queryname.Subject

queryname.CC

queryname.To

queryname.CurrentRow

queryname.RecordCount

queryname.ColumnList

queryname.Attachments

queryname.AttachmentFiles

CFQUERY and CFSTOREDPROC variables

In addition to returning data from a ColdFusion data source, the CFQUERY tag also returns information about the query:

CFQUERY.ExecutionTime

CFQUERY also uses the name of the query to scope data about the query:

queryname.CurrentRow

queryname.RecordCount

queryname.ColumnList

The CFSTOREDPROC tag also returns:

CFSTOREDPROC.ExecutionTime

CFSTOREDPROC.StatusCode

CFREGISTRY variables

The CFREGISTRY tag returns a query record set that you can reference after executing the GetAll action. Queryname is the value of the NAME attribute used in the CFREGISTRY operation.

queryname.Entry

queryname.Type

queryname.Value

CFSEARCH variables

Every CFSEARCH operation returns the following variables. Searchname is the value of the NAME attribute used in the CFSEARCH operation.

searchname.URL

searchname.Key

searchname.Title

searchname.Score

searchname.Custom1 and Custom2

searchname.Summary

searchname.RecordCount

searchname.CurrentRow

searchname.RecordsSearched

searchname.ColumnList

Standard CGI Variables

This is a list of CGI 1.1 variables many Web servers create when a CGI script is called.

NOTE: The CGI variables that are available for your use vary with the Web server and configuration. Some of the following variables may not be available to you.

Request

CGI.AUTH_TYPE

CGI.CONTENT_LENGTH

CGI.CONTENT_TYPE

CGI.PATH_INFO

CGI.PATH_TRANSLATED

CGI.QUERY_STRING

CGI.REMOTE_ADDR

CGI.REMOTE_HOST

CGI.REMOTE_USER

CGI.REQUEST_METHOD

CGI.SCRIPT_NAME

Server

CGI.GATEWAY_INTERFACE

CGI.SERVER_NAME

CGI.SERVER_PORT

CGI.SERVER_PROTOCOL

CGI.SERVER_SOFTWARE

Client

CGI.CERT_ISSUER

CGI.CERT_SUBJECT

CGI.CLIENT_CERT_ENCODED

CGI.HTTP_ACCEPT

CGI.HTTP_USER_AGENT

NOTE: The CERT_ISSUER, CERT_SUBJECT, CLIENT_CERT_ENCODED variables are available only if you are using client certificates.