CFML Quick Reference
Page 1: ...CFML Quick Reference...
Page 2: ...emarks 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...
Page 3: ...e 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 va...
Page 4: ...4 CFML Quick Reference Standard CGI variables 33 Request 33 Server 33 Client 33...
Page 5: ...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 cfassoci...
Page 6: ...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...
Page 7: ...cfelseif cfif expression HTML and CFML tags cfelseif expression HTML and CFML tags cfelse HTML and CFML tags cfif cferror cferror type a type template template_path mailTo email_address exception exc...
Page 8: ...ntent 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 preserveDa...
Page 9: ...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 javascrip...
Page 10: ...fgridrow 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 tabl...
Page 11: ...om_value URLpath URL extensions file_extensions query query_name recurse Yes or No language language cfinput cfinput type input_type name name value initial_value required Yes or No range min_value ma...
Page 12: ...gname for instantiated component method method name returnVariable variable name argumentCollection argument collection OR Syntax 4B this syntax invokes a web service This syntax shows instantiation w...
Page 13: ...ype application application name yes or no cflogin cflogin idletimeout value applicationToken token cookieDomain domain cfloginuser name name password password string roles roles cflogin cfloginuser c...
Page 14: ...value header value cfmail cfmailpart cfmail Optional cfmailparam entries cfmailpart type mime type charset character encoding wraptext number cfmail cfmodule cfmodule template path name tag_name attri...
Page 15: ...encoding literal string OR cfprocessingdirective suppressWhiteSpace Yes or No pageEncoding page encoding literal string CFML tags cfprocessingdirective cfprocparam cfprocparam type in or out or inout...
Page 16: ...on get branch branch entry key or value variable variable type data type cfregistry action set branch branch entry key or value type value type value data cfregistry action delete branch branch entry...
Page 17: ...text size integer multiple Yes or No query queryname selected column_value value text display text passThrough HTML_attributes cfselect cfset cfset var variable_name expression cfsetting cfsetting en...
Page 18: ...umber cftable cftextinput cftextinput name name value text required Yes or No range min_value max_value validate data_type pattern Java regular expression onValidate script_name message text onError t...
Page 19: ...order Yes or No hScroll Yes or No vScroll Yes or No notSupported text cftree cftreeitem cftreeitem value text display text parent parent_name img filename imgopen filename href URL target URL_target q...
Page 20: ...ions ArrayToList array delimiter Hash string LCase string ListToArray list delimiters ToBase64 string or binary_object encoding ToBinary string_in_Base64 or binary_value ToString any_value encoding UR...
Page 21: ...Second date TimeFormat time mask Week date Year date Decision functions DirectoryExists absolute_path FileExists absolute_path IIf condition string_expression1 string_expression2 IsArray value number...
Page 22: ...imeFormat time mask NumberFormat number mask ParagraphFormat string RJustify string length StripCR string TimeFormat time mask YesNoFormat value StripCR string Dynamic evaluation functions DE string E...
Page 23: ...umber string LSTimeFormat time mask SetEncoding scope_name charset SetLocale new_locale List functions ArraySort array sort_type sort_order ArrayToList array delimiter Asc string Chr number Cjustify s...
Page 24: ...er 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 BitSH...
Page 25: ...g functions ColdFusion MX ColdFusion now supports the Java UCS 2 representation of Unicode character values 0 65535 Earlier releases supported ASCII values String processing functions process any of t...
Page 26: ...st2 ReplaceNoCase string substring1 substring2 scope REReplace string reg_expression substring scope REReplaceNoCase string reg_expression substring scope Reverse string Right string count RJustify st...
Page 27: ...me GetException object GetFileFromPath path GetFunctionList GetHttpRequestData GetLocale GetMetaData object GetMetaData this if used in a ColdFusion component GetMetricData mode GetProfileSections ini...
Page 28: ...as Variables linguist Caller scope ColdFusion MX supports the Caller scope as a structure Client variables The following client variables are read only Client CFID Client CFToken Client HitCount Clien...
Page 29: ...ET Request field_name1 value CFSET Request field_name2 value CFSET Request field_name3 value Each nested tag can access the variable with the cfoutput tag as follows CFOUTPUT Request field_name1 CFOUT...
Page 30: ...eryname Type queryname DateLastModified queryname Attributes queryname Mode CFERROR variables When cferror generates an error page the following error variables are available if type request exception...
Page 31: ...E ServerFile CFFILE ServerFileExt CFFILE ServerFileName CFFILE TimeCreated CFFILE TimeLastModified CFFTP error variables When you use the cfftp stoponerror attribute these variables are populated CFFT...
Page 32: ...ame MessageNumber queryname ReplyTo queryname Subject queryname CC queryname To queryname CurrentRow queryname RecordCount queryname ColumnList queryname Attachments queryname AttachmentFiles CFQUERY...
Page 33: ...d configuration Some of the following variables may not be available Request CGI AUTH_TYPE CGI CONTENT_LENGTH CGI CONTENT_TYPE CGI PATH_INFO CGI PATH_TRANSLATED CGI QUERY_STRING CGI REMOTE_ADDR CGI RE...
Page 34: ...34 CFML Quick Reference...