User Guide
Table Of Contents
- CFML Tags
- cfabort
- cfapplet
- cfapplication
- cfassociate
- cfauthenticate
- cfbreak
- cfcache
- cfcol
- cfcollection
- cfcontent
- cfcookie
- cfdirectory
- cfdump
- cferror
- cfexecute
- cfexit
- cffile
- cfflush
- cfform
- cfftp
- cfgraph
- cfgraphdata
- cfgrid
- cfgridcolumn
- cfgridrow
- cfgridupdate
- cfheader
- cfhtmlhead
- cfhttp
- cfhttpparam
- cfifcfelseifcfelse
- cfimpersonate
- cfinclude
- cfindex
- cfinput
- cfinsert
- cfldap
- cflocation
- cflock
- cflog
- cfloop
- cfmail
- cfmailparam
- cfmodule
- cfobject
- cfoutput
- cfparam
- cfpop
- cfprocessingdirective
- cfprocparam
- cfprocresult
- cfquery
- cfqueryparam
- cfregistry
- cfreport
- cfrethrow
- cfsavecontent
- cfschedule
- cfscript
- cfsearch
- cfselect
- cfservlet
- cfservletparam
- cfset
- cfsetting
- cfsilent
- cfslider
- cfstoredproc
- cfswitchcfcasecfdefaultcase
- cftable
- cftextinput
- cfthrow
- cftransaction
- cftree
- cftreeitem
- cftry cfcatch
- cfupdate
- cfwddx
- 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 ])
- Authentication functions
- AuthenticatedContext()
- AuthenticatedUser()
- IsAuthenticated([security-context-name ])
- IsAuthorized(resourcetype, resourcename [, action ])
- Conversion functions
- Hash(string)
- ToBase64(string or binary_object)
- ToBinary(string_in_Base64 or binary_value)
- ToString(any_value)
- URLDecode(urlEncodedString)
- URLEncodedFormat(string)
- XMLFormat(string)
- 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)
- DaysInYear(date)
- FirstDayOfMonth(date)
- GetHttpTimeString(date_time_object)
- GetTimeZoneInfo()
- Hour(date)
- IsDate(string)
- IsLeapYear(year)
- IsNumericDate(number)
- LSDateFormat(date [, mask ])
- LSIsDate(string)
- LSParseDateTime(date/time-string)
- LSTimeFormat(time [, mask ])
- Minute(date)
- Month(date)
- MonthAsString(month_number)
- Now()
- ParseDateTime(date/time-string [, pop-conversion ] )
- Quarter(date)
- Second(date)
- TimeFormat(time [, mask ])
- Week(date)
- Year(date)
- Decision functions
- IsArray(value [, number ])
- IsAuthenticated([security-context-name ])
- IsAuthorized(resourcetype, resourcename [, action ])
- FileExists(absolute_path)
- IsBinary(value)
- IsBoolean(value)
- IsCustomFunction(name)
- IsDate(string)
- IsDebugMode()
- IsDefined("variable_name")
- IsLeapYear(year)
- IsNumeric(string)
- IsNumericDate(number)
- IsProtected(resourcetype, resourcename [, action])
- IsQuery(value)
- IsSimpleValue(value)
- IsStruct(variable )
- IsWDDX(value)
- LSIsCurrency(string)
- LSIsDate(string)
- LSIsNumeric(string)
- ParameterExists(parameter)
- 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)
- TimeFormat(time [, mask ])
- YesNoFormat(value)
- Dynamic evaluation functions
- DE(string)
- Evaluate(string_express1 [, string_express2 [,…]])
- IIf(condition, string_express1, string_express2)
- SetVariable(name, value)
- International functions
- DateConvert(conversion-type, date)
- GetHttpTimeString(date_time_object)
- GetLocale()
- GetTimeZoneInfo()
- LSCurrencyFormat(number [, type ])
- LSDateFormat(date [, mask ])
- LSEuroCurrencyFormat(currency-number [, type ])
- LSIsCurrency(string)
- LSIsDate(string)
- LSIsNumeric(string)
- LSNumberFormat(number [, mask ])
- LSParseCurrency(string)
- LSParseDateTime(date/time-string)
- LSParseEuroCurrency(currency-string)
- LSParseNumber(string)
- LSTimeFormat(time [, mask ])
- SetLocale(new_locale)
- 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 ])
- 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)
- Insert(substring, string, position)
- 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)
- Encrypt(string, seed)
- Find(substring, string [, start ])
- FindNoCase(substring, string [, start ])
- FindOneOf(set, string [, start ])
- FormatBaseN(number, radix)
- GetToken(string, index [, delimiters ])
- Hash(string)
- Insert(substring, string, position)
- JavaCast(type, variable)
- JSStringFormat(string)
- LCase(string)
- Left(string, count)
- Len(string or binary object)
- ListValueCount(list, value [, delimiters ])
- ListValueCountNoCase(list, value [, delimiters ])
- LJustify(string, length)
- LSIsCurrency(string)
- LSParseCurrency(string)
- LSParseDateTime(date/time-string)
- LSParseEuroCurrency(currency-string)
- LSParseNumber(string)
- LTrim(string)
- Mid(string, start, count)
- MonthAsString(month_number)
- ParseDateTime(date/time-string [, pop-conversion ] )
- 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, substrng1, substrng2 [, scope])
- REReplace(string, reg_express, substrng [, scope])
- REReplaceNoCase(string, reg_express, substrng [, scope])
- Reverse(string)
- Right(string, count)
- RJustify(string, length)
- RTrim(string)
- SpanExcluding(string, set)
- SpanIncluding(string, set)
- ToBase64(string or binary_object)
- Trim(string)
- UCase(string)
- Val(string)
- Structure functions
- Duplicate(variable_name)
- IsStruct(variable )
- StructAppend(struct1, struct2, overwriteFlag)
- StructClear(structure)
- StructCopy(structure)
- StructCount(structure)
- StructDelete(structure, key [, indicatenotexisting ])
- StructFind(structure, key)
- StructFindKey(top, key, scope)
- StructFindValue(struct top, string value [, scope])
- StructGet(pathDesired)
- StructInsert(structure, key, value [, allowoverwrite])
- StructIsEmpty(structure)
- StructKeyArray(structure)
- StructKeyExists(structure, key)
- StructKeyList(structure, [delimiter])
- StructNew()
- StructSort(base, pathToSubElement, sortOrder, sortType)
- StructUpdate(structure, key, value)
- System functions
- DirectoryExists(absolute_path)
- ExpandPath(relative_path)
- FileExists(absolute_path)
- GetCurrentTemplatePath()
- GetDirectoryFromPath(path)
- getException(object)
- GetFileFromPath(path)
- GetFunctionList()
- GetHttpRequestData()
- GetMetricData(mode)
- GetProfileString(iniPath, section, entry)
- GetTempDirectory()
- GetTempFile(dir, prefix)
- GetTemplatePath()
- SetProfileString(iniPath, section, entry, value)
- Other functions
- CreateObject("COM", class, context, serverName)
- CreateObject("CORBA", class, context, locale)
- CreateObject("Java", class)
- CreateUUID()
- Decrypt(encrypted_string, seed)
- DeleteClientVariable("name")
- Duplicate(variable_name)
- GetBaseTagData(tagname [, instancenumber ] )
- GetBaseTagList()
- GetBaseTemplatePath()
- GetClientVariablesList()
- GetTickCount()
- Hash(string)
- PreserveSingleQuotes(variable)
- QuotedValueList(query.column [, delimiter ])
- StripCR(string)
- ToBinary(string_in_Base64 or binary_value)
- URLDecode(urlEncodedString)
- URLEncodedFormat(string)
- ValueList(query.column [, delimiter ])
- WriteOutput(string)
- ColdFusion Variables
- ColdFusion Tag-Specific Variables
- ColdFusion query variables
- CFCATCH variables
- CFDIRECTORY variables
- CFERROR variables
- NOTE: You can substitute the prefix CFERROR for Error if you have specified the type as "Exceptio...
- CFFILE ACTION=Upload variables
- CFFTP error variables
- CFFTP ReturnValue variable
- CFFTP query object columns
- CFHTTP variables
- CFLDAP variables
- CFPOP variables
- CFQUERY and CFSTOREDPROC variables
- CFREGISTRY variables
- CFSEARCH variables
- CFSERVLET variables
- Standard CGI Variables
- ColdFusion Studio Keyboard Shortcuts
22 CFML Quick Reference
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 vari-
ables:
• CFCATCH
• CFDIRECTORY
• CFERROR
• CFFILE
• CFFTP
• CFHTTP
• CFINDEX
• CFLDAP
• CFMAIL
• CFPOP
• CFQUERY
• CFREGISTRY
• CFSEARCH
• CFSERVLET
• CFSTOREDPROC
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 excep-
tion 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