Adobe Cold Fusion 11.0 CFML Reference CF11 CFMLRef En

User Manual: adobe ColdFusion - 11.0 - CFML Reference Free User Guide for Adobe ColdFusion Software, Manual

Open the PDF directly: View PDF PDF.
Page Count: 3053

DownloadAdobe Cold Fusion - 11.0 CFML Reference CF11 CFMLRef-en
Open PDF In BrowserView PDF
Adobe ColdFusion Documentation
September 2014

1. Adobe ColdFusion CFML Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.1 CFML Reference (ColdFusion 11) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2 Reserved Words and Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.1 Reserved words . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.1.1 Reserved words in forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.1.2 Reserved words in queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.2 Scope-specific built-in variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.2.1 Variable scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.2.2 Caller scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.2.3 CGI variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.2.4 Client variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.2.5 Server variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.2.6 Application and session variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.3 Custom tag variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.3.1 Request variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.3.2 Form variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.4 ColdFusion tag-specific variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.4.1 ColdFusion query variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.4.2 CFCATCH variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.4.3 CFDIRECTORY variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.4.4 CFERROR variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.4.5 CFFILE ACTION=Upload variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.4.6 CFFTP error variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.4.7 CFFTP ReturnValue variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.4.8 CFFTP query object columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.4.9 CFHTTP variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.4.10 CFLDAP variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.4.11 CFPOP variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.4.12 CFQUERY and CFSTOREDPROC variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.4.13 CFREGISTRY variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.4.14 CFSEARCH variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.5 CGI environment (CGI Scope) variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.5.1 Testing for CGI variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.5.2 CGI server variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.5.3 CGI client variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.2.5.4 CGI client certificate variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3 ColdFusion Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.1 Tags in ColdFusion 10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.2 Tag summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.3 Tags by function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.3.1 Application framework tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.3.2 Communications tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.3.3 Database manipulation tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.3.4 Data output tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.3.5 Debugging tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.3.6 Display management tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.3.7 Exception handling tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.3.8 Extensibility tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.3.9 File management tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.3.10 Flow-control tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.3.11 Forms tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.3.12 Internet protocol tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.3.13 Page processing tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.3.14 Security tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.3.15 Variable manipulation tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.3.16 Web Socket tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.3.17 Other tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.4 Tag changes since ColdFusion 5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.4.1 New tags, attributes, and values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.4.2 Deprecated tags, attributes, and values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.4.3 Obsolete tags, attributes, and values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.5 Tags a-b . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.5.1 cfabort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.5.2 cfajaximport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.5.3 cfajaxproxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.5.4 cfapplet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.5.5 cfapplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.5.6 cfargument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.5.7 cfassociate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

19
20
22
23
24
25
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
55
56
58
59
60
61
62
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
104
106
107
108
110
115
124
127
135
142

1.3.5.8 cfauthenticate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.5.9 cfbreak . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.6 Tags c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.6.1 cfcache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.6.2 cfcalendar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.6.3 cfcase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.6.4 cfcatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.6.5 cfchart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.6.6 cfchartdata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.6.7 cfchartseries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.6.8 cfcol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.6.9 cfcollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.6.10 cfcomponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.6.11 cfcontent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.6.12 cfcontinue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.6.13 cfcookie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.6.14 cfclient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.6.15 cfclientsettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.7 Tags d-e . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.7.1 cfdbinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.7.2 cfdefaultcase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.7.3 cfdirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.7.4 cfdiv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.7.5 cfdocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.7.6 cfdocumentitem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.7.7 cfdocumentsection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.7.8 cfdump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.7.9 cfelse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.7.10 cfelseif . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.7.11 cferror . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.7.12 cfexchangecalendar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.7.13 cfexchangeconnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.7.14 cfexchangecontact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.7.15 cfexchangeconversation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.7.16 cfexchangefilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.7.17 cfexchangefolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.7.18 cfexchangemail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.7.19 cfexchangetask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.7.20 cfexecute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.7.21 cfexit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8 Tags f . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.1 cffeed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.2 cffile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.3 cffile action = "append" . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.4 cffile action = "copy" . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.5 cffile action = "delete" . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.6 cffile action = "move" . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.7 cffile action = "read" . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.8 cffile action = "readBinary" . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.9 cffile action = "rename" . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.10 cffile action = "upload" . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.11 cffile action = "uploadAll" . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.12 cffile action = "write" . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.13 cffileupload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.14 cffinally . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.15 cfflush . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.16 cfformgroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.17 cfformitem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.18 cfftp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.19 cfftp: Opening and closing FTP server connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.20 cfftp: Opening and closing secure FTP server connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.21 cfftp: Connection: file and directory operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.22 cfftp action = "listDir" . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.23 cfform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.8.24 cffunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.9 Tags g-h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.9.1 cfgraph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.9.2 cfgraphdata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.9.3 cfgrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.9.4 cfgridcolumn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.9.5 cfgridrow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.9.6 cfgridupdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

144
145
147
148
158
163
166
171
188
190
200
203
209
224
231
233
238
239
247
248
254
256
264
268
283
286
291
295
296
297
303
329
338
349
356
365
376
390
400
404
407
408
427
434
437
439
440
443
446
448
451
460
466
471
478
480
482
494
501
502
506
512
517
518
537
549
550
552
553
575
588
590

1.3.9.7 cfheader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.9.8 cfhtmlhead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.9.9 cfhtmltopdf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.9.10 cfhtmltopdfitem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.9.11 cfhttp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.9.12 cfhttpparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.10 Tags i . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.10.1 cfif . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.10.2 cfimage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.10.3 cfimap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.10.4 cfimapfilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.10.5 cfimpersonate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.10.6 cfimport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.10.7 cfinclude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.10.8 cfindex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.10.9 cfinput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.10.10 cfinsert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.10.11 cfinterface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.10.12 cfinvoke . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.10.13 cfinvokeargument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.11 Tags j-l . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.11.1 cflayout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.11.2 cflayoutarea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.11.3 cfldap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.11.4 cflocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.11.5 cflock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.11.6 cflog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.11.7 cflogin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.11.8 cfloginuser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.11.9 cflogout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.11.10 cfloop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.11.11 cfloop: index loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.11.12 cfloop: conditional loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.11.13 cfloop: looping over a date or time range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.11.14 cfloop: looping over a query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.11.15 cfloop: looping over a list, a file, or an array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.11.16 cfloop: looping over a COM collection or structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.12 Tags m-o . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.12.1 cfmail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.12.2 cfmailparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.12.3 cfmailpart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.12.4 cfmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.12.5 cfmapitem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.12.6 cfmediaplayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.12.7 cfmenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.12.8 cfmenuitem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.12.9 cfmessagebox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.12.10 cfmodule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.12.11 cfNTauthenticate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.12.12 cfoauth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.12.13 cfobject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.12.14 cfobject: .NET object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.12.15 cfobject: COM object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.12.16 cfobject: component object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.12.17 cfobject: CORBA object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.12.18 cfobject: Java or EJB object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.12.19 cfobject: web service object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.12.20 cfobjectcache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.12.21 cfoutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.13 Tags p-q . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.13.1 cfparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.13.2 cfpdf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.13.3 cfpdfform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.13.4 cfpdfformparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.13.5 cfpdfparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.13.6 cfpdfsubform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.13.7 cfpod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.13.8 cfpop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.13.9 cfpresentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.13.10 cfpresentationslide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.13.11 cfpresenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.13.12 cfprint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

593
595
596
603
607
627
632
633
636
653
663
674
675
679
682
695
716
721
727
736
738
739
749
765
773
777
785
788
791
793
795
796
799
800
802
804
807
809
810
823
827
830
838
841
848
852
856
862
867
871
876
877
882
885
887
889
891
895
896
901
902
907
956
968
970
973
975
980
987
996
1004
1007

1.3.13.13 cfprocessingdirective . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.13.14 cfprocparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.13.15 cfprocresult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.13.16 cfprogressbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.13.17 cfproperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.13.18 cfquery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.13.19 cfqueryparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.14 Tags r-s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.14.1 cfregistry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.14.2 cfreport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.14.3 cfreportparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.14.4 cfrethrow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.14.5 cfreturn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.14.6 cfsavecontent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.14.7 cfschedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.14.8 cfscript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.14.9 cfsearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.14.10 cfselect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.14.11 cfservlet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.14.12 cfservletparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.14.13 cfset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.14.14 cfsetting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.14.15 cfsharepoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.14.16 cfsilent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.14.17 cfslider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.14.18 cfspreadsheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.14.19 cfsprydataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.14.20 cfstoredproc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.14.21 cfswitch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.15 Tags t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.15.1 cftable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.15.2 cftextarea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.15.3 cftextinput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.15.4 cfthread . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.15.5 cfthrow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.15.6 cftimer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.15.7 cftooltip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.15.8 cftrace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.15.9 cftransaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.15.10 cftree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.15.11 cftreeitem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.15.12 cftry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.16 Tags u-z . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.16.1 cfupdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.16.2 cfwddx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.16.3 cfwebsocket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.16.4 cfwindow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.16.5 cfxml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.16.6 cfzip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.3.16.7 cfzipparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4 ColdFusion Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.1 New Functions in ColdFusion 10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2 Functions by category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.1 Array functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.2 Cache functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.3 Conversion functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.4 Date and time functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.5 Data output functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.6 Debugging functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.7 Decision functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.8 Display and formatting functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.9 Dynamic evaluation functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.10 Exception handling functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.11 Extensibility functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.12 Flow control functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.13 Full-text search functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.14 Image functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.15 International functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.16 List functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.17 Mathematical functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.18 Microsoft office integration functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.19 ORM functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1017
1020
1026
1028
1034
1042
1051
1057
1058
1065
1087
1091
1093
1095
1097
1105
1110
1120
1132
1133
1134
1138
1141
1149
1150
1157
1166
1169
1176
1178
1179
1182
1196
1197
1205
1209
1213
1216
1219
1225
1237
1245
1247
1248
1251
1255
1258
1268
1271
1286
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315

1.4.2.20 Other functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.21 Query functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.22 Security functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.23 Spreadsheet functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.24 String functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.25 Structure functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.26 System functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.27 Transaction functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.28 XML functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.2.29 Mobile Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.3 Function changes since ColdFusion 5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.3.1 New functions, parameters, and values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.3.2 Deprecated functions, parameters, and values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.3.3 Obsolete functions, parameters, and values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4 Functions a-b . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.1 Abs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.2 ACos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.3 AddSOAPRequestHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.4 AddSOAPResponseHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.5 AjaxLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.6 AjaxOnLoad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.7 ApplicationStop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.8 ArrayAppend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.9 ArrayAvg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.10 ArrayClear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.11 ArrayContains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.12 ArrayDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.13 ArrayDeleteAt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.14 ArrayEach . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.15 ArrayFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.16 ArrayFind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.17 ArrayFindAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.18 ArrayFindAllNoCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.19 ArrayFindNoCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.20 ArrayInsertAt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.21 ArrayIsDefined . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.22 ArrayIsEmpty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.23 arrayLen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.24 ArrayMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.25 ArrayMax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.26 ArrayMin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.27 ArrayNew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.28 ArrayPrepend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.29 ArrayReduce . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.30 ArrayResize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.31 ArraySet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.32 ArraySlice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.33 ArraySort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.34 ArraySum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.35 ArraySwap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.36 ArrayToList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.37 Asc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.38 ASin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.39 Atn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.40 AuthenticatedContext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.41 AuthenticatedUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.42 BinaryDecode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.43 BinaryEncode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.44 BitAnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.45 BitMaskClear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.46 BitMaskRead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.47 BitMaskSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.48 BitNot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.49 BitOr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.50 BitSHLN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.51 BitSHRN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.52 BitXor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.4.53 ArrayDeleteNoCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5 Functions c-d . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.1 CacheIdExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.2 CacheGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.3 CacheGetAllIds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1335
1336
1337
1339
1340
1342
1344
1346
1347
1349
1351
1353
1356
1357
1359
1360
1362
1364
1365
1366
1367
1369
1371
1373
1375
1377
1379
1380
1381
1382
1383
1385
1387
1388
1390
1391
1394
1396
1397
1399
1401
1403
1405
1406
1407
1409
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1423
1425
1426

1.4.5.4 CacheGetMetadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.5 cacheGetSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.6 CachePut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.7 CacheRegionExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.8 CacheRegionNew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.9 CacheRegionRemove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.10 CacheRemove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.11 CacheRemoveAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.12 CacheSetProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.13 CallStackGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.14 CallStackDump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.15 CacheGetProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.16 CanDeSerialize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.17 Canonicalize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.18 CanSerialize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.19 Ceiling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.20 CharsetDecode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.21 CharsetEncode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.22 Chr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.23 CJustify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.24 Compare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.25 CompareNoCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.26 Cos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.27 CreateDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.28 CreateDateTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.29 CreateObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.30 CreateObject: .NET object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.31 CreateObject: COM object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.32 CreateObject: component object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.33 CreateObject: CORBA object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.34 CreateObject: Java or EJB object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.35 CreateObject: web service object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.36 CreateODBCDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.37 CreateODBCDateTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.38 CreateODBCTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.39 CreateTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.40 CreateTimeSpan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.41 CreateUUID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.42 CSRFGenerateToken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.43 CSRFVerifyToken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.44 DateAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.45 DateCompare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.46 DateConvert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.47 DateDiff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.48 DateFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.49 DateTimeFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.50 DatePart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.51 Day . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.52 DayOfWeek . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.53 DayOfWeekAsString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.54 DayOfYear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.55 DaysInMonth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.56 DaysInYear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.57 DE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.58 DecimalFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.59 DecodeForHTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.60 DecodeFromURL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.61 DecrementValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.62 Decrypt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.63 DecryptBinary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.64 DeleteClientVariable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.65 DeserializeJSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.66 DirectoryCopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.67 DirectoryCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.68 DirectoryDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.69 DirectoryExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.70 DirectoryList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.71 DirectoryRename . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.72 DollarFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.73 DotNetToCFType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.74 Duplicate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.5.75 Deserialize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1427
1429
1432
1434
1435
1437
1438
1440
1441
1443
1445
1447
1450
1451
1455
1456
1457
1460
1463
1465
1467
1469
1471
1473
1475
1477
1478
1481
1483
1485
1487
1488
1491
1493
1496
1498
1500
1503
1504
1505
1506
1510
1514
1517
1521
1524
1527
1529
1531
1533
1535
1537
1539
1541
1544
1545
1546
1547
1548
1553
1557
1559
1562
1563
1565
1567
1569
1573
1575
1576
1578
1580

1.4.5.76 DeserializeXML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6 Functions e-g . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.1 EncodeForCSS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.2 EncodeForHTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.3 EncodeForHTMLAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.4 EncodeForJavaScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.5 EncodeForURL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.6 EncodeForXML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.7 Encrypt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.8 GetTempDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.9 GetApplicationMetadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.10 EncryptBinary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.11 EntityDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.12 EntityLoad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.13 EntityLoadByExample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.14 EntityLoadByPK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.15 EntityMerge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.16 EntityNew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.17 EntityReload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.18 EntitySave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.19 EntityToQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.20 Evaluate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.21 Exp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.22 ExpandPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.23 FileClose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.24 FileCopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.25 FileDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.26 FileExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.27 FileGetMimeType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.28 FileIsEOF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.29 FileMove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.30 FileOpen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.31 FileRead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.32 FileReadBinary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.33 FileReadLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.34 FileSeek . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.35 FileSetAccessMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.36 FileSetAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.37 FileSetLastModified . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.38 FileSkipBytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.39 FileUpload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.40 FileUploadAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.41 FileWrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.42 FileWriteLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.43 Find . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.44 FindNoCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.45 FindOneOf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.46 FirstDayOfMonth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.47 Fix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.48 FormatBaseN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.49 GenerateSecretKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.50 GetAuthUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.51 GetBaseTagData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.52 GetBaseTagList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.53 GetBaseTemplatePath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.54 GetClientVariablesList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.55 GetComponentMetaData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.56 GetContextRoot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.57 GetCPUUsage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.58 GetCurrentTemplatePath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.59 GetDirectoryFromPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.60 GetEncoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.61 GetException . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.62 GetFileFromPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.63 GetFileInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.64 GetFreeSpace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.65 GetFunctionCalledName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.66 GetFunctionList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.67 GetGatewayHelper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.68 GetHttpRequestData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.69 GetHttpTimeString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.70 GetK2ServerDocCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1581
1582
1584
1586
1588
1590
1592
1594
1596
1603
1604
1606
1610
1611
1614
1615
1616
1617
1619
1620
1622
1624
1626
1628
1630
1632
1634
1636
1638
1640
1642
1644
1646
1648
1650
1651
1653
1655
1656
1657
1658
1660
1665
1667
1668
1670
1672
1674
1675
1676
1678
1682
1683
1685
1687
1688
1690
1691
1692
1693
1694
1696
1698
1699
1701
1703
1705
1707
1708
1710
1712
1713

1.4.6.71 GetK2ServerDocCountLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.72 GetLocale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.73 GetLocaleDisplayName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.74 GetLocalHostIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.75 GetMetaData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.76 GetMetricData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.77 GeneratePBKDFKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.78 GetPageContext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.79 GetPrinterInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.80 GetPrinterList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.81 GetProfileSections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.82 GetProfileString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.83 GetReadableImageFormats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.84 GetSOAPRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.85 GetSOAPRequestHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.86 GetSOAPResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.87 GetSOAPResponseHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.88 GetSystemFreeMemory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.89 GetSystemTotalMemory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.90 GetTempFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.91 GetTemplatePath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.92 GetTickCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.93 GetTimeZoneInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.94 GetToken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.95 GetTotalSpace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.96 GetUserRoles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.97 GetVFSMetaData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.98 GetWriteableImageFormats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.99 GetSafeHTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.100 EncodeForXMLAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.6.101 EncodeForXpath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7 Functions h-im . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.1 Hash . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.2 HMac . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.3 HQLMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.4 Hour . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.5 HTMLCodeFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.6 HTMLEditFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.7 IIf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.8 ImageAddBorder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.9 ImageBlur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.10 ImageClearRect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.11 ImageCopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.12 ImageCreateCaptcha . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.13 ImageCrop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.14 ImageDrawArc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.15 ImageDrawBeveledRect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.16 ImageDrawCubicCurve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.17 ImageDrawLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.18 ImageDrawLines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.19 ImageDrawOval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.20 ImageDrawPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.21 ImageDrawQuadraticCurve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.22 ImageDrawRect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.23 ImageDrawRoundRect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.24 ImageDrawText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.25 ImageFlip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.26 ImageGetBlob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.27 ImageGetBufferedImage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.28 ImageGetEXIFMetadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.29 ImageGetEXIFTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.30 ImageGetHeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.31 ImageGetIPTCMetadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.32 ImageGetIPTCTag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.33 ImageGetWidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.34 ImageGrayscale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.35 ImageInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.36 ImageMakeColorTransparent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.37 ImageMakeTranslucent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.38 ImageNegative . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.39 ImageNew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.40 ImageOverlay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1714
1715
1717
1719
1720
1725
1728
1730
1732
1734
1735
1737
1739
1740
1742
1745
1747
1749
1750
1751
1752
1753
1754
1756
1760
1762
1763
1765
1766
1768
1770
1772
1774
1778
1780
1783
1784
1786
1788
1791
1794
1796
1798
1800
1802
1804
1806
1808
1810
1812
1814
1816
1818
1820
1822
1825
1828
1831
1833
1835
1837
1839
1840
1842
1843
1844
1846
1848
1849
1851
1853
1857

1.4.7.41 ImagePaste . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.42 ImageRead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.43 ImageReadBase64 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.44 ImageResize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.45 ImageRotate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.46 ImageRotateDrawingAxis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.47 ImageScaleToFit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.48 ImageSetAntialiasing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.49 ImageSetBackgroundColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.50 ImageSetDrawingColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.51 ImageSetDrawingStroke . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.52 ImageSetDrawingTransparency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.53 ImageSharpen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.54 ImageShear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.55 ImageShearDrawingAxis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.56 ImageTranslate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.57 ImageTranslateDrawingAxis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.58 ImageWrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.59 ImageWriteBase64 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.60 ImageXORDrawingMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.7.61 ImageGetMetadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8 Functions in-k . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.1 IncrementValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.2 InputBaseN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.3 Insert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.4 Int . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.5 Invoke . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.6 IsArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.7 IsAuthenticated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.8 IsAuthorized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.9 IsBinary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.10 IsBoolean . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.11 IsClosure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.12 IsCustomFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.13 IsDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.14 IsDDX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.15 IsDebugMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.16 IsDefined . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.17 IsImage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.18 IsImageFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.19 IsInstanceOf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.20 IsIPv6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.21 IsJSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.22 IsK2ServerABroker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.23 IsK2ServerDocCountExceeded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.24 IsK2ServerOnline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.25 IsLeapYear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.26 IsLocalHost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.27 IsNull . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.28 IsNumeric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.29 IsNumericDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.30 IsObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.31 isOnline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.32 IsPDFFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.33 IsPDFObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.34 IsProtected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.35 IsQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.36 IsSimpleValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.37 IsSOAPRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.38 IsSpreadsheetFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.39 IsSpreadsheetObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.40 IsStruct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.41 IsUserInAnyRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.42 IsUserInRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.43 IsUserLoggedIn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.44 IsValid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.45 IsWDDX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.46 IsXML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.47 IsXmlAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.48 IsXmlDoc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.49 IsXmlElem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.50 IsXmlNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1859
1861
1863
1865
1868
1870
1872
1875
1877
1879
1881
1885
1888
1890
1892
1894
1896
1898
1900
1902
1904
1905
1907
1908
1910
1912
1913
1914
1916
1917
1918
1920
1921
1924
1926
1928
1930
1931
1933
1934
1936
1938
1939
1941
1942
1943
1944
1945
1946
1947
1948
1950
1952
1953
1954
1955
1956
1958
1960
1962
1963
1964
1966
1967
1968
1969
1973
1975
1977
1979
1981
1983

1.4.8.51 IsXmlRoot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.52 JavaCast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.53 JSStringFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.54 isSafeHTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.55 InvalidateOauthAccesstoken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.56 IsValidOauthAccesstoken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.8.57 InvokeCFClientFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9 Functions l . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.1 LCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.2 Left . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.3 Len . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.4 ListAppend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.5 ListChangeDelims . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.6 ListContains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.7 ListContainsNoCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.8 ListDeleteAt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.9 ListFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.10 ListFind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.11 ListFindNoCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.12 ListFirst . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.13 ListGetAt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.14 ListInsertAt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.15 ListLast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.16 ListLen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.17 ListPrepend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.18 ListQualify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.19 ListRemoveDuplicates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.20 ListRest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.21 ListSetAt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.22 ListSort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.23 ListToArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.24 ListValueCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.25 ListValueCountNoCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.26 LJustify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.27 Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.28 Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.29 Log10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.30 LSCurrencyFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.31 LSDateFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.32 LSDateTimeFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.33 LSEuroCurrencyFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.34 LSIsCurrency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.35 LSIsDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.36 LSIsNumeric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.37 LSNumberFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.38 LSParseCurrency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.39 LSParseDateTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.40 LSParseEuroCurrency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.41 LSParseNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.42 LSTimeFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.43 LTrim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.44 ListEach . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.45 ListReduce . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.9.46 ListMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10 Functions m-r . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.1 Max . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.2 Mid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.3 Min . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.4 Minute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.5 Month . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.6 MonthAsString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.7 Now . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.8 NumberFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.9 ObjectEquals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.10 ObjectLoad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.11 ObjectSave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.12 OnWSAuthenticate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.13 ORMClearSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.14 ORMCloseAllSessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.15 ORMCloseSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.16 ORMEvictCollection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.17 ORMEvictEntity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1985
1987
1991
1992
1994
1995
1996
1998
1999
2000
2002
2004
2006
2008
2010
2012
2014
2015
2017
2019
2021
2023
2025
2027
2029
2031
2033
2034
2036
2038
2041
2043
2045
2047
2049
2050
2052
2054
2058
2061
2063
2067
2069
2071
2073
2077
2079
2082
2084
2086
2089
2091
2093
2095
2096
2098
2099
2101
2102
2103
2105
2107
2108
2111
2112
2114
2116
2118
2119
2120
2121
2122

1.4.10.18 ORMEvictQueries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.19 ORMExecuteQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.20 ORMFlush . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.21 ORMFlushall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.22 ORMGetSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.23 ORMGetSessionFactory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.24 ORMIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.25 ORMIndexPurge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.26 ORMReload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.27 ORMSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.28 ORMSearchOffline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.29 ParagraphFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.30 ParameterExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.31 ParseDateTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.32 Pi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.33 PrecisionEvaluate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.34 Quarter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.35 PreserveSingleQuotes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.36 QueryAddColumn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.37 QueryAddRow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.38 QueryNew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.39 QueryConvertForGrid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.40 QuerySetCell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.41 QuotedValueList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.42 Rand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.43 Randomize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.44 RandRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.45 ReEscape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.46 REFind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.47 REFindNoCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.48 REMatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.49 REMatchNoCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.50 ReleaseComObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.51 RemoveCachedQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.52 RemoveChars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.53 RepeatString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.54 Replace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.55 ReplaceList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.56 ReplaceNoCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.57 REReplace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.58 REReplaceNoCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.59 RestDeleteApplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.60 RestSetResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.61 RestInitApplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.62 Reverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.63 Right . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.64 RJustify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.65 Round . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.66 RTrim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.67 QueryGetRow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.10.68 QueryExecute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11 Functions s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.1 Second . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.2 SendGatewayMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.3 SerializeJSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.4 SessionInvalidate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.5 SessionRotate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.6 SessionGetMetaData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.7 SetEncoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.8 SetLocale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.9 SetProfileString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.10 SetVariable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.11 Sgn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.12 Sin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.13 Sleep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.14 SpanExcluding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.15 SpanIncluding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.16 SpreadsheetAddColumn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.17 SpreadsheetAddImage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.18 SpreadsheetAddFreezePane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.19 SpreadsheetAddInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.20 SpreadsheetAddRow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2123
2124
2126
2127
2128
2129
2130
2131
2132
2133
2136
2138
2140
2141
2144
2145
2147
2148
2150
2153
2155
2158
2160
2162
2164
2166
2168
2170
2171
2175
2179
2180
2181
2183
2184
2186
2187
2189
2191
2193
2195
2197
2198
2199
2200
2202
2204
2206
2207
2209
2210
2213
2215
2216
2218
2225
2227
2229
2230
2232
2235
2238
2240
2241
2243
2245
2247
2249
2251
2253
2255
2257

1.4.11.21 SpreadsheetAddRows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.22 SpreadsheetAddSplitPane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.23 SpreadsheetCreateSheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.24 SpreadsheetDeleteColumn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.25 SpreadsheetDeleteColumns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.26 SpreadsheetDeleteRow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.27 SpreadsheetDeleteRows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.28 SpreadsheetFormatCell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.29 SpreadsheetFormatColumn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.30 SpreadsheetFormatCellRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.31 SpreadsheetFormatColumns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.32 SpreadsheetFormatRow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.33 SpreadsheetFormatRows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.34 SpreadsheetGetCellComment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.35 SpreadsheetGetCellFormula . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.36 SpreadsheetGetCellValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.37 SpreadsheetInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.38 SpreadsheetMergeCells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.39 SpreadsheetNew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.40 SpreadsheetRead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.41 SpreadsheetReadBinary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.42 SpreadsheetRemoveSheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.43 SpreadsheetSetActiveSheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.44 SpreadsheetSetActiveSheetNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.45 SpreadsheetSetCellComment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.46 SpreadsheetSetCellFormula . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.47 SpreadsheetSetCellValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.48 SpreadsheetSetColumnWidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.49 SpreadsheetSetFooter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.50 SpreadsheetSetHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.51 SpreadsheetSetRowHeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.52 SpreadsheetShiftColumns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.53 SpreadsheetShiftRows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.54 SpreadsheetWrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.55 Sqr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.56 StripCR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.57 StructAppend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.58 StructClear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.59 StructCopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.60 StructCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.61 StructDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.62 StructEach . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.63 StructFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.64 StructFind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.65 StructFindKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.66 StructFindValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.67 StructGet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.68 StructInsert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.69 StructIsEmpty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.70 StructKeyArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.71 StructKeyExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.72 StructKeyList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.73 StructNew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.74 StructSort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.75 StructUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.76 SpreadSheetAddPagebreaks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.77 SpreadSheetAddAutofilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.78 StructReduce . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.79 StructMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.80 Serialize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.11.81 SerializeXML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12 Functions t-z . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.1 Tan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.2 ThreadJoin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.3 ThreadTerminate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.4 Throw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.5 TimeFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.6 ToBase64 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.7 ToBinary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.8 ToScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.9 ToString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.10 Trace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2259
2261
2263
2265
2267
2269
2271
2273
2279
2281
2283
2285
2287
2289
2291
2293
2295
2297
2299
2301
2302
2303
2304
2306
2308
2312
2314
2316
2318
2320
2322
2324
2326
2328
2331
2332
2334
2336
2338
2343
2345
2347
2348
2349
2351
2353
2355
2357
2359
2361
2364
2366
2369
2371
2373
2375
2377
2379
2381
2382
2383
2384
2385
2387
2389
2390
2392
2395
2397
2399
2404
2407

1.4.12.11 Transactionandconcurrency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.12 TransactionCommit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.13 TransactionRollback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.14 TransactionSetSavePoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.15 Trim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.16 UCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.17 URLDecode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.18 URLEncodedFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.19 URLSessionFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.20 Val . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.21 ValueList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.22 VerifyClient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.23 Week . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.24 Wrap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.25 WriteDump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.26 WriteLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.27 WriteOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.28 WSGetAllChannels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.29 WSGetSubscribers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.30 WSPublish . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.31 WSSendMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.32 XmlChildPos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.33 XmlElemNew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.34 XmlFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.35 XmlGetNodeType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.36 XmlNew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.37 XmlParse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.38 XmlSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.39 XmlTransform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.40 XmlValidate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.41 Year . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.4.12.42 YesNoFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5 Ajax JavaScript Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.1 Function summary Ajax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.2 ColdFusion.Ajax.submitForm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3 ColdFusion.Autosuggest.getAutosuggestObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.1 ColdFusion.Chart.getChartHandle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.2 ColdFusion.FileUpload.cancelUpload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.3 ColdFusion.FileUpload.clearAllFiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.4 Coldfusion.fileUpload.setUrl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.5 ColdFusion.FileUpload.startUpload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.6 ColdFusion.getElementValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.7 ColdFusion.grid.clearSelectedRows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.8 ColdFusion.Grid.getBottomToolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.9 ColdFusion.Grid.getGridObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.10 ColdFusion.grid.getSelectedRows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.11 ColdFusion.Grid.getTopToolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.12 ColdFusion.Grid.hideBottomToolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.13 ColdFusion.Grid.hideTopToolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.14 ColdFusion.Grid.refresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.15 ColdFusion.Grid.refreshBottomToolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.16 ColdFusion.Grid.refreshTopToolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.17 ColdFusion.Grid.showBottomToolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.18 ColdFusion.Grid.showTopToolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.19 ColdFusion.Grid.sort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.20 ColdFusion.JSON.decode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.21 ColdFusion.JSON.encode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.22 ColdFusion.Layout.createTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.23 ColdFusion.Layout.collapseArea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.24 ColdFusion.Layout.collapseAccordion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.25 ColdFusion.Layout.createAccordionPanel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.3.26 ColdFusion.Layout.disableSourceBind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4 ColdFusion.Layout.enableSourceBind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.1 ColdFusion.Layout.expandAccordion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.2 ColdFusion.Layout.disableTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.3 ColdFusion.Layout.enableTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.4 ColdFusion.Layout.expandArea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.5 ColdFusion.Layout.getAccordionLayout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.6 ColdFusion.Layout.getBorderLayout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.7 ColdFusion.Layout.getTabLayout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.8 ColdFusion.Layout.hideAccordion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.9 ColdFusion.Layout.hideArea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2409
2411
2413
2414
2415
2416
2417
2419
2421
2423
2425
2427
2428
2430
2432
2434
2437
2438
2439
2440
2442
2443
2445
2447
2449
2451
2453
2457
2460
2463
2468
2470
2472
2473
2479
2481
2483
2484
2486
2488
2490
2492
2494
2499
2500
2501
2502
2503
2504
2505
2507
2511
2512
2513
2514
2515
2517
2518
2522
2523
2524
2527
2529
2531
2533
2535
2536
2537
2538
2539
2540
2542

1.5.4.10 ColdFusion.Layout.hideTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.11 ColdFusion.Layout.selectAccordion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.12 ColdFusion.Layout.selectTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.13 ColdFusion.Layout.showAccordion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.14 ColdFusion.Layout.showArea . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.15 ColdFusion.Layout.showTab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.16 ColdFusion.Log.debug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.17 ColdFusion.Log.dump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.18 ColdFusion.Log.error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.19 ColdFusion.Log.info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.20 ColdFusion.Map.addEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.21 ColdFusion.Map.addMarker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.22 ColdFusion.Map.getLatitudeLongitude . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.23 ColdFusion.Map.getMapObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.24 ColdFusion.Map.hide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.25 ColdFusion.Map.refresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.26 ColdFusion.Map.setCenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.27 ColdFusion.Map.setZoomlevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.28 ColdFusion.Map.show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.29 ColdFusion.MediaPlayer.getPlayer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.30 ColdFusion.Mediaplayer.getType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.31 ColdFusion.Mediaplayer.logError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.32 ColdFusion.Mediaplayer.resize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.33 ColdFusion.Mediaplayer.setTitle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.34 ColdFusion.Mediaplayer.setMute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.35 ColdFusion.Mediaplayer.setSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.36 ColdFusion.Mediaplayer.setVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.37 ColdFusion.Mediaplayer.startPlay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.38 ColdFusion.Mediaplayer.stopPlay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.39 ColdFusion.MessageBox.create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.4.40 ColdFusion.MessageBox.show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.5 ColdFusion.MessageBox.getMessageBoxObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.6 ColdFusion.MessageBox.isMessageBoxDefined . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.6.1 ColdFusion.MessageBox.update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.6.2 ColdFusion.MessageBox.updateMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.6.3 ColdFusion.MessageBox.updateTitle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.6.4 ColdFusion.navigate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7 ColdFusion.ProgressBar.getProgressBarObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.1 ColdFusion.ProgressBar.hide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.2 ColdFusion.ProgressBar.reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.3 ColdFusion.ProgressBar.show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.4 ColdFusion.ProgressBar.start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.5 ColdFusion.ProgressBar.stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.6 ColdFusion.ProgressBar.update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.7 ColdFusion.ProgressBar.updatestatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.8 ColdFusion.RichText.getEditorObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.9 ColdFusion.RichText.onComplete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.10 ColdFusion.setGlobalErrorHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.11 ColdFusion.Slider.disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.12 ColdFusion.Slider.enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.13 ColdFusion.Slider.getSliderObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.14 ColdFusion.Slider.getValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.15 ColdFusion.Slider.hide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.16 ColdFusion.Slider.setValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.17 ColdFusion.Slider.show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.18 ColdFusion.Tree.getTreeObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.19 ColdFusion.Tree.refresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.20 ColdFusion.Window.create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.21 ColdFusion.Window.destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.22 ColdFusion.Window.getWindowObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.23 ColdFusion.Window.hide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.24 ColdFusion.Window.onHide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.25 ColdFusion.Window.onShow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.7.26 ColdFusion.Window.show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.5.8 JavaScriptFunctionsinColdFusion9Update1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.6 Script Functions Implemented as CFCs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.6.1 Accessing the functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.6.2 Function summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.6.3 ftp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.6.4 http . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.6.5 mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.6.6 pdf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2543
2545
2547
2549
2550
2551
2552
2554
2556
2558
2560
2562
2564
2566
2568
2569
2571
2573
2575
2576
2577
2579
2580
2582
2584
2586
2588
2590
2592
2594
2598
2599
2600
2601
2604
2605
2606
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2620
2621
2622
2624
2625
2627
2629
2631
2633
2634
2635
2639
2640
2641
2643
2645
2647
2648
2670
2671
2672
2673
2677
2683
2689

1.6.7 query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.6.8 storedproc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.6.9 Script functions implemented as CFCs in ColdFusion 9 Update 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.7 ColdFusion Flash Form Style Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.7.1 Styles valid for all controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.7.2 Styles for cfform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.7.3 Styles for cfformgroup with horizontal or vertical type attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.7.4 Styles for box-style cfformgroup elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.7.5 Styles for cfformgroup with accordion type attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.7.6 Styles for cfformgroup with tabnavigator type attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.7.7 Styles for cfformitem with hrule or vrule type attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.7.8 Styles for cfinput with radio, checkbox, button, image, or submit type attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.7.9 Styles for cftextarea tag and cfinput with text, password, or hidden type attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.7.10 Styles for cfselect with size attribute value of 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.7.11 Styles for cfselect with size attribute value greater than 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.7.12 Styles for cfcalendar tag and cfinput with dateField type attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.7.13 Styles for the cfgrid tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.7.14 Styles for the cftree tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.8 Application.CFC Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.8.1 Application variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.8.2 Method summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.8.3 onAbort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.8.4 onApplicationEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.8.5 onApplicationStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.8.6 onCFCRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.8.7 onError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.8.8 onMissingTemplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.8.9 onRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.8.10 onRequestEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.8.11 onRequestStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.8.12 onServerStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.8.13 onSessionEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.8.14 onSessionStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9 ColdFusion Event Gateway Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.1 addEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.2 CFEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.3 CFEventclass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.4 Constructor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.5 Gateway development interfaces and classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.6 GatewayHelper interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.7 Gateway interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.8 GatewayServices class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.9 getCFCMethod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.10 getCFCPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.11 setCFCTimeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.12 getCFCTimeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.13 getData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.14 getGatewayID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.15 getGatewayID_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.16 getGatewayServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.17 getGatewayType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.18 getHelper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.19 getLogger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.20 getMaxQueueSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.21 getOriginatorID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.22 setCFCMethod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.23 setCFCPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.24 getQueueSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.25 getStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.26 outgoingMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.27 restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.28 setCFCListeners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.29 setData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.30 setGatewayID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.31 setGatewayType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.32 setOriginatorID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.33 start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.34 stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.35 Logger class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.36 debug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.37 error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.38 fatal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2694
2700
2705
2721
2722
2726
2727
2728
2731
2732
2733
2734
2736
2737
2738
2739
2740
2741
2742
2743
2753
2754
2756
2758
2760
2762
2764
2766
2768
2770
2772
2773
2775
2776
2778
2780
2782
2783
2785
2786
2787
2788
2789
2790
2791
2793
2794
2796
2797
2798
2799
2800
2801
2803
2804
2806
2808
2810
2811
2812
2814
2815
2817
2819
2820
2822
2824
2826
2828
2829
2831
2833

1.9.39 info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.40 warn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.41 CFML CFEvent structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.42 IM gateway methods and commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.43 IM Gateway CFC incoming message methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.44 onAddBuddyRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.45 onAddBuddyResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.46 onBuddyStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.47 onIMServerMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.48 onIncomingMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.49 IM Gateway GatewayHelper class methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.50 IM gateway message sending commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.51 addBuddy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.52 addDeny . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.53 addPermit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.54 getBuddyInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.55 getBuddyList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.56 getCustomAwayMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.57 getDenyList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.58 getName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.59 getNickName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.60 getPermitList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.61 getPermitMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.62 getProtocolName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.63 getStatusAsString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.64 getStatusTimeStamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.65 numberOfMessagesReceived . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.66 numberOfMessagesSent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.67 removeBuddy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.68 removeDeny . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.69 removePermit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.70 setNickName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.71 setPermitMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.72 setStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.73 SMS Gateway CFEvent structure and commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.74 SMS Gateway incoming message CFEvent structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.75 SMS gateway message sending commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.76 submit command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.77 submit Multi command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.78 data command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.9.79 CFML event gateway SendGatewayMessage data parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.10 ColdFusion C++ CFX Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.10.1 C++ class overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.10.2 Deprecated class methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.10.3 CCFXException class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.10.4 CCFXQuery class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.10.5 CCFXRequest class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.10.6 CCFXStringSet class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.11 ColdFusion Java CFX Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.11.1 Class libraries overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.11.2 Custom tag interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.11.3 Query interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.11.4 Request interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.11.5 Response interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.11.6 Debugging classes reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.12 WDDX JavaScript Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.12.1 JavaScript object overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.12.2 WddxRecordset object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.12.3 WddxSerializer object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.13 ColdFusion ActionScript Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.13.1 CF.http . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.13.2 CF.query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14 ColdFusion Mobile Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.1 Accelerometer Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.1.1 cfclient.accelerometer.clearWatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.1.2 cfclient.accelerometer.getOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.1.3 cfclient.accelerometer.setOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.1.4 cfclient.accelerometer.watch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.2 Camera Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.2.1 cfclient.camera.cleanup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.2.2 cfclient.camera.getOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.2.3 cfclient.camera.getPicture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2834
2836
2838
2839
2840
2841
2844
2846
2849
2851
2853
2854
2855
2857
2858
2859
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2881
2882
2884
2885
2887
2889
2891
2893
2894
2895
2896
2898
2903
2915
2919
2920
2921
2923
2929
2935
2939
2940
2941
2942
2950
2955
2956
2964
2967
2968
2969
2970
2971
2972
2974
2975
2976
2977

1.14.2.4 cfclient.camera.getPictureFromAlbum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.2.5 cfclient.camera.getPictureFromPhotoLibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.2.6 cfclient.camera.setOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.2.7 options Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.3 Connection Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.3.1 cfclient.connection.getType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.3.2 cfclient.connection.onOffline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.3.3 cfclient.connection.onOnline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.4 Contact Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.4.1 Contact Creation Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.4.2 Contacts Searching Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.5 Event Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.5.1 cfclient.events.onBackButton . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.5.2 cfclient.events.onBatteryCritical . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.5.3 cfclient.events.onBatteryLow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.5.4 cfclient.events.onBatteryStatusChange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.5.5 cfclient.events.onMenuButton . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.5.6 cfclient.events.onPause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.5.7 cfclient.events.onResume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.5.8 cfclient.events.onSearchButton . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6 File System Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.1 cfclient.file.append . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.2 cfclient.file.copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.3 cfclient.file.copyDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.4 cfclient.file.createDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.5 cfclient.file.directoryExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.6 cfclient.file.download . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.7 cfclient.file.exists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.8 cfclient.file.get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.9 cfclient.file.getDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.10 cfclient.file.getWorkingDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.11 cfclient.file.listDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.12 cfclient.file.move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.13 cfclient.file.moveDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.14 cfclient.file.read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.15 cfclient.file.readAsBase64 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.16 cfclient.file.remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.17 cfclient.file.removeDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.18 cfclient.file.renameDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.19 cfclient.file.setFileSystem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.20 cfclient.file.setWorkingDirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.21 cfclient.file.upload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.22 cfclient.file.write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.23 DirectoryEntry Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.24 FileEntry Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.6.25 rename Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.7 Geolocation Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.7.1 cfclient.geolocation.clearWatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.7.2 cfclient.geolocation.getCurrentPosition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.7.3 cfclient.geolocation.getOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.7.4 cfclient.geolocation.setOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.7.5 cfclient.geolocation.watchPosition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.8 Media and Capture Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.8.1 Audio Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.8.2 Video Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.9 Notification Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.9.1 cfclient.notification.alert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.9.2 cfclient.notification.beep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.9.3 cfclient.notification.confirm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.9.4 cfclient.notification.vibrate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.10 Splash Screen Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.10.1 cfclient.splashscreen.hide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.10.2 cfclient.splashscreen.show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.11 Storage Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.11.1 cfclient.localstorage.clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.11.2 cfclient.localstorage.getItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.11.3 cfclient.localstorage.removeItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1.14.11.4 cfclient.localstorage.setItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

2979
2980
2982
2983
2984
2985
2986
2987
2988
2989
2992
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053

Adobe ColdFusion Documentation

Adobe ColdFusion CFML Reference
The CFML Reference is your primary ColdFusion Markup Language (CFML) reference. Use this manual to learn
about CFML tags and functions, ColdFusion expressions, and using JavaScript objects for WDDX in Adobe
ColdFusion. It also provides detailed references for Java and C++ CFX interfaces.
CFML Reference (ColdFusion 11)
Reserved Words and Variables
ColdFusion Tags
ColdFusion Functions
Ajax JavaScript Functions
Script Functions Implemented as CFCs
ColdFusion Flash Form Style Reference
Application.CFC Reference
ColdFusion Event Gateway Reference
ColdFusion C++ CFX Reference
ColdFusion Java CFX Reference
WDDX JavaScript Objects
ColdFusion ActionScript Functions
ColdFusion Mobile Functions

© 2014 Adobe Systems Incorporated. All rights reserved.

19

Adobe ColdFusion Documentation

CFML Reference (ColdFusion 11)
New functions
The following new functions are added:
GetSafeHTML
isSafeHTML
ImageGetMetadata
GeneratePBKDFKey
SpreadSheetAddPagebreaks
SpreadSheetAddAutofilter
QueryExecute
QueryGetRow
ListMap
ListReduce
ListEach
ArrayMap
ArrayReduce
StructMap
StructReduce
Serialize
CanSerialize
SerializeXML
Deserialize
CanDeSerialize
DeserializeXML
InvalidateOauthAccesstoken
IsValidOauthAccesstoken
EncodeForXpath
EncodeForXMLAttribute
InvokeCFClientFunction

Changes in functions
The following functions are enhanced:
Canonicalize
cflocation
EncodeForCSS
EncodeForHTML
EncodeForHTMLAttribute
EncodeForJavaScript
EncodeForURL
EncodeForXML
SpreadsheetAddColumn
SpreadsheetWrite
SpreadsheetSetCellValue
SpreadsheetAddRows
SpreadsheetAddRow
GetProfileSections
SetProfileString
GetProfileString

© 2014 Adobe Systems Incorporated. All rights reserved.

20

Adobe ColdFusion Documentation

DirectoryList
SerializeJSON
DeserializeJSON
RestInitApplication
CacheRemove

New tags
The following tags have been added:
cfimapfilter
cfoauth
cfclient
cfclientsettings
cfhtmltopdf
cfhtmltopdfitem
cf_socialplugin

Changes in tags
The following tags are enhanced:
cfexchangecalendar
cffile action = "uploadAll"
cfmail
cfzip
cflogout
cflogin
cfspreadsheet
cfldap
cflocation
cfpdf
cfwebsocket

Mobile functions
See ColdFusion Mobile Functions

Other changes
For a list of other changes, see New in ColdFusion.

© 2014 Adobe Systems Incorporated. All rights reserved.

21

Adobe ColdFusion Documentation

Reserved Words and Variables
Adobe ColdFusion language includes reserved words and scope variables.
Reserved words
Scope-specific built-in variables
Custom tag variables
ColdFusion tag-specific variables
CGI environment (CGI Scope) variables

#back to top

© 2014 Adobe Systems Incorporated. All rights reserved.

22

Adobe ColdFusion Documentation

Reserved words
The following list indicates words you must not use for ColdFusion variables, user-defined function names, or
custom tag names. Although you can safely use some of these words in some situations, you can prevent errors by
avoiding them entirely.
Any name starting with cf. However, when you call a CFML custom tag directly, you prefix the custom tag
page name with cf_.
Built-in function names, such as Now or Hash
Scope names, such as Form or Session
Operators, such as NE or IS
The names of any built-in data structures, such as Error or File
The names of any built-in variables, such as RecordCount or CGI variable names
The following CFScript language element names:
for
default
continue
import
finally
local (inside function declaration)
interface
pageencoding
Remember that ColdFusion is not case sensitive. For example, all of the following are reserved words:
IS, Is, iS, and is.
Note
Keywords in the newly added statements, such as abort, rethrow, param, and so on
are not reserved.

© 2014 Adobe Systems Incorporated. All rights reserved.

23

Adobe ColdFusion Documentation

Reserved words in forms
Do not create form field names that end in any of the following, except to specify a form field validation rule by using
a hidden form field name.
_integer
_float
_range
_date
_time
_eurodate

© 2014 Adobe Systems Incorporated. All rights reserved.

24

Adobe ColdFusion Documentation

Reserved words in queries
The following table lists SQL keywords that are reserved in ColdFusion queries of queries. This list includes all
reserved words in the SQL standard. Avoid them in variables used in all queries. Do not use these keywords as
variable names in any queries.
Note
Many database management systems have additional reserved words that you cannot use as
variable names in queries to their databases. For a detailed list, see your DBMS documentation.

ABSOLUTE

ACTION

ADD

ALL

ALLOCATE

ALTER

AND

ANY

ARE

AS

ASC

ASSERTION

AT

AUTHORIZATION

AVG

BEGIN

BETWEEN

BIT

BIT_LENGTH

BOTH

BY

CASCADE

CASCADED

CASE

CAST

CATALOG

CHAR

CHARACTER

CHARACTER_LEN
GTH

CHAR_LENGTH

CHECK

CLOSE

COALESCE

COLLATE

COLLATION

COLUMN

COMMIT

CONNECT

CONNECTION

CONSTRAINT

CONSTRAINTS

CONTINUE

CONVERT

CORRESPONDING

COUNT

CREATE

CROSS

CURRENT

CURRENT_DATE

CURRENT_TIME

CURRENT_TIMEST
AMP

CURRENT_USER

CURSOR

DATE

DAY

DEALLOCATE

DEC

DECIMAL

DECLARE

DEFAULT

DEFERRABLE

DEFERRED

DELETE

DESC

DESCRIBE

DESCRIPTOR

DIAGNOSTICS

DISCONNECT

DISTINCT

DOMAIN

DOUBLE

DROP

ELSE

END

END-EXEC

ESCAPE

EXCEPT

EXCEPTION

EXEC

EXECUTE

EXISTS

EXTERNAL

EXTRACT

FALSE

FETCH

FIRST

FLOAT

FOR

FOREIGN

FOUND

© 2014 Adobe Systems Incorporated. All rights reserved.

25

Adobe ColdFusion Documentation

FROM

FULL

GET

GLOBAL

GO

GOTO

GRANT

GROUP

HAVING

HOUR

IDENTITY

IMMEDIATE

IN

INDICATOR

INITIALLY

INNER

INPUT

INSENSITIVE

INSERT

INT

INTEGER

INTERSECT

INTERVAL

INTO

IS

ISOLATION

JOIN

KEY

LANGUAGE

LAST

LEADING

LEFT

LEVEL

LIKE

LOCAL

LOWER

MATCH

MAX

MIN

MINUTE

MODULE

MONTH

NAMES

NATIONAL

NATURAL

NCHAR

NEXT

NO

NOT

NULL

NULLIF

NUMERIC

OCTET_LENGTH

OF

ON

ONLY

OPEN

OPTION

OR

ORDER

OUTER

OUTPUT

OVERLAPS

PAD

PARTIAL

POSITION

PRECISION

PREPARE

PRESERVE

PRIMARY

PRIOR

PRIVILEGES

PROCEDURE

PUBLIC

READ

REAL

REFERENCES

RELATIVE

RESTRICT

REVOKE

RIGHT

ROLLBACK

ROWS

SCHEMA

SCROLL

SECOND

SECTION

SELECT

SESSION

SESSION_USER

SET

SIZE

SMALLINT

SOME

SPACE

SQL

SQLCODE

SQLERROR

SQLSTATE

SUBSTRING

SUM

SYSTEM_USER

TABLE

TEMPORARY

THEN

TIME

TIMESTAMP

TIMEZONE_HOUR

TIMEZONE_MINUT
E

TO

TRAILING

TRANSACTION

TRANSLATE

TRANSLATION

TRIM

© 2014 Adobe Systems Incorporated. All rights reserved.

26

Adobe ColdFusion Documentation

TRUE

UNION

UNIQUE

UNKNOWN

UPDATE

UPPER

USAGE

USER

USING

VALUE

VALUES

VARCHAR

VARYING

VIEW

WHEN

WHENEVER

WHERE

WITH

WORK

WRITE

YEAR

ZONE

#back to top

© 2014 Adobe Systems Incorporated. All rights reserved.

27

Adobe ColdFusion Documentation

Scope-specific built-in variables
ColdFusion returns variables, such as those returned in a cfdirectory or cfftp operation. A variable is usually
referenced by scoping it according to its type: naming it according to the code context in which it is available; for
example, Session.varname, or Application.varname. For more information on ColdFusion scopes, see Using
ColdFusion Variables in the Developing ColdFusion Applications
You use the cflock tag to limit the scope of CFML constructs that modify shared data structures, files, and CFXs,
to ensure that modifications occur sequentially. For more information, see cflock, and Using Persistent Data and
Locking in the Developing ColdFusion Applications.

© 2014 Adobe Systems Incorporated. All rights reserved.

28

Adobe ColdFusion Documentation

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 the statement  can be
referenced as{{#Variables.linguist#}}.

© 2014 Adobe Systems Incorporated. All rights reserved.

29

Adobe ColdFusion Documentation

Caller scope
History

ColdFusion MX: The Caller scope is accessible as a structure. (In earlier releases, it was not.)

© 2014 Adobe Systems Incorporated. All rights reserved.

30

Adobe ColdFusion Documentation

CGI variables
see CGI environment (CGI Scope) variables

© 2014 Adobe Systems Incorporated. All rights reserved.

31

Adobe ColdFusion Documentation

Client variables
The following client variables are reserved:

Client.CFID
Client.CFToken
Client.HitCount
Client.LastVisit
Client.TimeCreated
Client.URLToken

© 2014 Adobe Systems Incorporated. All rights reserved.

32

Adobe ColdFusion Documentation

Server variables
Use the Server prefix to reference server variables, as follows:

Server.ColdFusion.ProductName
Server.ColdFusion.ProductVersion
Server.ColdFusion.ProductLevel
Server.ColdFusion.SerialNumber
Server.ColdFusion.SupportedLocales
Server.ColdFusion.AppServer
Server.ColdFusion.Expiration
Server.ColdFusion.RootDir
Server.ColdFusion.UpdateLevel
Server.OS.Name
Server.OS.AdditionalInformation
Server.OS.Version
Server.OS.BuildNumber

© 2014 Adobe Systems Incorporated. All rights reserved.

33

Adobe ColdFusion Documentation

Application and session variables
To enable application and session variables, use the cfapplication tag or Application.cfc. Reference them as
follows:

Application.myvariable
Session.myvariable

To ensure that modifications to shared data occur in the intended sequence, use the cflock tag. For more
information, see cflock.
ColdFusion provides the following predefined application and session variables:

Application.ApplicationName
Session.CFID
Session.CFToken
Session.URLToken

#back to top

© 2014 Adobe Systems Incorporated. All rights reserved.

34

Adobe ColdFusion Documentation

Custom tag variables
A ColdFusion custom tag returns the following variables:

ThisTag.ExecutionMode
ThisTag.HasEndTag
ThisTag.GeneratedContent
ThisTag.AssocAttribs[index]

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



The calling page can access the variable with the cfoutput tag, as follows:

#variable_name#

© 2014 Adobe Systems Incorporated. All rights reserved.

35

Adobe ColdFusion Documentation

Request variable
Request variables store data about the processing of one page request. Request variables store data in a structure
that can be passed to nested tags, such as custom tags, and processed once.
To provide information to nested tags, set a Request variable, as follows:




...

Each nested tag can access the variable with the cfoutput tag, as follows:

#Request.field_name1#

© 2014 Adobe Systems Incorporated. All rights reserved.

36

Adobe ColdFusion Documentation

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

Form.FieldNames

#back to top

© 2014 Adobe Systems Incorporated. All rights reserved.

37

Adobe ColdFusion Documentation

ColdFusion tag-specific variables
Some 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 you can reference in variables:

cfcatch
cfdirectory
cferror
cffile
cfftp
cfhttp
cfindex
cfldap
cfpop
cfquery
cfregistry
cfsearch
cfstoredproc

© 2014 Adobe Systems Incorporated. All rights reserved.

38

Adobe ColdFusion Documentation

ColdFusion query variables
A ColdFusion tag that returns a query object supports the following variables, where queryname is the value of the n
ame attribute:

queryname.CurrentRow
queryname.RecordCount
queryname.ColumnList

© 2014 Adobe Systems Incorporated. All rights reserved.

39

Adobe ColdFusion Documentation

CFCATCH variables
Within a cfcatch block, the active exception properties can be accessed as the following 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

Within a cfcatch block, database exception properties can be accessed as the following variables:

CFCATCH.QueryError
CFCATCH.SQL
CFCATCH.Where
CFCATCH.Datasource

Within a cfcatch block, undefined variable exception properties can be accessed as the following variable:

CFCATCH.Name

Within a cfcatch block, syntax and parsing exception properties can be accessed as the following variables:

CFCATCH.TokenText
CFCATCH.Snippet
CFCATCH.Column
CFCATCH.KnownColumn
CFCATCH.Line
CFCATCH.KnownLine

© 2014 Adobe Systems Incorporated. All rights reserved.

40

Adobe ColdFusion Documentation

CFDIRECTORY variables
The cfdirectory tag, with action=list, returns a query object as follows, where queryname is the name attribu
te value:

queryname.Name
queryname.Size
queryname.Type
queryname.DateLastModified
queryname.Attributes
queryname.Mode

© 2014 Adobe Systems Incorporated. All rights reserved.

41

Adobe ColdFusion Documentation

CFERROR variables
When cferror generates an error page, the following error variables are available if type="request" or "excep
tion".

Error.Diagnostics
Error.MailTo
Error.DateTime
Error.Browser
Error.GeneratedContent
Error.RemoteAddress
Error.HTTPReferer
Error.Template
Error.QueryString

The following error variables are available if type="validation".

Error.ValidationHeader
Error.InvalidFields
Error.ValidationFooter

Any cfcatch variable that applies to exception type can be accessed within the Error scope, as follows:

Error.Type
Error.Message
Error.Detail
Error.ErrNumber
Error.NativeErrorCode
Error.SQLState
Error.LockName
Error.LockOperation
Error.MissingFileName
Error.TagContext
Error.ErrorCode
Error.ExtendedInfo

Note
You can substitute the prefix CFERROR for Error, if type = "Exception"; for example, CFER
ROR.Diagnostics, CFERROR.Mailto, or CFERROR.DateTime.

© 2014 Adobe Systems Incorporated. All rights reserved.

42

Adobe ColdFusion Documentation

CFFILE ACTION=Upload variables
File variables are read-only. Use the CFFILE prefix to reference file variables, for example, CFFILE.ClientDirec
tory. 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

© 2014 Adobe Systems Incorporated. All rights reserved.

43

Adobe ColdFusion Documentation

CFFTP error variables
When you use the cfftp stoponerror attribute, the following variables are populated:

CFFTP.Succeeded
CFFTP.ErrorCode
CFFTP.ErrorText

© 2014 Adobe Systems Incorporated. All rights reserved.

44

Adobe ColdFusion Documentation

CFFTP ReturnValue variable
Some cfftp file and directory operations provide a return value, in the variable CFFTP.ReturnValue. Its value is
determined by the results of the action attribute. When you specify any of the following actions, cfftp returns a
value:

GetCurrentDir
GetCurrentURL
ExistsDir
ExistsFile
Exists

© 2014 Adobe Systems Incorporated. All rights reserved.

45

Adobe ColdFusion Documentation

CFFTP query object columns
When you use the cfftp tag with the listdir action, cfftp returns a query object, where queryname is the nam
e attribute value, and row__ is the row number of each file or directory entry:

queryname.Name[row]
queryname.Path[row]
queryname.URL[row]
queryname.Length[row]
queryname.LastModified[row]
queryname.Attributes
queryname.IsDirectory
queryname.Mode

© 2014 Adobe Systems Incorporated. All rights reserved.

46

Adobe ColdFusion Documentation

CFHTTP variables
A cfhttp get operation can return text and binary files. Files are downloaded and the contents stored in a
variable or file, depending on the MIME type, as follows:

CFHTTP.FileContent
CFHTTP.MimeType
CFHTTP.Header
CFHTTP.ResponseHeader[http_hd_key]
CFHTTP.StatusCode

© 2014 Adobe Systems Incorporated. All rights reserved.

47

Adobe ColdFusion Documentation

CFLDAP variables
The cfldap action=query tag returns information about the LDAP query, as follows:

queryname.CurrentRow
queryname.RecordCount
queryname.ColumnList

© 2014 Adobe Systems Incorporated. All rights reserved.

48

Adobe ColdFusion Documentation

CFPOP variables
The cfpop tag returns the following result columns, depending on the action attribute value and the use of other
attributes, such as attachmentpath, where queryname is the name attribute value:

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

© 2014 Adobe Systems Incorporated. All rights reserved.

49

Adobe ColdFusion Documentation

CFQUERY and CFSTOREDPROC variables
The cfquery tag returns information about the query in this variable:

CFQUERY.ExecutionTime

The cfquery tag uses the query name to scope the following data about the query:

queryname.CurrentRow
queryname.RecordCount
queryname.ColumnList

The cfstoredproc tag returns the following variables:

CFSTOREDPROC.ExecutionTime
CFSTOREDPROC.StatusCode

© 2014 Adobe Systems Incorporated. All rights reserved.

50

Adobe ColdFusion Documentation

CFREGISTRY variables
The cfregistry tag returns a query record set that you can reference after executing the GetAll action, as
follows, where queryname is the name attribute value:

queryname.Entry
queryname.Type
queryname.Value

© 2014 Adobe Systems Incorporated. All rights reserved.

51

Adobe ColdFusion Documentation

CFSEARCH variables
A cfsearch operation returns the following variables, where searchname is the name attribute value:

searchname.URL
searchname.Key
searchname.Title
searchname.Score
searchname.Custom1 and Custom2
searchname.Summary
searchname.RecordCount
searchname.CurrentRow
searchname.RecordsSearched
searchname.ColumnList

#back to top

© 2014 Adobe Systems Incorporated. All rights reserved.

52

Adobe ColdFusion Documentation

CGI environment (CGI Scope) variables
When a browser makes a request to a server, the web server and the browser create environment variables. In
ColdFusion, these variables are referred to as CGI environment variables. CGI Environment variables contain data
about the transaction between the browser and the server, such as the IP Address, browser type, and authenticated
username. The available CGI variables depend on the browser and server software.
The CGI variables are available to ColdFusion pages in the CGI scope. They take the CGI prefix regardless of
whether the server uses a server API or CGI to communicate with the ColdFusion server. You can reference CGI
environment variables for a given page request anywhere in the page. CGI variables are read-only.
By default, when you use the cfdump tag to display the CGI scope, or when you request debug output of the CGI
scope, ColdFusion attempts to display a fixed list of standard CGI environment variables. Because the available
variables depend on the server, browser, and the types of interactions between the two, not all variables are
normally available. They are represented by empty strings in the debug output. You can request any CGI variable in
your application code, including variables that are not in the list variables displayed by dump and debug output.
ColdFusion checks for the following variables for the cfdump tag and debug output:

© 2014 Adobe Systems Incorporated. All rights reserved.

53

Adobe ColdFusion Documentation

AUTH_PASSWORD
AUTH_TYPE
AUTH_USER
CERT_COOKIE
CERT_FLAGS
CERT_ISSUER
CERT_KEYSIZE
CERT_SECRETKEYSIZE
CERT_SERIALNUMBER
CERT_SERVER_ISSUER
CERT_SERVER_SUBJECT
CERT_SUBJECT
CF_TEMPLATE_PATH
CONTENT_LENGTH
CONTENT_TYPE
CONTEXT_PATH
GATEWAY_INTERFACE
HTTPS
HTTPS_KEYSIZE
HTTPS_SECRETKEYSIZE
HTTPS_SERVER_ISSUER
HTTPS_SERVER_SUBJECT
HTTP_ACCEPT
HTTP_ACCEPT_ENCODING
HTTP_ACCEPT_LANGUAGE
HTTP_CONNECTION
HTTP_COOKIE
HTTP_HOST
HTTP_REFERER
HTTP_USER_AGENT
QUERY_STRING
REMOTE_ADDR
REMOTE_HOST
REMOTE_USER
REQUEST_METHOD
SCRIPT_NAME
SERVER_NAME
SERVER_PORT
SERVER_PORT_SECURE
SERVER_PROTOCOL
SERVER_SOFTWARE
WEB_SERVER_API (This value is always blank; retained for compatibility.)

The following sections describe how to test for CGI environment variables and provide information on some of the
more commonly used CGI environment variables

© 2014 Adobe Systems Incorporated. All rights reserved.

54

Adobe ColdFusion Documentation

Testing for CGI variables
Because some browsers do not support some CGI variables, ColdFusion always returns true when it tests for the
existence of a CGI variable, regardless of whether the browser supports the variable. To determine if the CGI
variable is available, test for an empty string, as the following example shows:


CGI variable exists

CGI variable does not exist


© 2014 Adobe Systems Incorporated. All rights reserved.

55

Adobe ColdFusion Documentation

CGI server variables
The following table describes common CGI environment variables that the server creates (some variables are not
available with some servers):
CGI server variable

Description

SERVER_SOFTWARE

Name and version of the information server software
answering the request (and running the gateway).
Format: name/version.

SERVER_NAME

Server's hostname, DNS alias, or IP address as it
appears in self-referencing URLs.

GATEWAY_INTERFACE

CGI specification revision with which this server
complies. Format: CGI/revision.

SERVER_PROTOCOL

Name and revision of the information protocol this
request came in with. Format: protocol/revision.

SERVER_PORT

Port number to which the request was sent.

REQUEST_METHOD

Method with which the request was made. For HTTP,
this is Get, Head, Post, and so on.

PATH_INFO

Extra path information, as given by the client. Scripts
can be accessed by their virtual pathname, followed by
extra information at the end of this path. The extra
information is sent as PATH_INFO.

PATH_TRANSLATED

Translated version of PATH_INFO after any
virtual-to-physical mapping.

SCRIPT_NAME

Virtual path to the script that is executing; used for
self-referencing URLs.

QUERY_STRING

Query information that follows the ? in the URL that
referenced this script.

REMOTE_HOST

Hostname making the request. If the server does not
have this information, it sets REMOTE_ADDR and does
not set REMOTE_HOST.

REMOTE_ADDR

IP address of the remote host making the request.

AUTH_TYPE

If the server supports user authentication, and the
script is protected, the protocol-specific authentication
method used to validate the user.

© 2014 Adobe Systems Incorporated. All rights reserved.

56

Adobe ColdFusion Documentation

REMOTE_USER AUTH_USER

If the server supports user authentication, and the
script is protected, the username the user has
authenticated as. (Also available as AUTH_USER.)

REMOTE_IDENT

If the HTTP server supports RFC 931 identification, this
variable is set to the remote username retrieved from
the server. Use this variable for logging only.

CONTENT_TYPE

For queries that have attached information, such as
HTTP POST and PUT, this is the content type of the
data.

CONTENT_LENGTH

Length of the content as given by the client.

© 2014 Adobe Systems Incorporated. All rights reserved.

57

Adobe ColdFusion Documentation

CGI client variables
The following table describes common CGI environment variables the browser creates and passes in the request
header:
CGI client variable

Description

HTTP_REFERER

The referring document that linked to or submitted form
data.

HTTP_USER_AGENT

The browser that the client is currently using to send
the request. Format: software/version library/version.

HTTP_IF_MODIFIED_SINCE

The last time the page was modified. The browser
determines whether to set this variable, usually in
response to the server having sent the LAST_MODIFIE
D HTTP header. It can be used to take advantage of
browser-side caching.

© 2014 Adobe Systems Incorporated. All rights reserved.

58

Adobe ColdFusion Documentation

CGI client certificate variables
ColdFusion makes available the following client certificate data. These variables are available when running
Microsoft IIS 4.0 or Netscape Enterprise under SSL if your web server is configured to accept client certificates.
CGI client certificate variable

Description

CERT_SUBJECT

Client-specific information provided by the web server.
This data typically includes the client's name, e-mail
address, and so on, for example:O = "VeriSign,
Inc.", OU = VeriSign Trust Network, OU =
"www.verisign.com/repository/RPA Incorp.
by Ref.,LIAB.LTD(c)98", OU = Persona Not
Validated, OU = Digital ID Class 1 Microsoft, CN = Matthew Lund, E =
mlund@.com

CERT_ISSUER

Information about the authority that provided the client
certificate, for example:O = "VeriSign, Inc.",
OU = VeriSign Trust Network, OU =
"www.verisign.com/repository/RPA Incorp.
By Ref.,LIAB.LTD(c)98", CN = VeriSign
Class 1 CA Individual Subscriber-Persona
Not Validated

© 2014 Adobe Systems Incorporated. All rights reserved.

59

Adobe ColdFusion Documentation

ColdFusion Tags
ColdFusion Markup Language (CFML) includes a set of tags that you use in ColdFusion pages to interact with data
sources, manipulate data, and display output. CFML tag syntax is similar to HTML element syntax.
Tags in ColdFusion 10
Tag summary
Tags by function
Tag changes since ColdFusion 5
Tags a-b
Tags c
Tags d-e
Tags f
Tags g-h
Tags i
Tags j-l
Tags m-o
Tags p-q
Tags r-s
Tags t
Tags u-z

#back to top

© 2014 Adobe Systems Incorporated. All rights reserved.

60

Adobe ColdFusion Documentation

Tags in ColdFusion 10
The following table briefly describes CFML tags added in ColdFusion 10:
CFML tag

Category

Description

cfexchangeconversation

Communications tags

Helps users organize and manage
conversations from a Microsoft
Exchange account.

cfexchangefolder

Communications tags

Allows you to perform various
actions on the mail folder, such as
get folder information, find folders,
or create, copy, modify, move,
delete, and empty the contents of a
folder.

cfwebsocket

Web Socket tags

Lets you create the WebSocket
object in your CFM template. The
tag creates a reference to the
WebSocket JavaScript object at the
client-side.

#back to top

© 2014 Adobe Systems Incorporated. All rights reserved.

61

Adobe ColdFusion Documentation

Tag summary
The following table briefly describes CFML tags:
CFML tag

Category

Description

cfabort

Flow-control tags

Stops the processing of a
ColdFusion page at the tag location

cfajaximport

Internet protocol tags

Controls importation of JavaScript
files used for ColdFusion
AJAX-based features

cfajaxproxy

Internet protocol tags

Generates an AJAX proxy class on
the client page for a ColdFusion
component

cfapplet

Forms tags

Embeds Java applets in a cfform t
ag

cfapplication

Application framework tags

Defines an application name;
activates client variables; specifies
client variable storage mechanism

cfargument

Extensibility tags

Creates a parameter definition
within a component definition;
defines a function argument

cfassociate

Application framework tags

Enables subtag data to be saved
with a base tag

cfbreak

Flow-control tags

Breaks out of a CFML looping
construct

cfcache

Page processing tags

Caches ColdFusion pages

cfcalendar

Forms tags

Provides a calendar from which to
select a date

cfcase

Flow-control tags

Used with the cfswitch and cfde
faultcase tags

cfcatch

Exception handling tags, Flow-contr
ol tags

Catches exceptions in ColdFusion
pages

cfchart

Data output tags

Generates and displays a chart

cfchartdata

Data output tags

Defines chart data points

© 2014 Adobe Systems Incorporated. All rights reserved.

62

Adobe ColdFusion Documentation

cfchartseries

Data output tags

Defines style in which chart data
displays

cfclient

The  tag is a marker tag
that instructs ColdFusion to
generate client-side code
(JavaScript) for ColdFusion code.

cfclientsettings

This tag is similar to
cfprocessingdirective and acts as a
compiler directive to include plugins
for various features (device
detection and device API).

cfcol

Data output tags

Defines table column header,
properties

cfcollection

Extensibility tags

Administers Solr collections

cfcomponent

Extensibility tags

Creates and defines a component
object

cfcontent

Data output tags, Page processing
tags

Defines content type and filename
of a file to be downloaded by the
current page

cfcontinue

Flow-control tags

Returns processing to the top of a
loop; used within a cfloop tag.

cfcookie

Variable manipulation tags

Defines and sets cookie variables,
including expiration and security
options

cfdbinfo

Database manipulation tags

Lets you retrieve information about
a data source

cfdefaultcase

Flow-control tags

Receives control if there is no
matching cfcase tag value

cfdirectory

File management tags

Performs typical directory-handling
tasks from within a ColdFusion
application

cfdiv

Display management tags

Creates an HTML tag with that is
populated using a bind expressions.

cfdocument

Data output tags

Creates PDF or Adobe FlashPaper
output from a text block that
contains CFML and HTML

© 2014 Adobe Systems Incorporated. All rights reserved.

63

Adobe ColdFusion Documentation

cfdocumentitem

Data output tags

Specifies action items, such as
header, footer, and page break, for
a PDF or FlashPaper document

cfdocumentsection

Data output tags

Divides a PDF or FlashPaper
document into sections

cfdump

Debugging tags, Variable
manipulation tags

Outputs variables for debugging

cfelse

Flow-control tags

Creates IF-THEN-ELSE constructs

cfelseif

Flow-control tags

Creates IF-THEN-ELSE constructs

cferror

Exception handling tags, Applicatio
n framework tags

Displays custom HTML error pages
when errors occur

cfexchangecalendar

Communications tags

Gets, creates, deletes, modifies, or
responds to Microsoft Exchange
calendar events

cfexchangeconnection

Communications tags

Opens or closes a persistent
connection with an Exchange
server

cfexchangecontact

Communications tags

Gets, creates, deletes, or modifies
Exchange contacts

cfexchangeconversation

Communications tags

Helps users organize and manage
conversations from a Microsoft
Exchange account.

cfexchangefolder

Communications tags

Allows you to perform various
actions on the mail folder, such as
get folder information, find folders,
or create, copy, modify, move,
delete, and empty the contents of a
folder.

cfexchangefilter

Communications tags

Sets filter conditions used in
Exchange tag get operations

cfexchangemail

Communications tags

Gets and deletes Exchange mail
messages and sets message
properties

cfexchangetask

Communications tags

Gets, creates, deletes, or modifies
an Exchange user task

© 2014 Adobe Systems Incorporated. All rights reserved.

64

Adobe ColdFusion Documentation

cfexecute

Flow-control tags, Extensibility tags

Executes developer-specified
process on server computer

cfexit

Flow-control tags

Aborts processing of executing
CFML tag

cffeed

Communications tags, Internet
protocol tags

Reads, creates, and converts, Atom
and RSS syndication feeds

cffile

File management tags

Performs typical file-handling tasks
from within ColdFusion application

cffileupload

File management tags Forms tags

Displays a dialog for uploading
multiple files from the user's
system.

cffinally

Exception handling tags

Used inside a cftry tag

cfflush

Data output tags, Page processing
tags

Flushes currently available data to
client

cfform

Forms tags

Builds input form; performs
client-side input validation

cfformgroup

Forms tags

Groups form control into a
containing object

cfformitem

Forms tags

Adds text and dividing rules to
Adobe Flash forms

cfftp

Forms tags, Extensibility tags, Inter
net protocol tags

Permits FTP file operations

cffunction

Extensibility tags

Defines function that you build in
CFML

cfgrid

Forms tags

Displays tabular grid control, in cff
orm tag

cfgridcolumn

Forms tags

Used in cfform; defines columns
in a cfgrid

cfgridrow

Forms tags

Defines a grid row; used with cfgr
id

cfgridupdate

Forms tags

Directly updates ODBC data source
from edited grid data

© 2014 Adobe Systems Incorporated. All rights reserved.

65

Adobe ColdFusion Documentation

cfheader

Data output tags, Page processing
tags

Generates HTTP headers

cfhtmlhead

Page processing tags

Writes text and HTML to HEAD
section of page

cfhtmltopdfcfhtmltopdf

Data output tags

 creates high quality
PDF output from a text block
containing CFML and HTML using
the PDF Service Manager.

cfhtmltopdfitem

Data output tags

The  specifies the
action items for a PDF document
created by the tag
.

cfhttp

Internet protocol tags

Performs GET and POST to upload
file or post form, cookie, query, or
CGI variable directly to server

cfhttpparam

Internet protocol tags

Specifies parameters required for a
cfhttp POST operation; used with
cfhttp

cfif

Flow-control tags

Creates IF-THEN-ELSE constructs

cfimage

Other tags

Creates a cfimage, a ColdFusion
data type that can be operated by
image functions.

cfimap

Communications tags, Internet
protocol tags

Retrieves and manages e-mails and
folders in IMAP servers

cfimapfilter

Communication tags

Specifies filter parameters that
control the actions of cfimap, get
operations.

cfimport

Application framework tags

Imports JSP tag libraries into a
CFML page

cfinclude

Flow-control tags

Embeds references to ColdFusion
pages

cfindex

Extensibility tags

Creates Solr search indexes

cfinput

Forms tags

Creates an input element (radio
button, check box, text entry box);
used in cfform

cfinsert

Database manipulation tags

Inserts records in a data source

© 2014 Adobe Systems Incorporated. All rights reserved.

66

Adobe ColdFusion Documentation

cfinterface

Application framework tags, Extensi
bility tags

Defines an interface that a
ColdFusion component can
implement

cfinvoke

Extensibility tags

Invokes component methods from a
ColdFusion page or component

cfinvokeargument

Extensibility tags

Passes a parameter to a
component method or a web
service

cflayout

Display management tags

Creates a region of its container
with a specific layout behavior

cflayoutarea

Display management tags

Defines a display region within a cf
layout tag body

cfldap

Internet protocol tags

Provides access to LDAP directory
servers

cflocation

Flow-control tags

Controls execution of a page

cflock

Application framework tags

Ensures data integrity and
synchronizes execution of CFML
code

cflog

Data output tags, Other tags

Writes a message to a log file

cflogin

Security tags

Defines a container for user login
and authentication code

cfloginuser

Security tags

Identifies an authenticated user to
ColdFusion

cflogout

Security tags

Logs the current user out

cfloop

Flow-control tags

Repeats a set of instructions based
on conditions

cfmail

Communications tags, Internet
protocol tags

Assembles and posts an e-mail
message

cfmailparam

Communications tags, Internet
protocol tags

Attaches a file or adds a header to
an e-mail message

cfmailpart

Communications tags, Internet
protocol tags

Contains one part of a multipart
mail message

© 2014 Adobe Systems Incorporated. All rights reserved.

67

Adobe ColdFusion Documentation

cfmap

Other tags

Embeds a Google map within a
ColdFusion web page

cfmapitem

Other tags

Creates markers on the map; a
child tag of the cfmap tag

cfmediaplayer

Other tags

Creates an in-built media player
that can play FLV files

cfmenu

Display management tags

Creates a top-level menu or a tool
bar.

cfmenuitem

Display management tags

Defines an entry in a menu,
including an item that is the head of
a submenu.

cfmessagebox

Application framework tags

Defines a control for displaying
pop-up messages

cfNTauthenticate

Security tags

Authenticates user information
against an NT domain

cfoauth

Communications tags, Internet
protocol tags

The  tag allows you to
easily integrate third-party Oauth 2
authentication provider

cfobject

Extensibility tags

Creates COM, component, CORBA,
Java, and web service objects

cfobjectcache

Database manipulation tags

Flushes the query cache

cfoutput

Data output tags

Displays the output of a database
query or other operation

cfparam

Variable manipulation tags

Defines a parameter and its default
value

cfpdf

Forms tags

Manipulates existing PDF
documents.

cfpdfform

Forms tags

Creates and manipulates PDF
forms.

cfpdfformparam

Forms tags

Creates interactive fields on a PDF
form.

© 2014 Adobe Systems Incorporated. All rights reserved.

68

Adobe ColdFusion Documentation

cfpdfparam

Forms tags

Child tag of the cfpdf tag. Used
only with the merge action to merge
multiple pages or PDF documents
into one file

cfpdfsubform

Forms tags

Creates subforms within a PDF
form.

cfpod

Display management tags

Creates a an area of the browser or
layout area with an optional title bar
and a body

cfpop

Communications tags, Internet
protocol tags

Gets and deletes messages from
POP mail server

cfpresentation

Data output tags

Creates a presentation dynamically
from an HTML page or SWF files

cfpresentationslide

Data output tags

Creates a slide dynamically from an
HTML page or SWF source files
(child tag of the cfpresentation
tag)

cfpresenter

Data output tags

Describes a presenter in a slide
presentation

cfprint

Data output tags

Prints PDF documents. Used for
automated print jobs

cfprocessingdirective

Data output tags

Suppresses white space and other
output

cfprocparam

Database manipulation tags

Holds parameter information for
stored procedure

cfprocresult

Database manipulation tags

Result set name that ColdFusion
tags use to access result set of a
stored procedure

cfprogressbar

Other tags

Defines a progress bar to indicate
the progress of an activity

cfproperty

Extensibility tags

Defines components

cfquery

Database manipulation tags

Passes SQL statements to a
database

cfqueryparam

Database manipulation tags

Checks data type of a query
parameter

© 2014 Adobe Systems Incorporated. All rights reserved.

69

Adobe ColdFusion Documentation

cfregistry

Other tags, Variable manipulation
tags

Reads, writes, and deletes keys
and values in a Windows system
registry

cfreport

Exception handling tags

Embeds a ColdFusion Report
Builder or Crystal Reports report

cfreportparam

Exception handling tags

Passes an input parameter to a
ColdFusion Report Builder report

cfrethrow

Exception handling tags

Rethrows currently active exception

cfreturn

Extensibility tags

Returns results from a component
method

cfsavecontent

Variable manipulation tags

Saves generated content inside tag
body in a variable

cfschedule

Variable manipulation tags

Schedules page execution;
optionally, produces static pages

cfscript

Application framework tags

Encloses a set of cfscript statem
ents

cfsearch

Extensibility tags

Executes searches against data
indexed in Solr collections, using cf
index

cfselect

Forms tags

Creates a drop-down list box form
element; used in cfform tag

cfset

Variable manipulation tags

Defines a variable

cfsetting

Other tags, Variable manipulation
tags

Defines and controls ColdFusion
settings

cfsharepoint

Extensibility tags

Invokes a SharePoint action from
ColdFusion

cfsilent

Data output tags, Page processing
tags

Suppresses CFML output within tag
scope

cfslider

Forms tags

Creates slider control; used in cffo
rm

cfspreadsheet

Extensibility tags

Manages Excel spreadsheet files

cfsprydataset

Internet protocol tags

Creates a spry data set

© 2014 Adobe Systems Incorporated. All rights reserved.

70

Adobe ColdFusion Documentation

cfstoredproc

Database manipulation tags

Holds database connection
information; identifies a stored
procedure to execute

cfswitch

Flow-control tags

Evaluates passed expression;
passes control to matching cfcase
tag

cftable

Data output tags

Builds a table in a ColdFusion page

cftextarea

Forms tags

Puts a multiline text box in a form

cfthread

Application framework tags

Creates and manages ColdFusion
threads, independent streams of
execution.

cfthrow

Exception handling tags, Flow-contr
ol tags

Throws a developer-specified
exception

cftimer

Debugging tags

Displays execution time for a block
of code

cftooltip

Display management tags

Specifies text to display when the
mouse pointer hovers over the tag
body elements

cftrace

Debugging tags

Displays and logs application
debugging data

cftransaction

Database manipulation tags

Groups cfquery operations into
one transaction; performs rollback
processing

cftree

Forms tags

Creates tree control element; used
in cfform

cftreeitem

Forms tags

Populates a tree control element in
a form; used with cftree

cftry

Exception handling tags, Flow-contr
ol tags

Catches exceptions in ColdFusion
pages

cfupdate

Database manipulation tags

Updates rows in a database data
source

© 2014 Adobe Systems Incorporated. All rights reserved.

71

Adobe ColdFusion Documentation

cfwebsocket

Web Socket tags

Lets you create the WebSocket
object in your CFM template. The
tag creates a reference to the
WebSocket JavaScript object at the
client-side.

cfwddx

Extensibility tags

Serializes and deserializes CFML
data structures to XML-based
WDDX format

cfwindow

Display management tags

Creates a pop-up window in the
browser

cfxml

Extensibility tags

Creates an XML document object

cfzip

File management tags

Manipulates ZIP and JAR files

cfzipparam

File management tags

Manipulates ZIP and JAR files

#back to top

© 2014 Adobe Systems Incorporated. All rights reserved.

72

Adobe ColdFusion Documentation

Tags by function
This section lists tags by their function or purpose.

© 2014 Adobe Systems Incorporated. All rights reserved.

73

Adobe ColdFusion Documentation

Application framework tags
cfapplication
cfassociate
cferror

cfimport
cfinterface
cflock

© 2014 Adobe Systems Incorporated. All rights reserved.

cfscript
cfthread

74

Adobe ColdFusion Documentation

Communications tags
cfexchangecalendar
cfexchangeconnectio
n
cfexchangecontact

cfexchangefilter
cfexchangemail
cfexchangetask

© 2014 Adobe Systems Incorporated. All rights reserved.

cffeed
cfmail
cfmailparam

cfmailpart
cfpopcfimap

75

Adobe ColdFusion Documentation

Database manipulation tags
cfdbinfo
cfinsert
cfobjectcache

cfprocparam
cfprocresult
cfquery

© 2014 Adobe Systems Incorporated. All rights reserved.

cfqueryparam
cfstoredproc
cftransaction

cfupdate

76

Adobe ColdFusion Documentation

Data output tags
cfchart
cfchartdata
cfchartseries
cfcol
cfcontent
cfdocument

cfdocumentitem
cfdocumentsection
cfflush
cfheader
cflog
cfoutput

© 2014 Adobe Systems Incorporated. All rights reserved.

cfpresentation
cfpresentationslide
cfpresenter
cfprocessingdirecti
ve
cfprint
cfreport

cfreportparam
cfsilent
cftable

77

Adobe ColdFusion Documentation

Debugging tags
cfdump

cftimer

© 2014 Adobe Systems Incorporated. All rights reserved.

cftrace

78

Adobe ColdFusion Documentation

Display management tags
cfdiv
cflayout
cflayoutarea
cfmap

cfmapitem
cfmediaplayer
cfmenu

© 2014 Adobe Systems Incorporated. All rights reserved.

cfmenuitem
cfmessagebox
cfpod

cfprogressbar
cftooltip
cfwindow

79

Adobe ColdFusion Documentation

Exception handling tags
cfcatch
cferror

cffinally
cfrethrow

© 2014 Adobe Systems Incorporated. All rights reserved.

cfthrow
cftry

80

Adobe ColdFusion Documentation

Extensibility tags
cfchart
cfchartdata
cfchartseries
cfcollection
cfcomponent
cfexecute

cfftp
cffunction
cfindex
cfinterface
cfinvoke
cfinvokeargument

© 2014 Adobe Systems Incorporated. All rights reserved.

cfobject
cfproperty
cfreport
cfreportparam
cfreturn
cfsearch

cfsharepoint
cfspreadsheet
cfwddx
cfxml

81

Adobe ColdFusion Documentation

File management tags
cfdirectory
cffile

cffileupload
cfftp

© 2014 Adobe Systems Incorporated. All rights reserved.

cfzip
cfzipparam

82

Adobe ColdFusion Documentation

Flow-control tags
cfabort
cfbreak
cfcase
cfcontinue
cfdefaultcase

cfelse
cfelseif
cfexecute
cfexit
cfif

© 2014 Adobe Systems Incorporated. All rights reserved.

cfinclude
cflocation
cfloop
cfrethrow
cfswitch

cfthrow
cftry

83

Adobe ColdFusion Documentation

Forms tags
cfapplet
cfcalendar
cffileupload
cfform
cfformgroup
cfformitem

cfgrid
cfgridcolumn
cfgridrow
cfgridupdate
cfinput
cfpdf

© 2014 Adobe Systems Incorporated. All rights reserved.

cfpdfform
cfpdfformparam
cfpdfparam
cfpdfsubform
cfselect
cfslider

cftextarea
cftree
cftreeitem

84

Adobe ColdFusion Documentation

Internet protocol tags
cfajaximport
cfajaxproxy
cfftp
cffeed

cfimap
cfhttp
cfhttpparam
cfldap

© 2014 Adobe Systems Incorporated. All rights reserved.

cfmail
cfmailparam
cfmailpart
cfpop

cfsprydataset

85

Adobe ColdFusion Documentation

Page processing tags
cfcache
cfcontent
cfflush

cfheader
cfhtmlhead
cfinclude

© 2014 Adobe Systems Incorporated. All rights reserved.

cfprocessingdirective
cfsetting
cfsilent

86

Adobe ColdFusion Documentation

Security tags
cflogin

cfloginuser

© 2014 Adobe Systems Incorporated. All rights reserved.

cflogout

cfNTauthenticate

87

Adobe ColdFusion Documentation

Variable manipulation tags
cfcookie
cfdump

cfparam
cfregistry

© 2014 Adobe Systems Incorporated. All rights reserved.

cfsavecontent
cfschedule

cfset
cfsetting

88

Adobe ColdFusion Documentation

Web Socket tags
cfwebsocket

© 2014 Adobe Systems Incorporated. All rights reserved.

89

Adobe ColdFusion Documentation

Other tags
cfimage

cflog

cfregistry

#back to top

© 2014 Adobe Systems Incorporated. All rights reserved.

90

Adobe ColdFusion Documentation

Tag changes since ColdFusion 5
The following section lists tags, attributes, and values that have changed since ColdFusion 5, and indicate the
specific release in which the change was made.

© 2014 Adobe Systems Incorporated. All rights reserved.

91

Adobe ColdFusion Documentation

New tags, attributes, and values
New and changed tags are also documented elsewhere, for the following releases:
New Tags in ColdFusion 9 (in the ColdFusion 9 version of this manual)
Tags in ColdFusion 10
New in ColdFusion 11
This table lists tags, attributes, and attribute values that have been added since the ColdFusion MX release:
Tag

Attribute or value

Added in this ColdFusion release

Multiple tags

attributeCollection

ColdFusion 8

cfajaximport

All

ColdFusion 8

cfajaxproxy

All

ColdFusion 8

cfapplication

scriptProtect

ColdFusion MX 7

loginStorage

ColdFusion MX 6.1

component value of type attribute

ColdFusion 8

xml value of type attribute

ColdFusion MX 7

All

ColdFusion MX

cfcache

cachedirectory, timespan attri
butes

ColdFusion MX

cfcalendar

onBlur and onFocus attributes

ColdFusion MX 7.01

All

ColdFusion MX 7

style , title attributes

ColdFusion MX 7

xAxisType, yAxisType attributes

ColdFusion MX 6.1

All

ColdFusion MX

cfchartdata

All

ColdFusion MX

cfchartseries

datalabelstyle attribute

ColdFusion MX 7

cfargument

cfchart

horizontalbar value of type attr
ibute
All

© 2014 Adobe Systems Incorporated. All rights reserved.

ColdFusion MX

92

Adobe ColdFusion Documentation

cfcollection

categories attribute

ColdFusion MX 7

New values of the language attrib
ute
list and categoryList values
of action attribute

cfcomponent

name attribute

ColdFusion MX

implements, serviceaddress a
ttributes

ColdFusion 8

component value of extends attri
bute
style, namespace, servicepor
tname, porttypename, wsdlfil
e, bindingname, and output attri
butes

ColdFusion MX 7

Extended functionality for the hint
and displayname attributes when
publishing document-literal style
web services
All

ColdFusion MX

cfcontent

variable attribute

ColdFusion MX 7

cfcontinue

All

ColdFusion 9

cfdbinfo

All

ColdFusion 8

cfdirectory

listinfo and type attributes

ColdFusion 8

recurse attribute for list and de
lete actions

ColdFusion MX 7

All

ColdFusion 8

cfdiv

© 2014 Adobe Systems Incorporated. All rights reserved.

93

Adobe ColdFusion Documentation

bookmark, authPassword, auth
User, localUrl, proxyHost, pr
oxyPassword, proxyPort, prox
yUser, saveAsName and userAge
nt attributes
totalsectionpagecount and cu
rrentsectionpagenumber scop
e variables

ColdFusion 8

src, srcfile, and mimetype attri
butes

ColdFusion MX 7.01

All

ColdFusion MX 7

cfdocumentitem

All

ColdFusion MX 7

cfdocumentsection

name, authPassword, authUser,
and userAgent attributes

ColdFusion 8

All

ColdFusion MX 7

cfdump

show, format, hide, keys, meta
info, output, and showUDFs attri
butes

ColdFusion 8

cfexchangecalendar

All

ColdFusion 8

cfexchangeconnection

All

ColdFusion 8

cfexchangecontact

All

ColdFusion 8

cfexchangefilter

All

ColdFusion 8

cfexchangemail

All

ColdFusion 8

cfexchangetask

All

ColdFusion 8

cfexecute

variable attribute

ColdFusion MX 6.1

cffeed

All

ColdFusion 8

cffile

result attribute for action="upl
oad" action

ColdFusion MX 7

cfdocument

fixnewline attribute for action=
"append" and action="write"
actions

© 2014 Adobe Systems Incorporated. All rights reserved.

94

Adobe ColdFusion Documentation

cffileupload

All

ColdFusion 9

cffinally

All

ColdFusion 9

cfform

onSuccess attribute support in
AJAX controls for the onError attri
bute

ColdFusion 8

name and action attributes are
optional

ColdFusion MX 7

accessible, format, height, w
idth , method, onError, onRese
t, preloader, scriptsrc, skin,
style, timeout, wMode attributes
cfformgroup

All

ColdFusion MX 7

cfformitem

script value of type attribute

ColdFusion MX 7.01

All

ColdFusion MX 7

fingerprint, key, paraphrase,
and secure attributes
quote, site, allo, and acct valu
es to the action attribute

ColdFusion 8

result attribute

ColdFusion MX 7

description attribute; the XML va
lue to the returntype attribute

ColdFusion MX 7

All

ColdFusion MX

bind, bindOnLoad, pageSize, p
reservePageOnSort, stripeRo
ws, stripeRowColor attributes,
and HTML value of format attribute
.

ColdFusion 8

onBlur and onFocus attributes

ColdFusion MX 7.01

format attribute and support for
Flash and XML output
enabled, onChange, style, too
ltip, visible attributes (Flash
format only)

ColdFusion MX 7

cfftp

cffunction

cfgrid

© 2014 Adobe Systems Incorporated. All rights reserved.

95

Adobe ColdFusion Documentation

cfgridcolumn

cfhttp

mask attribute

ColdFusion MX 7

currency value of type attribute

ColdFusion MX 7

clientCert and clientCertPa
ssword attributes

ColdFusion 8

never value of GetAsBinary attri
bute

ColdFusion MX 7.01

result attribute

ColdFusion MX 7

HEAD, PUT, DELETE, OPTIONS, and
TRACE values of method attribute

ColdFusion MX 6.1

multipart, getasbinary, prox
yUser, proxyPassword attributes

cfhttpparam

charset,firstrowasheaders at
tributes

ColdFusion MX

header and body values of type a
ttribute

ColdFusion MX 6.1

encoded, mimeType attributes
cfimage

All

ColdFusion 8

cfimport

All

ColdFusion MX

cfimap

All

ColdFusion 9

cfindex

prefix attribute

ColdFusion MX 7.01

custom3, custom4, category,
and categorytree attributes for u
pdate and refresh actions

ColdFusion MX 7

status attribute for update, refr
esh, delete, and purge actions
New values of the language attrib
ute

© 2014 Adobe Systems Incorporated. All rights reserved.

96

Adobe ColdFusion Documentation

cfinput

autosuggest, autosuggestBin
dDelay, autosuggestMinLengt
h, delimiter, maxResultsDisp
layed, showAutosuggestLoadi
ngIcon, sourceForTooltip, and
typeahead attributes.

ColdFusion 8

support for the bind attribute in
HTML forms and the bindAttribu
te, bindOnload, and onBindErr
or attributes.
datefield value of the type attrib
ute in HTML forms
height and width attributes (all
except checkbox and radiobutton)

ColdFusion MX 7

bind attribute (text and password)
label attribute (all but button,
image, reset, and submit)
mask attribute (text only)
validateAt attribute (all but
button, image, reset, and submit)
datefield, button, file, hidd
en, image, reset, and submit val
ues of type attribute
daynames and monthnames attrib
utes (type="datefield" only)
boolean, email, guid, maxleng
th, noblanks, range, submitOn
ce, URL, USdate, and uuid values
of the validate attribute
tooltip, visible, and enabled
attributes (Flash forms only)
src attribute (image only)
cfinterface

All

© 2014 Adobe Systems Incorporated. All rights reserved.

ColdFusion 8

97

Adobe ColdFusion Documentation

refreshWSDL, wsdl2java argum
ents

ColdFusion 8

servicePort attribute for web
services

ColdFusion MX 7

All

ColdFusion MX

cfinvokeargument

omit attribute

ColdFusion MX 7

All

ColdFusion MX

cflayout

All

ColdFusion 8

cflayoutarea

All

ColdFusion 8

cfldap

returnAsBinary attribute

ColdFusion MX 7

cflocation

statusCode attribute

ColdFusion 8

cflock

Request value of scope attribute

ColdFusion 8

cflogin

All

ColdFusion MX

cfloginuser

All

ColdFusion MX

cflogout

All

ColdFusion MX

cfloop

characters, file, and array att
ributes

ColdFusion 8

cfmail

prioirity, useSSL, and useTLS

ColdFusion 8

The cfmail tag no longer lets you
send multipart mail by embedding
the entire MIME-encoded message
in the tag body. Use the cfmailpa
rt tag, instead.

ColdFusion MX 7

charset, failto, replyTo, use
rName, password, wrapText attri
butes

ColdFusion MX 6.1

spoolEnable attribute

ColdFusion MX

contentID,
{{disposition}}attributes

ColdFusion MX 7

cfinvoke

cfmailparam

© 2014 Adobe Systems Incorporated. All rights reserved.

98

Adobe ColdFusion Documentation

type attribute

ColdFusion MX 6.1

cfmailpart

All

ColdFusion MX 6.1

cfmap

All

ColdFusion 9

cfmapitem

All

ColdFusion 9

cfmediaplayer

All

ColdFusion 9

cfmenu

All

ColdFusion 8

cfmenuitem

All

ColdFusion 8

cfmessagebox

All

ColdFusion 9

cfNTauthenticate

All

ColdFusion MX 7

cfobject

.net value of type attribute and
related assembly, port, protoco
l, and secure attributes

ColdFusion 8

password, proxyPassword, pro
xyPort, proxyServer, proxyUs
er, refreshWSDL, userName, ws
dl2JavaArgs, and wsportname a
ttributes for web services
component and webservice attri
butes

ColdFusion MX

cfobjectcache

All

ColdFusion MX

cfparam

min, max, pattern attributes

ColdFusion MX 7

creditcard, email, eurodate,
float, integer, range, regex, r
egular_expression, ssn, soci
al_security_number, time, UR
L, USdate, XML, zipcode values
of the type attribute

© 2014 Adobe Systems Incorporated. All rights reserved.

99

Adobe ColdFusion Documentation

cfpdf

action = "thumbnail" has the
following new attributes:

ColdFusion 9

hires
compresstiffs
maxlength
maxbreadth
maxscale
action = "optimize" (new
action with all new attributes)
action = "addheader" (new
action)
action = "addfooter" (new
action)
action =
"removeheaderfooter" (new
action)
action = "extracttext"
action = "extractimage"
action = "write" package
= "true"
action = "merge"
encodeall="true"
action = "write" name=
#PDF variable#
action = "transform" (new
action)
cfpdfform

All

ColdFusion 8

cfpdfformparam

All

ColdFusion 8

cfpdfparam

All

ColdFusion 8

cfpdfsubform

All

ColdFusion 8

cfpod

All

ColdFusion 8

cfpop

cids query variable

ColdFusion MX 7.01

cfpresentation

All

ColdFusion 8

cfpresentationslide

All

ColdFusion 8

cfpresenter

All

ColdFusion 8

cfprint

All

ColdFusion 8

cfprocessingdirective

pageEncoding attribute

ColdFusion MX

© 2014 Adobe Systems Incorporated. All rights reserved.

100

Adobe ColdFusion Documentation

cfprocparam

All

ColdFusion 9

cfprogressbar

All

ColdFusion 9

cfproperty

All

ColdFusion MX

cfquery

result attribute

ColdFusion MX 7

cfreturn

All

ColdFusion MX

cfreport

HTML, XML values of format attribu
te, resourceTimespan, style att
ributes

ColdFusion 8

RTF value of format attribute

ColdFusion MX 7.01

template, format, name, filen
ame, query, overwrite attribute

ColdFusion MX 7

cfreportparam

chart, query, series, style, su
breport attributes

ColdFusion 8

name, value attributes

ColdFusion MX 7

cfsearch

category, categoryTree, stat
us, suggestions, contextPass
ages, contextBytes, contextH
ighlightBegin, contextHighl
ightEnd, previousCriteria att
ributes

ColdFusion MX 7

natural, internet, and intern
et_basic values of type attribute
cfselect

support for the bind attribute in
HTML forms and the bindAttribu
te, bindOnload, and onBindErr
or attributes.

ColdFusion 8

Support for tooltips in HTML forms
including the sourceForTooltip
attribute
selected attribute can take a list

© 2014 Adobe Systems Incorporated. All rights reserved.

ColdFusion MX 7

101

Adobe ColdFusion Documentation

enabled, group, height, label,
onKeyUp, onKeyDown, onMouseU
p, onMouseDown, onChange, onC
lick, queryPosition, tooltip,
visible, and width attributes
cfsetting

requestTimeOut attribute

ColdFusion MX

cfsharepoint

All

ColdFusion 9

cfspreadsheet

All

ColdFusion 9

cfsprydataset

All

ColdFusion 8

cfstoredproc

result attribute

ColdFusion MX 7

cftextarea

Rich text editor support including
the following attributes (HTML
format only): richtext, basepath
, fontFormats, fontNames, fon
tSizes, skin, stylesXML, temp
latesXML, toolbar, toolbarOn
Focus, and support for the height
and width attributes in HTML
format

ColdFusion 8

support for the bind attribute and b
indAttribute, bindOnLoad, and
onBindError attributes in HTML
format
support for tooltips in HTML format
including tooltip and sourceFo
rToolTip attribute
html attribute

ColdFusion MX 7.01
All

ColdFusion MX 7

cfthread

All

ColdFusion 8

cfthrow

object attribute

ColdFusion MX

cftimer

All

ColdFusion MX 7

cftooltip

All

ColdFusion 8

© 2014 Adobe Systems Incorporated. All rights reserved.

102

Adobe ColdFusion Documentation

onBlur and onFocus attributes

ColdFusion MX 7.01

format, onChange, style attribut
es

ColdFusion MX 7

cftrace

All

ColdFusion MX

cfwindow

ALL

ColdFusion 8

cfxml

All

ColdFusion MX

cfzip

All

ColdFusion 8

cfzipparam

All

ColdFusion 8

cftree

© 2014 Adobe Systems Incorporated. All rights reserved.

103

Adobe ColdFusion Documentation

Deprecated tags, attributes, and values
The following tags, attributes, and attribute values are deprecated. Do not use them in ColdFusion applications.
They might not work, and might cause an error, in releases later than ColdFusion MX.
Updated information for ColdFusion 11
Please note that there is a new document for ColdFusion 11, located outside of this manual, with
additional and more details information about deprecated and removed/obsoleted features. See
Deprecated Features.

Tag

Attribute or value

Deprecated as of this ColdFusion
release

cfcache

cachedirectory, timeout attrib
utes

ColdFusion MX

cfcollection

map and repair options of the act
ion attribute

ColdFusion MX 7

cferror

monitor option of the exception
attribute

ColdFusion MX

cffile

system value for attributes attri
bute

ColdFusion MX

temporary value for attributes
attribute

ColdFusion MX

passthrough attribute

ColdFusion MX 7

enableCAB attribute

ColdFusion MX

cfftp

agentname attribute

ColdFusion MX

cfgraph

All

ColdFusion MX

cfgraphdata

All

ColdFusion MX

cfgridupdate

connectString, dbName, dbSer
ver, dbType, provider, provid
erDSN attributes

ColdFusion MX

cfinput

passthrough attribute

ColdFusion MX 7

cfinsert

connectString, dbName, dbSer
ver, dbType, provider, provid
erDSN attributes

ColdFusion MX

cfform

© 2014 Adobe Systems Incorporated. All rights reserved.

104

Adobe ColdFusion Documentation

cfldap

filterFile attribute

ColdFusion MX

cflog

date, thread, time attributes

ColdFusion MX

cfquery

connectString, dbName, dbSer
ver, provider, providerDSN, s
ql attributes

ColdFusion MX

The following dbType attribute
values:
dynamic, ODBC, Oracle73, Orac
le80, Sybase11, OLEDB, DB2

ColdFusion MX(The value query is
valid.)

cfregistry

All, on UNIX only

ColdFusion MX

cfsearch

external, language attributes

ColdFusion MX

cfselect

passthrough attribute

ColdFusion MX 7

cfservlet

All

ColdFusion MX

cfservletparam

All

ColdFusion MX

cfslider

img, imgStyle, grooveColor, r
efreshLabel, tickmarkimages,
tickmarklabels, tickmarkmaj
or, tickmarkminor attributes

ColdFusion MX

cfstoredproc

connectString, dbName, dbSer
ver, dbtype, provider, provid
erDSN attributes

ColdFusion MX

cftextinput

All

ColdFusion MX 7

cfupdate

connectString, dbName, dbSer
ver, dbtype, provider, provid
erDSN attributes

ColdFusion MX

© 2014 Adobe Systems Incorporated. All rights reserved.

105

Adobe ColdFusion Documentation

Obsolete tags, attributes, and values
The following tags, attributes, and attribute values are obsolete. Do not use them in ColdFusion applications. They
do not work, and might cause an error, in releases later than ColdFusion 5.
Updated information for ColdFusion 11
Please note that there is a new document for ColdFusion 11, located outside of this manual, with
additional and more details about deprecated and removed/obsoleted features. See Deprecated
Features.

Tag

Attribute or value

Obsolete as of this ColdFusion
release

cfauthenticate

All

ColdFusion MX

cfchart

rotated attribute

ColdFusion MX 7

cffile

attributes attribute value archi
ve

ColdFusion MX

cfimpersonate

All

ColdFusion MX

cfindex

action attribute value optimize

ColdFusion MX

external attribute
cfinternaladminsecurity

All

ColdFusion MXThis tag did not
appear in CFML Reference.

cfldap

filterConfig and filterFile
attributes

ColdFusion MX

cfnewinternaladminsecurity

All

ColdFusion MXThis tag did not
appear in CFML Reference.

cfsetting

catchExceptionsByPattern att
ribute

ColdFusion MX

#back to top

© 2014 Adobe Systems Incorporated. All rights reserved.

106

Adobe ColdFusion Documentation

Tags a-b

This section lists tags starting with alphabets A-B with their description.
cfabort
cfajaximport
cfajaxproxy
cfapplet
cfapplication
cfargument
cfassociate
cfauthenticate
cfbreak

© 2014 Adobe Systems Incorporated. All rights reserved.

107

Adobe ColdFusion Documentation

cfabort
Description

Stops the processing of a ColdFusion page at the tag location. ColdFusion returns everything that was processed
before the tag. The tag is often used with conditional logic to stop processing a page when a condition occurs.
Category

Flow-control tags
Syntax



Note
You can specify this tag's attributes in an attributeCollection whose value is a structure.
Specify the structure name in the attributeCollection and use the tag's attribute names as
structure keys.

See also

cfbreak, cfexecute, cfexit, cfif, cflocation, cfloop, cfswitch, cfthrow, cftry; cfabort and cfexit in
the Developing ColdFusion Applications
Attributes

Attribute

Req/Opt

showError

Optional

Default

Description
Error to display, in a
standard ColdFusion error
page, when tag executes.

Usage

When you use the cfabort and cferror tags together, the cfabort tag halts processing immediately; the cfer
ror tag redirects output to a specified page. If this tag does not contain a showError attribute value, processing
stops when the tag is reached and ColdFusion returns the page contents up to the line that contains the cfabort ta
g.
When you use this tag with the showError attribute, but do not define an error page using cferror, page
processing stops when the cfabort tag is reached. The message in showError displays to the client.When you
use this tag with the showError attribute and an error page using cferror, ColdFusion redirects output to the
error page specified in the cferror tag.
Note
When using cfabort, cflocation, or cfcontent tags, the OnAbort method is invoked
instead on OnRequestEnd.

© 2014 Adobe Systems Incorporated. All rights reserved.

108

Adobe ColdFusion Documentation
Example

This example shows the use of cfabort to stop processing. In the second example, where cfabort is used, the
result never displays.


Example A: Let the instruction complete itself









The value of myVariable after incrementing through the loop #Counter# times is:
#myVariable#



Example B: Use cfabort to halt the instructions with showmessage attribute and
cferror


















 The value of myVariable after incrementing through the loop#counter# times is:
#myVariable#



© 2014 Adobe Systems Incorporated. All rights reserved.

109

Adobe ColdFusion Documentation

cfajaximport
Description

Controls the JavaScript files that are imported for use on pages that use ColdFusion AJAX tags and features.
Category

Internet protocol tags
Syntax



Note
You can specify this tag's attributes in an attributeCollection whose value is a structure.
Specify the structure name in the attributeCollection and use the tag's attribute names as
structure keys.

See also

cfform, cfgrid, cfinput, cflayout, cfmenu, cfpod, cfsprydataset, cftextarea, cftooltip, cftree,
cfwindow, Specifying client-side support files in the Developing ColdFusion Applications
History

ColdFusion 8: Added this tag.
Attributes

Attribute

Req/Opt

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

110

Adobe ColdFusion Documentation

cssSrc

Optional

params

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

scriptsrc/ajax

Specifies the URL,
relative to the web root, of
the directory that contains
the CSS files used by
ColdFusion AJAX
features, with the
exception of the rich text
editor. This directory must
have the same directory
structure, and contain the
same CSS files, and
image files required by the
CSS files, as the web_roo
t/CFIDE/scripts/ajax/resou
rces directory.
This attribute lets you
create different custom
styles for ColdFusion
AJAX controls in different
applications.
This attribute allows you
to specify parameters for
the CFM page. Currently,
the only parameter that
you can specify is googl
emapkey. You can
specify the googlemapke
y as follows:

111

Adobe ColdFusion Documentation

scriptSrc

Optional

tags

Optional

scriptsrc setting in the
Administrator;default path
is /CFIDE/scripts/

Specifies the URL,
relative to the web root, of
the directory that contains
the client-side script files
used by ColdFusion. This
directory includes the
JavaScript files and the
default location of the
CSS files used for all
AJAX features. If you use
this attribute, the cfajax
import tag must precede
all other ColdFusion AJAX
tags on the page; that is,
all tags that rely on the
scripts.
You can have only one sc
riptsrc attribute on a
page, in a cfajaximpor
t tag or a cfform tag.
You can use a scriptsr
c attribute in a cfajaxim
port tag to apply its
value to all forms on a
page.
A comma-delimited list of
tags or tag-attribute
combinations for which to
import the supporting
JavaScript files on this
page.
If you use this attribute, it
must specify all
ColdFusion AJAX tags
that you use on the page
and on any pages
specified in tag source at
tributes.
For a list of valid attribute
values and their purposes,
see Usage.

Usage
Using the scriptsrc and cssSrc attributes

The scriptsrc attribute is useful if the JavaScript files are not in the default location. This attribute is required in
some hosting environments and configurations that block access to the /CFIDE directory. The default scriptsrc v
alue is determined by the Default CFFORM ScriptSrc Directory setting on the Server Settings > Settings page of the
ColdFusion Administrator. For cfform tags, the tag's scriptsrc attribute takes precedence over this attribute.

© 2014 Adobe Systems Incorporated. All rights reserved.

112

Adobe ColdFusion Documentation

You can use this attribute only if the cfajaximport tag is on a top-level page; that is, a page that the client directly
requests. You cannot use it, for example, on a page that is specified in a cfwindow tag source attribute.
When you use the cfajaximport tag with a scriptsrc attribute, the specified directory must have the same
structure as the /CFIDE/scripts directory. For example, if you specify scriptsrc="/resources/myScripts",
the JavaScript files used by AJAX must be in the /resources/myScripts/ajax directory. This attribute specifies the
folder that contains the ColdFusion client-side files for all subsequent tags on the current page, not just for
AJAX-based tags. Therefore, the directory tree must include all ColdFusion client-side files used by those tags. For
example, if a cfform tag on the page is in Flash or applet format, include the CF_RunActiveContent.js file in the
directory specified by the scriptsrc attribute.
You use the cssSrc attribute to specify the location of the CSS files required by ColdFusion AJAX features. This
attribute overrides the scriptsrc/ajax/resources directory for the current page. Therefore, if all pages that use a
custom scriptsrc directory also use a custom cssSrc directory, you do not have to include the ColdFusion AJAX
CSS files in the scriptsrc directory tree.
Using the tags attribute or no attribute

If you do not use the cfajaximport tag on a page that contains ColdFusion tags with AJAX UI features,
ColdFusion correctly imports the required JavaScript files in most cases. Use this tag to explicitly import JavaScript
files in these cases:
If you use a ColdFusion AJAX JavaScript function, such as ColdFusion.navigate, ColdFusion.Ajax.s
ubmitForm, or ColdFusion.Log.info on a page that does not otherwise import any AJAX JavaScript
functions, use the cfajaximport tag with no attribute to import the base JavaScript functions only. For
example, use this tag on a page that does not include any ColdFusion AJAX-based tags,
If the following conditions are true:
You use any source attributes in cflayoutarea, cfpod or cfwindow tags, or bind attribute in cfd
iv tag.
The file that the source or bind attribute specifies has any of the tags listed in the following table.
You do not use each of the listed tags on the top-level page.
If these conditions are true, the top-level page must use the cfajaximport tag with a tags attribute
that specifies the tags that only the other pages use. Otherwise, ColdFusion cannot identify that it will
be using the tags and does not import the necessary JavaScript files.
You can specify any or all the following tag attribute values:
Attribute value

Used for

cfdiv

cfdiv tags

cfform

Forms that are in cfpod, cfwindow, or cflayoutare
a tag bodies

cfgrid

AJAX format cfgrid tags

cfinput-autosuggest

cfinput tags that use the autosuggest attribute

cfinput-datefield

HTML format cfinput tags that use the datefield a
ttribute

cflayout-border

cflayout tags with a type attribute value of border

© 2014 Adobe Systems Incorporated. All rights reserved.

113

Adobe ColdFusion Documentation

cflayout-tab

cflayout tags with a type attribute value of tab

cfmenu

cfmenu tags

cfpod

cfpod tags

cfsprydataset-JSON

cfsprydataset tags that generate Spry JSON data
sets

cfsprydataset-XML

cfsprydataset tags that generate Spry XML data
sets

cftextarea

HTML format cftextarea tags

cftooltip

cftooltip tags

cftree

HTML format cftree tags

cfwindow

cfwindow tags

Example

The following cfajaximport tag example specifies separate custom locations for the scripts used for AJAX
features and for the AJAX CSS files. It also imports all JavaScript files used for cftree, and cftooltip.



© 2014 Adobe Systems Incorporated. All rights reserved.

114

Adobe ColdFusion Documentation

cfajaxproxy
Description

Creates a JavaScript proxy for a ColdFusion component, for use in an AJAX client. Alternatively, creates a proxy for
a single CFC method, JavaScript function, or URL that is bound to one or more control attribute values.
Category

Internet protocol tags
Syntax


OR


Note
You can specify this tag's attributes in an attributeCollection whose value is a structure.
Specify the structure name in the attributeCollection and use the tag's attribute names as
structure keys.

See also

DeserializeJSON, IsJSON, SerializeJSON, Using Ajax Data and Development Features in the Developing
ColdFusion Applications
History

ColdFusion 8: Added this tag
Attributes

Attribute

Req/Opt

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

115

Adobe ColdFusion Documentation

bind

A bind or cfc attribute is
required

A bind expression that
specifies a CFC method,
JavaScript function, or
URL to call. For detailed
information about
specifying bind
expressions, see Binding
data to form fields in the D
eveloping ColdFusion
Applications.
You cannot use this
attribute with the cfc attri
bute.

cfc

A bind or cfc attribute is
required

The CFC for which to
create a proxy. Specify a
dot-delimited path to the
CFC. The path can be an
absolute filepath, or
relative to location of the
CFML page. For example,
if the myCFC CFC is in
the cfcs subdirectory of
the ColdFusion page,
specify cfcs.myCFC. If the
CFC extends another
CFC, the extended CFC
methods are also
available to the JavaScript
proxy.On UNIX-based
systems, the tag searches
first for a file whose name
or path corresponds to the
specified name or path,
but is in all lowercase. If it
does not find it,
ColdFusion then searches
for a filename or path that
corresponds to the
attribute value exactly,
with identical character
casing.
This attribute cannot be
used with the bind attribu
te.

© 2014 Adobe Systems Incorporated. All rights reserved.

116

Adobe ColdFusion Documentation

jsclassname

Optional

The value of the cfc attri
bute

The name to use for the
JavaScript proxy class
that represents the CFC.
This attribute cannot be
used with a bind attribute
.

onError

Optional

The name of a JavaScript
function to invoke when a
bind, specified by the bin
d attribute fails. The
function must take two
arguments: an error code
and an error message.
This attribute cannot be
used with a cfc attribute.

onSuccess

Optional

The name of a JavaScript
function to invoke when a
bind, specified by the bin
d attribute succeeds. The
function must take one
argument, the bind functi
on return value. If the bind
function is a CFC function,
the return value is
automatically converted to
a JavaScript variable
before being passed to
the onSuccess function.
This attribute cannot be
used with a cfc attribute.

Usage

Make sure that the Enable HTTP Status Codes option on the Server Settings > Settings page of the ColdFusion
Administrator is selected. Otherwise, the proxy cannot determine if an error occurs in invoking the CFC function and
cannot call the error handler.A cfajaxproxy tag with a bind attribute does not refresh any control that is not
specified in the bind expression.
If you specify a URL in the bind attribute, the HTTP response must consist of a single JSON representation of an
object, array, or simple value, corresponding to the onSuccess argument.
Creating a CFC proxy

The cfajaxproxy tag with a cfc attribute generates a JavaScript proxy that represents a CFC on the web client.
The tag and the proxy it generates have the following characteristics:
The proxy provides one function that corresponds to each CFC remote function. Calling these functions in
your client-side JavaScript code remotely calls the CFC functions on the server.
The proxy provides several functions that you call to configure the interaction between the client and the
server. These functions set the HTTP method and synchronization mode of the XMLHttpRequest call that the
proxy uses to interact with the server. The functions also can specify a JavaScript callback handler and an

© 2014 Adobe Systems Incorporated. All rights reserved.

117

Adobe ColdFusion Documentation

error handler for asynchronous calls.
Because JavaScript is case sensitive, ensure that you match the case of the keys in any ColdFusion structure
or scope that you send to the client. By default, ColdFusion sets variable names and structure element
names to all-uppercase. (You can create structure element names with lowercase characters by specifying
the names in associative array notation, for example, myStruct"myElement"="value".) The keys for the
two arrays in the JSON object that the ColdFusion serializeJSON tag generates to represent a query are C
OLUMNS and DATA, for example, not columns and data.
For detailed information on using AJAX CFC proxies, see Using ColdFusion Ajax CFC proxies in Using Ajax
Data and Development Features in the Developing ColdFusion Applications.
Note
The proxy passes a _CF_NODEBUG Boolean argument to called CFC functions.
ColdFusion checks this value, and when it is true, does not append to the response any
debugging information that it normally would send. This behavior ensures that the JSON
responses to AJAX requests do not include any non-JSON (i.e., debug information) text.

CFC proxy utility functions

When you use the cfc option, the JavaScript proxy object provides the following functions that you can use to
control interaction with the server:
Function

Description

setAsyncMode()

Sets the call mode to asynchronous. The calling thread
(the Java thread of the client system that is processing
the page) is not blocked when you make a call to a
proxy function, so page processing can continue while
waiting for a response from the server. The proxy
invokes the function specified by the setCallbackHa
ndler function with the response from the server. If an
error occurs, the proxy invokes the error handler
specified by the setErrorHandler function.

setCallbackHandler(function)

Specifies the callback handler for an asynchronous call.
The function parameter is the JavaScript function to
invoke as an argument. The callback function must
take one parameter, the return value from the CFC that
the proxy has deserialized from JSON to a JavaScript
representation.
This method automatically sets the call mode to
asynchronous.

© 2014 Adobe Systems Incorporated. All rights reserved.

118

Adobe ColdFusion Documentation

setErrorHandler(function)

Sets the error handler that the proxy invokes if there is
an error in an asynchronous call. The function para
meter is the JavaScript function to invoke. The error
handler function must take two parameters:
An HTTP error code
A status message
This method automatically sets the call mode to
asynchronous.

setForm(ID)

Adds names and values of the fields in the form
specified by the ID attribute to the arguments passed
by a proxy function that is called immediately after this
function.
For more information, see Submitting data to a CFC in
the Developing ColdFusion Applications.

setHTTPMethod("method")

Sets the HTTP method to use for the call. The method
parameter is a case-insensitive string, and must have
one of the following values:
GET (the default method)
POST

setQueryFormat(format)

Specifies the JSON format in which to return
ColdFusion query data. The parameter must have one
of the following values:
row: (Default) Sends the data as a JSON object with
two entries: the column names and an array of row
arrays.
column: Sends the data as a JSON object that
represents WDDX query format. This object has
three entries: the number of rows, an array with the
column names, and an object where the keys are the
column names and the values are arrays containing
the column data.
For more information on query formats, see Serial
izeJSON.

© 2014 Adobe Systems Incorporated. All rights reserved.

119

Adobe ColdFusion Documentation

setReturnFormat(format)

Specifies the format in which the CFC function returns
the result. ColdFusion automatically converts the
function return value into the specified format before
returning it to the client.
The parameter must have one of the following values:
json (the default format if you don't use this
function)
plain
wddx
If you specify plain, and set the "content-type"
header on the response from the server to text/xm
l, the proxy returns an XML object to the caller or
callback function. If the content type is not set to tex
t/xml, the return value from the server is returned
as-is. This function is useful if you return XML or a
plain string to the browser.

setSyncMode()

Sets the call mode to synchronous (the default
synchronization mode). The calling thread remains
blocked until the call returns. If an error occurs, the
proxy throws an exception. In synchronous mode, the
methods in the CFC proxy return the CFC method
results directly to the caller.

Example

The following example uses a remote CFC method to populate a drop-down list of employees. When you select a
name from the list, it uses a call to the CFC method to get information about the employee, and displays the results.
The application page has the following lines:











List of Employees:   








© 2014 Adobe Systems Incorporated. All rights reserved.

122

Adobe ColdFusion Documentation




The following component, which gets the data from the data source, must be in a file named emp.cfc in the
components subdirectory of the application directory. The CFC uses the cfdocexamples data source that is installed
with ColdFusion if you install the documentation.






select * from Employees

where Emp_ID = #empid#






© 2014 Adobe Systems Incorporated. All rights reserved.

123

Adobe ColdFusion Documentation

cfapplet
Description

This tag references a registered custom Java applet. To register a Java applet, in the ColdFusion Administrator,
select Extensions > Java Applets. Using this tag within a cfform tag is optional. If you use it within cfform, and
the method attribute is defined in the Administrator, the return value is incorporated into the form.
Category

Forms tags
Syntax



Note
You can specify this tag's attributes in an attributeCollection whose value is a structure.
Specify the structure name in the attributeCollection and use the tag's attribute names as
structure keys.

See also

cfform, cfformgroup, cfformitem, cfgrid, cfinput, cfobject, cfselect, cfservlet, cfslider, cfte
xtarea, cftree
History

ColdFusion MX:
Removed the requirement that you use this tag within a cfform tag.
Changed the behavior when this tag is used within a cfform tag; if the method attribute is defined in the
Administrator, the return value of the applet's method is incorporated into the form.
Attributes

Attribute

Req/Opt

appletSource

Required

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description
Name of registered
applet.

124

Adobe ColdFusion Documentation

name

Required

Form variable name for
applet.

align

Optional

Alignment:
Left
Right
Bottom
Top
TextTop
Middle
AbsMiddle
Baseline
AbsBottom

height

Optional

Height of applet, in pixels.

hSpace

Optional

Space on left and right of
applet, in pixels.

notSupported

Optional

param_n

Optional

Registered parameter for
applet. Specify only to
override values for applet
in ColdFusion
Administrator.

vSpace

Optional

Space above and below
applet, in pixels.

width

Optional

Width of applet, in pixels.

See description

Text to display if a page
that contains a Java
applet-based cfform con
trol is opened by a
browser that does not
support Java or has Java
support disabled, for
example:notSupported
= "Browser must
support Java to
view ColdFusion{{Java
Applets"}} Default
value: Browser
must support Java
to
 view
ColdFusion Java
Applets!

Usage

© 2014 Adobe Systems Incorporated. All rights reserved.

125

Adobe ColdFusion Documentation

You can specify the applet method attribute only in the Administrator, Java Applets view. For other attributes, you
can accept the default values in the Administrator view, or specify values in this tag and override the defaults. If Java
applet components are stored in a JAR file, enter the information in the J2EE Archives > ColdFusion Administrator.
For more information, see Embedding Java applets in the Developing ColdFusion Applications
Example


cfapplet lets you reference custom Java applets that have been
registered using the ColdFusion Administrator.

To register a Java applet, open the ColdFusion Administrator and
click "Applets" link under "extensions" section.

This example applet copies text that you type into a form. Type
some text, and then click "copy" to see the copied text.




© 2014 Adobe Systems Incorporated. All rights reserved.

126

Adobe ColdFusion Documentation

cfapplication
Description

Defines the scope of a ColdFusion application; enables and disables storage of Client variables; specifies the Client
variable storage mechanism; enables Session variables; and sets Application variable time-outs.
Category

Application framework tags
Syntax



Note
You can specify this tag's attributes in an attributeCollection whose value is a structure.
Specify the structure name in the attributeCollection and use the tag's attribute names as
structure keys.

See also

cfassociate, cferror, cflock, cfmessagebox; Application.CFC Reference; Designing and
Optimizing a ColdFusion Application and Integrating JEE and Java Elements in CFML
Applications in the Developing ColdFusion Applications
History

ColdFusion 11: Added attributes - compileextforinclude and strictnumbervalidation
ColdFusion 9: Added datasource, googleMapKey, and serverSideFormValidation attributeColdFusion
8: Added secureJSON and SecureJSONPrefix attributesColdFusion MX 7: Added scriptProtect attributeCol
dFusion MX 6.1: Added loginStorage attributeColdFusion MX:
Changed how persistent scopes are available: Server, Session, and Application scope variables are stored in
memory as structures. In earlier releases, only Session and Application scope variables were stored this way.
You cannot access the UDF function scope as a structure.
Changed the algorithm for setting the CFTOKEN variable value: if the registry key UUIDToken is a nonzero

© 2014 Adobe Systems Incorporated. All rights reserved.

127

Adobe ColdFusion Documentation

value, ColdFusion uses a number constructed from the UUID plus a random number. Otherwise, ColdFusion
sets the CFTOKEN variable default value using a positive random integer. (In earlier releases, ColdFusion
always used a number constructed from the UUID plus a random number.)
Attributes

Attribute

Req/Opt

Default

Description

authCookie

Optional

Struct containing
ColdFusion Authentication
cookie related properties

datasource

Optional

Name of the data source
from which the query
retrieves data.

name

See Description

Name of application. Up
to 64 characters.
For Application and
Session variables:
Required. For Client
variables: Optional

applicationTimeout

Optional

Specified in Variables
page of ColdFusion
Administrator

clientManagement

Optional

no

clientStorage

Optional

registry

Lifespan of application
variables. CreateTimeS
pan function and values in
days, hours, minutes, and
seconds, separated by
commas.
yes: enables client
variables.
no
How client variables are
stored:
datasource_name: in
ODBC or native data
source. Create storage
repository in the
Administrator.
registry: in the
system registry.
cookie: on client
computer in a cookie.
Scalable. If client
disables cookies in the
browser, client variables
do not work.

© 2014 Adobe Systems Incorporated. All rights reserved.

128

Adobe ColdFusion Documentation

exchangeServerVersi
on

Optional

2007

Specifies the Microsoft
Exchange Server version.
The values are:
2003
2007
2010
If you do not specify the
details, 2007 is taken
by default.

googleMapKey

Optional

The Google Maps API key
required to embed Google
Maps in your web pages.

loginStorage

Optional

cookie

scriptProtect

Optional

Determined by
ColdFusion Administrator
Enable Global Script
Protection setting

secureJSON

Optional

Administrator value

serverSideFormValid
ation

Optional

yes

© 2014 Adobe Systems Incorporated. All rights reserved.

cookie: store login
information in the
Cookie scope.
session: store login
information in the
Session scope.
Specifies whether to
protect variables from
cross-site scripting attacks
none: do not protect
variables
all: protect Form,
URL, CGI, and Cookie
variables
comma-delimited list of
ColdFusion scopes:
protect variables in the
specified scopes.
For more information,
see Usage.

If no, disables validation
on cfform fields when the
form is submitted.

129

Adobe ColdFusion Documentation

secureJSONPrefix

Optional

sessionCookie

Optional

sessionManagement

Optional

no

sessionTimeout

Optional

Specified in Variables
page of ColdFusion
Administrator

setClientCookies

Optional

yes

© 2014 Adobe Systems Incorporated. All rights reserved.

Administrator value

The security prefix to put
in front of the value that a
ColdFusion function
returns in JSON-format in
response to a remote call
if the secureJSON setting
is true. The default value
is the value of the Prefix
serialized JSON setting in
the Administrator Server
Settings > Settings page
(which defaults to //, the
JavaScript comment
character).
For more information see I
mproving security in the D
eveloping ColdFusion
Applications.
Struct containing
ColdFusion session
cookie related properties.
yes: enables session
variables.
no
Life span of session
variables. CreateTimeS
pan function and values in
days, hours, minutes, and
seconds, separated by
commas.
yes: enables client
cookies.
no: ColdFusion does
not automatically send
CFID and CFTOKEN
cookies to client
browser; you must
manually code CFID
and CFTOKEN on the
URL for every page that
uses Session or Client
variables.

130

Adobe ColdFusion Documentation

setDomainCookies

Optional

compileextforinclude

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

no

yes: uses domain
cookies for CFID and
CFTOKEN cookies and
for all Client variables
when using cookies for
client variable storage.
Required for
applications running on
clusters.
no: uses host-specific
cookies for CFID,
CFTOKEN, and all
client variable cookies.
Specify the list of allowed
file extensions (as a
comma separated list) for
the  tag.
Specifying a wildcard ('*')
in the list makes any file
included using the
 tag to be
compiled. If any file
included using the
 tag is not
found in this list, their
content will be statically
included. By default, files
with the extensions cfm
and cfml are always
compiled irrespective of
this setting. See cfinclude.

131

Adobe ColdFusion Documentation

strictnumbervalidation

Optional

true

In ColdFusion 10 and
earlier versions, the IsVali
d function allowed
currency symbols at the
start and commas inside
the number.
Starting from ColdFusion
11, this function evaluates
on a more strict basis.
Setting this value to false
makes the isValid function
to behave in the older
way. This setting effects cf
argument, cfparam and cff
orm tags wherever integer
& numeric validation is
used. Based on this
setting, the validation
reflects in those tags as
well.

Usage

This tag is typically used in the Application.cfm file, to set defaults for a ColdFusion application.
Note
You can also set the application defaults in the Application.cfc file. For more information, see Ap
plication variables.

This tag enables application variables, unless they are disabled in the ColdFusion Administrator. The Administrator
setting also overrides the sessionManagement attribute. For more information, see Configuring and Administering
ColdFusion. If ColdFusion is running on a cluster, specify clientStorage = "cookie" or a data source name;
you cannot specify "registry".ColdFusion generates an error if the application name is longer than 64
characters. The CFTOKEN variable is 8 bytes in length. Its range is 10000000 -99999999.
Note
If you specify ClientStorage=cookie, any Client scope variables set following a cfflush ta
g are not saved in the Client browser.

Protecting variables from cross-site scripting attacks

The ScriptProtect attribute lets you protect one or more variable scopes from cross-site scripting attacks, where
a client attempts to get your application to send malicious code back to a user's browser. In these attacks, user input
(for example, from form fields or from URL variables) sets a CF variable which is destined for user output. The
submitted data includes malicious code, such as JavaScript or an applet or object reference, which then executes
on the user's system.

© 2014 Adobe Systems Incorporated. All rights reserved.

132

Adobe ColdFusion Documentation

Note
The ColdFusion Administrator Settings page Enable Global Script Protection option determines
the default script protection setting. You can use the scriptProtect attribute to override the
Administrator setting. You can also use the Application.cfc initialization code to set the protection
value.

The ColdFusion cross-site scripting protection operation is done when ColdFusion processes the application
settings at the beginning of a request. Thus, it can process the URL, and Cookie, CGI, and Form variables in a
user's request. By default, it replaces occurrences of the following HTML tag names with the text InvalidTag: objec
t, embed, script, applet, and meta. It allows these names in plain text, and replaces the words if they are used
as tag names. You can specify any or all ColdFusion scopes for protection, but only the Form, URL, CGI, and
Cookie scopes have variables that are often provided by unknown sources. Also, protecting a scope requires
additional processing. For these reasons, the all attribute value applies protection to only the four scopes.
The script protection mechanism applies a regular expression that is defined in the cf_root/lib/neo-security.xml file in
the server configuration, or the cf_root/WEB-INF/cfusion/lib/neo-security.xml file in the JEE configuration to the
variable value. You can customize the patterns that ColdFusion replaces by modifying the regular expression in the
CrossSiteScriptPatterns variable.
Locking server, application, and session variables

When you set or update variables in the server, application, and session scopes, use the cflock tag with the scop
e attribute set to the following value:
For server variables, specify server
For application variables, specify application
For session variables, specify session
In some cases, you must also lock code that reads variables in these scopes. For information about locking
scopes, see cflock.
Example

© 2014 Adobe Systems Incorporated. All rights reserved.

133

Adobe ColdFusion Documentation



cfapplication Example


cfapplication defines scoping for a ColdFusion application and enables or
disables application and/or session variable storage. This tag is placed in a
special file called Application.cfm that automatically runs before any other CF page
in a directory (or subdirectory) where the Application.cfm file appears.













E-Turtleneck is proud to say that we have sold #application.number# turtlenecks to
date.



© 2014 Adobe Systems Incorporated. All rights reserved.

134

Adobe ColdFusion Documentation

cfargument
Description

Creates a parameter definition within a component definition. Defines a function argument. Used within a cffuncti
on tag.
Category

Extensibility tags
Syntax



See also

cfcomponent, cffunction, cfinterface, cfinvoke, cfinvokeargument, cfobject, cfproperty, cfret
urn
History

ColdFusion 10: Added the following REST attributes: restArgSource, restArgName}}
ColdFusion 8: Added {{component as a valid value for the ReturnType attribute.
ColdFusion MX 7: Added the xml value of type attribute.ColdFusion MX: Added this tag.
Attributes

Attribute

Req/Opt

name

Required

String; an argument
name.

default

Optional

If no argument is passed,
specifies a default
argument value.

displayname

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

name attribute value

Description

Meaningful only for CFC
method parameters. A
value to display when
using introspection to
show information about
the CFC.

135

Adobe ColdFusion Documentation

hint

Optional

required

Optional

Meaningful only for CFC
method parameters. Text
to display when using
introspection to show
information about the
CFC. The hint attribute
value follows the displa
yname attribute value in
the parameter description
line. Use this attribute to
describe the purpose of
the parameter.
no

Note: All arguments are
required when invoked as
a web service,
irrespective of how they
are defined.Specifies
whether the parameter is
required to execute the
component method. The
parameter is not required
if you specify a default
attribute.
yes
no

restArgSource

Optional

One of the following:
path: Extracts
parameters from the
resource URL. URI path
parameters are
extracted from the
request URI, and the
parameter names
correspond to the URI
path template variable
names specified in the
restPath specified in
cffunction. The
default value cannot be
used with path param.

© 2014 Adobe Systems Incorporated. All rights reserved.

136

Adobe ColdFusion Documentation

query: Extracts
parameters from URL
query parameters.
Mostly used with HTTP
GET method. When
using GET method to
send data, the
parameters and values
are encoded into the
URL. QueryParam is
used to extract these
values and assign them
to the appropriate
variables.
form: Extracts
parameters from a form
submission. It is used
with HTTP POST metho
d.
cookie: Extracts
values form a cookie.
header: Extracts
parameters from HTTP
header.
matrix: Extracts
parameters from matrix
URI. For details, see htt
p://www.w3.org/DesignI
ssues/MatrixURIs.html.
If no value is specified,
parameters are taken
from the body of the
request.Using cfhttp,
you can send
arguments in either
form or body. For form
parameter, the
argument is consumed
if you specify form as
the value for restArgS
ource and for body
parameter, if you do not
specify restArgSourc
e.
While calling the
service, if you pass the
argument in body, in
some scenarios, it is
accepted as form. For
example, . This is
because, when you
pass the form
name-value pair
through cfhttp or the
body as "name=value
", the body content is
same, due to which
REST service is not
able to detect what is
passed.
In the service, if you
expect body argument
but while accessing the
service through cfhttp
, no argument in the
body is passed, you will
still receive the body
argument as empty
string.
If you use this attribute,
but do not specify the

© 2014 Adobe Systems Incorporated. All rights reserved.

138

Adobe ColdFusion Documentation

type attribute, string is
considered by default
as the type.
restArgName

Optional

type

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

The name that can be
mapped to the argument
name.
While calling functions,
arguments are extracted
from the incoming
request. If restArgName
is provided, it is searched
in the restArgSource s
cope of the request to
populate the argument. If
not specified, argument
name is searched.
If specified, then
argument name has no
impact. You can specify
correct argument name so
that it corresponds to the
appropriate parameter. If
the argument name
passed to a REST service
is not a valid Java
identifier, for example, the
name has hyphen (say ar
g-name), then you can
use this attribute to map
the argument name.
any

String; a type name; data
type of the argument.

139

Adobe ColdFusion Documentation

any
array
binary
boolean
component: the
argument must be a
ColdFusion component.
date
guid: the argument
must be a UUID or
GUID of the form xxxxx
xxx-xxxx-xxxx-xxxx-xxx
xxxxxxxxx where each_
x_ is a character
representing a
hexadecimal number
(0-9A-F).
numeric
query
string
struct
uuid: the argument
must be a ColdFusion
UUID of the form xxxxx
xxx-xxxx-xxxx-xxxxxxxx
xxxxxxxx where each_
x_ is a character
representing a
hexadecimal number
(0-9A-F).
variableName: a
string formatted
according to
ColdFusion variable
naming conventions.
xml: XML objects and
XML strings
a component name: if
the type attribute value
is not one of the
preceding items,
ColdFusion treats it as
the name of a
ColdFusion component.
When the function
executes, it generates
an error if the argument
that is passed in is not a
CFC with the specified
name.

Usage

© 2014 Adobe Systems Incorporated. All rights reserved.

140

Adobe ColdFusion Documentation

This tag must be in a cffunction tag, before any other tags in the cffunction tag body.Arguments that are
passed when a method is invoked can be accessed from the method body in the following ways:
With shorthand syntax: #myargument# (This example accesses the argument myargument.)
Using the arguments scope as an array: #arguments[1]# (This example accesses the first defined
argument in the cffunction.)
Using the arguments scope as a struct: #arguments.myargument# (This example accesses the argument
myargument in the array.)
Example







SELECT Descript
FROM Courses
WHERE Number = '#Course_Number#'





© 2014 Adobe Systems Incorporated. All rights reserved.

141

Adobe ColdFusion Documentation

cfassociate
Description

Allows subtag data to be saved with a base tag. Applies only to custom tags.
Category

Application framework tags
Syntax



Note
You can specify the attributes of this tag in an attributeCollection whose value is a
structure. Specify the structure name in the attributeCollection and use the tag's attribute
names as structure keys.

See also

cfapplication, cferror, cflock, cfmessagebox; High-level data exchange in Nesting custom tags in
the Developing ColdFusion Applications.
Attributes

Attribute

Req/Opt

baseTag

Required

dataCollection

Optional

Default

Description
Base tag name.

AssocAttribs

Structure in which base
tag stores subtag data.

Usage

Call this tag within a subtag, to save subtag data in the base tag.
When ColdFusion passes subtag attributes back to the base tag, it saves them in a structure whose default name is
AssocAttribs. To segregate subtag attributes (in a base tag that can have multiple subtags), specify a structure
name in the dataCollection attribute. The structure is appended to an array whose name is thistag.collectionNa
me.
In the custom tag code, the attributes passed to the tag by using the cfmodule tag attributeCollection attrib
ute are saved as independent values, with no indication that they are grouped into a structure by the custom tag's
caller. Therefore, in the called tag, if you assign a value to a specific attribute, it replaces the value passed in the at
tributeCollection attribute that you used when calling the subtag.
Example

© 2014 Adobe Systems Incorporated. All rights reserved.

142

Adobe ColdFusion Documentation








...

© 2014 Adobe Systems Incorporated. All rights reserved.

143

Adobe ColdFusion Documentation

cfauthenticate
Description

This tag is obsolete. Use the newer security tools; see Conversion functions and Securing Applications in the Develo
ping ColdFusion Applications.
History

ColdFusion MX: This tag is obsolete. It does not work in ColdFusion MX and later releases.

© 2014 Adobe Systems Incorporated. All rights reserved.

144

Adobe ColdFusion Documentation

cfbreak
Description

Used within a cfloop tag. Breaks out of a loop.
Category

Flow-control tags
Syntax



See also

cfabort, cfcontinue, cfexecute, cfif, cflocation, cfloop, cfthrow, cftry; cfloop and cfbreak in the D
eveloping ColdFusion Applications
Tag example


#i#






Script example

for (i=1; i <= 10; i++){
writeOutput("#i#
");
if (i >= 5){
break;
}
}

Either version of the code above outputs:

1
2
3
4
5

© 2014 Adobe Systems Incorporated. All rights reserved.

145

Adobe ColdFusion Documentation

© 2014 Adobe Systems Incorporated. All rights reserved.

146

Adobe ColdFusion Documentation

Tags c
This section lists tags starting with alphabet C with their description.
cfcache
cfcalendar
cfcase
cfcatch
cfchart
cfchartdata
cfchartseries
cfcol
cfcollection
cfcomponent
cfcontent
cfcontinue
cfcookie
cfclient
cfclientsettings

© 2014 Adobe Systems Incorporated. All rights reserved.

147

Adobe ColdFusion Documentation

cfcache
Description

Stores a copy of a page on the server and/or client computer, to improve page rendering performance. To do this,
the tag creates temporary files that contain the static HTML returned from a ColdFusion page.Use this tag if it is not
necessary to get dynamic content each time a user accesses a page. You can use this tag for simple URLs and for
URLs that contain URL parameters.
Category

Page processing tags
Syntax


useCache = "true|false"
usequerystring = "false|true"
username = "username"
value = "value">
The page fragment to be cached, if any.


Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfflush, cfheader, cfhtmlhead, cfsetting, cfsilent, Cache functions
History

ColdFusion 10: Added the attribute {{region}}ColdFusion 9:
Added support for the following features:

© 2014 Adobe Systems Incorporated. All rights reserved.

148

Adobe ColdFusion Documentation

Caching in memory. Memory is now the default cache location.
Caching page fragments.
Caching specific objects, including the ability to put, get, and flush cached objects.
Setting cache dependencies.
Setting an idle timeout.
Getting metadata about cached objects.
The ability to strip white space from cached page fragments.
The ability to throw an exception if an error occurs when flushing a cached object.
Added get and put values of the action attribute. These values support caching of objects.
Added dependsOn, id, idleTime, key, metadata, name, stripWhiteSpace, throwOnError, useCac
he, usequerystring, and value attributes.
ColdFusion MX:
Deprecated the cachedirectory and timeout attributes. They might not work, and might cause an error,
in later releases.
Added the timespan attribute.
Changed how pages are cached: the default action attribute value, cache, caches a page on the server
and the client. (In earlier releases, this option cached a page only on the server.)
Changed the source of the protocol and port values: the default protocol and port values are now
taken from the current page URL. (In earlier releases, they were "http" and "80", respectively.)
Changed how session state is handled when caching a page: this tag can cache pages that depend on
session state, including pages that are secured with a ColdFusion login. (In earlier releases, the session state
was cleared when caching the page, causing authentication to be lost.)
Changed how files are cached: this tag uses a hash() of the URL for the filename to cache a file. (In earlier
releases, ColdFusion used the cfcache.map file.)
Attributes

Attribute

Actions

© 2014 Adobe Systems Incorporated. All rights reserved.

Req/Opt

Default

Description

149

Adobe ColdFusion Documentation

action

All

Optional

dependsOn

cache, serverCac
he, optimal

Optional

directory

cache, serverCa
che, clientCach
e, optimal,
flush, put

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

serverCache

cache:
server-side and
client-side page
caching.
clientcache:
browser-side
page caching
only. To cache a
personalized
page, use this
option.
flush: remove
the current
versions of
cached pages,
fragments, or an
object from the
cache. The cache
is refreshed the
next time a user
accesses the
item. For more
information see
Description.
get: get an object
from the cache.
optimal: same
as cache.
put: Add an
object to the
cache.
serverCache:
server-side
caching only.
A comma separated
list of variables. If
any of the variable
values change,
ColdFusion updates
the cache. This
attribute can take an
expression that
returns a list of
variables.

Cache in memory

Absolute path of
cache directory.

150

Adobe ColdFusion Documentation

expireURL

flush

Optional

id

flush, get, put

See description

idleTime

cache, serverCa
che, clientCach
e, optimal,
flush, put

Optional

Flush all cached
pages

A URL reference.
Can include
wildcards, for
example: "/view.c
fm?id=".
ColdFusion flushes,
from the cache,
pages that match
the specified URL or
pattern.
The identifier for a
cached object. This
attribute can also
take a
comma-separated
list of identifiers.
This attribute is
required for the any
operation on an
object. Therefore it
is required for the g
et and put actions,
and to flush an
object. It is not
required to flush a
page.

No idle timeout

Flushes the cached
item if it is not
accessed for the
specified time span:
A decimal number
of days, for
example: ".25", for
one-fourth day (6
hours); "1", for
one day; "1.5", for
one and one half
days
A return value
from the CreateT
imeSpan function
, for example, "#C
reateTimeSpan
(0, 6, 0, 0)#".

© 2014 Adobe Systems Incorporated. All rights reserved.

151

Adobe ColdFusion Documentation

metadata

get

Optional

The name of a
structure variable in
which to put object
metadata. The get
operation returns
the following data:
timespan: The
time span during
which the cached
item is valid; the
value of the
timespan attribute
for the cached
item.
createdtime: The
time when the
cache was
created
lasthit: The time
when the cached
item was most
recently used.
hitnumber:
Number of times
the cached item
has been used.
missnumber:
Number of misses

name

get

Required

The name of the
variable in which to
put the retrieved
object.

password

cache, serverCa
che, clientCach
e, optimal,
flush

Optional

A password. Provide
this if the page
requires
authentication at the
web-server level.

© 2014 Adobe Systems Incorporated. All rights reserved.

152

Adobe ColdFusion Documentation

port

cache, serverCa
che, clientCach
e, optimal,
flush

Optional

The port for the
current page

Port number of the
web server from
which the URL for
the cached page is
requested. In the
internal call from cf
cache to cfhttp,
ColdFusion resolves
each URL variable
in the page; this
ensures that links in
the page remain
functional.

protocol

cache, serverCa
che, clientCach
e, optimal,
flush

Optional

The current page
protocol

Protocol that is used
to create URL from
cache.
http://
https://

Optional

region

Name that you
assign to a cache
region

stripWhiteSpace

cache, serverCa
che, optimal

Optional

false

Specifies whether to
strip any
unnecessary white
space characters
from a cached page
fragment. Does not
have any effect on
cached pages or
objects.

throwOnError

flush with id attrib
ute

Optional

false

A Boolean value
specifying whether
to throw an error if
the flush action
encounters an error.
Otherwise the action
does not generate
an error if it fails. If
this attribute is true
you can handle the
error in a cfcatch
block, for example, if
a specified id value
is invalid.

© 2014 Adobe Systems Incorporated. All rights reserved.

153

Adobe ColdFusion Documentation

timespan

useCache

cache, serverCa
che, clientCach
e, optimal,
flush, put

Optional

cache, serverCa
che, optimal,

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

See Description

The interval until the
item is flushed from
the cache.
A decimal number
of days, for
example: ".25", for
one-fourth day (6
hours); "1", for
one day; "1.5", for
one and one half
days
A return value
from the CreateT
imeSpan function
, for example, "#C
reateTimeSpan
(0, 6, 0, 0)#".
The default action
is to flush the item
when it is idle for
the time specified
by the idleTime
attribute, or cfca
che action = "
flush" executes.

true

Specifies whether to
use caching for a
page. This attribute
can be useful during
development. For
example, you could
use a function to
predict when to use
a cache, based on
the application state.

154

Adobe ColdFusion Documentation

Optional

usequerystring

false

If true, generates a
template cache ID
that includes the
query string. This
means that a new
template cache is
created whenever
the query string
changes.
If set to true, the
attribute dependso
n considers the URL
parameters defined
in the query string
as well to generate
template caches.
Also see the Usage
section

username

cache, serverCa
che, clientCach
e, optimal,
flush

Optional

A username.
Provide this if the
page being cached
or flushed requires
authentication at the
web server level.

value

put

Required

The object to cache.

Usage

Page fragments: To cache a page fragment, put the fragment in the body of the tag, between the begin tag and the
end tag. Do not use a tag body to cache full pages or objects.
flush: The flush action can have two formats: One uses the ExpireURL attribute to specify the page to flush, the
other uses the id attribute to specify the object to flush. When you flush an object, ColdFusion ignores errors by
default. If you specify a throwOnError attribute with a true value, the action throws the errors, and you can use a
catch block to handle them. This is useful to determine if you use invalid cache ID values.
User-defined cache: To create user-defined cache,
1. Add the following snippet to the ehcache.xml (in the _CF_root_lib):

© 2014 Adobe Systems Incorporated. All rights reserved.

155

Adobe ColdFusion Documentation



2. To reference the user-defined cache, use the key attribute as follows:


#now()#


By default, caching is memory-based and not disk-based. For each application, the default setting is 10000
object caches and 10000 template caches. It is important to note the limit imposed on the number of
objects/templates that can be cached.
Diskoverflow for caching by default is false. To enable disk caching, set overflowTodisk as true in the
ehcache.xml. To make the cached data available on server restart, set diskPersistent to true.
For further details of the properties in the ehcache.xml, refer to the documentation available at the following
URL:http://ehcache.org/
From ColdFusion 8 and earlier
The following remaining information for this tag also applied to previous releases.
Use this tag in pages whose content is not updated frequently. Taking this action can greatly improve the
performance of your application.
The output of a cached page is stored in a file on the client browser and/or the ColdFusion server. Instead of
regenerating and downloading the output of the page each time it is requested, ColdFusion uses the cached
output. ColdFusion regenerates and downloads the page only when the cache is flushed, as specified by the
timespan attribute, or by invoking cfcache action=flush.
To enable a simple form of caching, put a cfcache tag, specifying the timespan attribute, at the top of a
page. Each time the specified time span passes, ColdFusion flushes (deletes) the copy of the page from the
cache and caches a new copy for users to access.
You can specify client-side caching or a combination of client-side and server-side caching (the default),
using the action attribute. The advantage of client-side caching is that it requires no ColdFusion resources;
the browser stores pages in its own cache, improving performance. The advantage of combination caching is
that it optimizes server performance; if the browser does not have a cache of the page, the server can get
data from its own cache. (Adobe recommends that you use combination caching, and do not use server-side
only caching.)
If a page contains personalized content, use the action = "clientcache" option to avoid the possibility
of caching a personalized copy of a page for other users.
Debug settings have no effect on cfcache unless the application page enables debugging. When generating
a cached file, cfcache uses cfsetting showDebugOutput = "no".
The cfcache tag evaluates each unique URL, including URL parameters, as a distinct page, for caching
purposes. For example, the output of http://server/view.cfm?id=1 and the output of http://server/view.cfm?id=

© 2014 Adobe Systems Incorporated. All rights reserved.

156

Adobe ColdFusion Documentation

2 are cached separately.
The cfcache tag uses the cfhttp tag to get the contents of a page to cache. If there is an HTTP error
accessing the page, the contents are not cached. If a ColdFusion error occurs, the error is cached.
For more information, see Caching ColdFusion pages that change infrequently in Optimizing ColdFusion
applications in the Developing ColdFusion Applications.
Change in behaviour
Till ColdFusion 9, the request query string was automatically used as part of the page identifier, so that pages
with different query strings (URL parameters) are cached independent of each other. However, you must now
specify the new optional attribute usequerystring with value set to true, to achieve the older behavior.
Example





This is a test of some simple output


This page was generated at #now()#



The value of URL.x = # URL.x #

© 2014 Adobe Systems Incorporated. All rights reserved.

157

Adobe ColdFusion Documentation

cfcalendar
Description

Puts an interactive Flash format calendar in an HTML or Flash form. Not supported in XML format forms. The
calendar lets a user select a date for submission as a form variable.
Category

Forms tags
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfform, cfgrid, cfinput, cfselect, cfslider, cftextarea, cftree; About Flash form styles in the Develo
ping ColdFusion Applications.
History

ColdFusion MX 7.01: Added support for onBlur and onFocus events. ColdFusion MX 7: Added tag.
Attributes

Attribute

Req/Opt

name

Required

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description
The name of the calendar.

158

Adobe ColdFusion Documentation

dayNames

Optional

S, M, T, W, Th, F,
S

A comma-delimited list
that sets the names of the
weekdays displayed in the
calendar. Sunday is the
first day and the rest of
the weekday names follow
in the normal order.

disabled

Optional

Not disabled

Disables all user input,
making the control
read-only. To disable
input, specify disabled
without an attribute or dis
abled="Yes" (or any
ColdFusion positive
boolean value, such as tr
ue). To enable input, omit
the attribute or specify di
sabled="No" (or any
ColdFusion negative
Boolean value, such as f
alse).

enabled

Optional

yes

Flash only: Boolean value
that specifies whether the
control is enabled. A
disabled control appears
in light gray. This is the
inverse of the disabled
attribute.

endRange

Optional

firstDayOfWeek

Optional

0

Integer in the range 0-6
specifying the first day of
the week in the calendar:
0 indicates Sunday; 6
indicates Saturday.

height

Optional

Determined by Flash

The vertical dimension of
the calendar specified in
pixels.

© 2014 Adobe Systems Incorporated. All rights reserved.

The end of a range of
dates that are disabled.
Users cannot select dates
from the date specified by
the startRange attribute
through this date.

159

Adobe ColdFusion Documentation

mask

Optional

MM/DD/YYYY

A pattern that specifies
the format of the
submitted date. Mask
characters are:
D = day; can use 0-2
mask characters
M = month; can use 0-4
mask characters
Y = year; can use 0, 2,
or 4 characters
E = day in week; can
use 0-4 characters
Any other character =
put the character in the
specified location
For more information on
masking, see "Masking
input data" in the cfin
put reference page.

monthNames

Optional

onBlur

Optional

ActionScript that runs
when the calendar loses
focus.

onChange

Optional

ActionScript that runs
when the user selects a
date.

onFocus

Optional

ActionScript that runs
when the calendar gets
focus.

selectedDate

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

January, February,
March, April, May,
June, July, August,
September, October,
November, December

None (Flash shows the
current month)

A comma-delimited list of
the month names that are
displayed at the top of the
calendar.

The date that is initially
selected. It is highlighted
in a color determined by
the form skin. Must be in
mm/dd/yyyy or
dd/mm/yyyy format,
depending on the current
locale. (Use the setloca
le function to set the
locale, if necessary.)

160

Adobe ColdFusion Documentation

startRange

Optional

The start of a range of
dates that are disabled.
Users cannot select dates
from this date through the
date specified by the end
Range attribute.

style

Optional

Flash ActionScript style or
styles to apply to the
calendar. For more
information, see Setting
styles and skins in Flash
forms in the Developing
ColdFusion Applications.

tooltip

Optional

Flash only: Text to display
when the mouse pointer
hovers over the control.

visible

Optional

yes

Flash only: Boolean value
that specifies whether to
show the control. Space
that would be occupied by
an invisible control is
blank.

width

Optional

Determined by Flash

The horizontal dimension
of the calendar specified
in pixels.

Usage

The cfcalendar tag displays a calendar month, showing the month, the year, a grid of the days of the month, and
headings for the days of the week. The calendar contains forward and back arrow buttons to let you change the
month and year that are displayed.
If you include a value for the selectedDate attribute, that date is highlighted in green and determines the month
and year that display initially. Changing the month and year display does not change the selected date. A user can
change the selected date by clicking a different date on the calendar. The onChange attribute can specify an
ActionScript event handler function that runs when the user selects a date.
The current date is highlighted in reverse (that is, a white number on a black background). If the selected date is in a
different month or year, however, the current date does not appear unless you move to it by clicking the forward or
back arrows.
The mask attribute lets you specify the format of the selected date that is returned to the application.
You can use the keyboard to access and select dates from a cfcalendar control:
Use the Up, Down, Left, and Right Arrow keys to change the selected date.
Use the Home and End keys to reach the first and last enabled date in a month, respectively.
Use the Page Up and Page Down keys to reach the previous and next month, respectively.

© 2014 Adobe Systems Incorporated. All rights reserved.

161

Adobe ColdFusion Documentation

Note
The cfcalendar tag is not supported in XML format forms.

Example

This example produces a 200-pixel by 150-pixel calendar with a Flash haloBlue skin. It displays abbreviated month
names and two-character days of the week. It initially displays today's date as determined by the selectedDate att
ribute. When you click the Save button, the form submits back to the current page, which displays the submitted
information.
The example also has three dateField controls that let the user change the initial selected date that displays on
the calendar and a blocked-out date range. The initial blocked-out date is a four-day period immediately preceding
today's date.
Note
This example must be modified to work in locales that do not use mm/dd/yyyy date formats. To
do so, use the LSDateFormat function in place of the DateFormat function and a mask that is
appropriate for your locale, such as dd/mm/yyyy.







You selected #Form.selectedDate#



Please select a date on the calendar and click Save.











© 2014 Adobe Systems Incorporated. All rights reserved.

162

Adobe ColdFusion Documentation

cfcase
Description

Used only inside the cfswitch tag body. Contains code to execute when the expression specified in the cfswitc
h tag has one or more specific values.
Category

Flow-control tags
Syntax



See also

cfdefaultcase, cfswitch; cfswitch, cfcase, and cfdefaultcase in the Developing ColdFusion Applications
History

ColdFusion 8: Changed the way ColdFusion parses cfcase values. Previously, cfcase tags with numeric value
dates did not return expected results. For example, \ and \

You can use the delimiter attribute to specify one or more delimiters to use in place of the comma. For example,
the following line matches "cargo, live", "cargo, liquid", and "cargo, solid":



Example

The following example displays a grade based on a 1-10 score. Several of the cfcase tags match more than one
score. For simplicity, the example sets the score to 7.

© 2014 Adobe Systems Incorporated. All rights reserved.

164

Adobe ColdFusion Documentation




















Your grade is #grade#


© 2014 Adobe Systems Incorporated. All rights reserved.

165

Adobe ColdFusion Documentation

cfcatch
Description

Used inside a cftry tag. Together, they catch and process exceptions in ColdFusion pages. Exceptions are events
that disrupt the normal flow of instructions in a ColdFusion page, such as failed database operations, missing
include files, and developer-specified events.
Category

Exception handling tags
Syntax


Exception processing code here 

See also

cftry, cferror, cffinally, cfrethrow, cfthrow, onError; Handling Errors in the Developing
ColdFusion Applications
History

ColdFusion 10: Added the sessionCookie and authCookie attributes.ColdFusion MX:
Changed SQLSTATE value behavior: the SQLSTATE return value in a cfcatchtag depends on the
database driver type:
Type 1 (JDBC-ODBC bridge): the value is the same as in ColdFusion 5.
Type 4 (100% Java, no native methods): the value might be different.
If your application depends on SQLSTATE values for flow control, the application might produce
unexpected behavior with ColdFusion MX.
Changed the behavior of this tag when type="any": it is not necessary, when you include a cfcatch tag
with type="any", to do so in the last cfcatch tag in the block, to ensure that all other tests are executed
before it. ColdFusion finds the best-match cfcatch block.
Changed the behavior of the cfscript tag: it includes try and catch statements that are equivalent to the
cftry and cfcatch tags.
Changed object modification: you cannot modify the object returned by cfcatch.
Changed thrown exceptions: the cfcollection, cfindex, and cfsearch tags can throw the
SEARCHENGINE exception. In earlier releases, an error in processing these tags threw only an UNKNOWN
exception.
Attributes

Attribute

Req/Opt

name

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description
Variable name for cfcat
ch expression.

166

Adobe ColdFusion Documentation

Optional

type

Any

application: catches
application exceptions
database: catches
database exceptions
template: catches
ColdFusion page
exceptions
security: catches
security exceptions
object: catches object
exceptions
missingInclude:
catches missing include
file exceptions
expression: catches
expression exceptions
lock: catches lock
exceptions
custom_type: catches
the specified custom
exception type that is
defined in a cfthrow t
ag
searchengine:
catches Solr search
engine exceptions
any: catches all
exception types

Usage

You must code at least one cfcatch tag within a cftry block. Put cfcatch tags at the end of a cftry block.
ColdFusion tests cfcatch tags in the order in which they appear. This tag requires an end tag.
If type="any", ColdFusion catches exceptions from any CFML tag, data source, or external object. To get the
exception type use code such as the following:

#cfcatch.type#

Applications can use the cfthrow tag to throw developer-defined exceptions. Catch these exceptions with any of
these type options:
"custom_type"
"Application"
"Any"
The custom_type type is a developer-defined type specified in a cfthrow tag. If you define a custom type as
a series of strings concatenated by periods (for example, "MyApp.BusinessRuleException.InvalidAc
count"), ColdFusion can catch the custom type by its character pattern. ColdFusion searches for a cfcatc
h tag in the cftryblock with a matching exception type, starting with the most specific (the entire string), and
ending with the least specific. For example, you could define a type as follows:

© 2014 Adobe Systems Incorporated. All rights reserved.

167

Adobe ColdFusion Documentation



If you have the following cfcatchtag, it handles the exception:



Otherwise, if you have the following cfcatchtag, it handles the exception:



Finally, if you have the following cfcatchtag, it handles the exception:



You can code cfcatch tags in any order to catch a custom exception type.
If you specify type = "Application", the cfcatch tag catches only custom exceptions that have the Ap
plication type in the cfthrow tag that defines them.
The cfinclude, cfmodule, and cferror tags throw an exception of type = "template".
An exception that is thrown within a cfcatch block cannot be handled by the cftry block that immediately
encloses the cfcatch tag. However, you can rethrow the currently active exception with the cfrethrow tag.
The cfcatch variables provide the following exception information:
cfcatch variable

Content

cfcatch.type

Type: Exception type, as specified in cfcatch.

cfcatch.message

Message: Exception's diagnostic message, if provided;
otherwise, an empty string; in the cfcatch.message
variable.

cfcatch.detail

Detailed message from the CFML interpreter or
specified in a cfthrow tag. When the exception is
generated by ColdFusion (and not cfthrow), the
message can contain HTML formatting and can help
determine which tag threw the exception.

cfcatch.tagcontext

An array of tag context structures, each representing
one level of the active tag context at the time of the
exception.

© 2014 Adobe Systems Incorporated. All rights reserved.

168

Adobe ColdFusion Documentation

cfcatch.NativeErrorCode

Applies to type = "database". Native error code
associated with exception. Database drivers typically
provide error codes to diagnose failing database
operations. Default value is -1.

cfcatch.SQLState

Applies to type = "database". SQLState associated
with exception. Database drivers typically provide error
codes to help diagnose failing database operations.
Default value is 1.

cfcatch.Sql

Applies to type = "database". The SQL statement
sent to the data source.

cfcatch.queryError

Applies to type ="database". The error message as
reported by the database driver.

cfcatch.where

Applies to type= "database". If the query uses the c
fqueryparam tag, query parameter name-value pairs.

cfcatch.ErrNumber

Applies to type = "expression". Internal expression
error number.

cfcatch.MissingFileName

Applies to type = "missingInclude". Name of file
that could not be included.

cfcatch.LockName

Applies to type = "lock". Name of affected lock (if
the lock is unnamed, the value is "anonymous").

cfcatch.LockOperation

Applies to type = "lock". Operation that failed
(Timeout, Create Mutex, or Unknown).

cfcatch.ErrorCode

Applies to type = "custom". String error code.

cfcatch.ExtendedInfo

Applies to type = "application" and "custom".
Custom error message; information that the default
exception handler does not display.

Example

© 2014 Adobe Systems Incorporated. All rights reserved.

169

Adobe ColdFusion Documentation



cftry Example





SELECT *
FROM employees






You've Thrown a Database Error




#cfcatch.message#


Caught an exception, type = #CFCATCH.TYPE#


The contents of the tag stack are:






© 2014 Adobe Systems Incorporated. All rights reserved.

170

Adobe ColdFusion Documentation

cfchart
Description
Generates and displays a chart.
Category

Data output tags, Extensibility tags
Syntax




OR



© 2014 Adobe Systems Incorporated. All rights reserved.

172

Adobe ColdFusion Documentation

zoom = "JSON string representation"


Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfchartdata, cfchartseries, cfdocument, Controlling chart appearance in the Developing ColdFusion
Applications
History

ColdFusion 11:
The server-side charting introduced in ColdFusion 10 that allowed you to create highly interactive charts has been
further enhanced to produce visually more appealing charts.
Note that the new look and feel will not be available for the following tag attributes:
cfchart
labelFormat
seriesPlacement with percent as the value
sortXAxis
tipStlye
xAxisType
yAxisType
xOffset
yOffset

cfchartseries
markerStyle: letterx, mcross, snow, and rcross.
paintStyle

ColdFusion provides a utility to convert XML styles (used by the old charting system) to JSON styles (used by the
new charting system).
To perform this conversion, you need to use cfchart_xmltojson.bat (or cfchart_xmltojson.sh) available in
/bin folder:

cfchart_xmltojson.bat 

The converted JSON style will be created in the same location as the XML file.

© 2014 Adobe Systems Incorporated. All rights reserved.

173

Adobe ColdFusion Documentation

Also, in ColdFusion 11, the XML format style has been removed.

ColdFusion 10: Added the following new attributes: alpha, arrows, aspect3D, background, bevel,
border, crosshair, fill, format, height, ID, labels, legend, plot, plotarea, preview,
refresh, renderer, scales, type, tooltip, width, xaxis, axis2, xaxisvalues, yaxis,
yaxis2, yaxisvalues, zoom
ColdFusion 8:
Added the new attribute showLegend to the chart style files, which are the XML files located in the
charting\styles directory- This attribute displays an entry for each point and is applicable only to charts that
contain a single series. By default, the value of showLegend is set to true. To turn off this feature, you can
either modify the setting in all the chart style files, or use a custom style file.
ColdFusion MX 7.01: Changed documentation to state that the fontSize attribute can accept a number that is not
an integer.
ColdFusion MX 7:
Added style and title attributes.
Added support for eight-digit hexadecimal values to specify RGB color and transparency.
Removed the rotated attribute.
ColdFusion MX 6.1:
Added the xAxisType and yAxisType attributes.
Changed interpolation behavior: the tag now interpolates data points on line charts with multiple series.
ColdFusion MX: Added this tag.
Attributes

Attribute

Req/Opt

Default

alpha

Optional

Alpha (transparency) level
of the background. Valid
values range from 0
(transparent) to 1
(opaque).

arrows

Opt

© 2014 Adobe Systems Incorporated. All rights reserved.

Description

Creates an arrow for
pointing out data or other
chart items.JSON string
representation of array of
structs that contain values
such as to, from, size,
and label.

174

Adobe ColdFusion Documentation

aspect3D

Opt

JSON string
representation of struct
that defines the angle of
3D aspect. The valid
struct keys are angle and
depth.

background

Opt

A struct of keys related to
background such as
color: Sets the
background color(s)
color-1: Sets the first
background color for
the arrow
color-2: Sets the
second background
color for the arrow
(used with gradients)
transparent: Set the
transparency of a
background image so
that underlying colors or
chart can show.
fit: Defines the
width/height to fit area
of background.
repeat: Defines type
of image repeat.
image: Defines the
path to the background
image.
position: Defines the
position of the
background image.

backgroundColor

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

Color of the area between
the data background and
the chart border, around
labels and around the
legend. Hexadecimal
value or supported named
color; see the name list in
Usage. For a hexadecimal
value, use the form "##x
xxxxx" or "##xxxxxxxx
", where x = 0-9 or A-F;
use two number signs or
none.

175

Adobe ColdFusion Documentation

bevel

Opt

A struct of keys related to
bevel such as.
color: Defines the
color of the bevel.
blur-x: Defines the
sharpness/smoothness
of the bevel edges in
the x-direction.
blur-y: Defines the
sharpness/smoothness
of the bevel edges in
the y-direction.
angle: Defines the
angle of the bevel.
distance: Distance in
# | #px indicating the
distance from the object
the bevel should be
displayed.

border

Opt

A struct of keys related to
border such as:
color: Sets the color
of the border.
radius: Defines the
radius of rounded
corners.
width: Defines the
width of the border.

chartHeight

Optional

240

Chart height; integer
number of pixels.

chartWidth

Optional

320

Chart width; integer
number of pixels.

crosshair

Opt

A struct of keys related to
crosshair such as:
line-color: Sets the
color of the crosshair
lines.
alpha: Defines the
alpha transparency
level of the line.
line-style: Defines
the line style.

© 2014 Adobe Systems Incorporated. All rights reserved.

176

Adobe ColdFusion Documentation

dataBackgroundColor

Optional

fill

Opt

white

Color of area around chart
data.Hexadecimal value
or supported named color;
see the name list in the
Usage section.
For a hexadecimal value,
use the form "##xxxxxx
" or "##xxxxxxxx",
where x = 0-9 or A-F; use
two number signs or
none.
A struct of keys related to
fill such as:
angle: Sets the angle
at which a linear fill is
displayed. A fill angle of
zero displays a vertical
gradient from top
(background-color-1) to
bottom
(background-color-2).
offset-x: Set x-axis
offset for background
gradient.
offset-y: Set y-axis
offset for background
gradient..

format

Req

flash

Format of the chart to be
rendered. The supported
formats are html, flash,
jpg, and png.

font

Optional

arial

Name of text font:
arial
times
courier
arialunicodeMS.
This option is required,
if you are using a
double-byte character
set on UNIX, or using a
double-byte character
set in Windows with a
file type of Flash.

© 2014 Adobe Systems Incorporated. All rights reserved.

177

Adobe ColdFusion Documentation

fontBold

Optional

no

Whether to make the text
bold:
yes
no

fontItalic

Optional

no

Whether to make the text
italicized:
yes
no

fontSize

Optional

11

Font size. If the number is
not an integer, ColdFusion
rounds the number up to
the next integer.

foregroundColor

Optional

black

Color of text, grid lines,
and labels.Hexadecimal
value or supported named
color; see name list in the
Usage section.
For a hexadecimal value,
use the form "##xxxxxx
" or "##xxxxxxxx",
where x = 0-9 or A-F; use
two number signs or
none.

format

Optional

flash

File format in which to
save the graph:
flash
jpg
png

gridlines

Optional

height

Opt

Chart height; integer;
number of pixels.

ID

Opt

ID of the chart. Used to
get the underlying
chartobject.

© 2014 Adobe Systems Incorporated. All rights reserved.

10, including top and
bottom

Number of grid lines to
display on the value axis,
including axis; positive
integer.

178

Adobe ColdFusion Documentation

labels

Opt

labelFormat

Optional

An array of structs used to
display custom text or
images on the chart, for
example author or chart
information.
number

Format for y-axis labels:
number
currency
percent
date

legend

Opt

markerSize

Optional

name

Optional

pieSliceStyle

Optional

A struct used to define the
legend attributes, for
example,
background-color or
margin-top.
(Automatic)

Size of data point marker
in pixels; integer.
Page variable name;
string. Generates the
graph as binary data and
assigns it to the specified
variable. Suppresses
chart display. You can use
the name value in the cff
ile tag to write the chart
to a file.

sliced

Applies to the cfcharts
eries type attribute
value pie.
solid: displays pie as
if unsliced.
sliced: displays pie as
if sliced.

plot

Opt

A struct of keys such as a
nimation, aspect, mar
gin, and marker used to
style the plotting.

plotarea

Opt

A struct of keys such as p
osition and margin us
ed to style the plotarea.

© 2014 Adobe Systems Incorporated. All rights reserved.

179

Adobe ColdFusion Documentation

preview

Opt

A struct of keys such as v
isible and margin to
control chart preview.

refresh

Opt

A struct of keys such as t
ype, url, and interva
l to create dynamic
charts.

renderer

Opt

Specify the rendering
method. You must remove
the format=”html” setting
and then set the renderer
to “flash”. The supported
values are flash, svg, and
vml.

scaleFrom

Optional

scales

Opt

scaleTo

Optional

Determined by data

Y-axis maximum value;
integer.

seriesPlacement

Optional

default

Relative positions of
series in charts that have
more than one data
series.

Determined by data

Y-axis minimum value;
integer.
Comma-separated list of
axis against which to plot
the chart, for example, x,
y2.

default: ColdFusion
determines relative
positions, based on
graph types
cluster
stacked
percent
show3D

Optional

yes

Whether to display the
chart with
three-dimensional
appearance:
yes
no

© 2014 Adobe Systems Incorporated. All rights reserved.

180

Adobe ColdFusion Documentation

showBorder

Optional

no

Whether to display a
border around the chart:
yes
no

showLegend

Optional

yes

Whether to display the
legend if the chart
contains more than one
data series:
yes
no

showMarkers

Optional

yes

Whether to display
markers at data points in
line, curve, and scatter
graphs:
yes
no

showXGridlines

Optional

no

Whether to display x-axis
gridlines:
yes
no

showYGridlines

Optional

yes

Whether to display y-axis
gridlines:
yes
no

sortXAxis

Optional

no

Whether to display
column labels in
alphabetic order along the
x axis:
yes
no
Ignored if the xAxisTy
pe attribute is scale.

style

Optional

XML file or string to use to
specify the style of the
chart. In ColdFusion 11,
the XML format style has
been removed.

title

Optional

Title of the chart.

© 2014 Adobe Systems Incorporated. All rights reserved.

181

Adobe ColdFusion Documentation

tipbgcolor

Optional

white

Background color of tips.
Applies only to Flash
format graph files.
Hexadecimal value or
supported named color;
see the name list in the
Usage section.
For a hexadecimal value,
use the form "##xxxxxx
", where x = 0-9 or A-F;
use two number signs or
none.

tipStyle

Optional

mouseOver

Determines the action that
opens a pop-up window to
display information about
the current chart element.
mouseDown: display if
the user positions the
cursor at the element
and clicks the mouse.
Applies only to Flash
format graph files. (For
other formats, this
option functions the
same as mouseOver.)
mouseOver: displays if
the user positions the
cursor at the element.
none: suppresses
display.

tooltip

Optional

A struct of keys used to
style the tool tip such as b
ackground, font, or bo
rder.

type

Optional

Type of chart.

© 2014 Adobe Systems Incorporated. All rights reserved.

182

Adobe ColdFusion Documentation

url

Optional

URL to open if the user
clicks item in a data
series; the onClick desti
nation page.
You can specify variables
within the URL string;
ColdFusion passes
current values of the
variables.
$VALUE$: the value of
the selected row. If
none, the value is an
empty string.
$ITEMLABEL$: the
label of the selected
item. If none, the value
is an empty string.
$SERIESLABEL$: the
label of the selected
series. If none, the
value is an empty
string, for example: "so
mepage.cfm?item=$
ITEMLABEL$&series
=$SERIESLABEL$&va
lue=$VALUE$
"javascript:...":
executes a client-side
script.

width

Optional

xAxis

Optional

A struct of keys used to
style x axis such as form
at, guide, item, and la
bel.

xAxis2

Optional

A struct of keys used to
style second x axis such
as format, guide, item,
and label, which is on
the top of the chart.

xAxisTitle

Optional

Title that appears on the x
axis; text.

© 2014 Adobe Systems Incorporated. All rights reserved.

320

Width of the Chart in
pixels.

183

Adobe ColdFusion Documentation

xAxisType

Optional

category

Whether the x axis
indicates data or is
numeric:
category: The axis
indicates the data
category. Data is sorted
according to the sortX
Axis attribute.
scale: The axis is
numeric. All cfchartd
ata item attribute
values must be
numeric. The x axis is
automatically sorted
numerically.

xAxisvalues

Opt

xOffset

Optional

yaxis

Opt

A struct of keys used to
style y axis such as form
at, guide, item, and la
bel.

yaxis2

Opt

A struct of keys used to
style second y axis such
as format, guide, item,
and label, which is on
the top of the chart.

yAxisTitle

Optional

Title of the y axis; text.

yAxisType

Optional

yaxisvalues

Opt

© 2014 Adobe Systems Incorporated. All rights reserved.

An array of values to be
displayed on x axis.
0.1

category

Number of units by which
to display the chart as
angled, horizontally.
Applies if show3D="yes"
. The number can be
between 1 and 1, where
"-1" specifies 90 degrees
left and "1" specifies 90
degrees right.

Currently has no effect, as
the y axis is always used
for data values.
An array of values to be
displayed on y axis.

184

Adobe ColdFusion Documentation

yOffset

Optional

zoom

Opt

0.1

Number of units by which
to display the chart as
angled, vertically. Applies
if show3D="yes". The
number can be between 1
and 1, where "-1"
specifies 90 degrees left
and "1" specifies 90
degrees right.
A struct of keys to be
applied when you zoom
the chart such as alpha,
background, or bevel.

Usage

The cfchart tag defines a container in which a graph displays: its height, width, background color, labels, and so
on. The cfchartseries tag defines the chart style in which data displays: bar, line, pie, and so on. The cfchartd
ata tag defines a data point.Data is passed to the cfchartseries tag in the following ways:
As a query
As data points, using the cfchartdata tag
For the font attribute value ArialUnicodeMS, the following rules apply:
In Windows, to permit Flash charts (type = "flash") to render a double-byte character set, select this
value.
In UNIX, for all type values, to render a double-byte character set, select this value.
If this value is selected, the fontBold and fontItalic attributes have no effect.
The following table lists W3C HTML 4 named color value or hexadecimal values that the color attribute
accepts:
Color name

RGB value

Aqua

##00FFFF

Black

#000000

Blue

##0000FF

Fuchsia

##FF00FF

Gray

##808080

Green

##008000

Lime

##00FF00

Maroon

##800000

© 2014 Adobe Systems Incorporated. All rights reserved.

185

Adobe ColdFusion Documentation

Navy

##000080

Olive

##808000

Purple

##800080

Red

##FF0000

Silver

##C0C0C0

Teal

##008080

White

##FFFFFF

Yellow

##FFFF00

For all other color values, enter the hexadecimal value. You can enter a six-digit value, which specifies the RGB
value, or an eight-digit value, which specifies the RGB value and the transparency. The first two digits of an
eight-digit hexadecimal value specify the degree of transparency, with FF indicating opaque and 00 indicating
transparent. Values between 00 and FF are allowed.
For more color names that are supported by popular browsers, go to www.w3.org/TR/css3-color. You can specify
whether charts are cached in memory, the number of charts to cache, and the number of chart requests that
ColdFusion can process concurrently. To set these options in the ColdFusion Administrator, select Server
Settings>Charting.
For client-side charting, the following attributes are not supported: format, labelformat, seriesplacement wit
h percent as the value, sort, xaxis, tipsstlye, url, xAxisTYpe, xoffset, yaxistype, and yoffset.
Example

© 2014 Adobe Systems Incorporated. All rights reserved.

186

Adobe ColdFusion Documentation




SELECT Departmt.Dept_Name,
Employee.Dept_ID,
Employee.Salary
FROM Departmt, Employee
WHERE Departmt.Dept_ID = Employee.Dept_ID






SELECT Dept_Name,
AVG(Salary) AS avgSal,
SUM(Salary) AS sumSal
FROM GetSalaries
GROUP BY Dept_Name







Employee Salary Analysis








© 2014 Adobe Systems Incorporated. All rights reserved.

187

Adobe ColdFusion Documentation

cfchartdata
Description

Used with the cfchart and cfchartseries tags. This tag defines chart data points. Its data is submitted to the c
fchartseries tag.
Category

Data output tags, Extensibility tags
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfchart, cfchartseries; Creating Charts and Graphs in the _Developing ColdFusion
Applications_ColdFusion MX: Added this tag.
Attributes

Attribute

Req/Opt

Default

Description

item

Required

Data point name; string.

value

Required

Data point value; number
or expression.

Example

© 2014 Adobe Systems Incorporated. All rights reserved.

188

Adobe ColdFusion Documentation




SELECT Departmt.Dept_Name,
Employee.Dept_ID,
Employee.Salary
FROM Departmt, Employee
WHERE Departmt.Dept_ID = Employee.Dept_ID






SELECT Dept_Name,
AVG(Salary) AS avgSal,
SUM(Salary) AS sumSal
FROM GetSalaries
GROUP BY Dept_Name







Employee Salary Analysis










© 2014 Adobe Systems Incorporated. All rights reserved.

189

Adobe ColdFusion Documentation

cfchartseries
Description

Used with the cfchart tag. This tag defines the chart style in which the data displays: bar, line, pie, and so on.
Category

Data output tags, Extensibility tags
Syntax


toolTip = "JSON string representation"
zColumn = "query column"
type="type"
itemColumn="query column"
valueColumn="query column"
colorlist = "list"
dataLabelStyle="style"
markerStyle="style"
paintStyle="plain|raise|shade|light"
query="query name"
seriesColor="hexadecimal value|web color"
seriesLabel="label text">


Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

© 2014 Adobe Systems Incorporated. All rights reserved.

190

Adobe ColdFusion Documentation

See also

cfchart, cfchartdata; Creating Charts and Graphs in the Developing ColdFusion Applications
History

ColdFusion 10: Added the following attributes: {{alpha, animate, aspect, background, bevel, border, marker, color,
label, hoverMarker, data, scales, shadow, tooltip, zcolumn}}ColdFusion MX 7:
Added the dataLabelStyle attribute.
Added the horizontalbar value of the type attribute.
ColdFusion MX 6.1: Changed interpolation behavior: the tag now interpolates data points on line charts with
multiple series.ColdFusion MX: Added this tag.
Attributes

Attribute

Req/Opt

alpha

Optional

Alpha (transparency) level
of the background.Valid
values range from 0 (tra
nsparent) to 1 (opaque)
.

animate

Opt

A struct of keys to define
the animation such as
effect and speed. An
empty struct results in
default animation with ap
pear effect.

aspect

Opt

Defines the variations of a
chart type, for example li
ne, area, and dots in a
radar chart.

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

191

Adobe ColdFusion Documentation

background

Opt

A struct of keys related to
background such as
color: Sets the
background color(s)
color-1: Sets the first
background color for
the arrow
color-2: Sets the
second background
color for the arrow
(used with gradients)
transparent: Set the
transparency of a
background image so
that underlying colors or
chart can show.
fit: Defines the
width/height to fit area
of background.
repeat: Defines type
of image repeat.
image: Defines the
path to the background
image.
position: Defines the
position of the
background image.

bevel

Opt

A struct of keys related to
bevel such as:
color: Defines the
color of the bevel.
blur-x: Defines the
sharpness/smoothness
of the bevel edges in
the x-direction.
blur-y: Defines the
sharpness/smoothness
of the bevel edges in
the y-direction.
angle: Defines the
angle of the bevel.
distance: Distance in
# | #px indicating the
distance from the object
the bevel should be
displayed.

© 2014 Adobe Systems Incorporated. All rights reserved.

192

Adobe ColdFusion Documentation

border

Opt

A struct of keys related to
border such as:
color: Sets the color
of the border.
radius: Defines the
radius of rounded
corners.
width: Defines the
width of the border.

marker

Opt

A struct of keys used to
style the marker such as s
ize, border, backgrou
nd, and bevel.

color

Opt

Color of the main element
(such as the bars) of a
chart.
For a pie chart, this is the
color of the first
slice.Hexadecimal value
or supported named color;
see the name list and
information about six- and
eight-digit hexadecimal
values in the Usage
section for the cfchart tag.
For a hexadecimal value,
use the form "##xxxxxx
" or "##xxxxxxxx",
where x = 0-9 or A-F;
use two number signs or
none.

label

Opt

Text of the data series
label.

hoverMarker

Opt

A struct of keys used to
style the marker on
mouse hover such as siz
e, border, background
, and bevel.

© 2014 Adobe Systems Incorporated. All rights reserved.

193

Adobe ColdFusion Documentation

data

Opt

The chart data. This is an
array of arrays.Specify the
data as follows: [ ["a",3],
["b",5]] or [["a",4,5
],["b",7,3]] for charts
with z parameter such as
bubble chart.

scales

Opt

Comma-separated list of
axis against which to plot
the series, for example,
x,y2.

shadow

Opt

tooltip

Opt

A struct of keys used to
style the tool tip such as b
ackground, font, or bo
rder.

zcolumn

Opt

The value of the
dimension. Applicable if
the chart takes a third
dimension in addition to x
and y.

type

Required

Sets the chart display
style:

false

Used to enable/disable
the shadow. The value
can either be yes|no or a
struct that takes the key
alpha.

bar
line
pyramid
area
horizontalbar
cone
curve
cylinder
step
scatter
pie
itemColumn

Required if query attribut
e is specified

© 2014 Adobe Systems Incorporated. All rights reserved.

Name of a column in the
query specified in the que
ry attribute; contains the
item label for a data point
to graph.

194

Adobe ColdFusion Documentation

valueColumn

Required if query attribut
e is specified

Name of a column in the
query specified in the que
ry attribute; contains data
values to graph.

colorlist

Optional

Sets colors for each data
point. Applies if the cfcha
rtseries type attribute
is pie, pyramid, area, h
orizontalbar, cone, c
ylinder, or step.
Comma-delimited list of
hexadecimal values or
supported, named web
colors; see the name list
and information about sixand eight-digit
hexadecimal values in the
cfchart Usage section.
For a hexadecimal value,
use the form "##xxxxxx
" or "##xxxxxxxx",
where x = 0-9 or A-F; use
two number signs or
none.

dataLabelStyle

Optional

none

Specifies the way in which
the color is applied to the
item in the series:
none: nothing is
printed.
value: the value of the
datapoint.
rowLabel: the row's
label.
columnLabel: the
column's label.
pattern: combination
of column label, value,
and aggregate
information, such as the
columnLabel value for
the percentage of total
graph, for example,
Sales 55,000 20% of
277,000.

© 2014 Adobe Systems Incorporated. All rights reserved.

195

Adobe ColdFusion Documentation

markerStyle

Optional

rectangle

Sets the icon that marks a
data point for
two-dimensional line,
curve, and scatter graphs:
rectangle
triangle
diamond
circle
letter
mcross
snow
rcross

paintStyle

Optional

plain

Sets the paint display
style of the data series:
plain: solid color.
raise: the appearance
of a button.
shade: gradient fill,
darker at the edges.
light: a lighter shade
of color; gradient fill.

query

Optional

Name of the ColdFusion
query from which to get
data to graph.

seriesColor

Optional

Color of the main element
(such as the bars) of a
chart. For a pie chart, the
color of the first
slice.Hexadecimal value
or supported named color;
see the name list and
information about six- and
eight-digit hexadecimal
values in the Usage
section for the cfchart t
ag.
For a hexadecimal value,
use the form "##xxxxxx
" or "##xxxxxxxx",
where x = 0-9 or A-F; use
two number signs or
none.

seriesLabel

Optional

Text of the data series
label

Usage

© 2014 Adobe Systems Incorporated. All rights reserved.

196

Adobe ColdFusion Documentation

The following attributes are not supported for Client side charting:paintStyle and the following values for marker
style: letterx, mcross, snow, and rcross.A new attribute zvalue added to cfchartdata: Applicable if chart
takes a third dimension in addition to x and y.
For a pie chart, ColdFusion sets pie slice colors as follows:
If the seriesColor attribute is omitted, ColdFusion automatically determines the colors of the slices.
If the seriesColor attribute is specified, ColdFusion automatically determines the colors of the slices after
the first one, starting with the specified color for the first slice.
Limitations

The following server-side charting features are not available with client-side charting:
Linking charts to URL
Writing charts to a variable
Example 1

© 2014 Adobe Systems Incorporated. All rights reserved.

197

Adobe ColdFusion Documentation




SELECT Departmt.Dept_Name,
Employee.Dept_ID,
Employee.Salary
FROM Departmt, Employee
WHERE Departmt.Dept_ID = Employee.Dept_ID






SELECT
Dept_Name,
AVG(Salary) AS avgSal,
SUM(Salary) AS sumSal
FROM GetSalaries
GROUP BY Dept_Name







Employee Salary Analysis






Example 2

The following is a basic example of using client side charting.

© 2014 Adobe Systems Incorporated. All rights reserved.

198

Adobe ColdFusion Documentation










Example 3

This example showcases how you can create a simple bubble chart by specifying zcolumn.





Example 4

This is an example that specifies labels as a struct.











© 2014 Adobe Systems Incorporated. All rights reserved.

199

Adobe ColdFusion Documentation

cfcol
Description

Defines table column header, width, alignment, and text. Used within a cftable tag.
Category

Data output tags
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfcontent, cfoutput, cftable; Performing file operations with cfftp in the Developing
ColdFusion Applications
History

ColdFusion MX: Added the ability to construct dynamic cfcol statements.
Attributes

Attribute

Req/Opt

header

Required

Column header text. To
use this attribute, you
must also use the cftabl
e colHeaders attribute.

text

Required

Double-quotation
mark-delimited text;
determines what to
display. Rules: same as
for cfoutput sections.
You can embed
hyperlinks, image
references, and input
controls.

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

200

Adobe ColdFusion Documentation

align

Optional

left

Column alignment:
left
right
center

width

Optional

20

Column width. If the
length of data displayed
exceeds this value, data is
truncated to fit. To avoid
this, use an HTML table
tag.
If the surrounding cftabl
e tag includes the htmlt
able attribute, width spe
cifies the percent of the
table width and it does not
truncate text; otherwise, w
idth specifies the
number of characters.

Usage

At least one cfcol tag is required within the cftable tag. You must put cfcol and cftable tags adjacent in a
page. The only tag that you can nest within the cftable tag is the cfcol tag. You cannot nest cftable tags.
To display the cfcol header text, specify the cfcol header and the cftable colHeader attribute. If you
specify either attribute without the other, the header does not display. No error is thrown.
Example

© 2014 Adobe Systems Incorporated. All rights reserved.

201

Adobe ColdFusion Documentation




SELECT Emp_ID, FirstName, LastName, EMail, Phone, Department
FROM Employees




cfcol Example









© 2014 Adobe Systems Incorporated. All rights reserved.

202

Adobe ColdFusion Documentation

cfcollection
Description

Creates and administers Solr search engine collections.
Category

Extensibility tags
Syntax

cfcollection supports script style syntax:
new collection().CREATE(collection="", engine="solr", path="");



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfexecute, cfindex, cfobject, cfreport, cfsearch, cfwddx
History

ColdFusion 9: Added the engine attribute (required for Solr support).ColdFusion MX 7:
Starting with ColdFusion MX 7, you cannot use the cfcollection tag to create alias names for existing
collections. Because Verity maintains all the collection information, you cannot have two names point to the
same collection.
Removed reference to external collections.
Deprecated the map and repair options of the action attribute. They might not work, and might cause an
error, in later releases.
Added categories attribute and categorylist action.
Added CATEGORIES, SIZE, DOCCOUNT, and LASTMODIFIED to list of variables returned by the list acti
on.
Marked as obsolete the MAPPED, ONLINE, and REGISTERED variables returned by the list action.
ColdFusion MX:
Changed the requirements for the action attribute: it is now required.

© 2014 Adobe Systems Incorporated. All rights reserved.

203

Adobe ColdFusion Documentation

Added the action attribute list value. It is the default.
Changed the requirements for the action attribute value map: it is not necessary to specify the action attri
bute value map. (ColdFusion detects collections and creates maps collections as required.)
Changed acceptable collection naming: this tag accepts collection names that include spaces.
Changed Verity operations behavior: ColdFusion supports Verity operations on Acrobat PDF files.
Changed thrown exceptions: this tag can throw the SEARCHENGINE exception.
Attributes

Attribute

Req/Opt

Default

action

Required; see Usage

list

© 2014 Adobe Systems Incorporated. All rights reserved.

Description
categorylist:
Retrieves categories
from the collection and
indicates how many
documents are in each
one. Returns a structure
of structures in which
the category
representing each
substructure is
associated with a
number of documents.
For a category in a
category tree, the
number of documents is
the number at or below
that level in the tree.
create: registers the
collection with
ColdFusion. If the
collection is present, the
tag creates a map to it.
If the collection is not
present, the tag creates
it.
delete: unregisters a
collection and deletes
its directories.
list: returns a query
result set, named from
the name attribute
value, of the attributes
of the collections that
are registered by
ColdFusion. If you have
Solr collections and
omit the engine attribu
te, ColdFusion lists
information for both
types of collections.

204

Adobe ColdFusion Documentation

map: creates a map to a
collection. If the action
is create and the
collection exists,
ColdFusion also creates
a map to the collection.
optimize: optimizes
the structure and
contents of the
collection for searching;
recovers space. Causes
collection to be taken
offline, preventing
searches and indexing.
repair: deprecated.
Does nothing.
categories

See Usage

no

Used only for creating a
collection:
yes: this collection
includes support for
categories.
no: this collection does
not support categories.

collection

See Usage

engine

Optional

A collection name. The
name can include
spaces.
Solr

The search engine for the
collection:
solr: the Apache
Lucene open source
search engine
For the create and ma
p actions, the default is
Solr. For the list acti
on, the default is to list
all collections, Solr. For
all other actions
ColdFusion determines
the collection type.

language

See Usage

© 2014 Adobe Systems Incorporated. All rights reserved.

English

For a list of options, see
Usage.

205

Adobe ColdFusion Documentation

name

See Usage

Name for the query
results returned by the li
st and categorylist a
ctions.

path

See Usage

Absolute path to a
collection. To map an
existing collection, specify
a fully qualified path to the
collection (not including
the collection name); for
example, "C:\MyCollec
tions\".

Usage

With this tag you can
Create Solr collections.
Administer Solr collections created by this tag or the ColdFusion Administrator.
The following table shows the dependence relationships among this tag's attribute values:
This
attribute is
required,
optional,
or
unnecessa
ry (blank):

For this
action
attribute
value:

list

create

map

optimize

repair

delete

category
list

collecti
on

Required

Required

Required

Required

Required

Required

path

Required

Required

language

Optional

Optional

name

Required

Required

categori
es

The following examples show the structures returned by the categorylist action:
CATEGORIES

© 2014 Adobe Systems Incorporated. All rights reserved.

206

Adobe ColdFusion Documentation

blue

10

green

3

magenta

3

purple

2

CATEGORYTREES
a/

10

a/b

10

a/b/c

10

a/b/c/subdir

3

The list action returns the following information in a result set that contains one row per collection:
Column
CATEGORIES

Contents
yes: the collection has category support enabled.
no: the collection does not have category support
enabled.

CHARSET

The character set of the collection.

CREATED

The date and time that the collection was created.

DOCCOUNT

The number of documents in this collection.

EXTERNAL

yes: the collection is external.
no: the collection is not external.
not found: the collection is registered but is not
available in the defined path.

LANGUAGE

The locale setting of the collection. This information is
not available for K2Server collections.

LASTMODIFIED

The date and time that the collection was last changed.

MAPPED

Obsolete.

NAME

The name of the collection.

ONLINE

Obsolete.

© 2014 Adobe Systems Incorporated. All rights reserved.

207

Adobe ColdFusion Documentation

PATH

Absolute path to the collection.

REGISTERED

Obsolete.

SIZE

The size of the collection, expressed in kilobytes.

You can also specify uni to enable support for multiple languages.
To determine whether a collection exists, use code, such as the following, to execute a query of queries:



SELECT * from myCollections
WHERE myCollections.name = 'myCollectionName'






To determine whether a Solr collection exists, you must specifically add the attribute engine and provide the value
as solr. For example,{{}}To get a result set with
values for all the collections that are registered with the search server, use code such as the following:



#name#



To add content to a collection, use cfindex. To search a collection, use cfsearch.Restart the ColdFusion Search
Service for this change to take effect.
For Solr collections, the language attribute of this tag supports the following options:
Brazilian

cjk (Chinese, Japanese,
Korean)

French

Russian

Czech

Dutch

German

Thai

Chinese

English

Greek

© 2014 Adobe Systems Incorporated. All rights reserved.

208

Adobe ColdFusion Documentation

cfcomponent
Description

Creates and defines a component object; encloses functionality that you build in CFML and enclose in cffunction
tags. This tag contains one or more cffunction tags that define methods. Code within the body of this tag, other
than cffunction tags, is executed when the component is instantiated.A component file has the extension CFC
and is stored in any directory of an application.
A component method is invoked in the following ways:
In the cfinvoke tag in a ColdFusion page
In a URL that calls a CFC file and passes a method name as a URL parameter
In the cfscript tag
As a web service
From Flash code
Category

Extensibility tags
Syntax


variable declarations

...


...



See also

© 2014 Adobe Systems Incorporated. All rights reserved.

209

Adobe ColdFusion Documentation

cfargument, cffunction, cfinterface, cfinvoke, cfinvokeargument, cfobject, cfproperty, cfre
turn, IsInstanceOf, Building and Using ColdFusion Components in the Developing ColdFusion
Applications
History

ColdFusion 10: rest, restPath, httpMethod, produces, consumes, indexable, indexLanguage,
autoIndex, wsVersion}}ColdFusion 9.0.1: Added the attribute
{{mappedSuperClass}}ColdFusion 9: Added the attributes {{serializable and accessors.Cold
Fusion 8:
Added the implements and serviceaddress attributes.
Added support for the onMissingMethod function.
ColdFusion MX 7:
Added support for publishing document-literal style web services.
Added the style, namespace, serviceportname, porttypename, wsdlfile, bindingname, and out
put attributes.
Extended functionality for the hint and displayname attributes when publishing document-literal style web
services.
ColdFusion MX: Added this tag.
Attributes

Attribute

Req/Opt

Default

Description

accessors

Optional

yes (for persistent CFC)n
o for others

If set to yes, lets you
invoke implicit getters and
setters.
For persistent CFC, acce
ssors is always enabled.

alias

Optional

autoIndex

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

Specifies the type label
to give the object when it
is converted from CFML
to ActionScript 3. It
matches the alias attrib
ute of AS3 types. This is
attribute applies only to
Flash Remoting and
LiveCycle Data Services
value objects, and lets
you work with typed
objects in both
ColdFusion and Flash.
yes

If no, auto-indexing of
CFC does not occur. That
is, indexing occurs only in
offline mode.

210

Adobe ColdFusion Documentation

bindingname

Optional

consumes

optional

displayname

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

Specifies the binding att
ribute of the port elemen
t in the WSDL. If you don't
specify this attribute,
ColdFusion derives the
value from the CFC class
name.
/

Comma-separated list of
acceptable MIME types,
for example consumes="
text/plain,text/htm
l".Searches for the
Content-Type header in
the HTTP request; if the
value is, for example
HTML or XML,
ColdFusion finds the
appropriate method which
can handle the request
and invoke the
method.Used to specify
which MIME media types
of representation a
resource can accept or
consume, from the client.
If this attribute is used at
the component level (and
not at the function level),
all the response methods
accept the specified MIME
types by default.
If no function in a CFC
can consume the MIME
type in a client request,
the following error occurs:
415 Unsupported
Media Type.
If no value is specified, / i
s taken by default, which
means, all MIME types
are consumed.
A string that displays
when you use
introspection to show
information about the
CFC. The information
appears on the heading,
following the component
name.

211

Adobe ColdFusion Documentation

extends

Optional

WEB-INF.cftags.compone
nt

Name of parent
component from which to
inherit methods and
properties. You can use
the keyword component t
o specify the default
value.

hint

Optional

Text that displays when
you use introspection to
show information about
the CFC. The hint attrib
ute value appears below
the component name
heading. Use this attribute
to describe the purpose of
the parameter.

httpMethod

optional

The HTTP method to use,
must be one of the
following:
GET: Requests
information from the
server. Any data that
the server requires to
identify the requested
information must be in
the URL or in cfhttpp
aram type="URL" tag
.
POST: Sends
information to the
server for processing.
Requires one or more c
fhttpparam tags.
Often used for
submitting form-like
data.
PUT: Requests the
server to store the
message body at the
specified URL. Use this
method to send files to
the server.
DELETE: Requests the
server to delete the
specified URL.

© 2014 Adobe Systems Incorporated. All rights reserved.

212

Adobe ColdFusion Documentation

HEAD: Identical to the G
ET method, but the
server does not send a
message body in the
response. Use this
method for testing
hypertext links for
validity and
accessibility,
determining the type or
modification time of a
document, or
determining the type of
server. If you have not
specified HEAD, by
default, GET method is
called. However,
message body is not
sent in the response.

© 2014 Adobe Systems Incorporated. All rights reserved.

213

Adobe ColdFusion Documentation

OPTIONS: A request for
information about the
communication options
available for the server
or the specified URL.
This method enables
the ColdFusion
application to determine
the options and
requirements
associated with a URL,
or the capabilities of a
server, without
requesting any
additional activity by the
server. If you have not
specified OPTIONS,
then ColdFusion sends
a response.
Based on the request
method, the
corresponding function
is invoked. For
example, if a GET
request is sent to the
server, then a function
with httpMethod as GET
is invoked.
If this value is not
specified at the function
level, then the value
you define here is used.
So all functions for
which httpMethod is
not specified are
assigned this value.

© 2014 Adobe Systems Incorporated. All rights reserved.

214

Adobe ColdFusion Documentation

implements

Optional

indexable

Optional

no

If yes, enables indexing
for the component.

indexLanguage

Optional

english

Specify the language that
is used to index and
search.
The value you set
overrides the value
defined in the
Application.cfc.

mappedSuperClass

Optional

no

If set to yes on a
non-persistent CFC, child
CFCs can inherit its
properties. For example,
you can define a base
CFC with common
properties such as ID,
version, or createdOn
which all other persistent
CFCs would extend and
thus get one common
behavior.mappedSuperCl
ass cannot be set to yes
on a persistent CFC.

© 2014 Adobe Systems Incorporated. All rights reserved.

Name of the ColdFusion
interface or interfaces that
this component
implements. If the
component implements an
interface, it must define all
the functions in the
interface, and the function
definitions must conform
to the definitions specified
in the interface. For more
information, see cfinter
face.A component can
implement any number of
interfaces. To specify
multiple interfaces, use a
comma-delimited list with
the format interface1,
interface2.

215

Adobe ColdFusion Documentation

namespace

Optional

class name

Specifies the namespace
used in the WSDL for a
CFC that is invoked as a
web service. If you don't
specify this attribute,
ColdFusion derives the
value from the CFC class
name.

output

Optional

Component body
displayable text that is
processed as standard
CFML

Specifies whether
constructor code in the
component can generate
HTML output; does not
affect output in the body
of cffunction tags in
the component.
yes: Constructor code
is processed as if it
were within a cfoutpu
t tag. Variable names
surrounded by number
signs (#) are
automatically replaced
with their values.
no: Constructor code is
processed as if it were
within a cfsilent tag.
If you do not specify this
attribute, constructor
code is processed as
standard CFML. Any
variables must be in cf
output tags.

porttypename

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

Specifies the name attribu
te of the porttype eleme
nt in the WSDL. If you
don't specify this attribute,
ColdFusion derives the
value from the CFC class
name.

216

Adobe ColdFusion Documentation

produces

optional

/

Comma-separated list of
acceptable MIME types,
for example produces="
text/plain,text/htm
l". Searches for the
Accept header in the
HTTP request or
extension in the URL
(valid extensions are .xml
and .json); if the value is,
for example HTML, JSON,
or XML, ColdFusion finds
the appropriate method
that can handle the
request and invoke the
method.Used to specify
the MIME media types or
representations a CFC
can produce and send
back to the client.
If specified at the
component level (and not
at the function level) , all
the functions in a CFC
can produce the specified
MIME types by default. If
no methods in a CFC can
produce the MIME type in
a client request, the
following error occurs: 40
6 Not Acceptable.
If no value is specified, / i
s taken by default, which
means, all MIME types
are produced.

rest

Optional

true if RestPath is
specified

If true, the CFC is
REST-enabled.

restPath

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

217

Adobe ColdFusion Documentation

You can access the REST
resource either by
providing a REST path or
CFC path. So specify if
you want to use a path
other than the CFC path.
If rest="true" and you
do not specify this
attribute, path to the CFC
is used.Path to the CFC
should be from the
directory registered as a
REST service. Also, you
should include the CFC
name in the path. For
example, if you have a
folder college that is
registered as RestTest,
and you want to publish
student.cfc which is in a
sub-folder department (in
the folder college), then
the URL used to access
student.cfc is as follows:
http://localhost:8500/rest/
RestTest/department/stud
ent

© 2014 Adobe Systems Incorporated. All rights reserved.

218

Adobe ColdFusion Documentation

.
The restPath in this
case is department/st
udent.
The path is
case-sensitive. Also, it is
preferable to avoid special
character in the path.At
CFC level, specify the
path as follows:restPath
="restService" or
{{restPath="test/restServic
e"}}You
can specify templates as
value of restPath. For
example, restPath="{n
ame}". This means, all
URLs
in the format /rest// match
es the restPath. For
example,
http://localhost:8500/rest/s
ervice1/abc
.
The value in place of
template can be accessed
using the restargsourc
e value path. For details,
see the attribute details of
cfargument.
The attribute can have
complex expressions as
values. For example, res
tpath="customers/{f
irstname}-{lastname
}".
This matches URLs such
as "/customers/paulbensen" but
not "/customers/paul
bensen".Also restPath
can
include regular
expressions such as rest
path="/customers/{i
d : \d+}".

© 2014 Adobe Systems Incorporated. All rights reserved.

219

Adobe ColdFusion Documentation

Here, id is an integer that
can match "/customers
/123111" but
not "/customers/asd"
or "/customers/123/1
22".
If you have two methods
with different path
attribute values and if the
paths are ambiguous,
then there are precedence
rules for finding
the match. For example, r
estpath="/customers
/{id : .+}".
This expression matches
any stream of characters
after /customer.
It matches "/customers
/123", "/customers/a
sd",
and "/customers/123/
12/asdfa", but not "/c
ustomers".
You can also have
expressions such as rest
Path="/customers/{i
d : .+}/address", th
e
URL "/customers/123
/asd/address" is
matched with
both URLs. In such

© 2014 Adobe Systems Incorporated. All rights reserved.

220

Adobe ColdFusion Documentation

scenarios, the precedence
rules are used to find
the match.
serializable

Optional

true

Specifies whether this
component can be
serialized. If you set this
value to false, the
component and the data
in the component's This
and Variables scopes
cannot be serialized, so
they are not retained on
session replication, and
the component is in its
default state.

serviceaddress

Optional

URL of the CFC

Specifies the SOAP URL
of the web service. If you
don't specify this attribute,
ColdFusion uses the URL
of the CFC in the WSDL
service description. Use
this attribute to specify the
protocol, for example, by
specifying a URL that
starts with
https://
.
This attribute applies only
for web services.

serviceportname

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

Specifies the name attribu
te of the port element in
the WSDL. If you don't
specify this attribute,
ColdFusion derives the
value from the CFC class
name.

221

Adobe ColdFusion Documentation

style

Optional

rpc

Specifies whether a CFC
used for web services
uses RPC-encoded style
or document-literal style:
rpc: RPC-encoded
style
document:
Document-literal style
wrapped: If you are
setting wsVersion as
2, the default value is w
rapped and if it is 1,
then the default value is
rpc.

wsdlfile

Optional

A properly formatted
WSDL file to be used
instead of WSDL
generated by ColdFusion.

wsVersion

Optional

If you specify 2, CFC is
deployed using Axis 2
engine. The value you
specify overrides the
value you specify at
application or server level.

Usage

If you specify the extends attribute, the data and methods of the parent component are available to CFC methods
as if they were parts of the current component. If the managerCFC component extends the employeeCFC
component, and the employeeCFC component has a getEmployeeName method, you can call this method by
using the managerCFC, as follows:



This tag requires an end tag.
If you specify style="document", ColdFusion publishes the CFC as a document-literal style web service. For
more information, see Publishing document-literal style web services in the Developing ColdFusion Applications.CF
Cs support an onMissingMethod function. By defining an onMissingMethod function in the cfcomponent tag
body in the CFC, you can handle calls to methods that are not implemented in the CFC. If an application calls a
function that is not defined in the CFC, ColdFusion calls the onMissingMethod function and passes it the
requested method's name and arguments. If you do not define an onMissingMethod function, a call to a method
that is not defined in the CFC causes ColdFusion to throw an error that must be handled in the calling code.
The onMissingMethod function is useful for several purposes:
To handle errors directly in the component, instead of requiring that each instance of code that calls the

© 2014 Adobe Systems Incorporated. All rights reserved.

222

Adobe ColdFusion Documentation

component handles them.
To create a dynamic proxy, an object that can take arbitrary calls and dynamically determines the correct
action.
The onMissingMethodfunction must have the following format:




code to handle call to nonexistent method


Note
The argument name for onMissingMethod must not change.

Example 1




SELECT FIRSTNAME, LASTNAME, EMAIL
FROM tblEmployees





SELECT *
FROM tblDepartments





© 2014 Adobe Systems Incorporated. All rights reserved.

223

Adobe ColdFusion Documentation

cfcontent
Description

Does either or both of the following:
Sets the MIME content encoding header for the current page; if the encoding information includes a character
encoding, sets the character encoding of generated output.
Sends the contents of a file, or of a variable that contains binary data, as the page output.
To restrict this tag, use the settings in the ColdFusion Administrator > Security > Sandbox Security. For more
information, see the Administrator online Help.
Category

Data output tags
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfcol, cfheader, cfhttp, cfoutput, cftable
History

ColdFusion 8: Changed the behavior of the tag if the type attribute is not specified and the file attribute is
specified. Previously, ColdFusion assumed a default file type of text/html. Now, ColdFusion attempts to get the
content type from the file.ColdFusion MX 7: Added the variable attribute.
Attributes

Attribute

Req/Opt

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

224

Adobe ColdFusion Documentation

deleteFile

Optional

no

Applies only if you specify
a file with the file attribu
te.
yes: deletes the file on
the server after sending
its contents to the client.
no: leaves the file on
the server.

file

Optional

reset

Optional

Name of an on-disk or
in-memory file whose
contents provide the page
output. The filename must
start with a drive letter and
a colon, or a forward or
backward slash. When
using ColdFusion in a
distributed configuration,
the file attribute must
refer to a path on the
system on which the web
server runs. When you
use this attribute, any
other output on the
current CFML page is
ignored; only the contents
of the file are sent to the
client.
yes

If you specify a file or v
ariable attribute, this
attribute has no effect;
otherwise, it does the
following:
yes: discards output
that precedes call to cf
content
no: preserves output
that precedes call to cf
content. In this case,
all output is sent with
the specified type.

type

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

225

Adobe ColdFusion Documentation

The MIME content type of
the page, optionally
followed by a semicolon
and the character
encoding. By default,
ColdFusion sends pages
as text/html content type
in the UTF-8 character
encoding. However, if the
file attribute is
specified, ColdFusion
attempts to get the
content type from the file.
The content type
determines how the
browser or client
interprets the page
contents.
The following are some of
the content type values
that you can use:

© 2014 Adobe Systems Incorporated. All rights reserved.

226

Adobe ColdFusion Documentation

text/html
text/plain
application/x-sho
ckwave-flash
application/mswor
d
image/jpeg
The following list
includes commonly
used character
encoding values:
utf-8
iso-8859-1
windows-1252
us-ascii
shift_jis
iso-2022-jp
euc-jp
euc-kr
big5
euc-cn
utf-16
For example:

{{type =
"text/ht
ml"}}
{{type =
"text/ht
ml;
charset}
}{{=}}{{
ISO-8859
-1}}{{"}
}

© 2014 Adobe Systems Incorporated. All rights reserved.

227

Adobe ColdFusion Documentation

variable

Optional

Name of a ColdFusion
binary variable whose
contents can be displayed
by the browser, such as
the contents of a chart
generated by the cfchar
t tag or a PDF or Excel
file retrieved by a cffile
action="readBinary"
tag. When you use this
attribute, any other output
on the current CFML page
is ignored; only the
contents of the file are
sent to the client.

Usage

To set the character encoding (character set) of generated output, including the page HTML, use code such as the
following:



When ColdFusion processes an HTTP request, it determines the character encoding to use for the data it returns in
the HTTP response. By default, ColdFusion returns character data using the Unicode UTF-8 format, regardless of
the value of an HTML meta tag in the page. You can use the cfcontent tag to override the default character
encoding of the response. For example, to tell ColdFusion to return the page using Japanese EUC character
encoding, use the type attribute, as follows:



If you call the cfcontent tag from a custom tag, and you do not want the tag to discard the current page when it is
called from another application or custom tag, set reset = "no".
If a file delete operation is unsuccessful, ColdFusion throws an error.Do not use this tag after the cfflush tag on a
page, it has no effect or ColdFusion throws an error. The following tag can force most browsers to display a dialog
box that asks users whether they want to save the contents of the file specified by the cfcontent tag using the
filename specified by the filename value. If the user selects to open the file, most browsers open the file in the
related application, not the browser window.



Some file types, such as PDF documents, do not use executable code and can display directly in most browsers. To
request the browser to display the file directly, use a cfheader tag similar to the following:

© 2014 Adobe Systems Incorporated. All rights reserved.

228

Adobe ColdFusion Documentation



You can use any value for the filename part of the filename attribute, but the ext part must be the standard
Windows extension for the file type. For file types that might contain executable code, such as Microsoft Excel
documents, most browsers always ask before opening the document. For these file types, the inline content
disposition specification requests the browser to display the file directly if the user selects to open the file.
For more information on character encodings, see the following web pages:
The page atwww.w3.org/International/O-charset.html provides general information on character encodings
and the web, and has several useful links.
The page at www.iana.org/assignments/character-sets is a complete list of character sets names used on the
Internet, maintained by the Internet Assigned Numbers Authority.
ColdFusion uses the Java JCE for encoding support. The page at http://java.sun.com/javase/6/docs/technote
s/guides/intl/encoding.doc.html lists the character encodings that JCE 6, and therefore ColdFusion, can
interpret. This list uses Java internal names, not the IANA character encoding names that you use in the
SetEncoding charset parameter and other ColdFusion attributes and parameters.
For a complete list of media types used on the Internet, see www.iana.org/assignments/media-types/.
Note
When using cfabort, cflocation, or cfcontent tags, the OnAbort method is
invoked instead on OnRequestEnd.

Example

© 2014 Adobe Systems Incorporated. All rights reserved.

229

Adobe ColdFusion Documentation





This example shows how the Reset attribute changes output for text.


reset = "Yes": 123 
 456


This example shows how the Reset attribute changes output for text.


reset = "No": 123 
 456













MonthQuantity$ Sales


January80$245


February100$699


March230$2036


Total=Sum(B2..B4)=Sum(C2..C4)




© 2014 Adobe Systems Incorporated. All rights reserved.

230

Adobe ColdFusion Documentation

cfcontinue
Description

Used within a cfloop tag. Returns processing to the top of a loop.
Category

Flow-control tags
Syntax



See also

cfabort, cfbreak, cfexecute, cfif, cflocation, cfloop, cfthrow, cftry; cfloop and cfbreak in the Devel
oping ColdFusion Applications
History

ColdFusion 9: Added the tag.
Tag example


#i# is

ODD



EVEN



Script example

for (i=1; i <= 5; i++){
writeOutput("#i# is ");
if (i mod 2){
writeOutput("ODD
");
continue;
}
writeOutput("EVEN
");
}

Either version of the code above outputs:

© 2014 Adobe Systems Incorporated. All rights reserved.

231

Adobe ColdFusion Documentation

1
2
3
4
5

is
is
is
is
is

ODD
EVEN
ODD
EVEN
ODD

© 2014 Adobe Systems Incorporated. All rights reserved.

232

Adobe ColdFusion Documentation

cfcookie
Description

Defines web browser cookie variables, including expiration and security options.
Category

Forms tags, Variable manipulation tags
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfdump, cfparam, cfregistry, cfsavecontent, cfschedule, cfset
History

ColdFusion 10: Added the preserveCase and encodeValue attributes.
ColdFusion MX 6.1:
Changed the expires attribute: it now accepts a date time object.
Cookie names can include all ASCII characters except commas, semicolons, or whitespace characters.
ColdFusion 9: Added the attribute httponly.
Attributes

Attribute

Req/Opt

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

233

Adobe ColdFusion Documentation

name

Required

Name of cookie variable.
ColdFusion converts
cookie names to
all-uppercase. Cookie
names set using this tag
can include any printable
ASCII characters except
commas, semicolons, or
white space characters.

domain

Required if path attribute
is specified. Optional
otherwise

Domain in which cookie is
valid and to which cookie
content can be sent from
the user's system. By
default, the cookie is only
available to the server that
set it. Use this attribute to
make the cookie available
to other servers.Must start
with a period. If the value
is a subdomain, the valid
domain is all domain
names that end with this
string. This attribute sets
the available subdomains
on the site on which the
cookie can be used.
For a domain value that
ends in a country code,
the specification must
contain at least three
periods; for example, ".m
ongo.state.us". For
top-level domains, two
periods are required; for
example, ".mgm.com".
You cannot use an IP
address as a domain.

encodevalue

Optional

Specify if cookie value
should be encoded

© 2014 Adobe Systems Incorporated. All rights reserved.

234

Adobe ColdFusion Documentation

expires

Optional

session only

Expiration of cookie
variable.
The cookie expires
when the user closes
the browser, that is, the
cookie is "session only".
A date or date/time
object (for example,
10/09/97).
A number of days (for
example, 10, or 100).
now: deletes cookie
from client cookie.txt file
(but does not delete the
corresponding variable
the Cookie scope of the
active page).
never: The cookie
expires in 30 years from
the time it was created
(effectively never in web
years).

httponly

Optional

If yes, sets cookie as
httponly so that it cannot
be accessed using
JavaScripts. Note that the
browser must have
httponly compatibility.

path

Optional

URL, within a domain, to
which the cookie applies;
typically a directory. Only
pages in this path can use
the cookie. By default, all
pages on the server that
set the cookie can access
the cookie.

path =
"/services
/login"

To specify multiple URLs,
use multiple cfcookie ta
gs. If you specify path,
also specify domain.

© 2014 Adobe Systems Incorporated. All rights reserved.

235

Adobe ColdFusion Documentation

preserveCase

Optional

secure

Optional

False

Specify if cookie name
should be case-sensitive.
If browser does not
support Secure Sockets
Layer (SSL) security, the
cookie is not sent. To use
the cookie, the page must
be accessed using the
https protocol.
yes: Variable must be
transmitted securely.
no

Optional

value

Value to assign to cookie
variable. Must be a string
or variable that can be
stored as a string.

Usage

If this tag specifies that a cookie is saved beyond the current browser session, the client browser writes or updates
the cookie in its local cookies file. Until the browser is closed, the cookie resides in browser memory. If the expires
attribute is not specified, the cookie is not written to the browser cookies file.
If you use this tag after the cfflush tag on a page, ColdFusion does not send the cookie to the browser; however,
the value you set is available to ColdFusion in the Cookie scope during the browser session.
Note
You can also create a cookie that expires when the current browser session expires by using the
cfset tag or a CFScript assignment statement to set a variable in the Cookie scope, as in . To get a cookie's value, refer to the cookie name in the
Cookie scope, as in .

You can use dots in cookie names, as the following examples show:




To access cookies, including cookies that you set and all cookies that are sent by the client, use the Cookie scope.
For example, to display the value of the person.name cookie set in the preceding code, use the following line:

#cookie.person.name#

Example

© 2014 Adobe Systems Incorporated. All rights reserved.

236

Adobe ColdFusion Documentation




SELECT EMail, FromUser, Subject, Posted
FROM Comments




cfcookie Example



















The last AOL visitor to view this site was
#Cookie.LastAOLVisitor#, on
#DateFormat(COOKIE.TimeVisited)#


Hide my tracks


No AOL Visitors have viewed the site lately.


#back to top

© 2014 Adobe Systems Incorporated. All rights reserved.

237

Adobe ColdFusion Documentation

cfclient
The  tag is a marker tag that instructs ColdFusion to generate client-side code (JavaScript) for ColdFusion
code. This tag does not have any attribute. To know more about this tag, read this document.

© 2014 Adobe Systems Incorporated. All rights reserved.

238

Adobe ColdFusion Documentation

cfclientsettings
Description

This tag is similar to cfprocessingdirective and acts as a compiler directive to include plugins for various features
(device detection and device API). You can use this tag to load all the required device plugins and device detection
plugins
Syntax



See also

cfclient
History

ColdFusion 11: Added this tag.
Attributes

Attribute

Req/Opt

Default

Description

enableDeviceAPI

Optional

false

Enable/disable the device
API.

detectDevice

Optional

false

Enable/disable the device
detection plugin.

© 2014 Adobe Systems Incorporated. All rights reserved.

239

Adobe ColdFusion Documentation

deviceTimeout

Optional

10

The timeout for loading
the plugins (in seconds).
If the plug-in takes more
than 10 seconds (default
timeout value) to load, you
will get an error. Try
increasing the timeout to
avoid this problem.
If you have specified
enableDeviceAPI as
"true", the device plugins
will be loaded. After the
device plugins are loaded,
ColdFusion waits for an
event "DeviceReady" to
be triggered. Once the
DeviceReady event is
triggered successfully, the
execution of CFML starts.
In a desktop browser, the
DeviceReady event will
not be triggered.
However, for a mobile
application (shell
application or packaged
application), the event is
triggered.
So if you are trying to run
a CFM where the device
APIs are enabled on a
desktop browser you will
get a blank page and in
the console you can see
an error message about
deviceTimeout.

Device detection

The device detection feature of CFML allows you to identify the device properties and characteristics, which can be
used to determine the best content, layout, mark-up or application to serve to the given device.
These characteristics include screen size, browser type and version, media support, and the level of support for
CSS, HTML, and JavaScript.
For getting the device features and capabilities, you need to specify an attribute detectdevice in the
 tag and set it to true:



© 2014 Adobe Systems Incorporated. All rights reserved.

240

Adobe ColdFusion Documentation

If the detectdevice attribute is set to true, ColdFusion automatically detects the features and capabilities of the
device (width, height, and orientation) on which the application is running.
The following example shows the usage of the device detection feature:











Canvas support -



In the above example, we are trying to find if the device supports HTML5 Canvas. cfclient.canvas returns a boolean
value indicating the support for the HTML5 Canvas property.
In the above example, we are trying to find if the device supports HTML5 Canvas. cfclient.canvas returns a boolean
value indicating the support for the HTML5 Canvas property.
ColdFusion Server internally uses Modernizer JavaScript library (version 2.6.2) for the device detection feature.
The following table lists the supported device features with example usage:
Features

Syntax

Touch Events

cfclient.touch

Canvas Text

cfclient.canvastext

Canvas

cfclient.canvas

Geolocation

cfclient.geolocation

Web Sockets

cfclient.websockets

Drag ‘n Drop

cfclient.draganddrop

History

cfclient.history

© 2014 Adobe Systems Incorporated. All rights reserved.

241

Adobe ColdFusion Documentation

applicationCache

cfclient.applicationcache

localStorage

cfclient.localstorage

Width

cfclient.width

Height

cfclient.height

Device Width

cfclient.deviceWidth

Device Height

cfclient.deviceHeight

Orientation

cfclient.orientation

Device Group Name

cfclient.deviceGroupName

Device Group Descriptions

cfclient.deviceGroupDescription

CSS Animations

cfclient.cssanimations

CSS Columns

cfclient.csscolumns

CSS Generated Content

cfclient.generatedcontent

CSS Gradients

cfclient.cssgradients

CSS Reflections

cfclient.cssreflections

CSS 2D Transforms

cfclient.csstransforms

CSS 3D Transforms

cfclient.csstransforms3d

CSS Transitions

cfclient.csstransitions

Audio

cfclient.audio

Video

cfclient.video

Hash Change

cfclient.hashchange

IndexedDB

cfclient.indexeddb

Input Attributes

cfclient.input.* (* refers to attributes for input elements.
For possible values, see the Modernizr documentation)

Input Types

cfclient.inputtypes.* (* refers to input type attributes. For
possible values, see the Modernizr documentation)

© 2014 Adobe Systems Incorporated. All rights reserved.

242

Adobe ColdFusion Documentation

Post Message

cfclient.postmessage

Session Storage

cfclient.sessionstorage

Web Workers

cfclient.webworkers

Web SQL Database

cfclient.websqldatabase

For the description on all above mentioned features, see the Modernizr documentation.
Using media queries
Media queries allow you to apply changes to the page design based on the viewing size and capability of the device
on which your content is displayed. A media query consists of one or more logical expressions formed using the
detected device data that checks for certain conditions of media feature and based on the result of this expression
we can change the layout of the page dynamically.
If you are building a mobile application, you can easily detect the characteristics of the device and customize the
layout just for that device as shown in the following example:












In the above example, the web page is customized for different devices based on their screen sizes.
Handling orientation changes
For handling the device orientation changes, you can register a listener using the addOrientationListener() function:

© 2014 Adobe Systems Incorporated. All rights reserved.

243

Adobe ColdFusion Documentation




Orientation : 

Width : 

Height : 


















In the above example, addOrientationListener function is used to register a listener that monitors the orientation of
the device (landscape or portrait). When the orientation of the device changes, an orientationHandler call back
function is invoked.
You can use the removeOrientationListener to un-register the listener:





© 2014 Adobe Systems Incorporated. All rights reserved.

244

Adobe ColdFusion Documentation

You can also add multiple listeners:




When the device orientation changes, all the registered listener functions are invoked.
Handling window resizing events
For handling the window resizing events, you can register a listener using the addResizeListener() function:




Width :

Height :

Device width :

Device height :
















© 2014 Adobe Systems Incorporated. All rights reserved.

245

Adobe ColdFusion Documentation

You can also add multiple listeners:




When there is a change in window size all the registered resize listener functions are invoked. You can use
removeResizeListener() to un-register the handlers.





Setting device timeout
In the  tag, an attribute called deviceTimeOut can be specified. The default value of deviceTimeout
is 10 secs. When enableDeviceApi or detectDevice is set as true, the deviceTimeOut value will be honored. Time
will be provided for the required plugins to be loaded. After the specified time, an exception will be thrown.



© 2014 Adobe Systems Incorporated. All rights reserved.

246

Adobe ColdFusion Documentation

Tags d-e
This section lists tags starting with alphabets D-E with their description.
cfdbinfo
cfdefaultcase
cfdirectory
cfdiv
cfdocument
cfdocumentitem
cfdocumentsection
cfdump
cfelse
cfelseif
cferror
cfexchangecalendar
cfexchangeconnection
cfexchangecontact
cfexchangeconversation
cfexchangefilter
cfexchangefolder
cfexchangemail
cfexchangetask
cfexecute
cfexit

© 2014 Adobe Systems Incorporated. All rights reserved.

247

Adobe ColdFusion Documentation

cfdbinfo
Description

Lets you retrieve information about a data source, including details about the database, tables, queries, procedures,
foreign keys, indexes, and version information about the database, driver, and JDBC.
Category

Database manipulation tags
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfinsert, cfprocparam, cfprocresult, cfqueryparam, cfstoredproc, cftransaction, cfupdate; Opt
imizing database use in the Developing ColdFusion Applications.
History

ColdFusion 8: Added this tag.
Attributes

Attribute

Req/Opt

datasource

Optional

Datasource to use to
connect to the database.

name

Required

Name to use to refer to
the result.

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

248

Adobe ColdFusion Documentation

type

Required

Type of information to get:
dbnames: database
name and type
tables: name, type,
and remarks
columns: name, SQL
data type, size, decimal
precision, default value,
maximum length in
bytes of a character or
integer data type
column, whether nulls
are allowed, ordinal
position, remarks,
whether the column is a
primary key, whether
the column is a foreign
key, the table that the
foreign key refers to,
the key name the
foreign key refers to
version: database
product name and
version, driver name
and version, JDBC
major and minor version
procedures: name,
type, and remarks
foreignkeys: foreign
key name and table,
primary key name,
delete, and update rules
index: name, column
on which the index is
applied, ordinal
position, cardinality,
whether the row
represents a table
statistic or an index,
number of pages used
by the table or index,
whether the index
values are unique
ClientInfo: The
client information
metadata for the
specified data source.

© 2014 Adobe Systems Incorporated. All rights reserved.

249

Adobe ColdFusion Documentation

dbname

Optional

Name of the database.
Used only if the action
= "This overrides
the one mentioned
as a part of
datasource
definition."

password

Optional

Password to connect to
the database.

pattern

Optional

Used only if type =
"tables", type =
"columns", or type =
"procedures".
Specifies a filter to
retrieve information about
specific tables, columns,
or stored procedures. Use
an underline (_) to
represent a single
wildcard character and a
percent sign (%) to
represent a wildcard of
zero or more characters.

table

Required if type =
"columns" or type =
"foreignkeys" or
type = "index"

Name of the table from
which you retrieve
information.

username

Optional

no

User name to connect to
the database.

Usage

Use the cfdbinfo tag to return a query object that contains information about a database. The query object varies,
depending on the value that you specify in the type attribute. The following table lists the query object contents for
each type:
Type

Column name

Description

dbnames

DATABASE_NAME

Name of the database.

TYPE

Type of the database, whether
schema or catalog.

TABLE_NAME

Name of the table.

tables

© 2014 Adobe Systems Incorporated. All rights reserved.

250

Adobe ColdFusion Documentation

columns

version

TABLE_TYPE

Type of the table, including view,
table, synonym, and system table.

REMARKS

Remarks of the table.

COLUMN_NAME

Name of the column.

TYPE_NAME

SQL data type of the column.

IS_NULLABLE

Whether the column allows nulls.

IS_PRIMARYKEY

Whether the column is a primary
key.

IS_FOREIGNKEY

Whether the column is a foreign
key.

REFERENCED_PRIMARYKEY

If the column is a foreign key, the
name of the table it refers to.

REFERENCED_PRIMARYKEY_TA
BLE

If the column is a foreign key, the
key name it refers to.

COLUMN_SIZE

Size of the column

DECIMAL_DIGITS

Number of digits to the right of the
decimal point.

COLUMN_DEFAULT_VALUE

Default value of column.

CHAR_OCTET_LENGTH

Maximum length in bytes of a
character or integer data type
column.

ORDINAL_POSITION

Ordinal position of the column.

REMARKS

Remarks of the column.

DATABASE_VERSION

Version of the database
management system.

DATABASE_PRODUCTNAME

Name of the database management
system.

DRIVER_VERSION

Version of the database driver.

DRIVER_NAME

Name of the database driver.

© 2014 Adobe Systems Incorporated. All rights reserved.

251

Adobe ColdFusion Documentation

procedures

foreignkeys

index

JDBC_MAJOR_VERSION

Major version number of the driver.

JDBC_MINOR_VERSION

Minor version number of the driver.

PROCEDURE_NAME

Name of the stored procedure.

REMARKS

Remarks for the stored procedure.

PROCEDURE_TYPE

Procedure type, which indicates
whether the procedure returns a
result.

FKCOLUMN_NAME

Foreign key name.

FKTABLE_NAME

Foreign key table name.

PKCOLUMN_NAME

Primary key name.

DELETE_RULE

Specifies what action to take when
you delete a record that has
dependent records.

UPDATE_RULE

Specifies what action to take when
you update a record that has
dependent records.

INDEX_NAME

Name of the index, empty if type is
table statistic.

COLUMN_NAME

Name of the column on which the
index is applied, empty if the type is
table statistic.

ORDINAL_POSITION

Ordinal position.

CARDINALITY

Number of unique values if the type
is index, or number of rows if the
type is statistic

TYPE

Whether the row represents a table
statistic or an index. Index types are
clustered, hashed, or other.

PAGES

Number of pages used by the table
if the type is table statistic, or the
number of pages used by the index.

© 2014 Adobe Systems Incorporated. All rights reserved.

252

Adobe ColdFusion Documentation

NON_UNIQUE

Whether the index values are
unique.

Example




The #datasrc# data source has the following databases:








Database nameType




#dbdata.DATABASE_NAME##dbdata.TYPE#






© 2014 Adobe Systems Incorporated. All rights reserved.

253

Adobe ColdFusion Documentation

cfdefaultcase
Description

Used only inside the cfswitch tag body. Contains code to execute when the expression specified in the cfswitc
h tag does not match the value specified by a cfcase tag.
Category

Flow-control tags
Syntax



See also

cfcase, cfswitch; cfswitch, cfcase, and cfdefaultcase in the Developing ColdFusion Applications
History

ColdFusion MX: Changed placement requirements: this tag does not have to follow all cfcase tags in the cfswitc
h tag body.
Usage

The contents of the cfdefaultcase tag body executes if the expression attribute of the cfswitch tag does not
match any of the values specified by the cfcase tags in the cfswitch tag body. The contents of the cfdefaultc
ase tag body can include HTML and text, and CFML tags, functions, variables, and expressions.
You can specify only one cfdefaultcase tag within a cfswitch tag. You can put the cfdefaultcase tag at
any position within a cfswitch statement; it is not required to be the last item, but it is good programming practice
to put it last.
Example

© 2014 Adobe Systems Incorporated. All rights reserved.

254

Adobe ColdFusion Documentation





















Your grade is #grade#


© 2014 Adobe Systems Incorporated. All rights reserved.

255

Adobe ColdFusion Documentation

cfdirectory
Description

Manages interactions with directories.
Category

File management tags
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cffile
History

ColdFusion 10: Added the action copy and the attribute destination.
ColdFusion 9.0.1: Added the storeACL and storeLocation attributes.
ColdFusion 8: Added the listinfo and type attributes.
ColdFusion MX 7: Added the recurse attribute and directory result set column.
ColdFusion MX:
1. Changed behavior for action = "list":
On Windows, cfdirectory action = "list" no longer returns the directory entries "." (dot) or "
.." (dot dot), which represent "the current directory" and "the parent directory."
On Windows, cfdirectory action = "list" no longer returns the values of the Archive and
System attributes.

© 2014 Adobe Systems Incorporated. All rights reserved.

256

Adobe ColdFusion Documentation

On UNIX and Linux, cfdirectory action = "list" does not return any information in the mode c
olumn.
Attributes

Attribute

Req/Opt

directory

Required

Default

Description
Absolute pathname of
directory against which to
perform action. You can
use an IP address, as in
the following example:



action

Optional

destination

Required if action =
"copy"

Path of the destination
directory. If not an
absolute path, it is relative
to the source directory.

filter

Optional if action =
"list"

File extension filter
applied to returned
names, for example,
*.cfm. One filter can be
applied.

© 2014 Adobe Systems Incorporated. All rights reserved.

list

list: returns a query
record set of the files in
the specified directory.
The directory entries "."
(dot) and ".." (dot dot),
which represent the
current directory and
the parent directory, are
not returned.
create
delete
rename
copy

257

Adobe ColdFusion Documentation

listinfo

Optional

mode

Optional

all

all: includes all
information in the result
set.
name: includes only
filenames in the result
set.
Used with action =
"create". Permissions.
Applies only to UNIX and
Linux. Octal values of chm
od command. Assigned to
owner, group, and other,
respectively, for example:
644: assigns read/write
permission to owner;
read permission to
group and other.
777: assigns
read/write/execute
permission to all.

name

Required if action =
"list"

Name for output record
set.

newDirectory

Required if action =
"rename"

New name for directory.

recurse

Optional

no

Whether ColdFusion
performs the action on
subdirectories:
yes
no
Valid for action="lis
t" and action="dele
te".

© 2014 Adobe Systems Incorporated. All rights reserved.

258

Adobe ColdFusion Documentation

sort

Optional; used if action
= "list"

ASC

Query columns by which
to sort a directory listing.
Delimited list of columns
from query output. To
qualify a column, use one
of the following values:
asc: ascending (a to z)
sort order.
desc: descending (z to
a) sort order.
For example:

sort =
"directo
ry ASC,
size
DESC,
datelast
modified
"

storeACL

Optional; used if action
= "create"

StoreLocation

Optional; used if action
= "create"

US

Used to change the
location of the created
bucket. The location can
either be EU, US, or US-W
EST.
For details, see Using
Amazon S3 storage in Opt
imizing ColdFusion
applications.

type

Optional

all

file: includes only
filenames.
dir: includes only
directory names.
all: includes both
filenames and directory
names.

© 2014 Adobe Systems Incorporated. All rights reserved.

An array of struct where
each struct represents a
permission or grant.
For details, see Using
Amazon S3 storage in Opt
imizing ColdFusion
applications.

259

Adobe ColdFusion Documentation

storeLocation

Optional

Used to change the
location of the created
bucket. The location can
either be EU or US. The
default location is US.

storeACL

Optional

An array of struct where
each struct represents a
permission or grant.

Usage

If you put ColdFusion applications on a server that is used by multiple customers, you must consider the security of
files and directories that could be uploaded or otherwise manipulated with this tag by unauthorized users. For more
information about securing ColdFusion tags, see Configuring and Administering ColdFusion.
If action = "list", cfdirectory returns the following result columns, which you can reference in a cfoutput
tag:
name: Directory entry name. The entries "." and ".." are not returned.
directory: Directory that contains the entry.
size: Directory entry size.
type: File type: file, for a file; dir, for a directory.
dateLastModified: The date that an entry was last modified.
attributes: File attributes, if applicable.
mode: Empty column; retained for backward compatibility with ColdFusion 5 applications on UNIX.
Use the following result columns in standard CFML expressions, preceding the result column name with the
query name:

#mydirectory.name#
#mydirectory.directory#
#mydirectory.size#
#mydirectory.type#
#mydirectory.dateLastModified#
#mydirectory.attributes#
#mydirectory.mode#

Note
If the cfdirectory tag does not appear to work, for example, if a list operation returns
an empty result set, make sure that you have correct permissions to access the directory.
For example, if you run ColdFusion as a service on Windows, it operates by default as
System, and cannot access directories on a remote system or mapped drive; to resolve
this issue, do not run ColdFusion using the local system account.

The filter attribute specifies a pattern of one or more characters. All names that match that pattern are
included in the list. On Windows systems, pattern matching ignores text case, on UNIX and Linux, pattern
matches are case-sensitive. The following two characters have special meaning in the pattern and are called
metacharacters:
The asterisk (*) matches any zero or more characters.

© 2014 Adobe Systems Incorporated. All rights reserved.

260

Adobe ColdFusion Documentation

The question mark (?) matches any single character.
The following table shows examples of patterns and filenames that they match:
Pattern

Matches

foo.*

Any file called foo with any extension; for example,
foo.html, foo.cfm, and foo.xml.

*.html

All files with the suffix .html, but not files with the suffix
.htm.

??

All files with two-character names.

Example










The directory existed and the name has been changed to: #newDirectory#






Your directory has been created.












Files exist in this directory. Either delete the files or code
something to do so.







© 2014 Adobe Systems Incorporated. All rights reserved.

261

Adobe ColdFusion Documentation


The directory existed and has been deleted.






The directory did NOT exist.


















SELECT * FROM dirQuery
WHERE TYPE='Dir'

© 2014 Adobe Systems Incorporated. All rights reserved.

262

Adobe ColdFusion Documentation




Another example

The following example was contributed by Steve Blades:

component {
VARIABLES.instance.rootPath = "H:\Karaoke Library\";
/**
* @access remote
* @returnType struct
* @output false
*/
function GetSubordinates (string folder="", string parentage="") {
var retVal = {
'success':true,
'message':'',
'data':''
};
try {
// script version of cfdirectory
var dir = DirectoryList(VARIABLES.instance.rootPath &
ARGUMENTS.parentage & ARGUMENTS.folder, false, "query");
LOCAL.retVal.data = LOCAL.dir;
} catch (any err) {
LOCAL.retVal.success = false;
LOCAL.retVal.message = err.message;
LOCAL.retVal['errorCode'] = err.errorcode;
}
return LOCAL.retVal;
}
}

© 2014 Adobe Systems Incorporated. All rights reserved.

263

Adobe ColdFusion Documentation

cfdiv
Description

Creates an HTML div tag or other HTML container tag and lets you use asynchronous form submission or a bind
expression to dynamically control the tag contents.
Category

Display management tags
Syntax


OR

tag body contents


If the tag does not have a body and end tag, close it with /> character combination.
Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute name as structure key.

See also

cfajaximport, cflayout, cfpod, cfwindow
History

ColdFusion 8: Added this tag
Attributes

The following table lists attributes that ColdFusion uses directly. The tag passes any other attributes that you specify
directly as tag attributes to the generated HTML tag.
Attribute

Req/Opt

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

264

Adobe ColdFusion Documentation

bind

Optional

bindOnLoad

Optional

ID

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

A bind expression that
returns the container
contents. If you specify
this attribute the cfdiv ta
g cannot have a body.
Note:: If a CFML page
specified in this attribute
contains tags that use
AJAX features, such as c
fform, cfgrid, and cfw
indow, you must use a c
fajaximport tag on the
page with the cfdiv tag.
For more information, see
cfajaximport.
true

true: executes the bin
d attribute expression
when first loading the
tag.
false: does not
execute the bind attrib
ute expression until the
first bound event.
To use this attribute,
also specify a bind attri
bute.
For more information,
see Using the
bindOnLoad attribute in
Using Ajax User
Interface Components
and Features in the Dev
eloping ColdFusion
Applications.
The HTML ID attribute
value to assign to the
generated container tag.

265

Adobe ColdFusion Documentation

onBindError

Optional

See Description

The name of a JavaScript
function to execute if
evaluating a bind
expression results in an
error. The function must
take two attributes: an
HTTP status code and a
message.
If you omit this attribute,
and have specified a
global error handler (by
using the ColdFusion.s
etGlobalErrorHandle
r function), it displays the
error message; otherwise
a default error pop-up
window appears.
To use this attribute, also
specify a bind attribute.

tagName

Optional

DIV

The HTML container tag
to create.

Usage

By default, the cfdiv tag creates a div HTML element. You can use standard HTML and CSS techniques to
control the position and appearance of the element and its contents.Use the tagName attribute to create and
populate an HTML content element, such as span or b. Use the cfdiv tag to create tags that can take HTML
markup content directly in the body, such as span, i, b, or p, and not for tags that cannot, such as input, option,
and frameset.
If you submit a form that is inside a cfdiv tag (including in HTML returned by a bind expression), the form submits
asynchronously, and the response from the form submission populates the cfdiv region.
If you specify a bind attribute, the tag dynamically populates the element using a bind expression. The bind
expression can specify a CFC function, a JavaScript function, a URL, or a string that contains bind parameters. An
animated icon and the text "Loading..." appears while the contents are being fetched. For detailed information on
using the bind attribute and bind expressions, see Using Ajax Data and Development Features in the Developing
ColdFusion Applications.
Example

The following simple example shows how you can use the cfdiv tag. It uses binding to display the contents of a
text input field in an HTML DIV region.
The cfdivtag.cfm file, the main application file, has the following contents.

© 2014 Adobe Systems Incorporated. All rights reserved.

266

Adobe ColdFusion Documentation



cfdiv Example






 using a div





The divsource.cfm file that defines the contents of the div region has the following code:


Echoing main page input:



#url.InputText#

No input



To test the code, run the cfdivtag.cfm page, enter some text, and tab out of the text box or click outside the text box.
The div region appears with a light blue background and red text, and when you exit the text box, it shows the text
you entered.

© 2014 Adobe Systems Incorporated. All rights reserved.

267

Adobe ColdFusion Documentation

cfdocument
Description

Creates PDF or FlashPaper output from a text block containing CFML and HTML.
Category

Data output tags
Syntax


HTML and CFML code


© 2014 Adobe Systems Incorporated. All rights reserved.

268

Adobe ColdFusion Documentation

Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfdocumentitem, cfdocumentsection, cfform, cfpdf, cfpdfform, cfpresentation, cfprint, cfrepor
t
History

ColdFusion 9: Add ppt support to the srcFile attribute. Added the following attributes to support conversion of a
Word document to PDF or HTML using OpenOffice libraries:
formfields attribute
formsType attribute
openpassword attribute
permissionspassword attribute
pdfa attribute
tagged attribute
ColdFusion 8: Added the following attributes and variables:
bookmark attribute
localUrl attribute
Ability to embed existing PDF forms by using the cfpdfform tag in the cfdocument tag.
ColdFusion determines the MIME type of a source file based on the source filename, if the mimeType attribut
e is not specified.
Ability to pass a PDF variable created with the cfdocument tag as the source for the cfpdf tag.
authPassword, authUser, proxyHost, proxyPassword, proxyPort, proxyUser, and userAgent attr
ibutes
saveAsName attribute
totalsectionpagecount and currentsectionpagenumber scope variables.

ColdFusion MX 7.01: Added the src, srcfile, and mimetype attributes.ColdFusion MX 7: Added this tag.
Attributes

Attribute

Req/Opt

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

269

Adobe ColdFusion Documentation

authPassword

Optional

Password sent to the
target URL for Basic
Authentication. Combined
with username to form a
base64 encoded string
that is passed in the
Authenticate header.
Does not provide support
for Integrated Windows,
NTLM, or Kerebos
authentication.

authUser

Optional

User name sent to the
target URL for Basic
Authentication. Combined
with password to form a
base64 encoded string
that is passed in the
Authenticate header.
Does not provide support
for Integrated Windows,
NTLM, or Kerebos
authentication.

backgroundVisible

Optional

no

Specifies whether the
background prints when
the user prints the
document:
yes: includes the
background when
printing.
no: does not includes
the background when
printing.

bookmark

Optional

no

Specifies whether
bookmarks are created in
the document:
yes: creates
bookmarks.
no: does not create
bookmarks.

encryption

Optional

none

(format="PDF" only)
Specifies whether the
output is encrypted:
128-bit
40-bit
none

© 2014 Adobe Systems Incorporated. All rights reserved.

270

Adobe ColdFusion Documentation

filename

Optional

fontEmbed

Optional

Pathname of a file to
contain the PDF or
FlashPaper output.
If you omit the filename
attribute, ColdFusion
displays the output in the
browser.
yes

Specifies whether
ColdFusion embeds fonts
in the output:
yes: embeds fonts.
no: does not embed
fonts.
selective: embed
sall fonts except Java
fonts and core fonts.

format

Required

Report format:
PDF
FlashPaper

formfields

Optional

yes

This attribute is available
only if you have integrated
OpenOffice with
ColdFusion.A Boolean
value that specifies if form
fields are exported as
widgets or only their fixed
print representation is
exported.

formstype

Optional

FDF

This attribute is available
only if you have integrated
OpenOffice with
ColdFusion.Specifies the
submitted format of a PDF
form. It can be one of the
following values:
FDF
PDF
HTML
XML

© 2014 Adobe Systems Incorporated. All rights reserved.

271

Adobe ColdFusion Documentation

localUrl

Optional

no

Specifies whether to
retrieve image files
directly from the local
drive:
yes: ColdFusion
retrieves image files
directly from the local
drive rather than by
using HTTP, HTTPS, or
proxy.
no: ColdFusion uses
HTTP, HTTPS, or proxy
to retrieve image files
even if the files are
stored locally.
For more information,
see the "Using an
image file URL" section.

marginBottom

Optional

Bottom margin in inches
(default) or centimeters.
To specify the bottom
margin in centimeters,
include the unit=cm attri
bute.

marginLeft

Optional

Left margin in inches
(default) or centimeters.
To specify the left margin
in centimeters, include the
unit=cm attribute.

marginRight

Optional

Right margin in inches
(default) or centimeters.
To specify the right
margin in centimeters,
include the unit=cm attri
bute.

marginTop

Optional

Top margin in inches
(default) or centimeters.
To specify the top margin
in centimeters, include the
unit=cm attribute.

© 2014 Adobe Systems Incorporated. All rights reserved.

272

Adobe ColdFusion Documentation

mimeType

Optional

text/html

MIME type of the source
document. Supported
MIME types are:
text/html
text/plain
application/xml
image/bmp
image/jpeg
image/png
image/gif
If you do not specify this
attribute explicitly,
ColdFusion uses the
filename to determine
the MIME type.

name

Optional

Name of an existing
variable into which the tag
stores the PDF or
FlashPaper output.

openpassword

Optional

This attribute is available
only if you have integrated
OpenOffice with
ColdFusion.Password
required to open a
password-protected
document.

orientation

Optional

portrait

Page orientation:
portrait
landscape

overwrite

Optional

ownerPassword

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

no

Specifies whether
ColdFusion overwrites an
existing file. Used in
conjunction with the file
name attribute.
(format="PDF" only)
Specifies the owner
password.Cannot be
same as userPassword.

273

Adobe ColdFusion Documentation

pageHeight

Optional

pageType

Optional

Page height in inches
(default) or centimeters.
This attribute is only valid
if pagetype=custom. To
specify page height in
centimeters, include the u
nit=cm attribute.
letter

Page type into which
ColdFusion generates the
report:
legal: 8.5 inches x 14
inches.
letter: 8.5 inches x
11 inches.
A4: 8.27 inches x 11.69
inches.
A5: 5.81 inches x 8.25
inches.
B4: 9.88 inches x 13.88
inches.
B5: 7 inches x 9.88
inches.
B4-JIS: 10.13 inches x
14.31 inches.
B5-JIS: 7.19 inches x
10.13 inches.
custom: custom height
and width. If you specify
custom, also specify the
pageHeight and page
Width attributes, can
optionally specify marg
in attributes and
whether the units are
inches or centimeters.

pageWidth

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

Page width in inches
(default) or centimeters.
This attribute is only valid
if pageType=custom. To
specify page width in
centimeters, include the u
nit=cm attribute.

274

Adobe ColdFusion Documentation

pdfa

Optional

no

This attribute is available
only if you have integrated
OpenOffice with
ColdFusion.A Boolean
value that specifies if you
need to create a PDF of
type PDF/A-1 (ISO
19005-1:2005) .

permissionpasswrd

Optional

This attribute is available
only if you have integrated
OpenOffice with
ColdFusion.Password
required to access
restricted permissions.
The restricted permissions
are specified using the
permissions attribute.

permissions

Optional

(format="PDF" only)
Sets one or more of the
following permissions:
AllowPrinting
AllowModifyConten
ts
AllowCopy
AllowModifyAnnota
tions
AllowFillIn
AllowScreenReader
s
AllowAssembly
AllowDegradedPrin
ting
Separate multiple
permissions with
commas.

proxyHost

Optional

Host name or IP address
of a proxy server to which
to send the request.

proxyPassword

Optional

Password required by the
proxy server.

proxyPort

Optional

proxyUser

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

80

The port to connect to on
the proxy server.
User name to provide to
the proxy server.

275

Adobe ColdFusion Documentation

scale

Optional

Calculated by ColdFusion

Scale factor as a
percentage. Use this
option to reduce the size
of the HTML output so
that it fits on that paper.
Specify a number less
than 100.

saveAsName

Optional

(format="PDF" only)
The filename that appears
in the SaveAs dialog
when a user saves a PDF
file written to the browser.

src

Optional

URL or the relative path to
the web root. You cannot
specify both the src and
srcfile attributes. The
file must be in a
browser-writable format
such as, HTML, HTM,
BMP, PNG, and so on.

srcfile

Optional

Absolute path of a file that
is on the server. You
cannot specify both the s
rc and srcfile attribute
s. The file must be a PPT
file, a Word file, or be in a
browser-writable format
such as, HTML, HTM,
BMP, PNG, and so on.

tagged

Optional

no

This attribute is available
only if you have integrated
OpenOffice with
ColdFusion.A Boolean
value that determines if
the PDF is created using
the Tagged PDF tag.

unit

Optional

in

Default unit for the pageH
eight, pageWidth, and
margin attributes:
in: inches.
cm: centimeters.

© 2014 Adobe Systems Incorporated. All rights reserved.

276

Adobe ColdFusion Documentation

userAgent

Optional

userPassword

Optional

ColdFusion

Text to put in the HTTP
User-Agent request
header field. Used to
identify the request client
software.
(format="PDF" only)
Specifies a user
password.Cannot be
same as ownerPasswor
d.

Usage

Use the cfdocument tag to render HTML and CFML output into PDF or FlashPaper format. ColdFusion does not
return HTML and CFML outside of the   pair.
The cfdocument tag can render HTML that supports the following standards:
HTML 4.01
XML 1.0
DOM Level 1 and 2
CSS1 and CSS2 (For more information, see the "Supported CSS styles" section).
The cfdocument tag does not support the Internet Explorer-specific HTML generated by Microsoft
Word.Use the following syntax in the filenameattribute to specify an in-memory file, which is not written to
disk. In-memory files speed processing of transient data.

ram:///filepath

The filepath can include directories, for example ram:///petStore/tracking/ordersummary.pdf.
Create the directories in the path before you specify the file. For more information on using in-memory files,
see Working with in-memory files in the Developing ColdFusion Applications.
You can use the src, srcfile, and mimeType attributes to create PDF or FlashPaper output from a
specified file or URL. Use the src and srcfile attributes instead of using the cfhttp tag to display the
result in the cfdocument tag. When you specify the src or srcfile attributes, do not include any other
content inside the cfdocument tag: ColdFusion ignores the additional content. The PDF or FlashPaper
document returned by the cfdocument tag overwrites any previous HTML in the input stream and ignores
any HTML after the  tag.
You cannot embed a cfreport tag in a cfdocumenttag.
Note
If you notice that the header text is cropped in the cfdocument tag output, increase the
value of the marginTop attribute.

Supported CSS styles

The cfdocument tag supports the following CSS styles:

© 2014 Adobe Systems Incorporated. All rights reserved.

277

Adobe ColdFusion Documentation

background

background-attachment

background-color

background-image

background-position

background-repeat

border

border-bottom

border-bottom-color

border-bottom-style (solid
border only)

border-bottom-width

border-color

border-left

border-left-color

border-left-style (solid
border only)

border-left-width

border-right

border-right-color

border-right-style (solid
border only)

border-right-width

border-spacing

border-style (solid border
only)

border-top

border-top-color

border-top-style (solid
border only)

border-top-width

border-width

bottom

clear

clip

color

content (strings, counters
only)

counter-increment

counter-reset

cursor

display

float

font

font-family

font-size

font-style

font-weight

height

left

letter-spacing

line-height

list-style-type

margin

margin-bottom

margin-left

margin-right

margin-top

outline

outline-color

outline-style (solid, dotted,
dashed only)

outline-width

padding

padding-bottom

padding-left

padding-right

padding-top

page-break-after

page-break-before

page-break-inside

position

right

text-align (left, right, and
center)

text-decoration

text-indent

top

unicode-bidi

vertical-align

visibility

white space (normal,
nowrap only)

width

z-index

Using an image file URL

© 2014 Adobe Systems Incorporated. All rights reserved.

278

Adobe ColdFusion Documentation

For optimal performance and reliability, Adobe recommends that you specify a local file URL for images stored on
the server. In the following example, the cfdocument tag requests the server for images over HTTP even though
the image files are stored locally:






bird





fruit





rose







Also, in some applications, the browser displays a Red X image error instead of the image in the browser. For better
performance, and to avoid Red X image errors, set the localUrl attribute to yes:






bird





fruit





rose







Scope variables

When you use the cfdocument tag, ColdFusion creates a scope named cfdocument. This scope contains the
following variables:
currentpagenumber
totalpagecount
totalsectionpagecount
currentsectionpagenumber
ColdFusion lets you use the scope variables inside any expression within a cfdocumentitem tag. For
example, you can use the currentpagenumbervariable to place the section name on even pages and the

© 2014 Adobe Systems Incorporated. All rights reserved.

279

Adobe ColdFusion Documentation

chapter name on odd pages in the header, as follows:




#cfdocument.totalpagecount#

#cfdocument.currentpagenumber#


...


If you define the cfdocumentsection tag within the cfdocument tag, then specify the totalsectionpagecou
ntvariable as follows:




#cfdocument.totalpagecount#

#cfdocument.currentpagenumber#

cfdocument.currentpagenumber
:#cfdocument.currentpagenumber#
cfdocument.totalpagecount :#cfdocument.totalpagecount#
cfdocument.totalsectionpagecount
:#cfdocument.totalsectionpagecount#
cfdocument.currentsectionpagenumber
:#cfdocument.currentsectionpagenumber#



if#cfdocument.totalpagecount#

else#cfdocument.currentpagenumber#


Example Text



Bookmarks

ColdFusion 9 supports bookmarks. In the cfdocument tag, set the bookmark attribute to yes. Then specify the
bookmark name for each cfdocumentsection tag.
The following example shows how to specify bookmarks for document sections:

© 2014 Adobe Systems Incorporated. All rights reserved.

280

Adobe ColdFusion Documentation











Example

Example 1




This is a document rendered by the cfdocument tag.





Name
Role




Bill
Lead




Susan
Principal Writer




Adelaide
Part Time Senior Writer




Thomas
Full Time for 6 months




Michael
Full Time for 4 months






Example 2

© 2014 Adobe Systems Incorporated. All rights reserved.

281

Adobe ColdFusion Documentation







#cfdocument.currentsectionpagenumber# of
#cfdocument.totalsectionpagecount#








#cfdocument.currentpagenumber# of
#cfdocument.totalpagecount#






Section 1


Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor
incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud
exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute
irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla
pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia
deserunt mollit anim id est laborum.





Section 2


Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor
incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud
exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute
irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla
pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia
deserunt mollit anim id est laborum.





Section 3


Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor
incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud
exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute
irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla
pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia
deserunt mollit anim id est laborum.





© 2014 Adobe Systems Incorporated. All rights reserved.

282

Adobe ColdFusion Documentation

cfdocumentitem
Description

Specifies action items for a PDF or FlashPaper document created by the cfdocument tag. Action items include the
following:
header
footer
pagebreak
Category

Data output tags
Syntax





Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfreport, cfdocument, cfdocumentsection
History

ColdFusion 9: Added the evalAtPrint attribute.
ColdFusion 8: Added support for cfdocument.currentpagenumber, cfdocument.totalpagecount
cfdocument.totalsectionpagecount, and cfdocument.currentsectionpagenumber scopevariables.
ColdFusion MX 7.01: Added the src, srcfile, and mimetype attributes.ColdFusion MX 7: Added this tag.
Attributes

Attribute

Req/Opt

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

283

Adobe ColdFusion Documentation

Required

type

Specifies the action:
pagebreak: starts a
new page at the
location of the tag.
header: uses the text
between the  and  tags as
the running header.
footer: uses the text
between the  and  tags as
the running footer.

evalAtPrint

Optional

false

A Boolean value that
determines if the contents
of the cfdocumentitem t
ag body has to be
evaluated at the time of
printing the document.
true: evaluates the
contents of the cfdocu
mentitem tag body
only at the time of
printing the document.
false: evaluates the
contents of the cfdocu
mentitem tag body
immediately.

Usage

Use the evalAtPrint tag to evaluate the contents of the document before printing and to also accept additional
attributes. Use the cfdocumentitem tag to control the formatting of a PDF or FlashPaper report. This tag must be
wrapped inside a   pair.
Write code for one cfdocumentitem tag for each page break, running header, or running footer. ColdFusion has
added support for cfdocument scope variables within the cfdocumentitem tag. You can use the cfdocument s
cope variable, cfdocument.currentpagenumber, to display the current page number in a header or footer. You
can also use {{cfdocument.totalpagecoun}}t to display the total number of pages, for example:

...

SELECT parkname, suptmgr from parks


National Parks Report


Page #cfdocument.currentpagenumber# of
#cfdocument.totalpagecount#


Park list






Park
Manager




#parkname#
#suptmgr#







© 2014 Adobe Systems Incorporated. All rights reserved.

285

Adobe ColdFusion Documentation

cfdocumentsection
Description

Divides a PDF or FlashPaper document into sections. By using this tag in conjunction with a cfdocumentitem tag,
each section can have unique headers, footers, and page numbers.
Category

Data output tags
Syntax



HTML, CFML, and cfdocumentitem tags



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfreport, cfdocument, cfdocumentitem
History

ColdFusion 8: Added the name, authPassword, authUser, and userAgent attributes.ColdFusion MX 7.01:
Added the src, srcfile, and mimetype attributes.ColdFusion MX 7: Added this tag and the margintop, margin
bottom, marginleft, marginright attributes.
Attributes

Attribute

Req/Opt

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

286

Adobe ColdFusion Documentation

authPassword

Optional

Password sent to the
target URL for Basic
Authentication. Combined
with username to form a
base64 encoded string
that is passed in the
Authenticate header.
Does not provide support
for Integrated Windows,
NTLM, or Kerebos
authentication.

authUser

Optional

User name sent to the
target URL for Basic
Authentication. Combined
with password to form a
base64 encoded string
that is passed in the
Authenticate header.
Does not provide support
for Integrated Windows,
NTLM, or Kerebos
authentication.

marginBottom

Optional

Bottom margin in inches
(default) or centimeters.
To specify the bottom
margin in centimeters,
include the unit="cm" at
tribute in the parent cfdo
cument tag.

marginLeft

Optional

Left margin in inches
(default) or centimeters.
To specify the left margin
in centimeters, include the
unit="cm" attribute in
the parent cfdocument t
ag.

marginRight

Optional

Right margin in inches
(default) or centimeters.
To specify the right
margin in centimeters,
include the unit="cm" at
tribute in the parent cfdo
cument tag.

© 2014 Adobe Systems Incorporated. All rights reserved.

287

Adobe ColdFusion Documentation

marginTop

Optional

mimeType

Optional

Top margin in inches
(default) or centimeters.
To specify the top margin
in centimeters, include the
unit="cm" attribute in
the parent cfdocument t
ag.
text/html

MIME type of the source
document. Supported
MIME types are:
text/html
text/plain
application/xml
image/jpeg
image/png
image/gif
If you do not specify this
attribute explicitly,
ColdFusion uses the
filename to determine
the MIME type.

name

Optional

Bookmark name for the
section.

src

Optional

URL or the relative path to
the web root. You cannot
specify both the src and
srcfile attributes.

srcfile

Optional

Absolute path of an
on-disk or in-memory file
that is on the server. You
cannot specify both the s
rc and srcfile attribute
s.

userAgent

Optional

ColdFusion

Text to put in the HTTP
User-Agent request
header field. Used to
identify the request client
software.

Usage

Use the cfdocumentsection tag to divide a report into sections. Within each cfdocumentsection tag, you can
use one or more cfdocumentitem tags to specify unique headers and footers for each section.
When using cfdocumentsection, ColdFusion ignores HTML and CFML not enclosed within cfdocumentsecti
on tags.

© 2014 Adobe Systems Incorporated. All rights reserved.

288

Adobe ColdFusion Documentation

The margin attributes override margins specified in previous sections or in the parent cfdocument tag. If you
specify margin attributes, the units are controlled by the unit attribute of the parent cfdocument tag; the unit attr
ibute has a default value of inches. The cfdocumentsection tag forces a page break so that each section starts
on a new page.ColdFusion has added the name attribute to support bookmarks. Bookmarks defined at the documen
tsection tag level are children of the cfdocument root.
Example

Example 1


SELECT Emp_ID, firstname, lastname, e.dept_id, salary, d.dept_name
FROM employee e, departmt d
WHERE e.dept_id = d.dept_id
ORDER BY d.dept_name





Salary Report


Page #cfdocument.currentpagenumber#


#dept_name#











Employee
Salary





#empSalary.lastname#, #empSalary.firstname#


#DollarFormat(empSalary.salary)#





Total
#DollarFormat(deptTotal)#








© 2014 Adobe Systems Incorporated. All rights reserved.

289

Adobe ColdFusion Documentation

Example 2: Bookmarks











© 2014 Adobe Systems Incorporated. All rights reserved.

290

Adobe ColdFusion Documentation

cfdump
Description

Use the cfdump tag to get the elements, variables, and values of most kinds of ColdFusion objects. Useful for
debugging. You can display the contents of simple and complex variables, objects, components, user-defined
functions, and other elements. The cfdump now shows component properties defined by cfproperty when you
dump a CFC. A new key called PROPERTIES has been added in the component dump, which is expanded, by
default. The text format of cfdump also provides this information.
Category

Debugging tags, Variable manipulation tags
Syntax


label = "text"
metainfo = "yes|no"
top = "number of rows|number of levels"
show = "columns|keys"
hide = "columns|keys"
keys = "number of keys to display for structures"
expand = "yes|no"
showUDFs = "yes|no">

Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfcookie, cfparam, cfsavecontent, cfschedule, cfset, cftimer, cfwddx
History

ColdFusion 9: Added the attribute abort.
ColdFusion 8: Added the show, format, hide, keys, metainfo, output, and showUDFs attributes.
ColdFusion MX 7: Added the top attribute.
ColdFusion MX 6.1: Added the ability to dump COM objects; it displays the methods and Get and Put
properties typeinfo information for the object.
Attributes

Attribute

Req/Opt

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

291

Adobe ColdFusion Documentation

var

Required

Variable to display.
Enclose a variable name
in number signs. These
kinds of variables yield
meaningful cfdump outpu
t:
array
CFC
COM object
file object
Java object
simple
query
structure
UDF
wddx
xml

expand

Optional

yes

format

Optional

text

Use with the output attri
bute to specify whether to
save the results of a cfdu
mp to a file in text or
HTML format.

hide

Optional

all

For a query, this is a
column name or a
comma-delimited list of
column names. For a
structure, this is a key or a
comma-delimited list of
keys.
If you specify a structure
element that doesn't exist,
ColdFusion ignores it and
does not generate an
error.

keys

Optional

9999

For a structure, the
number of keys to display.

label

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

yes: in Internet
Explorer and Mozilla,
expands views.
no: contracts expanded
views.

A string; header for the
dump output. Ignored if
the value of the var
attribute is a simple types.

292

Adobe ColdFusion Documentation

metainfo

Optional

yes for query{{no}} for
persistence CFCs

For use with queries and
persistence CFCs.
Includes information about
the query in the cfdump
results, including whether
the query was cached, the
execution time, and the
SQL. Specify metainfo=
"no" to exclude this
information from the query
result. For persistence
CFCs, if metainfo="yes
", returns property
attributes such as getters
and setters.

output

Optional

browser

Where to send the results
of cfdump. The following
values are valid:
browser
console
filename
The filename must
include the full
pathname of the file.
You can specify an
absolute path, or a path
that is relative to the
ColdFusion temporary
directory. You can use
the GetTempDirector
y() function to
determine the
ColdFusion temporary
directory.

show

Optional

all

For a query, this is a
column name or a
comma-delimited list of
column names. For a
structure, this is a key or a
comma-delimited list of
keys.

showUDFs

Optional

yes

yes: includes UDFs,
with the methods
collapsed.
no: excludes UDFs.

© 2014 Adobe Systems Incorporated. All rights reserved.

293

Adobe ColdFusion Documentation

top

Optional

9999

The number of rows to
display. For a structure,
this is the number of
nested levels to display.

abort

Optional

false

If this attribute is set to
"true", it stops processing
the current page at the tag
location.

Usage

The expand/contract display capability is useful when working with large structures, such as XML document objects,
structures, and arrays.
To display a construct, use code such as the following, in which myDoc is a variable of type XmlDocument:





The tag output is color-coded according to data type.
If a table cell is empty, this tag displays "empty string".
Example




myfile = FileOpen("c:\temp\test1.txt", "read");

myfile refers to:


© 2014 Adobe Systems Incorporated. All rights reserved.

294

Adobe ColdFusion Documentation

cfelse
Description

Used as the last control block in a cfif tag block to handle any case not identified by the cfif tag or a cfelseif
tag.
Category

Flow-control tags
Syntax


HTML and CFML tags
HTML and CFML tags

HTML and CFML tags




See also

cfif, cfelseif, cfabort, cfbreak, cfexecute, cfexit, cflocation, cfloop, cfswitch, cfthrow, cftr
y
Usage

If the values of the expressions in the containing cfif tag and all cfelseif tags are no, ColdFusion processes the
code between this tag and the cfif end tag. This tag must be inside a cfif tag block. It does not require an end
tag. For more information and an example, see cfif.

© 2014 Adobe Systems Incorporated. All rights reserved.

295

Adobe ColdFusion Documentation

cfelseif
Description

Used as a control block in a cfif tag block to handle any case not identified by the cfif tag or a cfelseif tag.
Category

Flow-control tags
Syntax


HTML and CFML tags 
HTML and CFML tags

HTML and CFML tags 

See also

cfif, cfelse, cfabort, cfbreak, cfexecute, cfexit, cflocation, cfloop, cfswitch, cfthrow, cftry
Usage

If the value of the expression in this tag is yes, and the values of the expressions in the containing cfif tag and
preceding cfelseif tags are no, ColdFusion processes the code between this tag and a following cfelseif or c
felse tag, or the cfif end tag and then skips to the code following the cfif end tag. Otherwise, ColdFusion skips
the code.
This tag must be inside a cfif tag block. It does not require an end tag. For more information and an example, see
cfif.

© 2014 Adobe Systems Incorporated. All rights reserved.

296

Adobe ColdFusion Documentation

cferror
Description

Displays a custom HTML page when an error occurs. This lets you maintain a consistent look and feel among an
application's functional and error pages.
Category

Exception handling tags, Extensibility tags, Application framework tags
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfrethrow, cfthrow, cftry, Handling Errors in the Developing ColdFusion Applications.
History

ColdFusion MX: Deprecated the monitor option of the exception attribute. It might not work, and might cause an
error, in later releases.
Attributes

Attribute

Req/Opt

template

Required

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description
Relative path to the
custom error page. (A
ColdFusion page was
formerly called a
template.)

297

Adobe ColdFusion Documentation

type

Required

Type of error that the
custom error page
handles. The type also
determines how
ColdFusion handles the
error page. For more
information, see Specifyin
g a custom error page in
Specifying custom error
messages with the cferror
tag in the Developing
ColdFusion Applications.
exception: an
exception of the type
specified by the excep
tion attribute.
validation: errors
recognized by
server-side type
validation.
request: any
encountered error.

© 2014 Adobe Systems Incorporated. All rights reserved.

298

Adobe ColdFusion Documentation

exception

Optional

any

Type of exception that the
tag handles:
application:
application exceptions.
database: database
exceptions.
template: ColdFusion
page exceptions.
security: security
exceptions.
object: object
exceptions.
missingInclude:
missing include file
exceptions.
expression:
expression exceptions.
lock: lock exceptions.
custom_type:
developer-defined
exceptions, defined in
the cfthrow tag.
any: all exception
types.
For more information on
exception types, see cf
try.

mailTo

Optional

An e-mail address. This
attribute is available on
the error page as the
variable error.mailto.
ColdFusion does not
automatically send
anything to this address.

Usage

Use this tag to provide custom error messages for pages in an application. This lets you maintain a consistent look
and feel within the application, even when errors occur. You generally embed this tag in your Application CFC or
Application.cfm file to specify error-handling responsibilities for an entire application. You must put it in one of these
files if you specify type="validation"; ColdFusion ignores it on any other page. The cftry and cfcatch tags
provide a more interactive way to handle ColdFusion errors within a ColdFusion page than the cferror tag, but the
cferror tag is a good safeguard against general errors. To ensure that error pages display successfully, avoid
using the cfencode utility to encode pages that include the cferror tag.
Page types

The following table describes the types of errors you can specify and code you can use on the pages that handle
these error type:

© 2014 Adobe Systems Incorporated. All rights reserved.

299

Adobe ColdFusion Documentation

Page type

Description

Use

Exception

Dynamically invoked by the CFML
language processor when it detects
an unhandled exception
condition.Uses the full range of
CFML tags. Error variables must be
in cfoutput tags.

Can handle specific exception types
or display general information for
exceptions.

Request

Includes the error variables
described in the Error variables
section. Cannot include CFML tags,
but you can display values of the
error variables by enclosing them in
number signs (#), as in #error.Ma
ilTo#.

Use as a backup error handler to
other error handling methods,
including exception type.

Validation

Handles data input validation errors
that occur when submitting a form
that uses hidden form-field
validation or onSubmit validation.
Cannot include CFML tags, but you
can display values of the error
variables by enclosing them in
number signs (#), as in #Error.In
validFields#.Specify the
validation error handler in the
Application.cfc or Application.cfm
file.

Handles hidden form-field or
onSubmit format validation errors
only.

Error variables

The exception-handling page specified in the cferror tag template attribute contains one or more error
variables. ColdFusion substitutes the value of the error variable when an error displays.
The following table lists error variables:
Page type

Error variable

Description

Validation only

error.validationHeader

Validation message header text.

error.invalidFields

Unordered list of validation errors.

error.validationFooter

Validation message footer text.

error.diagnostics

Detailed error diagnostics from
ColdFusion.

error.mailTo

E-mail address (same as value in c
ferror.MailTo).

Request and Exception

© 2014 Adobe Systems Incorporated. All rights reserved.

300

Adobe ColdFusion Documentation

Exception only

error.dateTime

Date and time when error occurred.

error.browser

Browser that was running when
error occurred.

error.remoteAddress

IP address of remote client.

error.HTTPReferer

Page from which client accessed
link to page where error occurred.

error.template

Page executing when error
occurred.

error.generatedContent

The content generated by the page
up to the point where the error
occurred.

error.queryString

URL query string of client's request.

error.message

Error message associated with the
exception.

error.rootCause

The root cause of the exception.
This structure contains the
information that is returned by a cf
catch tag. For example, for a
database exception, the SQL
statement that caused the error is in
the error.RootCause.Sql variable.
For Java exceptions, this variable
contains the Java servlet exception
reported by the JVM as the cause
of the "root cause" of the exception.

error.tagContext

Array of structures containing
information for each tag in the tag
stack. The tag stack consists of
each tag that is currently open.

error.type

Exception type.

Note
If type = "exception", you can substitute the prefix cferror for Error; for example, cfer
ror.diagnostics, cferror.mailTo, or cferror.dateTime.

Example

© 2014 Adobe Systems Incorporated. All rights reserved.

301

Adobe ColdFusion Documentation


cferror Example





select * from nothing




We're sorry -- An Error Occurred



We're sorry -- An Error Occurred



If you continue to have this problem, please contact #error.mailTo#
with the following information:




    

  • Your Location: #error.remoteAddress#

  • Your Browser: #error.browser#

  • Date and Time the Error Occurred: #error.dateTime#

  • Page You Came From: #error.HTTPReferer#

  • Message Content:

    #error.diagnostics#
    



© 2014 Adobe Systems Incorporated. All rights reserved.

302

Adobe ColdFusion Documentation

cfexchangecalendar
Description

Creates, deletes, modifies, gets, and responds to Microsoft Exchange calendar events, and gets calendar event
attachments.
History

ColdFusion 11: Added three new optional attributes to the cfexchangecalendar tag for managing secondary
calendars. These attributes are applicable for get and create actions only and valid for exchange server version
starting from 2010. Secondary calendars can be specified in the exchangecalendar tag either using secondary
calendar folder ID or using the calendar folder path
ColdFusion 10: getUserAvailability, getRooms, getRoomsList
Added the attribute serverVersion.
ColdFusion 8: Added this tag.
Category

Communications tags
Syntax

create

delete

deleteAttachments

get

getAttachments

generateUniqueFilenames = "no|yes"
getRooms

getRoomsList

getUserAvailability

modify

respond

notify = "yes|no">

Note
For all actions, see cfexchangeconnection for additional attributes that you use if you do not
specify the connection attribute. If you omit the connection attribute, create a temporary
connection by specifying cfexchangeconnection tag attributes in the cfexchangecalenda
r tag. In this case, ColdFusion closes the connection when the tag completes. For details, see
the cfexchangeconnection tag open action.

Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfexchangeconnection, cfexchangecontact, cfexchangefilter, cfexchangemail, cfexchangetask,
Working with meetings and appointments in the Developing ColdFusion Applications
Attributes

Attribute

Action

Req/Opt

action

N/A

Required

Default

Description
The action to take.
Must be one of the
following values:
create
delete
deleteAttachm
ents
get
getAttachment
s
getRooms
getRoomsList
getUserAvailabilit
y
modify
respond

© 2014 Adobe Systems Incorporated. All rights reserved.

305

Adobe ColdFusion Documentation

attachmentPath

getAttachments

Optional

The filepath of the
on-disk or
in-memory directory
in which to put the
attachments. If an
on-disk directory
does not exist,
ColdFusion creates
it.
Note: If you omit
this attribute,
ColdFusion does not
save any
attachments. If you
specify a relative
path, the path root is
the ColdFusion
temporary directory,
which is returned by
the GetTempDirec
tory function.

attendees

getUserAvailabi
lity

Required

Comma-separated
list of all attendees.

connection

all

Optional

The name of the
connection to the
Exchange server, as
specified in the cfe
xchangeconnecti
on tag. If you omit
this attribute, you
must create a
temporary
connection by
specifying
cfexchangeconnecti
on tag connection
attributes in the cfe
xchangecalendar
tag.

© 2014 Adobe Systems Incorporated. All rights reserved.

306

Adobe ColdFusion Documentation

dataRequestType

getUserAvailabi
lity

Required

emailAddress

getRooms

Optional

Defines the Simple
Mail Transfer
Protocol (SMTP)
address of a
mailbox user.

endDate

getUserAvailabi
lity

Required

A string that
ColdFusion can
interpret as a
date-time value.

event

createmodify

Required

A reference to the
structure that
contains the event
properties to be set
or changed, and
their values. Specify
this attribute in
number signs (#).
The event attribute
also supports the
categories key.
For more
information on the
event structure, see
Usage.

© 2014 Adobe Systems Incorporated. All rights reserved.

freeBusy:
Returns an array
of availability
details.
Suggestions:
Returns an array
of struct that
contains
suggestion
details.
freeBusyandSu
ggestions:
Returns both the
array of
suggestions and
an array of atten
deeavailabili
ty.
See the sections
on suggestion
struct and atten
deeavailabili
ty struct for
details.

307

Adobe ColdFusion Documentation

getOccurrence

TrueFalse

Optional

generateUnique
Filenames

getAttachments

Optional

message

deleterespond

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

If True, retrieves all
occurrences of a
recurring event
between specified s
tartDate and End
Date values and
also, any single
events. You can not
use cfExchangeFi
lter tag if you
specify
getOccurrence as
True.
no

A Boolean value
that specifies
whether to generate
unique filenames if
multiple attachments
have the same
filenames. If two or
more attachments
have the same
filename and this
option is yes,
ColdFusion appends
a number to the
filename body
(before the
extension) of any
conflicting
filenames. Thus, if
three attachments
have the name
myfile.txt,
ColdFusion saves
the attachments as
myfile.txt,
myfile1.txt, and
myfile2.txt.
The text of an
optional message to
send in the
response or deletion
notification.

308

Adobe ColdFusion Documentation

name

getAttachments

Required

The name of the
ColdFusion query
variable that
contains the
retrieved events or
information about
the attachments that
were retrieved. For
more information on
the returned data,
see Usage.

getUserAvailabi
lity
getRoomsListget
Rooms

notify

deleterespond

Optional

responseType

respond

Required

true

Boolean value that
specifies whether to
notify others of the
changes made to
the event.
Must be one of the
following values:
accept
decline
tentative

result

create

© 2014 Adobe Systems Incorporated. All rights reserved.

Optional

The name of a
variable that
contains the UID of
the event that is
created. You use
the UID value in the
uid attribute of
actions other than c
reate to identify
the event to be
acted on.

309

Adobe ColdFusion Documentation

Optional

serverVersion

2007

Specifies the
Microsoft Exchange
Server version. The
values are:
2003
2007
2010
If you do not
specify the
details, 2007 is
taken by default.
The value you
specify overrides
the value that you
specify at the
application level.

startDate

getUserAvailabi
lity

Required

A string that
ColdFusion can
interpret as a
date-time value.

uid

delete

Required

Case-sensitive
Exchange UID value
or values that
uniquely identify the
event or events on
which to perform the
action. For the dele
te action, this
attribute can be a
comma-delimited list
of UID values. The d
eleteAttachment
s, getAttachment
s, modify, and res
pond actions allow
only a single UID
value.

Optional

Specify the calendar
folder ID from which
the calendar items
need to be
managed. If the
folder ID is not a
valid calendar, an
error will be
reported.

getAttachments
modify
respond

folderid

© 2014 Adobe Systems Incorporated. All rights reserved.

310

Adobe ColdFusion Documentation

folderpath

Optional

Full path to the
calendar folder in
the mailbox store.
Path delimiter also
can be specified in
the tag by using the
pathdelimiter
attribute.
If both folderid and
folderpath are not
specified,
cfexchangecalendar
tag manages the
default user
calendar. If both
folderid and
folderpath are
specfied, folderid
will be considered.

pathdelimiter

Optional

/

Lets you specify the
delimiter that is used
to separate the
folders in the
folderpath attribute.

Usage

The cfexchangecalendar tag manages calendar events on the Exchange server. Use the cfexchangecalend
ar to do the following actions:
Create an appointment or meeting event. You can create all-day events.
Delete one or more events.
Get one or more events that conform to an optional set of filter specifications, such as the subject, sender or
recipient ID, time received, and so on.
Get the attachments for a specific event.
Modify an existing event.
Respond to an event.
To use this tag, you must have a connection to an Exchange server. If you are using multiple tags that
interact with the Exchange server, such as if you are creating several contact records, use the cfexchangec
onnection tag to create a persistent connection. Then specify the connection identifier in each cfexchang
ecalendar tag, or in any other ColdFusion Exchange tag, if you are also accessing tasks, contacts, or mail.
Doing this eliminates the overhead of creating and closing the connection for each tag. Alternatively, you can
create a temporary connection that lasts only for the time that ColdFusion processes the single cfexchange
calendar tag. To do this, specify the connection attributes directly in the cfexchangecontact tag. For
details on the connection attributes, see the cfexchangeconnectiontag.
Note
To create an Exchange calendar appointment, create a calendar event and do not specify
any required or optional attendees.

© 2014 Adobe Systems Incorporated. All rights reserved.

311

Adobe ColdFusion Documentation

The create action

When you specify the create action, the event attribute must specify a structure that contains the information that
defines the events. The structure can have the following entries:
Element

Default

Description

AllDayEvent

no

A Boolean value that indicates
whether this is an all-day event.

Attachments

One or more paths to the files to
send as attachments. Separate
filepaths with semicolons (;) for
Windows, and colons (:) for UNIX
and Linux. Paths to the attachments
must be absolute.
If you specify one or more
attachments for a modify action,
the specified attachments are
added to any existing attachments;
the pre-existing attachments are not
deleted.

Categories

A comma-delimited list of
categories. The filter searches for
events that match all the categories
in the list.

Duration

The duration of the event in
minutes.

EndTime

The end time of the event, in any
valid ColdFusion date-time format.

Importance

normal

One of the following values:
high
normal
low.

IsRecurring

A Boolean value that indicates
whether this event repeats. If yes
, specify a RecurrenceType ele
ment and elements to specify the
recurrence details. For
information on the recurrence
fields, see the next table.

Location

© 2014 Adobe Systems Incorporated. All rights reserved.

A string that specifies the location of
the event.

312

Adobe ColdFusion Documentation

Message

A string that contains a message
about the event. The string can
include HTML formatting.

OptionalAttendees

A comma-delimited list of mail IDs.

Organizer

A string that specifies the name of
the meeting organizer.

Reminder

The time, in minutes before the
event, at which to display a
reminder message.

RequiredAttendees

A comma-delimited list of mail IDs.

Resources

A comma-delimited list of mail IDs
for Exchange scheduling resources,
such as conference rooms and
display equipment.
The valid values are normal, com
pany-confidential, personal,
and private.

Sensitivity

StartTime

The start time of the event, in any
valid ColdFusion date-time format.
If you specify a date and time in this
attribute and specify a YEARLY Rec
urrenceType with no other
recurrence attributes, the event
recurs yearly at the day and time
specified in this attribute.

Subject

A string that describes the event
subject.

The following table lists the elements that you use to specify the event recurrence if you set the IsRecurring field
to a yes value. For a detailed description of how to specify event recurrence, see Specifying Calendar recurrence in
Working with meetings and appointments in the Developing ColdFusion Applications.
Element

Type

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

313

Adobe ColdFusion Documentation

RecurrenceType

all

DAILY

Used only if the structure
has a yes IsRecurring
element. Must be one of
the following values:
DAILY
WEEKLY
MONTHLY
YEARLY

RecurrenceNoEndDate

all

RecurrenceCount

all

The number of times the
event recurs. Cannot be
used with RecurrenceEn
dDate or RecurrenceNo
EndDate.

RecurrenceEndDate

all

The date of the last
recurrence. Cannot be
used with RecurrenceCo
unt or RecurrenceNoEn
dDate.

RecurrenceFrequency

DAILY, WEEKLY, MONTHL
Y

RecurEveryWeekDay

DAILY

© 2014 Adobe Systems Incorporated. All rights reserved.

yes

1

Boolean value; if yes, the
event recurs until you
change or delete the
event. Cannot be used
with RecurrenceCount
or RecurrenceEndDate.

The frequency of the
recurrence in days,
weeks, or months,
depending on the type.
For example, for DAILY re
currence, a Recurrence
Frequency of 3
schedules the event every
three days.
The recurrence of the
event on every week day,
but not on Saturday or
Sunday. Cannot be used
with RecurrenceFreque
ncy.

314

Adobe ColdFusion Documentation

RecurrenceDays

WEEKLY

The day or days of the
week on which the event
occurs. Must be one or
more of the following
values in a
comma-delimited list:MON,
TUE, WED, THU, FRI, SAT,
{{SUN}}If you omit this
field for a weekly
recurrence, the event
recurs on the day of the
week that corresponds to
the specified start date.

RecurrenceDay

MONTHLY, YEARLY

The day of the week on
which the event occurs.
Must be one of the
following values:
MON
TUE
WED
THU
FRI
SAT
SUN

RecurrenceWeek

MONTHLY, YEARLY

The week of the month or
year on which the event
recurs. The valid values
are:
first
second
third
fourth
last

RecurrenceMonth

YEARLY

The month of the year on
which the event recurs.
The valid values are JAN,
FEB, MAR, APR, MAY, JUN,
JUL, AUG, SEP, OCT, NOV,
and DEC.

The delete action

When you specify the delete action, specify a uid attribute with a comma-delimited list of one or more Exchange
UIDs that identify the events to delete. Use the get action, with an appropriate filter expression, to determine the
UID values to specify.
If all UIDs that you specify are invalid, the cfexchangecalendar tag generates an error. If at least one UID is
valid, the tag ignores any invalid UIDs and deletes the items specified by the valid UID.

© 2014 Adobe Systems Incorporated. All rights reserved.

315

Adobe ColdFusion Documentation
The get action

When you specify the get action, use child cfexchangefilter tags to specify the messages to get. For detailed
information on filters, see cfexchangefilter.
When the tag completes processing, the query object specified by the name attribute contains one record for each
retrieved message. Each record has the following columns:
AllDayEvent

Duration

EndTime

From

HasAttachment

HtmlMessage

Importance

IsRecurring

Location

Message

OptionalAttendees

Organizer

Reminder

RequiredAttendees

Resources

Sensitivity

StartTime

Subject

UID

Categories

The following table describes the From, HtmlMessage, Message, and UID fields. For detailed information on the
other fields, see the table in the create action description.
Column

Description

From

The Exchange ID of the person who created the event.

HtmlMessage

An HTML-formatted version of the message about the
event.

Message

A plain-text version of the message about the event.

UID

The Exchange unique identifier for the mail event. Use
this value to identify the event in the delete, getAtta
chments, and modify actions.

The getAttachments action

When you use the getAttachments action, specify a single UID and a name attribute. The cfexchangecalenda
r tag populates a query object with the specified name. Each record has the following information about an
attachment to the event specified by the UID:
Column

Description

attachmentFileName

The filename of the attachment.

attachmentFilePath

The absolute path of the attachment file on the server.
If you omit the attachmentPath attribute, this column
contains the empty string.

© 2014 Adobe Systems Incorporated. All rights reserved.

316

Adobe ColdFusion Documentation

CID

The content-ID of the attachment. Typically used in
HTML img tags to embed images in a message.

mimeType

The MIME type of the attachment, such as text/html.

isMessage

A Boolean value that specifies whether the attachment
is a message.

size

The attachment size in bytes.

The tag places the attachments in the directory specified by the attachmentPath attribute. If you omit the attach
mentPath attribute, ColdFusion does not get any attachments, it gets the information about the attachments. This
lets you determine the event's attachments without incurring the overhead of getting the attachment files.Use the
following syntax to specify an in-memory attachmentPath directory. In-memory files are not written to disk and
speed processing of transient data.

attachmentpath = "ram:///path"

The path can include multiple directories, for example ram:///petStore/orders/messageAttachments.
Create all directories in the path before you specify the file. For more information on using in-memory files, see Work
ing with in-memory files in Optimizing ColdFusion applications in the Developing ColdFusion Applications.
The getAttachments action works only if authentication for EWS (Exchange Web Services) is set to basic in the
server setup of Exchange. IWA (Integrated Windows Authentication) is not supported.
The modify action

When you specify the modify action, you select the event to modify by specifying a uid attribute with single event
UID; multiple UIDs are not allowed. You populate the event structure with only the fields that you are changing. For
a detailed description of the fields and their valid values, see the table in the create action.
If an event has attachments and you specify attachments when you modify the event, the new attachments are
added to the previous attachments; they do not replace them. Use the deleteAttachments action to remove any
attachments.
The respond action

You use the respond action to respond to a meeting notification that you received by using the cfexchangemail t
ag. A meeting does not appear in your calendar, and cannot be accessed by using the cfexchangecalendar tag,
until you respond to the mail message and accept or tentatively accept the request.
When you specify the respond action, specify the UID, from the notification mail message, of the event to which
you are responding. Also specify the response type; that is, whether you are accepting, rejecting, or tentatively
accepting the event. You can optionally specify a message to include in the response and set a flag whether to
notify the creator of the event of your response. For detailed information on using the respond action, see Working
with meetings and appointments in the Developing ColdFusion Applications.
Suggestions struct values

Struct values

© 2014 Adobe Systems Incorporated. All rights reserved.

Description

317

Adobe ColdFusion Documentation

date

Suggested day for the meeting.

quality

The quality of the suggested day, if Excellent, Good,
Fair or Poor.

TimeSuggestion

An array of struct that contains the following values:
MeetingDate: Suggested meeting time.
Quality: The quality of the time. It can be Excelle
nt, Good, Fair, or Poor.
array of conflicts: The conflicts at the suggested time.
This is a struct that contains the following values: Co
nflictType (the type of conflict, which can be ind
ividualAttendeeConflict, which is a conflict
with an attendee, GroupConflict which is a
conflict with at least one member of a group, GroupT
ooBigConflict which is a conflict with at least one
member of a group, but the group was too big for
detailed information to be returned, and UnknownAt
tendeeConflict which is a conflict with an
unresolvable attendee or an attendee that is not a
user, group, or contact).
FreeBusyStatus: Gets the free/busy status of the
conflicting attendee. Only meaningful when Conflic
tType is equal to IndividualAttendee. The
values are Free, Tentative, Busy, OOF (time slot
associated with the appointment appears as Out of
Office) or NoData (no free/busy status is associated
with the appointment).
NoOfMembers: Gets the number of users,
resources, and rooms in the conflicting group. Only
meaningful when ConflictType is equal to Confl
ictType GroupConflict.
NoOfMembersAvailable: Gets the number of
available members (whose status is Free) in the
conflicting group. Only meaningful when ConflictT
ype is equal to ConflictType GroupConflict.
NoOfMembersWithConflict: Gets the number of
members who have a conflict (whose status is Busy,
OOF, or Tentative) in the conflicting group. Only
meaningful when ConflictType is equal to Confl
ictType GroupConflict.
NoOfMembersWithNoData: Gets the number of
members who do not have published free/busy data
in the conflicting group. Only meaningful when Conf
lictType is equal to ConflictType GroupConflict
.
isWorkTime: If the suggested meeting happens in
the work hours.

© 2014 Adobe Systems Incorporated. All rights reserved.

318

Adobe ColdFusion Documentation
Values of the struct attendeeavailability

Struct values

Description

CalendarEvent

A struct that contains the following values:
startTime: The start date and time of the event.
endTime: The end date and time of the event.
freeBusyStatus: The free/busy status associated
with the event. It can have following values: Free, t
entative, busy , OOF (Out of Office), or NoData (n
o free/busy status is associated with the
appointment).
details: The details of the calendar event; detai
ls is null if the user who requests for details does
not have the appropriate rights. details is a struct
that contains the following values: location (calend
ar location), eventstoreId (store ID of the
calendar event), and Subject (can be isExceptio
n which is a boolean value that indicates if the
calendar event is an exception in a recurring series,
isMeeting which is a boolean value that indicates if
the calendar event is a meeting, isPrivate which
is a boolean value that indicates if the calendar event
is private, isRecurring which is a boolean value
that indicates if the calendar event is recurring, and i
sRemainderSet which is a boolean value that
indicates if the calendar event has a reminder set).

mergedFreeBusyStatus

An array of struct that contains status. The status can
be
Free : The time slot associated with the appointment
appears as Free.
Tentative : The time slot associated with the
appointment appears as Tentative.
Busy : The time slot associated with the appointment
appears as Busy
OOF: The time slot associated with the appointment
appears as Out of Office.
NoData: No free/busy status is associated with the
appointment.
result: The result associated with the response.
This can be success, warning, or error.

© 2014 Adobe Systems Incorporated. All rights reserved.

319

Adobe ColdFusion Documentation

viewType

The free/busy view type retrieved for the attendee. It
can have the following values:
None: No view is returned. This value cannot be
specified in a call to GetUserAvailability.
MergedOnly: An aggregated free/busy stream. If the
target user in one forest does not have an Availability
service configured, the Availability service of the
requestor retrieves the target user's free/busy
information from the free/busy public folder. Because
public folders only stores free/busy information in
merged form, MergedOnly is the only available
information.
FreeBusy: The legacy status information (free, bu
sy, tentative, and OOF). This also includes the
start/end times of the appointments. This view is
comprehensive than the legacy free/busy view
because individual meeting start and end times are
provided instead of an aggregated free/busy stream.
FreeBusyMerged: All the properties in FreeBusy w
ith a stream of merged free/busy availability
information.
Detailed: The legacy status information (free, bu
sy, tentative, and OOF, the start/end times of the
appointments; and various properties of the
appointment such as subject, location, and
importance). This requested view returns the
maximum amount of information for which the
requesting user is privileged. If merged free/busy
information only is available, as with requesting
information for users in a Microsoft Exchange Server
2003 forest, MergedOnly is returned. Otherwise, Fr
eeBusy or Detailed are returned.
DetailedMerged: Represents all the properties in
Detailed with a stream of merged free/busy
availability information. If, only merged free/busy
information is available, for example if the mailbox
exists on a computer running Exchange 2003, Merg
edOnly is returned. Otherwise, FreeBusyMerged o
r DetailedMerged is returned.

© 2014 Adobe Systems Incorporated. All rights reserved.

320

Adobe ColdFusion Documentation

workingHours

A struct that contains the following details:
startTime: The start date and time of the event.
endTime: The end date and time of the event.
daysOfTheWeek: An array of struct. The working
days of the attendees. It can have the following
values: Sunday, Monday, Tuesday, Wednesday, T
hursday, Friday, Saturday, Weekday, and Week
EndDayDay.
Timezone: A struct that contains the following
fields: id (ID of the time zone definition) and name (n
ame of this time zone definition).

Exchange UID value

For all the cfexchangecalendar actions, the value of the attribute uid is as follows:
If exchangeServerVersion is set to 2003 or 2007: The uid indicates the ID of the appointment in the
mailbox of the organizer.
If exchangeServerVersion is set to 2010: The uid indicates the ID of the received appointment in the
mailbox of the attendee.
In the case of interaction with Microsoft Exchange server 2003 or 2007, whenever an appointment is created,
the UID of the organizer can be used by the attendee for any operation such as responding, deleting, or
getting attachments. In the case of Microsoft Exchange server 2010, the behavior is different. If attendees
have to perform appointment-related actions, they have to first search for the appointment in their mailbox
and then use the UID of that appointment.
Example 1

The following example lets you create, and then modify a calendar event. When you first submit the form,
ColdFusion creates the calendar event and redisplays the form with the data you entered. Accept the event before
you modify the form and resubmit it. When you submit the form a second time, ColdFusion sends the modification
information. For more information, see Working with meetings and appointments in the Developing ColdFusion
Applications.
This example resends all the event data (to limit the example length), but you could change the example so that it
only sends modified data.








sEvent.AllDayEvent="no";
sEvent=StructNew();
sEvent.Subject=Form.subject;
if (IsDefined("Form.allDay")) {
sEvent.AllDayEvent="yes";
sEvent.StartTime=createDateTime(Year(Form.date), Month(Form.date),
Day(Form.date), 8, 0, 0);
}
else {

© 2014 Adobe Systems Incorporated. All rights reserved.

321

Adobe ColdFusion Documentation

sEvent.StartTime=createDateTime(Year(Form.date), Month(Form.date),
Day(Form.date), Hour(Form.startTime), Minute(Form.startTime), 0);
sEvent.EndTime=createDateTime(Year(Form.date), Month(Form.date),
Day(Form.date), Hour(Form.endTime), Minute(Form.endTime), 0);
}
sEvent.Location=Form.location;
sEvent.RequiredAttendees=Form.requiredAttendees;
sEvent.OptionalAttendees=Form.optionalAttendees;
//sEvent.Resources=Form.resources;
if (Form.reminder NEQ "") {
sEvent.Reminder=Form.reminder;
}
else {
sEvent.Reminder=0;
}
sEvent.Importance=Form.importance;
sEvent.Sensitivity=Form.sensitivity;
sEvent.message=Form.Message;







Event Added. UID is#theUID#





Event ID #Form.eventID# Updated.

































© 2014 Adobe Systems Incorporated. All rights reserved.

323

Adobe ColdFusion Documentation




Example 2

The following example shows how you can get UserAvailability action:Application.cfm






























var eventInfo = structNew();
if(isdefined("AllDayEvent") EQ 1)
eventInfo.AllDayEvent = AllDayEvent;
if(isdefined("Duration") EQ 1)
eventInfo.Duration = Duration;
if(isdefined("EndTime") EQ 1)
eventInfo.EndTime = EndTime;
if(isdefined("From") EQ 1)
eventInfo.From = From;
if(isdefined("HasAttachment") EQ 1)
eventInfo.HasAttachment = HasAttachment;
if(isdefined("HtmlMessage") EQ 1)
eventInfo.HtmlMessage = HtmlMessage;
if(isdefined("Importance") EQ 1)
eventInfo.Importance = Importance;
if(isdefined("IsRecurring") EQ 1)

© 2014 Adobe Systems Incorporated. All rights reserved.

324

Adobe ColdFusion Documentation

eventInfo.IsRecurring = IsRecurring;
if(isdefined("Message") EQ 1)
eventInfo.Message = Message;
if(isdefined("OptionalAttendees") EQ 1)
eventInfo.OptionalAttendees = OptionalAttendees;
if(isdefined("Organizer") EQ 1)
eventInfo.Organizer = Organizer;
if(isdefined("Reminder") EQ 1)
eventInfo.Reminder = Reminder;
if(isdefined("RequiredAttendees") EQ 1)
eventInfo.RequiredAttendees = RequiredAttendees;
if(isdefined("Resources") EQ 1)
eventInfo.Resources = Resources;
if(isdefined("Sensitivity") EQ 1)
eventInfo.Sensitivity = Sensitivity;
if(isdefined("StartTime") EQ 1)
eventInfo.StartTime = StartTime;
if(isdefined("Subject") EQ 1)
eventInfo.Subject = Subject;
if(isdefined("UID") EQ 1)
eventInfo.UID = UID;
if(isdefined("Location") EQ 1)
eventInfo.Location = Location;











© 2014 Adobe Systems Incorporated. All rights reserved.

325

Adobe ColdFusion Documentation




Availability.cfm









sleep(15000);

sleep(15000);





The following example shows how you can use the actions getRooms and getRoomList.

© 2014 Adobe Systems Incorporated. All rights reserved.

326

Adobe ColdFusion Documentation







Example 3

Creating and getting an appointment in a secondary calendar using the folderId attribute:



eventStruct = structnew();
eventStruct.AllDayEvent = "yes";
eventStruct.Importance = "low";
eventstruct.RequiredAttendees = "testing@abc.com";
eventstruct.Subject = "Test Message";
eventStruct.StartTime = now();






Created Appointment Successfully in the given calendar




Created Appointment Successfully in the given calendar






© 2014 Adobe Systems Incorporated. All rights reserved.

328

Adobe ColdFusion Documentation

cfexchangeconnection
Description

Opens or closes a persistent connection to a Microsoft Exchange server, or gets information about mailbox
subfolders. You must have a persistent or temporary connection to use the cfexchangecalendar, cfexchangec
ontact, cfexchangemail, and cfexchangetask tags.
History

ColdFusion 10: Added the attribute serverVersion.
ColdFusion 8: Added this tag.
Category

Communications tags
Syntax

© 2014 Adobe Systems Incorporated. All rights reserved.

329

Adobe ColdFusion Documentation

open

server = "Exchange server ID"
username = "Exchange user ID">
optional
ExchangeApplicationName = "Application name"
ExchangeServerLanguage = "Language name"
formBasedAuthentication = "no|yes">
formBasedAuthenticationURL = "URL">
mailboxName = "Exchange mailbox">
password = "user password"
port = "IP port"
protocol = "http|https"
proxyHost = "proxy host URL"
proxyPort = "proxy IP port"
getSubfolders

name = "query name"
optional
folder = "Exchange folder path">
recurse = "no|yes">
OR

optional
ExchangeApplicationName = "Application name"
ExchangeServerLanguage = "Language name"
folder = "Exchange folder path">
formBasedAuthentication = "no|yes">
formBasedAuthenticationURL = "URL">
mailboxName = "Exchange mailbox">
password = "user password"
port = "IP port"
protocol = "http|https"
proxyHost = "proxy host URL"
proxyPort = "proxy IP port"
recurse = "no|yes">
close


© 2014 Adobe Systems Incorporated. All rights reserved.

330

Adobe ColdFusion Documentation

Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfexchangecalendar, cfexchangecontact, cfexchangefilter, cfexchangemail, cfexchangetask; Ma
naging connections to the Exchange server in the Developing ColdFusion Applications
Attributes

Attribute

Action

Req/Opt

action

all

Required

Default

Description
The action to take.
Must be one of the
following values:
open: Open a
new persistent
named connection
close: Close a
named connection
getSubfolders:
Get information
about the
subfolders of a
specific folder.

connection

all

Required for open a
nd close actions

ExchangeApplica
tionName

opengetSubfolde
rs

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

The name of the
connection. You can
specify this ID in any
tag that you use with
the open
connection.
exchange

The name of the
Exchange
application to use in
the URL that
accesses the server.
Specify this attribute
if your IIS server
does not use the
default name for
your Exchange
application.

331

Adobe ColdFusion Documentation

ExchangeServerL
anguage

opengetSubfolde
rs

Optional

english

The language of the
Exchange server. If
you are not sure,
you can specify the
empty string. For all
values except
english, including
the empty string, the
tag tries to get folder
names from the
server in the client's
local language. In
some cases, such
as when there is a
large amount of data
on the server, it
might take
significant time to
get folder names
from Exchange
server in the local
language.

folder

getSubfolders

Optional

The root of the
mailbox

The forward slash
delimited path from
the root of the
mailbox to the folder
for which to get
subfolders. If a
folder name
contains a forward
slash, use the xF8F
F escape sequence
to specify the
character in the
name.

© 2014 Adobe Systems Incorporated. All rights reserved.

332

Adobe ColdFusion Documentation

formBasedAuthen
tication

opengetSubfolde
rs

Optional

formBasedAuthen
ticationURL

opengetSubfolde
rs

Optional

no

A Boolean value
that specifies
whether to display a
login form and use
form based
authentication when
making the
connection. If the
attribute value is no
(the default), and
the Exchange server
returns a 440 error
status when
ColdFusion tries to
connect, ColdFusion
displays the login
form and attempts to
use form based
authentication.
Therefore, you can
safely omit this
attribute if you do
not know if the
server requires form
based
authentication.
The URL to which to
post the user ID and
password when an
Exchange server
uses form-based
authentication. Use
this attribute only if
your Exchange
server does not use
default URL for
form-based
authentication. The
default URL has the
form https://exc
hangeServer/exc
hweb/bin/auth/o
waauth.dll, for
example, {{
https://exchange.my
company.com/exch
web/bin/auth/owaau
th.dll
}}.

© 2014 Adobe Systems Incorporated. All rights reserved.

333

Adobe ColdFusion Documentation

mailboxName

opengetSubfolde
rs

Optional

The ID of the
Exchange mailbox
to use. Specify this
attribute to access a
mailbox whose
owner has
delegated access
rights to the account
specified in the use
rname attribute.

name

getSubfolders

Required

The name of the
ColdFusion query
variable that
contains information
about the
subfolders.

password

opengetSubfolde
rs

Optional

The user's
password for
accessing the
Exchange server.

port

opengetSubfolde
rs

Optional

80

The port the server
listens to, most
commonly port 80.

protocol

opengetSubfolde
rs

Optional

http

The protocol to use
for the connection.
Valid values are ht
tp and https.

proxyHost

opengetSubfolde
rs

Optional

The URL or IP
address of a proxy
host, if necessary
for access to the
network.

proxyPort

opengetSubfolde
rs

Optional

The port on the
proxy server to
connect to, most
commonly port 80.

© 2014 Adobe Systems Incorporated. All rights reserved.

334

Adobe ColdFusion Documentation

recurse

getSubfolders

Optional

false

A Boolean value:
true: get
information on the
immediate
subfolders of the
specified folder
only.
false: get
information on all
levels of
subfolders of the
specified folder.

server

opengetSubfolde
rs

Required

Optional

serverVersion

The IP address or
URL of the server
that is providing
access to
Exchange.
2007

Specifies the
Microsoft Exchange
Server version. The
values are:
2003
2007
2010
If you do not
specify the
details, 2007 is
taken by default.
The value you
specify overrides
the value that you
specify at the
application level.

username

opengetSubfolde
rs

Required

The Exchange user
ID.

Note
If you specify the getSubfolders action, you can specify the attributes that are listed as
working for both the open and getSubfolders actions only if you do not specify a connectio
n attribute.

Usage

The cfexchangeconnection tag can open or close a persistent connection with an Exchange server. If you use
the cfexchangeconnection to open a connection before you use any cfexchangecalendar, cfexchangecon

© 2014 Adobe Systems Incorporated. All rights reserved.

335

Adobe ColdFusion Documentation

tact, cfexchangemail, or cfexchangetask tags, you can use multiple tags to interact with the Exchange
server without incurring the overhead of creating a connection for each tag.
Note
To establish any connection, the Exchange server must grant you Outlook Web Access. For
information on how to enable this access, see Enabling access to the Exchange server in Manag
ing connections to the Exchange server in the Developing ColdFusion Applications. Also, you
cannot establish a connection to an Exchange server if you require a special authentication step,
such as requiring a VPN PIN or performing biometric authentication, on a server that is outside
your firewall, and the authentication server then routes the messages to your Exchange server
inside the firewall.

Use the cfexchangeconnection tag to close a persistent connection when you are finished accessing the
Exchange server. If you do not close the connection, it remains open and does not time out.
The cfexchangecalendar, cfexchangecontact, cfexchangemail, and cfexchangetask tags also let you
specify the open action connection attributes (but not the connection attribute) to create a temporary connection
that lasts for the duration of the single tag's activities, without requiring you to use the cfexchangeconnection ta
g to create the connection. In this case, ColdFusion automatically closes the connection when the tag completes
processing.
The getSubfolders action can get information about the immediate subfolders of a specified folder (or of the top
level of the mailbox), or information about all levels of subfolders. You must have a persistent connection to get the
subfolders.
The query returned by the getSubfolders action has the following columns:
Column

Contents

FOLDERNAME

The name of the subfolder, for example, ColdFusion.

FOLDERPATH

The forward slash
delimited path to the folder from
the mailbox root, including the folder name, for
example, Inbox/Marketing/ColdFusion.

FOLDERSIZE

Size of the folder in bytes.

Note
The ColdFusion exchange tags, including cfexchangeconnection use WebDAV to connect to
the exchange server. HTTP access must be enabled on the exchange server to use the tags.

Example

The following example opens a connection, gets all mail sent from spamsource.com, and deletes the messages
from the Exchange server:

© 2014 Adobe Systems Incorporated. All rights reserved.

336

Adobe ColdFusion Documentation










© 2014 Adobe Systems Incorporated. All rights reserved.

337

Adobe ColdFusion Documentation

cfexchangecontact
Description

Creates, deletes, modifies, and gets Microsoft Exchange contact records, and gets contact record attachments.
History

ColdFusion 10: Added the attribute serverVersion.
ColdFusion 8: Added this tag.
Category

Communications tags
Syntax

© 2014 Adobe Systems Incorporated. All rights reserved.

338

Adobe ColdFusion Documentation

create

delete

deleteAttachments

get

getAttachments

modify




Name





Address









Phone



Email


© 2014 Adobe Systems Incorporated. All rights reserved.

346

Adobe ColdFusion Documentation








sContact.FirstName=Form.firstName;
sContact.Company=Form.company;
sContact.LastName=Form.lastName;
sContact.BusinessAddress.Street=Form.street;
sContact.BusinessAddress.City=Form.city;
sContact.BusinessAddress.State=Form.state;
sContact.BusinessAddress.Country=Form.country;
sContact.BusinessPhoneNumber=Form.businessPhone;
sContact.MobilePhoneNumber=Form.cellPhone;
sContact.BusinessFax=Form.fax;
sContact.Email1=Form.email;





Contact Added. UID is#theUID#

© 2014 Adobe Systems Incorporated. All rights reserved.

347

Adobe ColdFusion Documentation




© 2014 Adobe Systems Incorporated. All rights reserved.

348

Adobe ColdFusion Documentation

cfexchangeconversation
Description

Helps users organize and manage conversations from a Microsoft Exchange account. The following actions are
supported:
Finds the required conversations in folder/subfolders based on filters.
Status of the conversation; if read
Copy, move, or delete conversation
History

ColdFusion 10: Added this tag.
Category

Communications tags
Syntax

© 2014 Adobe Systems Incorporated. All rights reserved.

349

Adobe ColdFusion Documentation

get

setReadState

copy

move

delete




































© 2014 Adobe Systems Incorporated. All rights reserved.

355

Adobe ColdFusion Documentation

cfexchangefilter
Description

Specifies filter parameters that control the actions of cfexchangemail, cfexchangecalendar, cfexchangetas
k, and cfexchangecontact, get operations.
History

ColdFusion 8: Added this tag.
Category

Communications tags
Syntax


OR


Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfexchangecalendar, cfexchangeconnection, cfexchangecontact, cfexchangemail, cfexchangeta
sk, Getting Exchange items and attachments in the Developing ColdFusion Applications
Attributes

Attribute

Req/Opt

name

Required

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description
The type of filter to use.

356

Adobe ColdFusion Documentation

from

Optional

The start date or date/time
combination of the range
to use for filtering. Cannot
be used with the value at
tribute. If you specify a fr
om attribute without a to a
ttribute, the filter selects
for all entries on or after
the specified date or time.
The value can be in any
date/time format
recognized by
ColdFusion, but must
correspond to a value that
is appropriate for the filter
type.

to

Optional

The end date or date/time
combination for the range
used for filtering. Cannot
be used with the value at
tribute. If you specify a to
attribute without a from at
tribute, the filter selects for
all entries on or before the
specified date or time.
The value can be in any
date/time format
recognized by
ColdFusion, but must
correspond to a value that
is appropriate for the filter
type.

© 2014 Adobe Systems Incorporated. All rights reserved.

357

Adobe ColdFusion Documentation

value

Optional

The filter value for all
filters that do not take a
date or time range.
Cannot be used with the f
rom and to attributes.Col
dFusion generates an
error if you specify this
attribute with an empty
contents. Therefore, you
cannot use the empty
string to search for empty
values.
If you set this attribute to
the empty string (""),
ColdFusion searches for
entries where the
specified field is empty.
6.07

The cfexchangeCalendar tag filters can have the following name attributes and associated value, or to and fr
om attributes that you use to specify the filter parameters for the specified action:
name attribute

Specification attributes

Valid specification attribute
values

maxRows

value

A positive integer specifying the
maximum number of matching rows
to return. By default, the maximum
number of rows is 100. You can
also specify -1; to return all
matching rows.

allDayEvent

value

A Boolean value.

duration

value

An integer number of minutes.

endTime

from to

A string that ColdFusion can
interpret as a date-time value.

fromID

value

An Exchange user ID.

hasAttachment

value

A Boolean value.

importance

value

One of the following values:
high
normal
low

isRecurring

value

© 2014 Adobe Systems Incorporated. All rights reserved.

A Boolean value.

358

Adobe ColdFusion Documentation

location

value

A string.

message

value

A string.

optionalAttendees

value

A comma-delimited list of Exchange
user IDs.

organizer

value

A string that identifies the organizer.
This value does not need to be an
Exchange ID or e-mail address.

requiredAttendees

value

A comma-delimited list of Exchange
user IDs.

sensitivity

value

One of the following values:
normal
personal
private
confidential

startTime

from to

A string that ColdFusion can
interpret as a date-time value.

subject

value

A string.

UID

value

A case-sensitive Exchange
message UID that uniquely
identifies one calendar entry.

The cfexchangecontact tag filters can have the following name attributes and associated value attributes.
Unlike other tags, you do not use from or to attributes.
name attribute

value attribute

maxRows

A positive integer that specifies the maximum number
of matching rows to return. By default, the maximum
number of rows is 100. You can also specify -1; to
return all matching rows.

assistant

A string.

businessAddress

A structure with the following fields: Street, City, State,
Zip, Country.

businessFax

A string.

businessPhoneNumber

A string.

© 2014 Adobe Systems Incorporated. All rights reserved.

359

Adobe ColdFusion Documentation

categories

A comma-delimited list of categories. The filter
searches for contacts that match all the categories in
the list.

company

A string.

description

A string.

displayAs

A string.

email1

A string.

email2

A string.

email3

A string.

firstName

A string.

hasAttachment

A Boolean value.

homeAddress

A structure with the following fields: Street, City, State,
Zip, Country.

homePhoneNumber

A string.

jobTitle

A string.

lastName

A string.

mailingAddressType

One of the following values: Home, Business, Other.

manager

A string.

middleName

A string.

mobilePhoneNumber

A string.

nickName

A string.

office

A string.

otherAddress

A structure with the following fields: Street, City, State,
Zip, Country.

otherPhoneNumber

A string.

pager

A string.

© 2014 Adobe Systems Incorporated. All rights reserved.

360

Adobe ColdFusion Documentation

profession

A string.

spouseName

A string.

webPage

A string.

The cfexchangemail tag filters can have the following name attributes and associated value, or to and from at
tributes that you use to specify the filter parameters for the specified action:
name attribute

Specification attributes

Specification attribute values

maxRows

value

A positive integer that specifies the
maximum number of matching rows
to return. By default, the maximum
number of rows is 100.
You can also specify -1; to return all
matching rows.

bcc

value

A comma-delimited list of Exchange
or web e-mail addresses.

cc

value

A comma-delimited list of Exchange
or web e-mail addresses.

folder

value

The forward slash delimited path
from the root of the Exchange
mailbox to the folder to search. By
default, the filter searches the top
level of the Inbox. The cfexchang
email tag searches only the
specified folder, and does not
search any subfolders. If a folder
name contains a forward slash, use
the xF8FF escape sequence to
specify the character in the name.
For the get and move actions, you
can use the cfexchangemail tag
folder attribute instead of this
field; however, this field takes
precedence over the value specified
in the folder attribute.

fromID

value

An Exchange or web e-mail
address.

hasAttachment

value

A Boolean value

© 2014 Adobe Systems Incorporated. All rights reserved.

361

Adobe ColdFusion Documentation

importance

value

One of the following values:
high
normal
low

isRead

value

A Boolean value.

message

value

A string.

MessageType

value

One of the following values: Mail,
Meeting, Meeting_Cancel, Mee
ting_Request, Meeting_Respo
nse, or All. If you omit this
attribute, the filter gets messages of
all types. The Meeting attribute
gets messages with Meeting_Can
cel, Meeting_Request, and Mee
ting_Response types.

MeetingUID

value

A case-sensitive Exchange
calendar event UID. Meeting UIDs
are used in Meeting_request or
Meeting_response message
types only. Do not specify this field
if you specify a MessageType field
value of Mail.

sensitivity

value

One of the following values:
normal
personal
private
confidential

subject

value

A string.

timeReceived

from to

A string that ColdFusion can
interpret as a date-time value.

timeSent

from to

A string that ColdFusion can
interpret as a date-time value.

toID

value

A comma-delimited list of Exchange
or web e-mail addresses.

uid

value

A case-sensitive Exchange
message UID.

The cfexchangetask tag filters can have the following name attributes and associated value, or to and from at

© 2014 Adobe Systems Incorporated. All rights reserved.

362

Adobe ColdFusion Documentation

tributes that you use to specify the filter parameters for the specified action:
name attribute

Specification attributes

Specification attribute values

maxRows

value

A positive integer specifying the
maximum number of matching rows
to return. By default, the maximum
number of rows is 100.
You can also specify -1; to return all
matching rows.

actualWork

value

A number representing the number
of hours. Use decimal numbers to
specify minutes.

billingInfo

value

A string.

companies

value

A string.

dateCompleted

value

A string that ColdFusion can
interpret as a date-time value.

dueDate

from to

A string that ColdFusion can
interpret as a date-time value.

mail_ID

value

A comma-delimited list of Exchange
mail IDs. This filter value is useful if
the connection user has delegate
rights for multiple users and you
want to select the tasks of a limited
number of those users.

message

value

A string.

mileage

value

A string.

percentCompleted

value

A number between 0 and 100.

priority

value

One of the following values:
high
normal
low

reminderDate

value

A string that ColdFusion can
interpret as a date-time value.

startDate

from to

A string that ColdFusion can
interpret as a date-time value.

© 2014 Adobe Systems Incorporated. All rights reserved.

363

Adobe ColdFusion Documentation

status

value

Must be one of the following values:
NOT_STARTED
IN_PROGRESS
COMPLETED
WAITING
DEFERRED

subject

value

A string.

totalWork

value

A number that represents the
number of hours. Use decimal
numbers to specify minutes.

UID

value

A case-sensitive Exchange UID.

Usage

The cfexchangefilter tag specifies the conditions to match when ColdFusion gets mail messages, calendar
entries, tasks, or contacts. Only those entries that match the specified filter conditions are returned in the structure
specified by the parent tag's name attribute. If the filter specifies a field that takes a text string, such as Message and
or Subject, ColdFusion returns items that contain the exact phrase that you specify in the value attribute.
The cfexchangefilter tag must be a child tag of a cfexchangecalendar, cfexchangecontact, cfexchan
gemail, or cfexchangetask tag with an action attribute value of get. If you specify multiple cfexchangefilt
er tags in the body of a ColdFusion exchange tag, such as cfexchangemail, the specified filters are cumulative,
and the selected records match the conditions specified in all the cfexchangefilter tags. If you specify multiple
cfexchangefilter tags with the same name attribute value, the last tag with that attribute specifies the filter
conditions.
Example

The following example gets the mail messages that were sent to a user during the last week from any e-mail
address that includes adobe.com. To focus on getting messages, rather than on displaying data, the example uses
the cfdump tag to show the results.









© 2014 Adobe Systems Incorporated. All rights reserved.

364

Adobe ColdFusion Documentation

cfexchangefolder
Description

Lets you perform various actions on the mail folder, such as get folder information, find folders, or create, copy,
modify, move, delete, and empty the contents of a folder.
History

ColdFusion 10: Added this tag.
Category

Communications tags
Syntax

getExtendedInfo

OR
getExtendedInfo

getlnfo

OR
getlnfo

findSubFolders

create

copy

connection = "connection_ID"
result = "variable for contact UID"/>
delete

connection = "connection_ID"/>
move

connection = "connection_ID"
result = "variable for contact UID"/>
modify

empty


© 2014 Adobe Systems Incorporated. All rights reserved.

366

Adobe ColdFusion Documentation

deleteSubFolder = "true|false"
connection = "connection_ID"/>

See also

cfexchangecalendar, cfexchangeconnection, cfexchangefilter, cfexchangemail, cfexchangetask
, Interacting with Microsoft Exchange Servers in the Developing ColdFusion Applications
Attributes

Attribute

Action

Req/Opt

action

N/A

Required

Default

Description
The action to take.
Must be one of the
following values:
getInfo
getExtendedIn
fo
findSubFolder
s
create
copy
delete
move
modify
empty

uid

getExtendedInfo
/ getInfo

Not required for get
ExtendedInfo and
getInfo, if folder
path is specified.

UID that is used to
identify the folder in
which the actions
are performed.

name

getExtendedInfo
/ getInfo / fin
dSubFolders

Required

The name of the
ColdFusion query
variable that
contains the
returned information
about the folder.

folderID

getExtendedInfo
/ getInfo / fin
dSubFolders / d
elete / modify
/ empty

Not required for get
ExtendedInfo an
d getInfo, if folder
path is specified.

UID that is used to
identify the folder in
which the actions
are performed.

© 2014 Adobe Systems Incorporated. All rights reserved.

367

Adobe ColdFusion Documentation

folderPath

getExtendedInfo
/ getInfo

Not required if fold
erID is specified.

pathDelimiter

getExtendedInfo
/ getInfo

Optional

parentFolderId

create

Required

UID that is used to
identify the folder in
which you create
subfolders.

connection

All actions

Required

The name of the
connection to the
Exchange server, as
specified in the cfe
xchangeconnecti
on tag. If you omit
this attribute, create
a temporary
connection by
specifying cfexcha
ngeconnection ta
g connection opena
ction attributes in
the cfexchangeco
ntact tag.

result

create / copy /
move

Required

A query variable that
contains the result
returned from the
exchange server
when one of the
action is performed.

destinationFold
erID

copy / move

Required

A case-sensitive
Exchange UID value
that uniquely
identifies the
destination folder.

© 2014 Adobe Systems Incorporated. All rights reserved.

Full path to the
folder where the
action has to be
performed.
If you do not specify
the path delimiter, /
is taken by default.
/

Lets you specify the
delimiter that is used
to separate the
folders.

368

Adobe ColdFusion Documentation

sourceFolderID

copy / move

Required

The UID that is used
to identify the folder
from which you copy
or move folders to
the destination
folder.

deleteType

delete / move

Optional

moveToDeletedIt
ems

deleteSubFolder
s

empty

Optional

False

folder

create / modify

Required

hardDelete:
Removes a folder
permanently from
the Exchange
server.
softDelete:
Moves a folder to
the dumpster in
Exchange server,
if dumpster is
enabled.
moveToDeleted
Items: Moves a
folder to the
deleted items
folder.
If true, deletes the
subfolder.
A struct that
contains the
required information
of the folder that has
to be created or
modified, such as
display name and
folder class.

Result struct values for cfexchangefolder action = "getExtendedInfo"

For the action getExtendedInfo, the result is a struct that contains the following fields:
Field

Description

ChildFolderCount

The number of child folders that the parent folder has.

displayName

The display name of the folder.

folderClass

The folder class.

FolderPath

Path to the exchange server folder.

© 2014 Adobe Systems Incorporated. All rights reserved.

369

Adobe ColdFusion Documentation

ManagedFolder

Struct that contains the following properties:
canDelete: Boolean value that indicates if the user
can delete objects in the folder.
canRenameOrMove: Boolean value that indicates if
the user can rename or move objects in the folder.
mustDisplayComment: Boolean value that
indicates if the client application must display the
comment property to the user.
HasQouta: Boolean value that indicates if the folder
has a quota.
IsManagedFoldersRoot: Boolean value that
indicates if the folder is the root of the managed
folder hierarchy.
ManagedFolderId: The ID of the managed folder.
comment: The comment that is associated with the
folder.
StorageQuota: The storage quota of the folder.
FolderSize: The size of the folder.
HomePage: The home page associated with the
folder.

mustDisplayComment

Boolean value that indicates if the client application
must display the comment property to the user.

ParentFolderId

The ID of the folder's parent folder.

Permission

List of permissions for the folder. This is an array of
permission structs with the following values:

© 2014 Adobe Systems Incorporated. All rights reserved.

370

Adobe ColdFusion Documentation

canCreateItems: Boolean value that indicates if
the user can create new items.
canCreateSubFolders: Boolean value that
indicates if the user can create sub-folders.
deleteItems: Indicates if/how the user can delete
existing items. The values are None (the user does
not have the associated permission), Owned (the
user has the associated permission on items that it
owns), and All (the user has the associated
permission on all items).
displayPermissionLevel: The permission level
that Outlook displays for this folder permission. It can
have the following values: None, Owner, Publishi
ngEditor, Editor, PublishingAuthor, Free
busytimeandsubjectandlocation, Freebusy
timeOnly, Author, NonEditingAuthor, Revei
wer, Contributor, and Custom.
EditItems: Indicates the items in a folder that the
user has permission to edit. Values are none, owned
, or all.
isFolderContact: Boolean value that indicates if
the user is a contact for the folder.
isFolderOwner: Boolean value that indicates if the
user owns the folder.
isFolderVisible: Boolean value that indicates if
the folder is visible to the user.
PermissionLevel: Represents the combination of
permissions that a user has on a folder. The values
are same as that of displayPermissionLevel ex
cept Freebusytimeandsubjectandlocation an
d FreebusytimeOnly.
readItems: The read item access permission. The
values are as follows: None (user has no read
access on the items in the folder), TimeOnly (user
can read the start and end date and time of
appointments; applies only to Calendar folders, Time
AndSubjectAndLocation (user can read the start
and end date and time, subject, and location of
appointments; applies only to calendar folders, and F
ullDetails (user has access to full details of
items).
UserIDDisplayName: Display name of the user.
UserIDprimarySMTPAddress: The primary SMTP
address of the user.
userIDSID: SID of the user.
UserIdstandardUser: Indicates the standard
user, if default (the default delegate user, used to
define default delegate permissions and Anonymous
(the anonymous delegate user, used to define
delegate permissions for unauthenticated users).

© 2014 Adobe Systems Incorporated. All rights reserved.

371

Adobe ColdFusion Documentation

TotalCount

Total number of items contained in the folder.

UnreadCount

Number of unread items in the folder.

Result struct values for cfexchangefolder action = "getInfo"

For the action getInfo, the result is a struct that contains the following fields:
Field

Description

ChildFolderCount

The number of child folders this folder has

displayName

The display name of the folder

folderClass

Folder class

folderPath

Path to the exchange server folder.

UID

ID of the folder

ParentFolderId

The Id of the current folder's parent folder

TotalCount

Total number of items contained in the folder

UnreadCount

The number of unread items in the folder

Filter parameters for cfexchangefolder action = "findSubFolders"

For the action findSubFolders, the result is a query that contains details of the subfolders. The values are same
as that of cfexchangefolder action = "getInfo".
Example

The following code shows how you can perform the actions getExtendedInfo, findSubFolders, getInfo, co
py, delete, modify, move, and create.










© 2014 Adobe Systems Incorporated. All rights reserved.

372

Adobe ColdFusion Documentation






sleep(1000);




sleep(1000);




































© 2014 Adobe Systems Incorporated. All rights reserved.

373

Adobe ColdFusion Documentation






© 2014 Adobe Systems Incorporated. All rights reserved.

374

Adobe ColdFusion Documentation



© 2014 Adobe Systems Incorporated. All rights reserved.

375

Adobe ColdFusion Documentation

cfexchangemail
Description

Gets mail messages and attachments, deletes messages, and sets properties for messages on a Microsoft
Exchange server.
History

ColdFusion 10: Added the attribute serverVersion and folderID.
ColdFusion 8: Added this tag.
Category

Communications tags
Syntax

delete

deleteAttachments

folder = "Exchange folder path">
get

folderID = "Exchange folder UID"


...

getAttachments

getMeetingInfo

move

folderID = "Exchange folder UID"


...

set

uid = "message UID">
optional
connection = "connection ID"

© 2014 Adobe Systems Incorporated. All rights reserved.

377

Adobe ColdFusion Documentation

folder = "Exchange folder path">
folderID = "Exchange folder UID"

Note
If you omit the connection attribute, create a temporary connection by specifying cfexchange
connection tag attributes in the cfexchangemail tag. In this case, ColdFusion closes the
connection when the tag completes. For details, see the cfexchangeconnection tag open ac
tion.
Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfexchangecalendar, cfexchangeconnection, cfexchangecontact, cfexchangefilter, cfexchange
task, Interacting with Microsoft Exchange Servers in the Developing ColdFusion Applications
Attributes

Note
If an attribute, such as folder or destinationFolder takes a folder path, and the folder
name contains forward slashes , specify the folder name by using the xF8FF escape character
to prevent exchange from interpreting the character as a path delimiter.

Attribute

Action

Req/Opt

action

all

Required

Default

Description
The action to take.
Must be one of the
following values:
delete
deleteAttachm
ents
get
getAttachment
s
getMeetingInf
o
move
set

© 2014 Adobe Systems Incorporated. All rights reserved.

378

Adobe ColdFusion Documentation

attachmentPath

getAttachments

Optional

The filepath of the
directory in which to
put the attachments.
If the directory does
not exist,
ColdFusion creates
it.
Note: If you omit
this attribute,
ColdFusion does not
save any
attachments. If you
specify a relative
path, the path root is
the ColdFusion
temporary directory,
which is returned by
the GetTempDirec
tory function.

connection

all

Optional

The name of the
connection to the
Exchange server, as
specified in the cfe
xchangeconnecti
on tag. If you omit
this attribute, create
a temporary
connection by
specifying cfexcha
ngeconnection ta
g open action
attributes in the cfe
xchangecalendar
tag.

destinationFold
er

move

Required

The forward slash
delimited path,
relative to the root of
the mailbox, of the
folder to which to
move the message
or messages.

© 2014 Adobe Systems Incorporated. All rights reserved.

379

Adobe ColdFusion Documentation

folder

all except getMeet
ingInfo

Optional

The forward slash
delimited path,
relative to the root of
the mailbox, of the
folder that contains
the message or
messages. The cfe
xchangemail tag
looks in the
specified folder only,
and does not search
subfolders.
For the get and mo
ve actions
specifying a cffexc
hangefilter child
tag with a name="f
older" attribute is
equivalent to setting
this attribute, and
takes precedence
over this attribute's
value.
If you omit this
attribute, or for get
and move actions, if
you do not use the
corresponding cfex
changefilter sett
ing, Exchange looks
in the top level of
the Inbox.

folderID

__ get, move,
set

Optional

A case-sensitive
Exchange UID value
that uniquely
identifies the folder.
If not specified,
folder is used. If
either folder or fo
lderID are not
specified, the inbox
is used as the
default folder to
perform the
operation.

© 2014 Adobe Systems Incorporated. All rights reserved.

380

Adobe ColdFusion Documentation

generateUniqueF
ilenames

getAttachments

Optional

mailUID

getMeetingInfo

Optional

The case-sensitive
UID of the mail
message that
contains the
meeting request,
response, or
cancellation
notification. Use this
attribute if there are
multiple messages
about a single
meeting.

meetingUID

getMeetingInfo

Required

The case-sensitive
UID of the meeting
for which you
received the
notification.

© 2014 Adobe Systems Incorporated. All rights reserved.

no

A Boolean value
that specifies
whether to generate
unique filenames if
multiple attachments
have the same
filenames. If two or
more attachments
have the same
filename and this
option is yes, Cold
Fusion appends a
number to the
filename body
(before the
extension) of any
conflicting
filenames. Thus, if
three attachments
have the name
myfile.txt,
ColdFusion saves
the attachments as
myfile.txt,
myfile1.txt, and
myfile2.txt.

381

Adobe ColdFusion Documentation

message

set

Required

A reference to a
structure that
contains the
properties to be set
and their values.
Specify this attribute
in number signs (#).
For more
information on the
message structure,
see Usage.

name

getgetAttachmen
tsgetMeetingInf
o

Required

The name of the
ColdFusion query
variable that
contains the
returned mail
messages or the
retrieved information
about the
attachments or
meeting. For more
information on the
returned data, see
Usage.

serverVersion

Optional

2007

Specifies the
Microsoft Exchange
Server version. The
values are:
2003
2007
2010
If you do not
specify the
details, 2007 is
taken by default.
The value you
specify overrides
the value that you
specify at the
application level.

© 2014 Adobe Systems Incorporated. All rights reserved.

382

Adobe ColdFusion Documentation

uid

deletegetAttach
mentsset

Required

The case-sensitive
UIDs of the
messages on which
to perform the
action. For the dele
te action, this
attribute can be a
comma-delimited list
of UID values. The d
eleteAttachment
s,
getAttachments,
and set actions
allow only a single
UID value.

Usage

The cfexchangemail tag performs mail actions on an Exchange server that you cannot do by using the cfmail t
ag. (You must use the cfmail tag to send, forward, and reply to mail messages.) Use the cfexchangemail tag to
perform the following actions:
Permanently delete one or more mail messages from the server.
Get the attachments for a specific message.
Get one or more messages that conform to an optional set of filter specifications, such as the subject, sender
or recipient ID, time received, and so on.
Get the attachments for a specific message.
Get detailed information about a meeting for which you have a notification, such as a meeting request or
cancellation notice.
Move one or more messages from one folder to another, including to the Deleted Items folder.
Set the properties of a specific mail message.
To use this tag, you must have a connection to an Exchange server. If you are using multiple tags that
interact with the exchange server, such as if you are creating several contact records, use the cfexchangec
onnection tag to create a persistent connection. You then specify the connection identifier in each cfexch
angemail tag, or any other ColdFusion Exchange tag, if you are also accessing tasks, contacts, or
connections. Doing this saves the overhead of creating and closing the connection for each tag. Alternatively,
you can create a temporary connection that lasts only for the time that ColdFusion processes the single cfex
changemail tag. To do this, you specify the connection attributes directly in the cfexchangemail tag. For
details on the connection attributes, see the cfexchangeconnection tag.
The delete action

The delete action permanently deletes a message from the server, and is equivalent to the Outlook Shift-Delete
keystroke action. Use the move action to move a message to the Deleted Items folder, which is equivalent to the
Outlook Delete keystroke action. When you specify the delete action you must specify a uid attribute with a
comma-delimited list of one or more Exchange UIDs that identify the tasks that you want to delete. You can use the
get action, with an appropriate filter expression, to determine the UID values to specify.
If all UIDs that you specify are invalid, the cfexchangemail tag generates an error. If at least one UID is valid, the
tag ignores any invalid UIDs and deletes the items specified by the valid UID.
The get action

© 2014 Adobe Systems Incorporated. All rights reserved.

383

Adobe ColdFusion Documentation

When you specify the get action, you use child cfexchangefilter tags to specify the messages to get. For
detailed information, see cfexchangefilter. When the tag completes processing, the query object specified by
the name attribute contains one record for each matching message that was found. Each record has the following
columns:
Column

Description

BCC

A comma-delimited list of Exchange user IDs or web
e-mail.

CC

A comma-delimited list of Exchange user IDs or web
e-mail addresses.

Folder

The forward slash delimited path from the root of the
Exchange mailbox to the mail folder containing the
message.

FromID

An Exchange user IDs or web e-mail addresses.

HasAttachment

A Boolean value that indicates whether the message
has at least one attachment.

HTMLMessage

A string containing a HTML-formatted version of the
message.

IsRead

A Boolean value.

Message

A string with a plain-text version of the message
contents.

MessageType

One of the following strings:
Mail
Meeting_Cancel
Meeting_Request
Meeting_Response

MeetingResponse

If the message type is Meeting_response, this
column contains the response code as one of the
following strings: Accept, Decline, or Tentative.
This field is not used for other message types.

MeetingUID

If the message type is Meeting_Cancel, Meeting_r
equest, or Meeting_response this column contains
the UID of the calendar event for which this message
was sent. Use this value in the cfexchangecalendar
tag to respond to a request. This field is not used for
the Mail message type.

© 2014 Adobe Systems Incorporated. All rights reserved.

384

Adobe ColdFusion Documentation

Sensitivity

One of the following strings:
public
private
normal
company-confidential

Subject

A string.

TimeReceived

A ColdFusion date-time object.

TimeSent

A Coldfusion date-time object.

ToId

A comma-delimited list of Exchange user IDs or web
mail IDs.

UID

The Exchange UID of the message.

Note
An invitation sender can get a meeting request message only if the sender is on the attendee list.

The getAttachments action

When you use the getAttachments action, specify a single UID and a name attribute. The cfexchangecontact
tag populates a query object specified by the name attribute with one record for each attachment. Each record has
the following information about the mail attachment specified by the UID:
Column name

Description

attachmentFileName

The filename of the attachment.

attachmentFilePath

The absolute path of the attachment file on the server.
If you omit the attachmentPath attribute, this column
contains the empty string.

CID

The content-ID of the attachment. Used in HTML img
tags to embed images in a message.

mimeType

The MIME type of the attachment, such as text/html.

isMessage

A Boolean value that specifies whether the attachment
is a message.

size

The attachment size in bytes.

The tag places the attachments in the directory specified by the attachmentPath attribute. If you omit the attach
mentPath attribute, ColdFusion does not get any attachments; it gets the information about the attachments. This
lets you determine the attachments without incurring the overhead of getting the attachment files.

© 2014 Adobe Systems Incorporated. All rights reserved.

385

Adobe ColdFusion Documentation

If a message has multiple attachments with the same name, the attachment information structure always lists the
attachments with their original, duplicate, names, even if you specify generateUniqueFilenames="yes". The g
enerateUniqueFilenames attribute only affects the names of the files on disk.Use the following syntax to specify
an in-memory attachmentPath directory. In-memory files are not written to disk and speed processing of transient
data.

attachmentpath = "ram:///path"

The path can include multiple directories, for example ram:///petStore/orders/messageAttachments.
Create all directories in the path before you specify the file. For more information on using in-memory files, see
Working with in-memory files in Optimizing ColdFusion applications in the Developing ColdFusion Applications.
The getAttachments action works only if authentication for EWS (Exchange Web Services) is set to basic in the
server setup of Exchange. IWA (Integrated Windows Authentication) is not supported.
The getMeetingInfo action

You use the getMeetingInfo action to get meeting-specific information, such as the meeting start and end times,
location, and so on, about a meeting for which you have received a notification message, such as an invitation
request or cancellation notice. This information is not available directly in the notification message query object that
is returned by the get action.
Note
At the time of publication, the following information does not completely reflect the behavior of
the getMeetingInfo action. For updated information, see cfexchangemail in the
ColdFusion documentation available online in HTML on the Adobe website.

When you specify the getMeetingInfo action, you specify a meetingUID attribute with the UID of the meeting.
You get this UID value from the query record that is returned by the get action. You can optionally specify a messa
geUID attribute with the UID of the specific message that contains the notification; if you receive multiple messages
about a single meeting, you can use this attribute to select a single notification message. When the tag completes
processing, the query object specified by the name attribute contains one record for each matching message that
was found. Each record has the following columns:
Field

Description

AllDayEvent

A Boolean value that indicates whether this is an all
day event.

Duration

The duration of the event in minutes.

EndTime

The end time of the event, in ColdFusion ODBC
date-time format.

From

The mail ID of the person who sent the meeting
notification.

© 2014 Adobe Systems Incorporated. All rights reserved.

386

Adobe ColdFusion Documentation

HasAttachment

A Boolean value that indicates whether this event has
attachments.

Importance

One of the following values:
high
normal
low

IsRecurring

A Boolean value that indicates whether this event
repeats.

Location

A string that specifies the location of the event.

MeetingUID

The UID of the event in the calendar.

Message

A string that contains a message about the event.

OptionalAttendees

A comma-delimited list of mail IDs.

Organizer

A string. This value is not necessarily an Exchange ID
or e-mail address.

Reminder

The time, in minutes before the event, at which to
display a reminder message.

RequiredAttendees

A comma-delimited list of mail IDs.

Resources

A comma-delimited list of mail IDs for Exchange
scheduling resources, such as conference rooms and
display equipment.

Sensitivity

One of the following values:
normal
company-confidential
personal
private

StartTime

The start time of the event, in ODBC date-time format.

Subject

A string describing the event subject.

TimeReceived

The time the message was received, in ODBC
date-time format.

UID

The UID of the message that contains the event
notification.

The move action

© 2014 Adobe Systems Incorporated. All rights reserved.

387

Adobe ColdFusion Documentation

Use the move action to move one or more messages from one folder to another folder. You can use this action to
move messages to the Deleted Items folder, which is equivalent to the Outlook Delete keystroke action. When you
specify the move action you specify the destination folder, and optionally the folder containing the messages to
move. (The default source folder is the Inbox). You use child cfexchangefilter tags to specify the messages to
get. For detailed information, see cfexchangefilter.
The set action

When you specify the set action, the structure specified by the message attribute contains key-value pairs that
specify the message properties to set. The following table lists the key names and their valid values:
Key name

Valid values

IsRead

yes, no

Importance

high, normal, low

Sensitivity

normal, company-confidential, personal, priv
ate

Example

The following example gets the attachments to all mail messages in the Inbox from docuser2 in the last week. It puts
each message's attachments in a directory with a unique name. It cannot use the UID as a filename because, for
each message with attachments, the UID can contain the application reports of the UID, directory path, subject,
date, and sender of the message, followed by a table that lists the message's attachments. The table includes the
attachment name, size, and MIME type.

© 2014 Adobe Systems Incorporated. All rights reserved.

388

Adobe ColdFusion Documentation


date range --->
= Now()>
= DateAdd("d","-7", rightNow)>










Message ID #weeksmail.uid# attachments are in the directory
C:\temp\cf_files\attachments\Msg_#i#



Message information:

Subject: #weeksmail.Subject#

Sent: #dateFormat(weeksmail.TimeSent)#

From: #weeksmail.FromID#



Attachments












© 2014 Adobe Systems Incorporated. All rights reserved.

389

Adobe ColdFusion Documentation

cfexchangetask
Description

Creates, deletes, modifies, and gets Microsoft Exchange tasks, and gets task attachments.
Note
For all actions, see cfexchangeconnection for additional attributes that you use if you do not
specify the connection attribute.

History

ColdFusion 10: Added the attribute serverVersion.ColdFusion 8: Added this tag.
Category

Communications tags
Syntax

© 2014 Adobe Systems Incorporated. All rights reserved.

390

Adobe ColdFusion Documentation

create

delete

deleteAttachments

get

getAttachments

modify

optional
connection = "connection ID">

© 2014 Adobe Systems Incorporated. All rights reserved.

391

Adobe ColdFusion Documentation

Note
If you omit the connection attribute, create a temporary connection by specifying cfexchange
connection tag attributes in the cfexchangetask tag. In this case, ColdFusion closes the
connection when the tag completes. For details, see the cfexchangeconnection tag open ac
tion.
Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfexchangecalendar, cfexchangeconnection, cfexchangecontact, cfexchangefilter, cfexchange
mail, Interacting with Microsoft Exchange Servers in the Developing ColdFusion Applications.
Attributes

The following table provides detailed information about each attribute. It lists the attribute name, the actions (actio
n attribute values) to which it apples, whether it is required or optional for those actions, and its default value, if any,
and provides a detailed description of the attribute and its valid values.
Attribute

Action

Req/Opt

action

all

Required

Default

Description
The action to take.
Must be one of the
following values:
create
delete
deleteAttachm
ents
get
getAttachment
s
modify

© 2014 Adobe Systems Incorporated. All rights reserved.

392

Adobe ColdFusion Documentation

attachmentPath

getAttachments

Optional

The filepath of the
directory in which to
put the attachments.
If the directory does
not exist,
ColdFusion creates
it.
Note: If you omit
this attribute,
ColdFusion does not
save any
attachments. If you
specify a relative
path, the path root is
the ColdFusion
temporary directory,
which is returned by
the GetTempDirec
tory function.

connection

all

Optional

The name of the
connection to the
Exchange server, as
specified in the cfe
xchangeconnecti
on tag. If you omit
this attribute, create
a temporary
connection by
specifying cfexcha
ngeconnection ta
g connection
attributes in the cfe
xchangetask tag.

© 2014 Adobe Systems Incorporated. All rights reserved.

393

Adobe ColdFusion Documentation

generateUniqueF
ilenames

getAttachments

Optional

name

getgetAttachmen
ts

Required

The name of the
ColdFusion query
variable that
contains the
returned task
records or
information about
the attachments that
were retrieved. For
more information on
the returned data,
see Usage.

result

create

Optional

The name of a
variable that
contains the UID of
the task that is
created. You use
this value in the uid
attribute of other
actions to identify
the task to be acted
on.

© 2014 Adobe Systems Incorporated. All rights reserved.

no

A Boolean value
that specifies
whether to generate
unique filenames if
multiple attachments
have the same
filenames. If two or
more attachments
have the same
filename and this
option is yes, Cold
Fusion appends a
number to the
filename body
(before the
extension) of any
conflicting
filenames. Thus, if
three attachments
have the name
myfile.txt,
ColdFusion saves
the attachments as
myfile.txt,
myfile1.txt, and
myfile2.txt.

394

Adobe ColdFusion Documentation

Optional

serverVersion

2007

Specifies the
Microsoft Exchange
Server version. The
values are:
2003
2007
2010
If you do not
specify the
details, 2007 is
taken by default.
The value you
specify overrides
the value that you
specify at the
application level.

task

createmodify

Required

A reference to the
structure that
contains the task
properties to be set
or changed and their
values. Specify this
attribute in number
signs (#).
For more
information on the
event structure, see
Usage.

uid

deletegetAttach
mentsmodify

Required

A case-sensitive
Exchange UID value
that uniquely
identifies the tasks
on which to perform
the action. For the d
elete action, this
attribute can be a
comma-delimited list
of UID values. The d
eleteAttachment
s,
getAttachments,
and modify actions
allow only a single
UID value.

When you specify the create or modify action, the task attribute must specify a structure that contains
information that defines the events. The structure can have the following fields. Include only the fields that you are
setting or changing.

© 2014 Adobe Systems Incorporated. All rights reserved.

395

Adobe ColdFusion Documentation

Column

Description

ActualWork

A number in minutes. Cannot be less than zero.

Attachments

The pathnames of any attachments to include in the
task. To specify multiple files, separate filepaths with
semicolons (;) for Windows, and colons (:) for UNIX
and Linux. Use absolute paths.
If you specify one or more attachments for a modify a
ction, these are added to any existing attachments; the
pre-existing attachments are not deleted.

Categories

A comma-delimited list of categories. The filter
searches for tasks that match all the categories in the
list.

BillingInfo

A string.

Companies

A string.

DateCompleted

A string in a date format that is valid in ColdFusion. If
you omit this field and set the Status field to complet
ed, or set the PercentCompleted field to 100, this
value is set to the current date. If you set this date, the
Status value is set to Completed and the PercentC
ompleted field is set to 100.

DueDate

A string in a date format that is valid in ColdFusion.

Message

A string containing the task description.

Mileage

A string.

PercentCompleted

A number in the range 0-100. If you set this field to 100,
The following values are set:
The Status value is set to Completed.
If the DateCompleted value is or was not set, it is
set to the current date.
If you set this value to a number with a value less
than 100, the following values are set:
If Status field is or was set to Completed, the Sta
tus is set to In_Progress.
The DateCompleted value is cleared.

Priority

One of the following values:
low
normal
high

© 2014 Adobe Systems Incorporated. All rights reserved.

396

Adobe ColdFusion Documentation

ReminderDate

A string in a date format that is valid in ColdFusion.

StartDate

A string in a date format that is valid in ColdFusion.
When you create a task, the default value defaults is
the current date.

Status

The following values are valid: Not_Started, In_Pro
gress, Completed, Waiting, or Deferred. If you
omit this field and the PercentCompleted value is
less than 100, the Status value it is set to In_Progr
ess.
If you set this field to Completed, the following values
are also set:
The PercentCompleted value is set to 100.
If the DateCompleted value is not set, it is set to
the current date.
If you set this field to a value other than Completed,
the following values are also set:
If the PercentCompleted field is or was 100, the P
ercentCompleted value is reset to 0.
The DateCompleted value is set to 0.

Subject

A String.

TotalWork

A number in minutes. Cannot be less than zero.

Usage

The cfexchangetask tag manages task records on the Exchange server. Use the cfexchangetask tag to
perform the following actions:
Create a task.
Delete one or more tasks.
Get one or more task records that conform to an optional set of filter specifications, such as the last name, job
title, or home phone number, and so on.
Get the attachments for a specific task record.
Modify an existing task
To use this tag, you must have a connection to an Exchange server. If you are using multiple tags that
interact with the exchange server, such as if you are creating several task records, use the cfexchangecon
nection tag to create a persistent connection. You then specify the connection identifier in each cfexchan
getask, or any other ColdFusion Exchange tag, if you are also accessing calendar entries, contacts, or mail.
Doing this saves the overhead of creating and closing the connection for each tag.Alternatively, you can
create a temporary connection that lasts only for the time that ColdFusion processes the single cfexchange
task tag. To do this, you specify the connection attributes directly in the cfexchangetask tag. For details
on the connection attributes, see the cfexchangeconnection tag.
The delete action

When you specify the delete action, specify a uid attribute with a comma-delimited list of one or more Exchange
UIDs that identify the tasks to delete. You can use the get action, with an appropriate filter expression, to determine

© 2014 Adobe Systems Incorporated. All rights reserved.

397

Adobe ColdFusion Documentation

the UID values to specify.
If all UIDs that you specify are invalid, the cfexchangetask tag generates an error. If at least one UID is valid, the
tag ignores any invalid UIDs and deletes the items specified by the valid UID.
The get action

When you specify the get action, the query object specified by the name attribute contains one record for each
retrieved task. The query object has columns with the same names and data formats as the fields listed for the task
attribute structure, with the following differences:
The query object has a Boolean HasAttachment column, and does not have an Attachments column. If
the HasAttachment field value is yes, use the getAttachments action to retrieve the attachments.
The query object has an additional UID column with the unique identifier for the task in the Exchange server.
You can use this value in the uid attribute of the getAttachments, delete, and modify actions to identify
the required task.
The query object has an additional HtmlMessage column. The Message column has a plain-text version of
the task description, and the HtmlMessage column text includes the description's HTML formatting.
You use child cfexchangefilter tags to specify the messages to get. For detailed information, see cfexc
hangefilter.
The getAttachments action

When you use the getAttachments action, specify a single UID and a name attribute. The cfexchangetask tag
populates a query object specified by the name attribute with the specified name. Each record has the following
information about an attachment to the specified task:
Column name

Description

attachmentFileName

The filename of the attachment.

attachmentFilePath

The absolute path of the attachment file on the server.
If you omit the attachmentPath attribute, this column
contains the empty string.

CID

The content-ID of the attachment. Typically used in
HTML img tags to embed images in a message.

mimeType

The MIME type of the attachment, such as text/html

isMessage

A Boolean value that specifies whether the attachment
is a message.

size

The attachment size, in bytes.

The tag places the attachments in the directory specified by the attachmentPath attribute. If you omit the attach
mentPath attribute, ColdFusion does not get any attachments, it gets the information about the attachments. This
lets you determine the attachments without incurring the overhead of getting the attachment files.Use the following
syntax to specify an in-memory attachmentPath directory. In-memory files are not written to disk and speed
processing of transient data.

© 2014 Adobe Systems Incorporated. All rights reserved.

398

Adobe ColdFusion Documentation

attachmentpath = "ram:///path"

The path can include multiple directories, for example ram:///petStore/orders/messageAttachments.
Create all directories in the path before you specify the file. For more information on using in-memory files, see Work
ing with in-memory files in Optimizing ColdFusion applications in the Developing ColdFusion Applications.
The getAttachments action works only if authentication for EWS (Exchange Web Services) is set to basic in the
server setup of Exchange. IWA (Integrated Windows Authentication) is not supported.
The modify action

If you specify the modify action, the uid attribute must specify a single Exchange UID. The task structure must
specify only the fields that you are changing. Any fields that you do not specify remain unchanged. For a detailed
description of the contents of the task structure, see the Attributes section.
If a task has attachments and you specify attachments when you modify the task, the new attachments are added to
the previous attachments, and do not replace them. Use the deleteAttachments action to remove any
attachments.
Example

The following example uses a transient connection to create a single task:



stask=StructNew();
stask.Priority="high";
stask.Status="Not_Started";
stask.DueDate="3:00 PM 09/14/2007";
stask.Subject="My New Task";
stask.PercentCompleted=0;
Message="Do this NOW!";






© 2014 Adobe Systems Incorporated. All rights reserved.

399

Adobe ColdFusion Documentation

cfexecute
Description

Executes a ColdFusion developer-specified process on a server computer.
Category

Extensibility tags, Flow-control tags
Syntax


...


Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfcollection, cfindex, cfobject, cfreport, cfsearch, cfwddx
History

ColdFusion MX 6.1:
Added the variable attribute.
Changed filepath behavior for the outputFile attribute: if you do not specify an absolute filepath in the out
putFile attribute, the path is relative to the ColdFusion temporary directory.
Attributes

Attribute

Req/Opt

name

Required

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description
Absolute path of the
application to execute.On
Windows, specify an
extension, for example,
C:\myapp.exe.

400

Adobe ColdFusion Documentation

arguments

Optional

Command-line variables
passed to application. If
specified as string, it is
processed as follows:
Windows: passed to
process control
subsystem for parsing.
UNIX: tokenized into an
array of arguments. The
default token separator
is a space; you can
delimit arguments that
have embedded spaces
with double-quotation
marks.
If passed as array, it is
processed as follows:
Windows: elements are
concatenated into a
string of tokens,
separated by spaces.
Passed to process
control subsystem for
parsing.
UNIX: elements are
copied into an array of
exec() arguments.

outputFile

Optional

File to which to direct
program output. If no out
putfile or variable at
tribute is specified, output
is displayed on the page
from which it was called. If
not an absolute path
(starting with a drive letter
and a colon, or a forward
or backward slash), it is
relative to the ColdFusion
temporary directory, which
is returned by the GetTem
pDirectory function.

errorFile

Optional

File in which to direct error
output, if any exists.

© 2014 Adobe Systems Incorporated. All rights reserved.

401

Adobe ColdFusion Documentation

timeout

Optional

0

Length of time, in
seconds, that ColdFusion
waits for output from the
spawned program.
0: equivalent to
nonblocking mode.
A very high value:
equivalent to blocking
mode.
If the value is 0:
ColdFusion starts a
process and returns
immediately.
ColdFusion may return
control to the calling
page before any
program output
displays. To ensure that
program output
displays, set the value
to 2 or higher.
If the outputFile attri
bute is not specified,
any program output is
discarded

variable

Optional

Variable in which to put
program output. If no out
putfile or variable a
ttribute is specified,
output is displayed on
page from which it was
called.

errorVariable

Optional

Variable in which to put
error output, if any exists.

Usage

Do not put other ColdFusion tags or functions between the start and end tags of cfexecute. You cannot nest cfex
ecute tags.
Exceptions

Throws the following exceptions:
If the application name is not found: java.io.IOException
If the effective user of the ColdFusion executing thread does not have permissions to execute the process: a
security exception
The time-out values must be between zero and the longest time-out value supported by the operating system.
Example

© 2014 Adobe Systems Incorporated. All rights reserved.

402

Adobe ColdFusion Documentation


cfexecute


This example executes the Windows NT version of the netstat network monitoring
program, and places its output in a file.



© 2014 Adobe Systems Incorporated. All rights reserved.

403

Adobe ColdFusion Documentation

cfexit
Description

This tag aborts processing of the currently executing CFML custom tag, exits the page within the currently executing
CFML custom tag, or re-executes a section of code within the currently executing CFML custom tag.
Category

Debugging tags, Flow-control tags
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfabort, cfbreak, cfexecute, cfif, cflocation, cfloop, cfswitch, cfthrow, cftry; cfabort and cfexit i
n the Developing ColdFusion Applications
Attributes

Attribute

Req/Opt

Default

method

Optional

exitTag

Description
exitTag: aborts
processing of currently
executing tag.
exitTemplate: exits
page of currently
executing tag.
loop: re-executes body
of currently executing
tag.

Usage

If this tag is encountered outside the context of a custom tag, for example in the base page or an included page, it
executes in the same way as cfabort. The cfexit tag can help simplify error checking and validation logic in
custom tags. The cfexit tag function depends on its location and execution mode:
Method value

Location of cfexit call

Behavior

exitTag

Base page

Terminate processing

© 2014 Adobe Systems Incorporated. All rights reserved.

404

Adobe ColdFusion Documentation

exitTemplate

loop

Execution mode = Start

Continue after end tag

Execution mode = End

Continue after end tag

Base page

Terminate processing

Execution mode = Start

Continue from first child in body

Execution mode = End

Continue after end tag

Base page

Error

Execution mode = Start

Error

Execution mode = End

Continue from first child in body

Example

© 2014 Adobe Systems Incorporated. All rights reserved.

405

Adobe ColdFusion Documentation


cfexit Example


cfexit can be used to abort the processing of the currently executing CFML custom
tag. Execution resumes following the invocation of the custom tag in the page that
called the tag.

Usage of cfexit


cfexit is used primarily to perform a conditional stop of processing inside a
custom tag. cfexit returns control to the page that called that custom tag, or in
the case of a tag called by another tag, to the calling tag.










If cfexit is used outside a custom tag, it functions like a cfabort. For example,
the text after this message is not processed:



This text is not executed because of the cfexit tag above it.


#back to top

© 2014 Adobe Systems Incorporated. All rights reserved.

406

Adobe ColdFusion Documentation

Tags f
This section lists tags starting with alphabet F with their description.
cffeed
cffile
cffile action = "append"
cffile action = "copy"
cffile action = "delete"
cffile action = "move"
cffile action = "read"
cffile action = "readBinary"
cffile action = "rename"
cffile action = "upload"
cffile action = "uploadAll"
cffile action = "write"
cffileupload
cffinally
cfflush
cfformgroup
cfformitem
cfftp
cfftp: Opening and closing FTP server connections
cfftp: Opening and closing secure FTP server connections
cfftp: Connection: file and directory operations
cfftp action = "listDir"
cfform
cffunction

© 2014 Adobe Systems Incorporated. All rights reserved.

407

Adobe ColdFusion Documentation

cffeed
Description

Reads or creates an RSS or Atom syndication feed. This tag can read RSS versions 0.90, 0.91, 0.92, 0.93, 0.94,
1.0, and 2.0, and Atom 0.3 or 1.0. It can create RSS 2.0 or Atom 1.0 feeds.
Category

Communications tags, Internet protocol tags
Syntax

© 2014 Adobe Systems Incorporated. All rights reserved.

408

Adobe ColdFusion Documentation

create
required

escapeChars = "true|false">

outputFile = "path"

OR
required

read
required


Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

History

© 2014 Adobe Systems Incorporated. All rights reserved.

409

Adobe ColdFusion Documentation

ColdFusion 8: Added this tag.
ColdFusion 9: The escapeChars attribute is newly added.
Attributes

Attribute

Req/Opt

Default

Description

action

Optional

read

The action to take, one of
the following values:
create: creates an
RSS 2.0 or Atom 1.0
feed XML document
and saves it in a
variable, writes it to a
file, or both.
read: parses an RSS
or Atom feed from a
URL or an XML file and
saves it in a structure or
query. You can also get
feed metadata in a
separate structure.

columnMap

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

Used only for the create
action with a query attrib
ute.A structure that
specifies a mapping
between the names of the
columns in the object
specified by the query att
ribute and the columns of
the ColdFusion feed
format (see the section
Query object rules.
The key for each field
must be a column name
(see the table in the
Query object rules
section). The value of the
field must be the name of
the corresponding column
in the query object used
as input to the create ac
tion.

410

Adobe ColdFusion Documentation

enclosureDir

Optional

escapeChars

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

Used only for the read ac
tion. Path to the directory
in which to save any
enclosures that are
available in the feed being
read. The path can be
absolute or relative to the
CFML file.
If the directory does not
exist, ColdFusion
generates an error. If you
omit this attribute,
ColdFusion does not save
enclosures. To specify the
directory that contains the
current page, set this
attribute to " ." (period).
false

Used only for the create
action. If this attribute is t
rue, escapes/replaces all
the invalid characters as
per W3C specification. No
te: Japanese characters
that are not part of UTF-8
encoding are replaced.
Non-UTF-8 Japanese
characters remain in the
feed as they are.
If this attribute is false,
does not escape invalid
characters and tries to
generate feed. If JDOM
fails to write the file with
these invalid characters,
the error message "Invalid
Character in Input" is
displayed.

411

Adobe ColdFusion Documentation

ignoreEnclosureErro
r

Optional

name

See Note

no

If this attribute is yes,
ColdFusion attempts to
save all enclosures. If it
encounters an error
downloading one
enclosure, it continues
downloading other
enclosures and writes the
error information in the
server log. If this attribute
is no, when ColdFusion
encounters an error
downloading an
enclosure, it stops
downloading all
enclosures and generates
an error.
Note: Enclosure errors
can occur if the specified
enclosure is of a type that
the web server does not
allow to be downloaded.
A structure that contains
complete feed data:
The output of a read ac
tion.
The input definition of
the feed to create.
When you specify the n
ame attribute for a crea
te action, enclose it in
number signs (#).
For more information,
see Name and
properties structure
rules section.

outputFile

See Note

© 2014 Adobe Systems Incorporated. All rights reserved.

Path of the file in which to
write the feed as XML
text.
The path can be absolute,
or relative to the CFML
file.

412

Adobe ColdFusion Documentation

overwrite

Optional

no

Whether to overwrite the
XML feed file if it exists. If
you do not set this
attribute to yes and the c
ffeed tag tries to write to
a file that exists,
ColdFusion generates an
error.

overwriteEnclosure

Optional

no

Used only for the read ac
tion. Whether to overwrite
files in the enclosure
directory if they exist. If
you do not set this
attribute to yes and the c
ffeed tag tries to write to
a file that exists,
ColdFusion generates an
error.

properties

See Note

A structure that contains
the feed metadata, the
information about the
entire feed. Can contain
either of the following:
The output of a read ac
tion.
Input to a create actio
n.
The properties and
query attributes
combined provide
complete feed
information.
When you specify the p
roperties attribute for
a create action,
enclose it in number
signs (#).
For more information,
see Name and
properties structure
rules section.

proxyPassword

Optional

proxyPort

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

Password required by the
proxy server.
80

The port to connect to on
the proxy server.

413

Adobe ColdFusion Documentation

proxyServer

Optional

Host name or IP address
of a proxy server to which
to send the request.

proxyUser

Optional

User name to provide to
the proxy server.

query

See Note

A query object that
contains the Atom entries
or RSS items in the feed.
Can contain either of the
following:
The output of a read ac
tion.
Input to a create actio
n.
The properties and
query attributes
combined provide
complete feed
information.
When you specify the q
uery attribute for a cre
ate action, enclose it in
number signs (#).
For more information,
see section Query
object rules.

source

Required

timeout

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

Used only for the read ac
tion. The URL of the feed
or the path to the XML file
that contains the feed
contents. A path can be
absolute, or relative to the
CFML file.
Request time-out

The number of seconds to
wait for a response from
the feed source. A value
of 0 specifies that the
request does not time out.
By default, ColdFusion
uses the request time-out
setting of the ColdFusion
Administrator Server
Settings > Settings page.

414

Adobe ColdFusion Documentation

userAgent

Optional

xmlVar

See Note

Cold Fusion

Text to put in the HTTP
User-Agent request
header field. Used to
identify the request client
software.
A variable in which to
save the read or created
feed as XML text.

Usage
Specifying file and directory attributes

Use the following syntax to specify an in-memory file or directory. In-memory files are not written to disk and speed
processing of transient data.

ram:///filepath

A filepath can include multiple directories, for example ram:///petStore/images/poodle.jpg. Create the
directories in the path before you specify the file. For more information on using in-memory files, see Working with
in-memory files in Optimizing ColdFusion applications in the Developing ColdFusion Applications.
Setting and getting feed information

The cffeed tag lets you specify and save feed data in many, flexible ways.
Usage

Use the following syntax to specify an in-memory file, which is not written to disk. In-memory files speed processing
of transient data.

ram:///filepath

The filepath can include directories, for example ram:///petStore/images/poodle.jpg. Create the directories
in the path before you specify the file. For more information on using in-memory files, see Working with in-memory
files in Optimizing ColdFusion applications in the Developing ColdFusion Applications.
When you create a feed
You specify the feed data in either of the following ways:
By putting all metadata and entry or item data in a single structure specified by the name attribute.
By putting the metadata in a structure specified by the properties structure and the entries or items
as rows in a query object specified by the query attribute.
You save the resulting feed XML in one or both of the following places:
A file specified by the OutputFile attribute. The cffeed tag saves the data in UTF-8 encoding.
An variable specified by the xmlVar attribute
When you read a feed You can save the feed data in any combination of the following forms:

© 2014 Adobe Systems Incorporated. All rights reserved.

415

Adobe ColdFusion Documentation

By saving all entry or item data and metadata in a single structure specified by the name attribute
By saving entries or items as rows in a query object specified by the query attribute
By saving the metadata in a structure specified by the properties structure
By writing the feed XML in a file specified by the OutputFile attribute. The cffeed tag saves the data in
UTF-8 encoding.
By saving the feed XML in a ColdFusion XML variable specified by the xmlVar attribute
When you save feed data, you do not have to save both the metadata and the entry or item data. You can
specify only the properties attribute, or only the query attribute.
Name and properties structure rules

The name and properties structures must conform to the following rules. For more information on requirements
for specific metadata entries, see the section Representing feed metadata.
All structure key names must be identical to the corresponding feed element names, with the exception of the
version and encoding fields. Also, the key names for Dublin Core and Apple iTunes extension elements
start with DC_ and ITUNES_ respectively.
The properties structure fields are identical to the metadata fields in the name structure.
When you read a feed, the structure contains only those elements and attribute values that exist in the feed.
For requirements for the create action, see the section Creating feeds.
If the feed can have multiple elements of the same type (such as entry, item, or link), the name or prope
rtystructure has a single entry that contains the data for all of the elements. The structure entry has the
following format:
The key is the element name (for example, item)
The value is an array of structures
Each structure in the array represents one element.
ColdFusion uses an array even if there is only a single element. If an Atom feed has only one link ele
ment, for example, you must specify that element in a nameattribute structure by using the following
format:

structureName.link[1]

For example, to specify a linkmetadata entry in an Atom 1.0 feed, you could use the following code:





If an element can have multiple attributes, or can have at least one attribute and a value, the element is
represented as a structure, even if the element specifies only one attribute or only a value.
If an element has one or more attributes and a value (body), the value is in a field of the element structure
named value. For example, the text of the summary element for the third entryin an Atom feed would go in
a field whose name has the following format:

structureName.entry[3].summary.value.

When the cffeed tag reads a feed, it reports dates as follows:Atom: W3C date format, such as

© 2014 Adobe Systems Incorporated. All rights reserved.

416

Adobe ColdFusion Documentation

2006-07-11T18:19:00Z.RSS: in RFC 822 Format, such as Thu, 05 Oct 2006 18:19:00 GMT.
When the cffeed tag creates a feed, you can use W3C or RFC 822 formats for both feed types. You can
also use any standard date or date/time format accepted by ColdFusion.
Query object rules

The query object specified by the query attribute conforms to the following rules:
The query object format supports multiple feed formats, and many feeds do not include all optional feed
attributes or elements. As a result:
When you read a feed, the returned query object contains entries for all standard RSS and Atom fields,
even for fields that are not supported by the feed type. Any columns that are not used by the feed
format, or are not used in that specific feed, contain empty strings or undefined values.
When you read a feed, the query object contains all iTunes extension fields if the feed contains any
iTunes extension elements, and the query object contains all Dublin Core extension fields if the feed
contains any Dublin Core extension elements. Otherwise, the query results do not contain any of the
extension fields.
When you create a feed, the query that you define requires only those columns that contain data for
your feed; you can omit unused columns.
If a feed entry or item has multiple child elements with the same name, the query column represents the
element values as a comma-delimited list. RSS 2.0 items can have multiple category elements. Atom 1.0
entries can have multiple category, author, contributor, and link elements. The Dublin Core
extensions allow all multiples of all element types.
Many entry or item elements that can have multiple instances have multiple attributes, not all of which are
required for any particular element instance. If an entry or item has multiple instances of an element, and any
of those elements omit attributes, ColdFusion represents the omitted attribute in the lists by a space. In XML,
an Atom entry, for example, might contain three author elements, as follows:


Anthony
http://www.MyCo.com
Tony@MyCo.com


Beverly


Cathy
cathy@MyCo.com


The ColdFusion query represents these columns as follows:
AUTHOR_PERSON

AUTHOR_URI

AUTHOR_EMAIL

Anthony,Beverly,Cathy

http://www.MyCo.com, ,

Tony@MyCo.com,
,cathy@MyCo.com

The following table lists the columns of the standard query object specified by the query attribute. If an RSS feed
includes either Dublin Core extensions or iTunes extensions, the query includes additional columns. For information
on these fields, see the sections Dublin Core Extensions and Apple iTunes Extensions.

© 2014 Adobe Systems Incorporated. All rights reserved.

417

Adobe ColdFusion Documentation

Column

Atom entry

RSS item

AUTHOREMAIL

author element email attribute

author item

AUTHORNAME

author element name attribute

Not used

AUTHORURI

author element uri attribute

Not used

CATEGORYLABEL

category element label attribute

category item value

CATEGORYSCHEME

category element scheme attribut
e

category item domain attribute

CATEGORYTERM

category element term attribute

Not used

COMMENTS

Not used

comments item value

CONTENT

content element value

description item value

CONTENTMODE

content element mode attribute
(Atom 0.3 only)

Not used

CONTENTSRC

content element src attribute

Not used

CONTENTTYPE

content element type attribute

Not used

CONTRIBUTOREMAIL

contributor element email attri
bute

Not used

CONTRIBUTORNAME

contributor element name attrib
ute

Not used

CONTRIBUTORURI

contributor element uri attribut
e

Not used

CREATEDDATE

created element value (Atom 0.3
only)

Not used

EXPIRATONDATE

Not used

expirationDate item value (RSS
0.93 only)

ID

id element value

guid item value

IDPERMALINK

Not used

guid item ispermalink attribute

LINKHREF

link element href attribute

enclosure item url attribute

© 2014 Adobe Systems Incorporated. All rights reserved.

418

Adobe ColdFusion Documentation

LINKHREFLANG

link element hreflang attribute

Not used

LINKLENGTH

link element length attribute

enclosure item length attribute

LINKREL

link element rel attribute

Not used

LINKTITLE

link element title attribute

Not used

LINKTYPE

link element type attribute

enclosure item type attribute

PUBLISHEDDATE

published element value (issue
d in Atom 0.3)

pubDate item value

RIGHTS

rights element value (copyrigh
t in Atom 0.3)

Not used

RSSLINK

Not used

link item value

SOURCE

Not used

source item value

SOURCEURL

Not used

source item url attribute

SUMMARY

summary element value

Not used

SUMMARYMODE

summary element mode attribute
(Atom 0.3 only)

Not used

SUMMARYSRC

Blank for all well-formed Atom
feeds. Contains data only if an
Atom 1.0 feed uses a content ele
ment format for the summary eleme
nt.

Not used

SUMMARYTYPE

summary element type attribute

Not used

TITLE

title element value

title item value

TITLETYPE

title element type attribute

Not used

UPDATEDDATE

updated element value (modifie
d in Atom 0.3)

Not used

URI

Not used

RSS 1.0 link item rdf:about attr
ibute

XMLBASE

content elemen{{t xml:base}}
attribute

Not used

© 2014 Adobe Systems Incorporated. All rights reserved.

419

Adobe ColdFusion Documentation

Representing feed metadata

When you create a feed, the name and properties structures can represent all standard metadata for RSS 2 or
Atom 1 feeds, in the format described in the Name and properties structure rules section. Similarly, when you read a
feed, the structures represent all received metadata. The following rules apply to specific feed metadata fields in the
name and properties structures:
The version field identifies or specifies the feed version in the form format_versionNumber. For the create
action, specify atom_1.0 or rss_2.0. When you read an RSS 0.91 feed, the version field value is rss_0.9
1U, not rss_0.91.
The feedExtension field identifies whether the feed includes iTunes or Dublin Core extension content.
Valid values are itunes and DublinCore. You do not have to specify this field when you create a feed with
iTunes extensions; ColdFusion automatically determines that you have specified extension fields. (You
cannot create a feed with Dublin Core extensions.)
For the read action, an encoding field identifies the XML encoding attribute, such as iso-8859-1. Do not
specify an encoding field for a create action. Currently, ColdFusion generates all feeds in UTF-8 format
and ignores any encoding value that you specify.
For RSS feeds, the skiphours field contains a comma-delimited list of up to 24 numbers in the range 0-23,
specifying hours of the day when aggregators should not read the feed. The hour beginning at midnight is
hour zero. Your application can use the field to decide when to read the feed.
For RSS feeds, the skipdays field contains a comma-delimited list of up to seven day-name values,
specifying days of the week when aggregators must not read the feed. The valid names are Monday, Tuesda
y, Wednesday, Thursday, Friday, Saturday and Sunday. Your application can use the field to decide
when to read the feed.
Dublin Core Extensions

Dublin Core extension elements provide additional metadata about the feed or an item. You can use the cffeed tag
to read feeds that include elements that conform to the Dublin Core Metadata Element Set specification as metadata
(channel elements) or as item elements. For detailed information Dublin Core extension elements, see the Dublin
Core Metadata Element Set specification. At the time this topic was written, this specification was available at http://
dublincore.org/documents/dces/.ColdFusion support for Dublin Core extensions has the following limitations:
You cannot create feeds containing these elements.
You cannot get Dublin Core extension elements that are contained in a top-level (metadata) image element.
ColdFusion ignores these elements.
ColdFusion supports only the Dublin Core Metadata Element Set. It does not support the additional Dublin
Core Metadata Initiative elements and element refinements.
When feed items include the Dublin Core extensions, the query specified by a query attribute includes all of
the columns listed in the following table. If the feed does not include any Dublin Core extension elements, the
query does not include the columns. With the exception of the DC_SUBJECT_TAXONOMURI and DC_SUBJECT
_VALUE columns, each column name (without the DC_ prefix) corresponds directly to a Dublin Core extension
element name.
Column

Description

DC_CONTRIBUTOR

The people or organizations responsible for
contributing to the resource

DC_COVERAGE

The extent of the content in the resource

© 2014 Adobe Systems Incorporated. All rights reserved.

420

Adobe ColdFusion Documentation

DC_CREATOR

The person or organization responsible for creating this
resource

DC_DATE

A date or date and time associated with this resource

DC_DESCRIPTION

A summary of the resource contents

DC_FORMAT

The file format, physical medium, or dimensions of the
resource

DC_IDENTIFIER

A string that can be used to unambiguously identify the
resource

DC_LANGUAGE

The language in which the resource is written

DC_PUBLISHER

The person or organization responsible for making the
resource available.

DC_RELATION

The identifier of a related resource, typically.

DC_RIGHT

Information about the property rights for the resource.

DC_SOURCE

A reference to the material from which this resource
was derived.

DC_SUBJECT_TAXONOMYURI

The taxonomy URI attribute of the Dublin Core subje
ct element

DC_SUBJECT_VALUE

The value of the Dublin Core subject element; a
string that defines the topic of the resource

DC_TITLE

A name to use for the resource

DC_TYPE

The nature or genre of the resource

When you get data for a feed that includes Dublin Core elements as a structure, the element names are identical to
the query column names listed above, with the exception of the representation of the Dublin Core subject element.
The structure format represents the subject element as a dc_subject entry, which consists of an array of
structures. The structures in the array have keys with the names value, for the element value, and taxononmyURI
, for the taxonomyURI attribute.
Apple iTunes Extensions

You can use the cffeed tag to create or read feeds that contain elements defined in the Apple iTunes RSS podcast
specification. For detailed information on iTunes extension format, see the Apple iTunes RSS specification. At the
time this topic was written, this specification was available at http://www.apple.com/itunes/store/podcaststechspecs.
html.
You can create feeds with only a subset of the iTunes RSS extensions. When you read a feed, ColdFusion ignores
all iTunes extension elements that are not in the supported subset. The following table lists the names of structure

© 2014 Adobe Systems Incorporated. All rights reserved.

421

Adobe ColdFusion Documentation

entries or query column names for the supported elements. (These names consist of the ITUNES_ prefix followed by
the iTunes extension element name.) The table also indicates which elements are used in the metadata, which are
used in the individual items, and which can be used in both:
Element

Used in

Description

ITUNES_AUTHOR

Both

Artist name

ITUNES_BLOCK

Both

a value of yes requests to prevent
the podcast or item (episode) from
appearing. When ColdFusion reads
a feed your application must
determine this field's value and take
any appropriate action.

ITUNES_DURATION

Item

The length of the item in second, or
in HH:MM:SS format.

ITUNES_EXPLICIT

Both

A string indicating whether the item
or items contain explicit material.
Valid values are yes, no, and clea
n.

ITUNES_KEYWORDS

Both

A comma-delimited list of words or
phrases used when searching in the
iTunes music store.

ITUNES_SUBTITLE

Both

Short description text, usually only a
few words.

ITUNES_SUMMARY

Both

A longer description (up to 4000
characters)/

You can also use the following channel elements in the name or properties structures.
Element

Description

itunes_category

A structure that specifies the iTunes Music Store
category. The structure has two fields:
category
subcategory
Notice that these element names do not have the it
unes_ prefix.

itunes_image

© 2014 Adobe Systems Incorporated. All rights reserved.

The URL of the artwork for the podcast.

422

Adobe ColdFusion Documentation

itunes_owner

A structure that contains contact information about the
owner of the podcast for communication. The structure
has two fields:
itunes_email
itunes_mail

Creating feeds

When you create a feed, you specify the feed contents in a name structure or in the combination of a query object
and a properties structure. The cffeed tag generates the feed XML and saves in to the variable specified by the
xmlVar attribute, the file specified by the outputFile attribute, or both. To create an RSS 2.0 feed you must
specify the following metadata fields in a name structure or in a properties structure. All other RSS2.0 metadata
fields, and all item fields, are optional.
title
link
description
version (must be "rss_2.0")
The cffeed tag does not enforce any rules on the Atom feed structure that it creates. You are responsible
for ensuring that the feed is valid.
In most cases, a database table uses column names that differ from the column names you must use to
create the feed. Therefore, use the columnmap attribute to map the input query column names to the
required column names. The attribute is a structure whose keys are the column names required by the cffe
edtag and whose values are the corresponding input query columns.
Note
Always capitalize the input query column names irrespective of whether the database
column names are capitalized or not.

The following example creates a feed using the cfartgallery data source's orders table. It maps the orders
table ORDERDATE column to the query publisheddate column, the ADDRESS column to the content column,
and so on. The sample code then displays the generated query XML to show the results.

© 2014 Adobe Systems Incorporated. All rights reserved.

423

Adobe ColdFusion Documentation



SELECT * FROM orders
















Reading feeds

The cffeed tag does not validate the feeds that it reads. It can read invalid or loosely formatted feeds, but ignores
some or all of the invalid content. For example, if you put more than one rights element in the Atom feed (which
invalidates the feed), the cffeed tag ignores the elements after the first one, and doesn't generate an error. Dates
and times in feeds that are being read must be in W3C or RFC 822 format. ColdFusion can also read iTunes
extension dates in the format normally used by the iTunes music store.
Example

The following example creates an RSS feed. Enter fields for the feed title, link, and description elements. Also enter
title, link, and description fields for one item. A second item is optional. The application saves the feed in a
createRSSOutput.xml file in the feedTest subdirectory of the directory that contains the CFML page.




// Create the feed data structure and add the metadata.
myStruct = StructNew();
mystruct.link = form.link;
myStruct.title = form.title;
mystruct.description = form.description;
mystruct.pubDate = Now();
mystruct.version = "rss_2.0";

© 2014 Adobe Systems Incorporated. All rights reserved.

424

Adobe ColdFusion Documentation

/* Add the feed items. A more sophisticated application would use dynamic
variables
and support varying numbers of items. */
myStruct.item = ArrayNew(1);
myStruct.item[1] = StructNew();
myStruct.item[1].description = StructNew();
myStruct.item[1].description.value = form.item1text;
myStruct.item[1].link = form.item1link;
myStruct.item[1].pubDate = Now();
myStruct.item[1].title = form.item1title;
myStruct.item[2] = StructNew();
myStruct.item[2].description = StructNew();
myStruct.item[2].description.value = form.item2text;
myStruct.item[2].link = form.item2link;
myStruct.item[2].pubDate = Now();
myStruct.item[2].title = form.item2title;






 Enter The Feed Metadata
 

 


 Enter Item 1
 

 

 

 Enter Item 2
 

 

 


© 2014 Adobe Systems Incorporated. All rights reserved.

425

Adobe ColdFusion Documentation




The following application is a simple feed reader that handles RSS and Atom feeds. It displays the feed title; for
each item or entry, it shows the title as a link, and shows the published date and the item or entry contents. To use
this example to read the feed created by the first application, enter the URL for the file the application created, for
example, http://localhost:8500/cffeed/feedTest/createRSSOutput.xml.







#myProps.title#





#title#


Published: #DateFormat(publisheddate)#



#title#


Published: #publisheddate#



#content#





Enter Feed URL:






© 2014 Adobe Systems Incorporated. All rights reserved.

426

Adobe ColdFusion Documentation

cffile
Description

Manages interactions with server files. The following sections describe the actions of the cffile tag:
cffile
cffile
cffile
cffile
cffile
cffile
cffile
cffile
cffile
cffile

action
action
action
action
action
action
action
action
action
action

=
=
=
=
=
=
=
=
=
=

"append"
"copy"
"delete"
"move"
"read"
"readBinary"
"rename"
"upload"
"uploadAll"
"write"

Note
To execute, this tag must be enabled in the ColdFusion Administrator. For more
information, see Configuring and Administering ColdFusion.

If your ColdFusion applications run on a server used by multiple customers, consider the security of the files
that could be uploaded or manipulated by cffile. For more information, see Configuring and Administering
ColdFusion.
Category

File management tags
Syntax

The tag syntax depends on the action attribute value. See the following sections.
See also

cfdirectory
History

ColdFusion 10: Modifications to the attribute accept}}
ColdFusion 9: {{uploadAll action
ColdFusion 8: Support for reading and writing cfimages.
ColdFusion MX 7:
Added the result attribute, which allows you to specify an alternate variable in which to receive result
parameters. Used for action = "upload" action.
Added the fixnewline attribute for action = "append" and action = "write" actions.
ColdFusion MX 6.1:
Changed file path requirements: if you do not specify an absolute file path, the path is relative to the
ColdFusion temporary directory, which is returned by the GetTempDirectory function.
Changed behavior for action="read": if the file starts with a byte order mark (BOM) ColdFusion uses it to

© 2014 Adobe Systems Incorporated. All rights reserved.

427

Adobe ColdFusion Documentation

determine the character encoding.
Changed behavior for action="upload" nameConflict="MakeUnique" ColdFusion now makes
filenames unique by appending a incrementing number, 1 for the first file, 2 for the second and so on, to the
name. In ColdFusion, filenames were made unique by appending an additional "1" for each file, as in 1, 11,
111, and so on.
ColdFusion MX:
Changed use of slashes in paths: you can use forward or backward slashes in paths on both UNIX and
Windows systems.
Changed file hierarchy requirements: ColdFusion does not require that you put files and directories that you
manipulate with this tag below the root of the web server document directory.
Changed directory path requirements for the destination attribute: a directory path that you specify in the
destination attribute does not require a trailing slash.
Deprecated the system value of the attributes attribute.
Deprecated the temporary value of the attributes attribute. In ColdFusion, it is a synonym for normal. It
might not work in later releases.
Changed the action attribute options read, write, append and move: they support a new attribute, chars
et.
The archive value of the attributes attribute is obsolete and has no effect.
Provide file content in the tag body

For cffile action = "append" and cffile action = "write", you can provide file content in the tag
body. If you provide file content in both the tag body and the output attribute, it results in an error. In the following
example, the text provided in the body is written to myfile.txt in the current directory.Now assume that the file does
not exist, then a new file myfile.txt is created. If the file exists, it is overwritten.





some tag body


File Length = #Len(content)#


#cfcatch.message#

#cfcatch.detail#






Similarly, if you use cffile action="append", the tag body content is appended to the contents of the file
myfile.txt. To create an empty file, you have to provide at least a blank line in the tag body as shown in the following
code:

© 2014 Adobe Systems Incorporated. All rights reserved.

428

Adobe ColdFusion Documentation





Modifications to the attribute accept in ColdFusion 10

The attribute accept takes comma-separated list of any or all extensions, MIME type, or list of MIME types as
values. Specify the extensions with a . prefix. That is, only .txt is supported and not txt, *.txt, or *.*.
However, you can use * as a wildcard to accept all files.
If you specify filename extension as value, the file is checked, only to ensure if it matches the list of
extensions you specified in comma-separated list. If it matches, the file is uploaded.
If the value is MIME type or list of MIME types and the attribute strict is set to true, then the first few
bytes of the file are read to determine the MIME type. If MIME type matches with what you have specified,
upload occurs, else results in an error. The default value of strict is false.
If you specify both filename extensions and MIME types and if strict is set to false, the verification is
based on the order in which you have specified the values. For example, if the first value is .txt, then the
.txt file is uploaded.
If strict is set to true, extensions are ignored.
Example: Using the attribute accept to verify the filename extension

upload.cfm






#cfhttp.filecontent#


#CFCATCH.message#

#CFCATCH.detail#






_upload.cfm

© 2014 Adobe Systems Incorporated. All rights reserved.

429

Adobe ColdFusion Documentation










#CFCATCH.message#

#CFCATCH.detail#







#qFileList.recordcount#
file(s) uploaded








In this example, accept is set to .txt and strict is not specified (and therefore is false by default). So, only files
with .txt extensions are considered for upload.Even if the file is originally a PDF ( sample.pdf) renamed as samp
le.txt, the file is uploaded (since strict is not set to true).
If you specify strict=true, then if the file is originally a .txt (and not renamed from some other type) the file is
uploaded only if the correct MIME type is specified. That is, strict=true requires MIME type to be specified in the
accept attribute. So, you should explicitly say accept="text/plain" in _upload.cfm.
Example 2: Using MIME type

Modify the Example 1 by specifying accept="application/pdf" in _upload.cfm as follows:



© 2014 Adobe Systems Incorporated. All rights reserved.

430

Adobe ColdFusion Documentation

Since strict = true, only files of type PDF are considered for upload. To use a different file, modify the the
following section of upload.cfm:



Example 3: Using both extension and MIME type

Modify the Example 1 by specifying the following in _upload.cfm:



Only PDF files are uploaded because strict = true. If you set strict as false, then both the files are uploaded.
To use a different file, modify the following snippet of upload.cfm:



Example
















© 2014 Adobe Systems Incorporated. All rights reserved.

431

Adobe ColdFusion Documentation

















Type in some text to include in your file:
 



A file exists (foobar.txt, in #GetTempDirectory()#).
You may add to it, read from it, or delete it. 








© 2014 Adobe Systems Incorporated. All rights reserved.

432

Adobe ColdFusion Documentation



 --->

© 2014 Adobe Systems Incorporated. All rights reserved.

433

Adobe ColdFusion Documentation

cffile action = "append"
Description

Appends text to a text file on the server.
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfdirectory
History

See the History section of the main cffile tag page.
Attributes

Attribute

Req/Opt

action

Required

Type of file manipulation
that the tag performs.

file

Required

Pathname of the file to
which to append content
of output attribute.
If not an absolute path
(starting with a drive letter
and a colon, or a forward
or backward slash), it is
relative to the ColdFusion
temporary directory, which
is returned by the GetTem
pDirectory function.

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

434

Adobe ColdFusion Documentation

output

Required

addNewLine

Optional

attributes

Optional

String to append to the
file.
yes

yes: appends newline
character to text written
to file.
no
Applies to Windows. A
comma-delimited list of
attributes to set on the file.
If omitted, the file's
attributes are
maintained.Each value
must be specified
explicitly. For example, if
you specify attributes
= "readOnly", all other
attributes are overwritten.
readOnly
hidden
normal

charset

Optional

JVM default file character
set

The character encoding in
which the file contents is
encoded. The following
list includes commonly
used values:
utf-8
iso-8859-1
windows-1252
us-ascii
shift_jis
iso-2022-jp
euc-jp
euc-kr
big5
euc-cn
utf-16
For more information
character encodings,
see www.w3.org/Intern
ational/O-charset.html.

© 2014 Adobe Systems Incorporated. All rights reserved.

435

Adobe ColdFusion Documentation

fixnewline

Optional

mode

Optional

No

yes: changes
embedded line-ending
characters in string
variables to
operating-system
specific line endings
no: (default) do not
change embedded
line-ending characters
in string variables.
For an example that
uses this attribute, see
cffile action =
"write".
Applies only to UNIX and
Linux. Permissions. Octal
values of UNIX chmod co
mmand. Assigned to
owner, group, and other,
respectively; for example:
644: assigns read/write
permission to owner;
read permission to
group and other.
777: assigns
read/write/execute
permission to all.

Example






© 2014 Adobe Systems Incorporated. All rights reserved.

436

Adobe ColdFusion Documentation

cffile action = "copy"
Description

Copies a file from one directory to another on the server.
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfdirectory
History

See the History section of the main cffile tag page.
Attributes

Attribute

Req/Opt

action

Required

Type of file manipulation
that the tag performs.

destination

Required

Pathname of a directory
or file on web server
where the file is copied. If
you specify a filename
without a directory path,
ColdFusion copies it
relative to the source
directory.

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

437

Adobe ColdFusion Documentation

source

Required

Pathname of the file to
copy. If not an absolute
path (starting with a drive
letter and a colon, or a
forward or backward
slash), it is relative to the
ColdFusion temporary
directory, which is
returned by the GetTemp
Directory function.

attributes

Optional

Applies to Windows. A
comma-delimited list of
attributes to set on the file.
If omitted, the file's
attributes are
maintained.Each value
must be specified
explicitly. For example, if
you specify attributes
= "readOnly", all other
attributes are overwritten.
readOnly
hidden
normal

Optional

mode

Applies only to UNIX and
Linux. Permissions. Octal
values of UNIX chmod co
mmand. Assigned to
owner, group, and other,
respectively; for example:
644: assigns read/write
permission to owner;
read permission to
group and other.
777: assigns
read/write/execute
permission to all.

Example

This example copies the keymemo.doc file to the c:\files\backup\ directory:



© 2014 Adobe Systems Incorporated. All rights reserved.

438

Adobe ColdFusion Documentation

cffile action = "delete"
Description

Deletes a file on the server.
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfdirectory
Attributes

Attribute

Req/Opt

Default

Description

action

Required

Type of file manipulation
that the tag performs.

file

Required

Pathname of the file to
delete. If not an absolute
path (starting with a drive
letter and a colon, or a
forward or backward
slash), it is relative to the
ColdFusion temporary
directory, which is
returned by the GetTemp
Directory function.

Example

The following example deletes the specified file:



© 2014 Adobe Systems Incorporated. All rights reserved.

439

Adobe ColdFusion Documentation

cffile action = "move"
Description

Moves a file from one location to another on the server.
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfdirectory
History

See the History section of the main cffile tag page.
Attributes

Attribute

Req/Opt

action

Required

Type of file manipulation
that the tag performs.

destination

Required

Pathname of the
destination directory or
file. If not an absolute
path, it is relative to the
source directory.

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

440

Adobe ColdFusion Documentation

source

Required

Pathname of the file to
move. If not an absolute
path (starting with a drive
letter and a colon, or a
forward or backward
slash), it is relative to the
ColdFusion temporary
directory, which is
returned by the GetTemp
Directory function.

attributes

Optional

Applies to Windows. A
comma-delimited list of
attributes to set on the file.
If omitted, the file's
attributes are
maintained.Each value
must be specified
explicitly. For example, if
you specify attributes
= "readOnly", all other
attributes are overwritten.
readOnly
hidden
normal

charset

Optional

JVM default file character
set

The character encoding in
which the file contents is
encoded. The following
list includes commonly
used values:
utf-8
iso-8859-1
windows-1252
us-ascii
shift_jis
iso-2022-jp
euc-jp
euc-kr
big5
euc-cn
utf-16
For more information
character encodings,
see www.w3.org/Intern
ational/O-charset.html.

© 2014 Adobe Systems Incorporated. All rights reserved.

441

Adobe ColdFusion Documentation

Optional

mode

Applies only to UNIX and
Linux. Permissions. Octal
values of UNIX chmod co
mmand. Assigned to
owner, group, and other,
respectively; for example:
644: assigns read/write
permission to owner;
read permission to
group and other.
777: assigns
read/write/execute
permission to all.

Example

The following example moves the keymemo.doc file from the c:\files\upload\ directory to the c:\files\memo\ directory
in Windows:



In this example, the destination directory is "memo."

© 2014 Adobe Systems Incorporated. All rights reserved.

442

Adobe ColdFusion Documentation

cffile action = "read"
Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

Description

Reads a text file on the server. The file is read into a dynamic, local variable that you can use in the page. For
example:
Read a text file; insert the file's contents into a database
Read a text file; use the find and replace function to modify the file's contents
Note
This action reads the file into a variable in the local Variables scope. It is not intended for
use with large files, such as logs, because this can bring down the server.

Syntax



See also

cfdirectory
History

See the History section of the main cffile tag page.
Attributes

Attribute

Req/Opt

action

Required

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description
Type of file manipulation
that the tag performs.

443

Adobe ColdFusion Documentation

file

Required

Pathname of the file to
read.
If not an absolute path
(starting with a drive letter
and a colon, or a forward
or backward slash), it is
relative to the ColdFusion
temporary directory, which
is returned by the GetTem
pDirectory function.

variable

Required

Name of variable to
contain contents of text
file.

charset

Optional

Character encoding
identified by the file's byte
order mark, if any;
otherwise, JVM default file
character set.

The character encoding in
which the file contents is
encoded. The following
list includes commonly
used values:
utf-8
iso-8859-1
windows-1252
us-ascii
shift_jis
iso-2022-jp
euc-jp
euc-kr
big5
euc-cn
utf-16
If the file starts with a
byte order mark and
you set this attribute to
a conflicting character
encoding, ColdFusion
generates an error.
For more information
character encodings,
see www.w3.org/Intern
ational/O-charset.html.

Usage

The following example creates a variable named Message for the contents of the file message.txt:



© 2014 Adobe Systems Incorporated. All rights reserved.

444

Adobe ColdFusion Documentation

The variable Message can be used in the page. For example, you could display the contents of the message.txt file
in the final web page as follows:

#Message#

ColdFusion supports functions for manipulating the contents of text files. You can also use the variable that is
created by a cffile action = "read" operation in the ArrayToList and ListToArray functions.
Note
If you use this tag to read a file that is encoded using the Windows Cp1252 (windows-1252)
encoding of the Latin-1 character set on a system whose default character encoding is Cp1252,
and the files has characters encoded in the Hex 8x or 9x range, specify charset="windows-1
252" attribute, even though this is the default encoding. Otherwise, some characters in the
Hex8x and 9x ranges that do not map correctly and display incorrectly.

© 2014 Adobe Systems Incorporated. All rights reserved.

445

Adobe ColdFusion Documentation

cffile action = "readBinary"
Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

Description

Reads a binary file (such as an executable or image file) on the server, into a binary object parameter that you can
use in the page. To send it through a web protocol (such as HTTP or SMTP) or store it in a database, first convert it
to Base64 using the ToBase64 function.
Note
This action reads the file into a variable in the local Variables scope. It is not intended for use
with large files, such as logs, because they can bring down the server.

Syntax



See also

cfdirectory
Attributes

Attribute

Req/Opt

action

Required

Type of file manipulation
that the tag performs.

file

Required

Pathname of a binary fine
to read. If not an absolute
path (starting with a drive
letter and a colon, or a
forward or backward
slash), it is relative to the
ColdFusion temporary
directory, which is
returned by the GetTemp
Directory function.

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

446

Adobe ColdFusion Documentation

variable

Required

Name of variable to
contain contents of binary
file.

Usage

You convert the binary file to Base64 to transfer it to another site.ColdFusion supports reading an image file as a
binary and passing the result to a cfimage, for example:






Example

The following example reads the binary file somewhere.jpg, writes it to a different folder as somewhereB.jpg,
and then displays the new file:







© 2014 Adobe Systems Incorporated. All rights reserved.

447

Adobe ColdFusion Documentation

cffile action = "rename"
Description

Renames or moves a file on the server.
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfdirectory
History

See the History section of the main cffile tag page.
Attributes

Attribute

Req/Opt

action

Required

Type of file manipulation
that the tag performs.

destination

Required

Destination file or
directory. If not an
absolute path, it is relative
to the source directory.

source

Required

Pathname of file to
rename. If not an absolute
path (starting with a drive
letter and a colon, or a
forward or backward
slash), it is relative to the
ColdFusion temporary
directory, which is
returned by the GetTemp
Directory function.

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

448

Adobe ColdFusion Documentation

attributes

Optional

Applies to Windows. A
comma-delimited list of
attributes to set on the file.
If omitted, the file's
attributes are
maintained.Each value
must be specified
explicitly. For example, if
attributes = "readOn
ly", all other attributes
are overwritten.
readOnly
hidden
normal

Optional

mode

Applies only to UNIX and
Linux. Permissions. Octal
values of UNIX chmod co
mmand. Assigned to
owner, group, and other.
For example:
644: assigns read/write
permission to owner;
read permission to
group and other.
777: assigns
read/write/execute
permission to all.

Usage

The rename action renames or move a file. The destination attribute must be a pathname, not just a new name
for the file. If the destination is a directory, the file is moved and not renamed.
Example

Windows example:




UNIX example:

© 2014 Adobe Systems Incorporated. All rights reserved.

449

Adobe ColdFusion Documentation



© 2014 Adobe Systems Incorporated. All rights reserved.

450

Adobe ColdFusion Documentation

cffile action = "upload"
Description

Copies a file to a directory on the server.
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfdirectory, cffile action = "uploadAll", cffileupload
History

The strict attribute has been added in ColdFusion 10. See the History section of the main cffile tag page.
Attributes

Attribute

Req/Opt

action

Required

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description
Type of file manipulation
that the tag performs.

451

Adobe ColdFusion Documentation

destination

Required

Pathname of directory in
which to upload the file. If
not an absolute path
(starting with a drive letter
and a colon, or a forward
or backward slash), it is
relative to the ColdFusion
temporary directory, which
is returned by the GetTem
pDirectory function.
If the destination you
specify does not exist,
ColdFusion creates a file
with the specified
destination name. For
example, if you specify
the destination, C:\XYZ,
ColdFusion creates a file
XYZ in the C: drive.

fileField

Optional

Name of form field used to
select the file. Do not use
number signs (#) to
specify the field name. If
omitted, it defaults to the
name of the first file field
submitted.

accept

Optional

Limits the MIME types to
accept. Comma-delimited
list. For example, the
following code permits
JPEG and Microsoft Word
file uploads:accept = {{"i
mage/jpg,
application/msword"}}The
browser uses the file
extension to determine file
type.

© 2014 Adobe Systems Incorporated. All rights reserved.

452

Adobe ColdFusion Documentation

attributes

Optional

Applies to Windows. A
comma-delimited list of
attributes to set on the file.
If omitted, the file's
attributes are
maintained.Each value
must be specified
explicitly. For example, if
you specify attributes
= "readOnly", all other
attributes are overwritten.
readOnly
hidden
normal (if you use this
option with other
attributes, it is
overridden by them)

mode

Optional

Applies only to UNIX and
Linux. Permissions. Octal
values of chmod comman
d. Assigned to owner,
group, and other,
respectively, for example:
644: assigns read/write
permission to owner;
read permission to
group and other.
777: assigns
read/write/execute
permission to all.

© 2014 Adobe Systems Incorporated. All rights reserved.

453

Adobe ColdFusion Documentation

nameConflict

Optional

Error

Action to take if filename
is the same as that of a
file in the directory.
Error: file is not saved.
ColdFusion stops
processing the page
and returns an error.
Skip: file is not saved.
This option permits
custom behavior based
on file properties.
Overwrite: replaces
file.
MakeUnique: forms a
unique filename for the
upload; name is stored
in the file object variable
serverFile.

result

Optional

strict

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

Lets you specify a name
for the variable in which c
ffile returns the result
(or status) parameters. If
you do not specify a value
for this attribute, cffile
uses the prefix cffile.
For more information, see
Usage.
true

When strict is true, only
MIME types or a
combination of MIME
types and extensions are
allowed in the accept
attribute. Since strict is
true by default, you should
specify MIME types for
the accept attribute. When
strict is false, either MIME
types or extensions or a
combination of both can
be specified as a value to
the accept attribute. For
more information, see this
blog entry.

454

Adobe ColdFusion Documentation

ContinueOnError

Optional

False

By default, when
uploading one of the files
fail, the remaining files will
not be uploaded. If this
value is set to true, file
upload continues evern
after encountering an
upload error. A file upload
error happens due to the
following reasons:
1. Empty file
2. Invalid file type
3. Invalid MIME or
extension
4. File already exists
In the case of an upload
failure, the error details
will be stored in the errors
attribute.

Errors

Optional

cffile.uploadAllErrors

The name of the variable
in which the file upload
errors will be stored.
Errors will be populated in
the specfied variable
name when
continueOnError is
true.After the file upload is
completed, this tag
creates an array of
structures that contains
upload failure information
for each upload failure.
The upload failure
information error structure
contains the following
fields:

© 2014 Adobe Systems Incorporated. All rights reserved.

455

Adobe ColdFusion Documentation

REASON - The reason
for the failure
DETAIL - File upload
failure detail
MESSAGE - A detailed
message depicting the
failure
CLIENTFILE - Name of
the file uploaded from
the client's system
CLIENTFILEEXT Extension of the
uploaded file on the
client system (without a
period)
CLIENTFILENAME Name of the uploaded
file on the client system
(without an extension)
INVALID_FILE_TYPE If the file mime type or
extension is not in the s
pecified accept
attribute. If the reason is
INVALID_FILE_TYPE,
two additional keys will
be available in the
structure.
ACCEPT: list of
mime types or
file extensions
given in the tag
MIMETYPE:
mime type of the
uploaded file
EMPTY_FILE - If the
uploaded file is an
empty file
FILE_EXISTS - If any
file with the given name
already exists in the
destination and the
overwritepolicy is error.
DEST - The destination
where file is copied
FORM_FILE_NOT_FO
UND - If the uploaded
file is not found on the
server

Usage

After a file upload is completed, you can get status information using file upload parameters. To refer to parameters,

© 2014 Adobe Systems Incorporated. All rights reserved.

456

Adobe ColdFusion Documentation

use either the cffile prefix or, if you specified an alternate name in the result attribute, the name you specified
there. For example, if you did not specify a name in the result attribute, access the fileExisted parameter as #
cffile.fileExisted#. If you set the result attribute to myResult, however, access fileExisted as #myRe
sult.fileExisted#. Status parameters can be used anywhere that other ColdFusion parameters can be used.
When you use a cfform tag or an HTML form tag to submit the form with the file to be uploaded, specify enctype
="multipart/form-data" in the tag, as shown in the example for this tag. By default, ColdFusion sends the
form with the encoding type of application/x-www-form-urlencoded, which causes an error in the cffile tag.
The result attribute allows functions or CFCs that get called from multiple pages at the same
time to avoid overwriting the results of one call with another.
Note
The file prefix is deprecated, in favor of the cffile prefix. Do not use the file prefix in new
applications.
If your page is uploading a file that was selected on a form or was otherwise sent to your page
via a multipart/form-data HTTP message, you can determine the approximate size of the file by
checking the value of the CGI.content_length variable. This variable includes the file length
plus the length of any other request content.

The following file upload status parameters are available after an upload:
Parameter

Description

attemptedServerFile

Initial name ColdFusion used when attempting to save
a file

clientDirectory

Directory location of the file uploaded from the client's
system

clientFile

Name of the file uploaded from the client's system

clientFileExt

Extension of the uploaded file on the client system
(without a period)

clientFileName

Name of the uploaded file on the client system (without
an extension)

contentSubType

MIME content subtype of the saved file

contentType

MIME content type of the saved file

dateLastAccessed

Date and time the uploaded file was last accessed

fileExisted

Whether the file existed with the same path (yes or no)

fileSize

Size of the uploaded file in bytes

© 2014 Adobe Systems Incorporated. All rights reserved.

457

Adobe ColdFusion Documentation

fileWasAppended

Whether ColdFusion appended uploaded file to a file (y
es or no)

fileWasOverwritten

Whether ColdFusion overwrote a file (yes or no)

fileWasRenamed

Whether uploaded file renamed to avoid a name
conflict (yes or no)

fileWasSaved

Whether ColdFusion saves a file (yes or no)

oldFileSize

Size of a file that was overwritten in the file upload
operation

serverDirectory

Directory of the file saved on the server

serverFile

Filename of the file saved on the server

serverFileExt

Extension of the uploaded file on the server (without a
period)

serverFileName

Name of the uploaded file on the server (without an
extension)

timeCreated

Time the uploaded file was created

timeLastModified

Date and time of the last modification to the uploaded
file

Note
File status parameters are read-only. They are set to the results of the most recent cffile oper
ation. If two cffile tags execute, the results of the second overwrite the first, unless you have
specified a different result variable in the result attribute.

Example

The following example creates a unique filename, if there is a name conflict when the file is uploaded on Windows:

© 2014 Adobe Systems Incorporated. All rights reserved.

458

Adobe ColdFusion Documentation









#cgi.script_name#
name="uploadForm" enctype="multipart/form-data">








© 2014 Adobe Systems Incorporated. All rights reserved.

459

Adobe ColdFusion Documentation

cffile action = "uploadAll"
Description

Copies all files sent to the page in an HTTP request to a directory on the server.
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cffile action = "upload", cfdirectory
History

ColdFusion 11: Added the attributes ContinueOnError and Errors.
See the History section of the main cffile tag page.
Attributes

Attribute

Req/Opt

action

Required

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description
Type of file manipulation
that the tag performs.

460

Adobe ColdFusion Documentation

destination

Required

Pathname of directory in
which to upload the file. If
not an absolute path
(starting with a drive letter
and a colon, or a forward
or backward slash), it is
relative to the ColdFusion
temporary directory, which
is returned by the GetTem
pDirectory function.

accept

Optional

Limits the MIME types to
accept. Comma-delimited
list. For example, the
following code permits
JPEG and Microsoft Word
file uploads:accept = {{"i
mage/jpg,
application/msword"}}The
browser uses the file
extension to determine file
type.

attributes

Optional

Applies to Windows. A
comma-delimited list of
attributes to set on the file.
If omitted, the file's
attributes are
maintained.Each value
must be specified
explicitly. For example, if
you specify attributes
= "readOnly", all other
attributes are overwritten.
readOnly
hidden
normal (if you use this
option with other
attributes, it is
overridden by them)

© 2014 Adobe Systems Incorporated. All rights reserved.

461

Adobe ColdFusion Documentation

mode

Optional

Applies only to UNIX and
Linux. Permissions. Octal
values of chmod comman
d. Assigned to owner,
group, and other,
respectively, for example:
644: assigns read/write
permission to owner;
read permission to
group and other.
777: assigns
read/write/execute
permission to all.

nameConflict

Optional

Error

Action to take if filename
is the same as that of a
file in the directory.
Error: file is not saved.
ColdFusion stops
processing the page
and returns an error.
Skip: file is not saved.
This option permits
custom behavior based
on file properties.
Overwrite: replaces
file.
MakeUnique: forms a
unique filename for the
upload. The name is
stored in the serverFi
le field of the result
structure for the file.

© 2014 Adobe Systems Incorporated. All rights reserved.

462

Adobe ColdFusion Documentation

ContinueOnError

Optional

False

By default, when
uploading one of the files
fail, the remaining files will
not be uploaded. If this
value is set to true, file
upload continues evern
after encountering an
upload error. A file upload
error happens due to the
following reasons:
1. Empty file
2. Invalid file type
3. Invalid MIME or
extension
4. File already exists
In the case of an upload
failure, the error details
will be stored in the errors
attribute.

Errors

Optional

cffile.uploadAllErrors

The name of the variable
in which the file upload
errors will be stored.
Errors will be populated in
the specfied variable
name when
continueOnError is
true.After the file upload is
completed, this tag
creates an array of
structures that contains
upload failure information
for each upload failure.
The upload failure
information error structure
contains the following
fields:

© 2014 Adobe Systems Incorporated. All rights reserved.

463

Adobe ColdFusion Documentation

REASON - The reason
for the failure
DETAIL - File upload
failure detail
MESSAGE - A detailed
message depicting the
failure
CLIENTFILE - Name of
the file uploaded from
the client's system
CLIENTFILEEXT Extension of the
uploaded file on the
client system (without a
period)
CLIENTFILENAME Name of the uploaded
file on the client system
(without an extension)
INVALID_FILE_TYPE If the file mime type or
extension is not in the s
pecified accept
attribute. If the reason is
INVALID_FILE_TYPE,
two additional keys will
be available in the
structure.
ACCEPT: list of
mime types or
file extensions
given in the tag
MIMETYPE:
mime type of the
uploaded file
EMPTY_FILE - If the
uploaded file is an
empty file
FILE_EXISTS - If any
file with the given name
already exists in the
destination and the
overwritepolicy is error.
DEST - The destination
where file is copied
FORM_FILE_NOT_FO
UND - If the uploaded
file is not found on the
server

© 2014 Adobe Systems Incorporated. All rights reserved.

464

Adobe ColdFusion Documentation

Optional

result

Lets you specify a name
for the variable in which c
ffile returns the result
(or status) parameters. If
you do not specify a value
for this attribute, cffile
uses the prefix cffile.
For more information, see
Usage.

Usage

Unlike cffile action="upload", which uploads only one file at a time cf fileaction="uploadall" upload
s multiple files thereby eliminating the need to code multiple cffile action="upload" statements. Use this tag
in the page specified by the action attribute of a cffileupload control. This tag uploads save the files that the c
ffileupload control sends when the user clicks the Save File button. After a file upload is completed, this tag
creates an array of structures specified by the result parameter. Each structure in the array contains upload result
information for one file. For information on the result structure contents, see cffile action = "upload".
Note
You can control the maximum file size of the upload by specifying the server Request Throttle
Threshold or the Settings page of the Administrator Server Settings section.

Example

The following example copies files uploaded by a cffileupload tag to a temp directory.














© 2014 Adobe Systems Incorporated. All rights reserved.

465

Adobe ColdFusion Documentation

cffile action = "write"
Description

Writes a text file on the server, based on dynamic content. You can create static HTML files from the content, or log
actions in a text file.
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfdirectory
History

See the History section of the main cffile tag page.
Attributes

Attribute

Req/Opt

action

Required

Type of file manipulation
that the tag performs.

file

Required

Pathname of the file to
write. If not an absolute
path (starting with a drive
letter and a colon, or a
forward or backward
slash), it is relative to the
ColdFusion temporary
directory, which is
returned by the GetTemp
Directory function.

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

466

Adobe ColdFusion Documentation

output

Required

addNewLine

Optional

attributes

Optional

Content of the file to be
created.
yes

yes: appends newline
character to text written
to file.
no
Applies to Windows. A
comma-delimited list of
attributes to set on the file.
If omitted, the file's
attributes are
maintained.Each value
must be specified
explicitly. For example, if
you specify attributes
= "readOnly", all other
attributes are overwritten.
readOnly
hidden
normal

charset

Optional

JVM default file character
set

The character encoding in
which the file contents is
encoded. The following
list includes commonly
used values:
utf-8
iso-8859-1
windows-1252
us-ascii
shift_jis
iso-2022-jp
euc-jp
euc-kr
big5
euc-cn
utf-16
For more information
character encodings,
see www.w3.org/Intern
ational/O-charset.html.

© 2014 Adobe Systems Incorporated. All rights reserved.

467

Adobe ColdFusion Documentation

fixnewline

Optional

mode

Optional

no

yes: changes
embedded line-ending
characters in string
variables to
operating-system
specific line endings.
no: does not change
embedded line-ending
characters in string
variables.
Applies only to UNIX and
Linux. Permissions. Octal
values of UNIX chmod
command. Assigned to
owner, group, and other,
respectively; for example:
644: assigns read/write
permission to owner;
read permission to
group and other.
777: assigns
read/write/execute
permission to all.

Example

This example creates a file with information a user entered in an HTML insert form:



If the user submitted a form with the following:

UpdateTitle = "FieldWork"
FullName = "World B. Frueh"
Date = "10/30/01"
Content = "We had a wonderful time in Cambridgeport."

ColdFusion would create a file named FieldWork.txt in the c:\files\updates\ directory and the file would contain the
following text:

© 2014 Adobe Systems Incorporated. All rights reserved.

468

Adobe ColdFusion Documentation

Created By: World B. Frueh
Date: 10/30/01
We had a wonderful time in Cambridgeport.

This example shows the use of the mode attribute for UNIX. It creates the file /tmp/foo with permissions rw-r-r(owner = read/write, group = read, other = read):



This example appends to the file and sets permissions to read/write (rw) for all:



This example uploads a file and gives it the permissions owner/group/other = read/write/execute):

cffile action = "upload"
fileField = "fieldname"
destination = "/tmp/program.exe"
mode = 777>

This example uses the fixnewline attribute to changes embedded line-ending characters in xmlString, which is
derived from xmlData, to operating-system specific line endings.

© 2014 Adobe Systems Incorporated. All rights reserved.

469

Adobe ColdFusion Documentation



This is some plain text












ColdFusion supports using cffile to write an image, for example:








© 2014 Adobe Systems Incorporated. All rights reserved.

470

Adobe ColdFusion Documentation

cffileupload
Description

Displays a dialog for uploading multiple files from the user's system. The enhanced dialog includes the following
features:
You can specify the maximum number of files and the maximum file size for the upload.
A progress bar to visually indicate the overall progress of the file upload task, and another progress bar to
indicate the upload progress of each individual file.
A success or failure message appears for each file upload and the overall upload task.
At any point during the upload task, you can cancel the upload.
Category

File management tags, Forms tags
Syntax


addbuttonlabel= "label"
align = align="center|left|right"
bgcolor = "color"
clearbuttonlabel = "label"
deletebuttonlabel = "label"
extensionfilter = "none|jpg,jpeg,png"
height= "number of pixels"
hideUploadButton = "true|false"
maxfileselect = "number of files"
maxuploadsize = "file size in mega bytes"
name = "File uploader name"
oncomplete = "JavaScript function name"
onerror = "JavaScript function name"
onUploadComplete = "JavaScript function name"
progressbar = "true|false"
stoponerror = "true|false"
style = "style specification"
title = "Title panel name"
uploadbuttonlabel = "label"
url = "URL"
width = "number of pixels"
wmode = "window|opaque|transparent"


Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cffile action = "uploadAll"
History

© 2014 Adobe Systems Incorporated. All rights reserved.

471

Adobe ColdFusion Documentation

ColdFusion 9: Added this tag.
Attributes

Attribute

Req/Opt

Default

Description

addbuttonlabel

Optional

Add Files

Label of the Add button.

align

Optional

left

Specifies the default
alignment.
The following values are
valid:
center
left
right

bgcolor

Optional

The background color for
the file upload control. A
hexadecimal value without
"#" prefixed or a
recognized color name,
for example red.

clearbuttonlabel

Optional

Clear All

Label of the Clear button

deletebuttonlabel

Optional

Delete

Label of the Delete button

extensionfilter

Optional

none

Use this attribute to
specify the type of file that
you will allow to be
uploaded. For example, to
let only image files to be
uploaded, you can specify
file extensions such as
.jpg, .jpeg, or .png.
If set to none, files are
uploaded without any
extension filter.

height

Optional

300

Height of the file upload
control, in pixels.

hideUploadButton

Optional

false

A Boolean value that
specifies if the Upload
button should appear in
the file upload dialog:
true
false

© 2014 Adobe Systems Incorporated. All rights reserved.

472

Adobe ColdFusion Documentation

maxfileselect

Optional

The maximum number of
files allowed for upload.

maxuploadsize

Optional

name

Optional

Name of the file upload
component.

onComplete

Optional

The JavaScript function to
run when a file has
finished uploading.By
default, ColdFusion
passes a JavaScript
object as a parameter to
this function with the
following properties:

10MB

The maximum file size, in
Megabytes, allowed for
upload in an
operation.ColdFusion
throws an error if the
value of the attribute
maxuploadsize exceeds
the throttle/ post data size
settings specified in the
ColdFusion Administrator.

STATUS - numeric value
that is based on the
HTTP status code
MESSAGE - Passed or
Failed
FILENAME - Name of
the file selected for
upload
You can also pass the
JavaScript object by
creating a struct with
parameters "status" and
"message" and call
serializeJSON() on the
JavaScript object.

© 2014 Adobe Systems Incorporated. All rights reserved.

473

Adobe ColdFusion Documentation

onError

Optional

The JavaScript function to
run if the uploading of a
file fails. The error can be
a network error or
server-side error. By
default, ColdFusion
passes a JavaScript
object as a parameter to
this function with the
following properties:
STATUS - numeric
value that is based on
the HTTP status code
MESSAGE - Passed or
Failed
FILENAME - Name of
the file selected for
upload
You can also pass the
JavaScript object by
creating a struct with
parameters "status" and
"message" and call
serializeJSON() on the
JavaScript object.

onUploadComplete

Optional

progressbar

Optional

The JavaScript function to
run after uploading all the
files.
true

Whether to display a
progress bar while the
files upload:
true
false

stoponerror

Optional

true

Specifies whether to
ignore the exceptions for
this operation.
true - Stops uploading
and displays an
appropriate error.
false - Continues
uploading and displays
an appropriate error.

style

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

A CSS style specification
that defines layout styles.

474

Adobe ColdFusion Documentation

title

Optional

Title for the upload dialog.

uploadbuttonlabel

Optional

url

Optional

width

Optional

420

Width of the file upload
control, in pixels.

wmode

Optional

window

Specifies the absolute
positioning and layering
capabilities in your
browser:

Upload

Label of the Upload
button.
The URL to the server
where the files are
uploaded.
The attribute is optional
and it defaults to
cgi.script_name.

window: Plays the
media player in its own
rectangular window on
a web page
opaque: Hides
everything behind the
media player on the
web page
transparent: Lets the
background of the web
page show through the
transparent portions of
the media player

Usage

Use this tag to create a SWF file-based file upload control that lets a user upload multiple files to a server. To upload
files to the server, define a server-side template. The template that you define reads the upload request and uploads
the selected files to the server.
Enhancements made in ColdFusion 9.0.1

In ColdFusion 9.0.1, the fileupload control passes the session information implicitly to the target page if session
management is turned on either in Application.cfc or Application.cfm.Assume that fileupload control is defined
without a URL attribute. In this case, if the user chooses to upload data using the upload button, the control comes
back to the same page. Users can check for form.fieldnames to perform the upload as shown in the following
example:Upload.cfm

© 2014 Adobe Systems Incorporated. All rights reserved.

475

Adobe ColdFusion Documentation






In this case, url defaults to CGI.script_name.
To maintain sessions between the fileupload control and the URL, users must turn on session management. You
can do this by setting the this.sessionmanagement=true in Application.cfc. The setting ensures that CFID and
CFtoken are passed as part of the URL if Enable J2EE Session Variables (ColdFusion Administrator > Server
Settings > Memory Variables) is not selected. If it is selected, then JsessionID is passed as part of the URL.
Supported Styles

The following are the supported styles:
Style

Description

headercolors

Format: color; colors of the band at the top of the
DateChooser control. Specify two values, separated by
a comma. For a solid band, use the same color for both
values. The default value is ##E6EEEE,##FFFFFF.

textcolor

Color of text. Can be a hexadecimal value or a named
color. For a hexadecimal value, use the
form"##xxxxxx", where x = 0-9 or A-F; use two number
signs or none.

titletextalign

Aligns the title text. The recognized values are left,
right, and center. The default value is right.

titletextcolor

Color of the title text.

bgcolor

The background color for the file upload control. A
hexadecimal value without "#" prefixed or a recognized
color name, for example red.

rollovercolor

Displays values on mouse-over.

selectcolor

Background color for a selected item. Can be a
hexadecimal value or a named color.
For a hexadecimal value, use the form "##xxxxxx",
where x = 0-9 or A-F; use two number signs or none.
For a list of the supported named colors, see cfchart.

Example

© 2014 Adobe Systems Incorporated. All rights reserved.

476

Adobe ColdFusion Documentation


Instructions


Create a folder Upload in your C: drive

Try uploading files using the file upload component and check if the files have
been appropriately saved in the Upload folder.




uploadfiles.cfm is given below:


#serializeJSON({STATUS=200,MESSAGE='Passed'})#

This example sends user-specified files to the server-side template - uploadfiles.cfm. The template file that you
define can use the "upload" or "uploadall" action defined in the cffile tag.
Note
The filefield attribute of the upload action is optional.

Use the destination attribute in the cffile tag to define the location to save the files. For the uploadfiles.cfm
code, see cffile action = "uploadAll".

© 2014 Adobe Systems Incorporated. All rights reserved.

477

Adobe ColdFusion Documentation

cffinally
Description

Used inside a cftry tag. Code in the cffinally block is processed after the main cftry code and, if an
exception occurs, the cfcatch code. The cffinally block code always executes, whether or not there is an
exception.
Category

Exception handling tags
Syntax


try code 
catch code 
...

final code 


See also

cftry, cfcatch, cferror, cfrethrow, cfthrow, onError; Handling Errors in the Developing ColdFusion
Applications
History

ColdFusion 9: Added the tag
Usage

The cffinally tag is optional in a cftry block, and the block can have only one cffinally tag. Put the cffina
lly tag at the end of all cftry block, after any cfcatch blocks. This tag requires an end tag. You can nest
cftry/cfcatch/cffinally blocks.Use the cffinally tag for code that should execute whether or not an exception
occurs. For example, use it to free up resources.
Example

© 2014 Adobe Systems Incorporated. All rights reserved.

478

Adobe ColdFusion Documentation


cffinally Example



....

....


....

....


© 2014 Adobe Systems Incorporated. All rights reserved.

479

Adobe ColdFusion Documentation

cfflush
Description

Flushes currently available data to the client.
Category

Data output tags, Page processing tags
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfcache, cfheader, cfinclude, cfsetting, cfsilent
Attributes

Attribute

Req/Opt

interval

Optional

Default

Description
Integer. Flushes output
each time this number of
bytes becomes available.
HTML headers, and data
that is already available
when the tag is executed,
are omitted from the
count.

Usage

The first occurrence of this tag on a page sends back the HTML headers and any other available HTML.
Subsequent cfflush tags on the page send only the output that was generated after the previous flush.
When you flush data, ensure that enough information is available, as some browsers might not respond if you flush
only a small amount. Similarly, set the interval attribute for a few hundred bytes or more, but not thousands of
bytes.Use the interval attribute only when a large amount of output is sent to the client, such as in a cfloop or a
cfoutput of a large query. Using this form globally (such as in the Application.cfm file) might cause unexpected
errors when CFML tags that modify HTML headers are executed. Because the cfflush tag sends data to the
browser when it executes, it has several limitations, including the following:
Using any of the following tags or functions on a page anywhere after the cfflush tag can cause errors or
unexpected results: cfcontent, cfcookie, cfform, cfheader, cfhtmlhead, cflocation, and SetLo

© 2014 Adobe Systems Incorporated. All rights reserved.

480

Adobe ColdFusion Documentation

cale. Similarly, do not use any tags that use AJAX features, including cfdiv, cflayout, cflayoutarea,
cfpod, cfsprydataset, cftooltip, cfwindow, or HTML format cfgrid, cftree, cftextarea, or cfi
nput (using autosuggest or datefield attributes) tags. All of the preceding tags and functions normally
modify the HTML header, but cannot do so after a cfflush tag, because the cfflush sends the header.
Using the cfset tag to set a cookie anywhere on a page that has a cfflush tag does not set the cookie in
the browser.
Using the cfflush tag in the body of several tags, including cfsavecontent, cfquery, and custom tags,
causes errors.
If you save Client variables as cookies, any client variables that you set after a cfflushtag are not saved in
the browser.
Note
Normally, the cferror tag discards the current output buffer and replaces it with the
contents of the error page. The cfflush tag discards the current buffer. As a result, the E
rror.GeneratedContent variable resulting from a cferror tag after a cfflush cont
ains any contents of the output buffer that has not been flushed. This content is not sent to
the client. The content of the error page displays to the client after the bytes that have
been sent.

Example

The following example uses cfloop tags and the rand random number generating function to delay data display. It
simulates a page that is slow to generate data.


Your Magic numbers


It will take us a little while to calculate your ten magic numbers. It takes a
lot of work to find numbers that truly fit your personality. So relax for a minute
or so while we do the hard work for you.


We are sure you will agree it was worth the short wait!













Magic number #Myindex# is:  #RandRange
(100000, 999999)#





© 2014 Adobe Systems Incorporated. All rights reserved.

481

Adobe ColdFusion Documentation

cfformgroup
Description

Creates a container control for multiple form controls. Used in the cfform tag body of Adobe Flash and XML forms.
Ignored in HTML forms.
Category

Forms tags
Syntax


width = "pixels"
height = "pixels"
enabled = "yes|no"
visible = "yes|no"
onChange = "ActionScript expression"
tooltip = "text"
id = "unique identifier">
...ColdFusion forms controls...

OR

startrow = "row number"
...ColdFusion forms controls


Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfapplet, cfcalendar, cfform, cfformitem, cfgrid, cfinput, cfselect, cfslider, cftextarea, and c
ftree
History

ColdFusion MX 7: Added this tag.
Attributes

© 2014 Adobe Systems Incorporated. All rights reserved.

482

Adobe ColdFusion Documentation

The following table lists the attributes and their behavior in Flash forms. For XML, if not otherwise noted, the
attribute is passed to the XML but is not interpreted by the basic XSL style sheet provided with ColdFusion.
Note
Attributes that are not marked as supported in XML are not handled by the skins provided with
ColdFusion. They are, however, included in the generated XML.

Attribute

Req/Opt; formats

type

Required;Flash and XML

Default

Description
XML: Can be any XForms
group type defined in the
XSLT. The XSL skins
provided with ColdFusion
support the following
types:
horizontal: align
child tags horizontally
within a form and put
this tag's label attribut
e to the left of the
children.
vertical: align child
tags vertically within a
form and put this tag's l
abel attribute to the left
of the children.
fieldset:
corresponds to the
HTML fieldset tag,
which groups its
children, typically by
drawing a box around
them and replacing part
of the top line with
legend text. To specify
the legend, use the lab
el attribute. To specify
the box dimensions,
use the style attribute
with height and widt
h values. Explicitly use
cfformgroup type="
vertical" inside this
formgroup to align its
child tags vertically.

© 2014 Adobe Systems Incorporated. All rights reserved.

483

Adobe ColdFusion Documentation

Flash: Must be one of the
following:
repeater: dynamically
creates an instance of
the cfformgroup's
child tag or tags for
each row of a query
object, without requiring
ColdFusion to
recompile the Flash
SWF file when the
number of rows
changes.
horizontal: aligns
child tags horizontally
within a form and put
this tag's label attribut
e to the left of the
children. Use this tag to
arrange individual
controls horizontally.
vertical: aligns child
tags vertically within a
form and puts this tag's
label attribute to the
left of the children. Use
this tag to arrange
individual controls
vertically.
hbox: aligns children
horizontally. Use this
type to arrange groups
of form controls
horizontally. Do not use
this attribute to align
individual controls
horizontally, because
the child controls do not
align properly; use the
horizontal type instead.
vbox: aligns children
vertically. Use this type
to arrange groups of
controls vertically. Do
not use this attribute to
align individual controls
vertically, because the
child controls do not
align properly; use the
vertical type instead.

© 2014 Adobe Systems Incorporated. All rights reserved.

484

Adobe ColdFusion Documentation

hdividedbox: aligns
children horizontally.
Each child is in a box
with a border, and there
are dividers between
the boxes that users
can move to change the
relative sizes of the
children. Use a tag with
this attribute to arrange
groups of form controls
horizontally. You cannot
use this attribute to
align individual controls
horizontally.
vdividedbox: aligns
children vertically. Each
child is in a box with a
border, and there are
dividers between the
boxes that users can
move to change the
relative sizes of the
children. Use this type
to group form controls,
for example as a unit in
an hbox form group. Do
not use this attribute to
align individual tags
vertically.
panel: a container
consisting of a title bar
containing the label at
tribute text, a border,
and a content area with
vertically arranged
children.
tile: places the
children in a rectangular
grid.
accordion: places
each child in a pleat of
an expanding and
contracting accordion.
Define each pleat using
a cfformgroup
type="page" tag.

© 2014 Adobe Systems Incorporated. All rights reserved.

485

Adobe ColdFusion Documentation

tabnavigator: places
the children in a tabbed
dialog box. Define each
tab by using a cfformg
roup type="page" ta
g.
page: places the
children tags, aligned
vertically, in a single tab
of a parent tabnavigator
or pleat of an accordion
container.
query

Required for type=
repeater, ignored
otherwise;Flash

enabled

Optional;Flash

height

Optional; Flash

Height of the group
container, in pixels. If you
omit this attribute, Flash
automatically sizes the
container height. Ignored
for Flash repeater type.

id

Optional;Flash

Unique identifier for the
form group. When using
the tabnavigator or
accordion type, specify
the id attribute to
reference the controls
through custom
ActionScript.

© 2014 Adobe Systems Incorporated. All rights reserved.

The query to use with the
repeater. Flash creates an
instance of each of the cf
formgroup tag's child
tags for each row in the
query. You can use the b
ind attribute in the child
tags to use data from the
query row for the
instance.
yes

Boolean value that
specifies whether the
controls in the form group
are enabled. Disabled
controls appear in light
gray.

486

Adobe ColdFusion Documentation

label

Optional;Flash and XML

Label to apply to the form
group. In Flash, does the
following:
For a page or panel
form group, determines
the label to put on the
corresponding
accordion pleat, the
tabnavigator tab, or the
panel title bar. For a
Flash horizontal or
vertical form group,
specifies the label to put
to the left of the group.
Ignored in Flash for
repeater, hbox,
hdividedbox, vbox,
vdividedbox, tile,
accordion, and
tabnavigator types.

maxrows

Optional;Flash

Used only for the repeat
er type; ignored
otherwise.Specifies the
maximum number of
query rows to use in the
Flash form repeater. If the
query has more rows than
the sum of the startrow
attribute and this value,
the repeater does not use
the remaining rows.

onChange

Optional;Flash

Tabnavigator and
accordion types only:
ActionScript expression or
expressions to execute
when a new tab or
accordion page is
selected. Note: The onCh
ange event occurs when
the form first appears.

© 2014 Adobe Systems Incorporated. All rights reserved.

487

Adobe ColdFusion Documentation

selectedIndex

Optional; Flash only

startrow

Optional;Flash

style

Optional;Flash and XML

Flash: a Flash style
specification in CSS
format. For detailed
information on specifying
Flash styles, see Creating
Forms in Flash in the Dev
eloping ColdFusion
Applications.XML: an
inline CSS style
specification.

tooltip

Optional;Flash

Text to display when the
mouse pointer hovers in
the form group area. If a
control in the form group
also specifies a tooltip,
Flash displays the
control's tooltip when the
mouse pointer hovers
over the control.

visible

Optional;Flash

© 2014 Adobe Systems Incorporated. All rights reserved.

Used only for accordion
and tabnavigator types;
ignored otherwise.
Specifies the page control
to display as open, where
0 (not 1) specifies the first
page control defined in
the group.
0

yes

Used only for the repeat
er type; ignored
otherwise.Specifies the
row number of the first
row of the query to use in
the Flash form repeater.
This attribute is
zero-based: the first row is
row 0, not row 1 (as in
most ColdFusion tags).

Boolean value specifying
whether the controls in the
form group are visible. If
the controls are invisible,
the space that would be
occupied by visible
controls is blank.

488

Adobe ColdFusion Documentation

width

Optional;Flash and XML

Width of the group
container, in pixels. If you
omit this attribute, Flash
automatically sizes the
container width. Ignored
for Flash repeater type.

Usage

This tag requires an end tag. This tag is ignored if the cfform type is HTML; any tag body's contents are interpreted
as if the surrounding cfformgroup does not exist.
In Flash format forms, this tag organizes the contents of the form. It groups and arranges child tags. The body of this
tag can contain the following tags; all other tags and text are ignored:
cfformitem
cfcalendar
cfgrid
cfinput
cfselect
cftextarea
cftree

For more information on using this tag in Flash forms, see Creating Forms in Flash in the Developing ColdFusion
Applications. In XML format, ColdFusion passes the tag and its attributes to the XML; it is the responsibility of the
skin XSLT to handle the XML. The ColdFusion basic skin supports the horizontal, vertical, and dualselect
list styles only. For more information on using this tag in XML forms, see Creating Forms in Flash in the Developin
g ColdFusion Applications.
Example

For a simple example of an XML form that uses a single cfformgroup tag, see cfform.
The following example shows how to use the cfformgroup tag to arrange elements on a Flash form. It creates an
hdividedbox container that has a vbox container on each side. The left box has heading text and two radio buttons.
The right box has heading text and three check boxes.

© 2014 Adobe Systems Incorporated. All rights reserved.

489

Adobe ColdFusion Documentation


Simple cfformgroup Example





Pets:






Fruits:








The following more complex example shows more fully how you can use cfformgroup tags to arrange controls in
a Flash form. It also shows many of the text formatting features that you can use in a text cfformgroup body.
When you submit the form, the page dumps the contents of the Forms scope, to show you the submitted data.


cfformgroup Example



The form submitted the following information to ColdFusion:







A Flash form using cfformgroup tags





This form has two tabs, asking for the following:


  • contact information
    • 

  • preferences
    • 
Try entering information on both tabs
    
Submit the form and see what ColdFusion gets in the Forms scope.
    


This link displays the home page in a new browser window

    
 
    
    




© 2014 Adobe Systems Incorporated. All rights reserved.

490

Adobe ColdFusion Documentation







Flash fills the email field in automatically.
You can replace any of the text.








Tell us your preferences






Pets:









Fruits:


<--- Flash requires unique names for all controls --->









© 2014 Adobe Systems Incorporated. All rights reserved.

491

Adobe ColdFusion Documentation









© 2014 Adobe Systems Incorporated. All rights reserved.

492

Adobe ColdFusion Documentation


    

© 2014 Adobe Systems Incorporated. All rights reserved.

493

Adobe ColdFusion Documentation

cfformitem
Description

Inserts a horizontal line, a vertical line, a spacer, or text in a Flash form. Used in the cfform or cfformgroup tag
body for Flash and XML forms. Ignored in HTML forms.
Category

Forms tags
Syntax


OR

...text 

Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfapplet, cfform, cfformgroup, cfgrid, cfinput, cfselect, cfslider, cftextarea, cftree, Adding
text, images, rules, and space with the cfformitem tag in Building Flash forms in the Developing ColdFusion
Applications
History

ColdFusion MX 7.01: Added the "script" value for type attribute.
ColdFusion MX 7: Added tag
Attributes

The following table lists the attributes and their behavior in Flash forms. For XML format, if not otherwise noted, the

© 2014 Adobe Systems Incorporated. All rights reserved.

494

Adobe ColdFusion Documentation

attribute is passed to the XML but is not interpreted by the basic XSL style sheet provided with ColdFusion.
Note
Attributes that are marked as Flash only are not handled by the skins provided with ColdFusion.
They are, however, included in the generated XML in all controls except text and html types.

Attribute

Req/Opt; formats

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

495

Adobe ColdFusion Documentation

type

Required;Flash and XML

Flash:
html: place the text in
the body of this tag on
the form. For Flash
forms, you can use the
following text formatting
tags, most of which
correspond to HTML
tags, in the text: a, b, b
r, font, i, img, li, p,
textformat, and u.
For details on using
these formatting tags,
see the Flash
documentation. The st
yle attribute has no
effect on the format of
the text in type.
text: place the text in
the body of this tag on
the form verbatim,
without interpreting any
markup. You can
control the overall
appearance of the text
by using the style attri
bute.
spacer: places an
invisible spacer of the
specified height and
width on the form. Used
to place space between
form controls. This tag
must not have any
children.
hrule: places a
horizontal rule on the
form. This tag must not
have any children.
vrule: places a vertical
rule on the form. This
tag must not have any
children.
script: lets you create
functions in Flash
forms, which reduces
the possibility of
reaching the 64 KB
limit.

© 2014 Adobe Systems Incorporated. All rights reserved.

496

Adobe ColdFusion Documentation

XML:
html: puts the CFML
tag's body text in a
CDATA section in an
XML xf:output eleme
nt.
text: XML-formats
(escapes characters
such as <) the CFML
tag's body text and puts
it in a CDATA section in
an XML xf:output ele
ment.
hrule: puts an hr tag
in the output. Use the s
tyle attribute to
specify all rule
characteristics,
including height and
width. This tag must not
have any children.
Any other string:
generates an XML xf:
group element with the
type name as the appe
arance attribute. The
CFML tag body is put in
a CDATA section in a c
f:attribute name="
body" element. The
XSL transforms
provided with
ColdFusion ignore
these elements.

© 2014 Adobe Systems Incorporated. All rights reserved.

497

Adobe ColdFusion Documentation

bind

Optional;Flash

enabled

Optional;Flash

height

Optional;Flash

© 2014 Adobe Systems Incorporated. All rights reserved.

A Flash bind expression
that populates the field
with information from
other form fields. If you
use this attribute,
ColdFusion ignores any
text that you specify in the
body of the cftextitem
tag. This attribute can be
useful if the cfformitem
tag is in a cfformgroup
type="repeater" tag.
For more information, see
Flash form data binding in
the cfinput tag
description.
yes

Boolean value that
specifies whether the
control is enabled.
Disabled text appear in
light gray. Has no effect
on spacers and rules.
Height of the item, in
pixels. If you omit this
attribute, Flash
automatically sizes the
height. In ColdFusion XSL
skins, use the style attri
bute, instead.

498

Adobe ColdFusion Documentation

style

Optional;Flash and XML

Flash:
Must be a style
specification in CSS
format.
Ignored if the type attribu
te is html.
For detailed information
on specifying Flash styles,
see Creating Forms in
Flash in the Developing
ColdFusion Applications.
Not used with the spacer
type.
XML:
ColdFusion passes the
style attribute to the
XML. ColdFusion skins
include the style
attribute in the
generated HTML.

tooltip

Optional;Flash

visible

Optional;Flash

width

Optional;Flash

Text to display when the
mouse pointer hovers
over the control. Has no
effect on spacers.
yes

Boolean value that
specifies whether to show
the control. Space that
would be occupied by an
invisible control is blank.
Has no effect on spacers.
Width of the item, in
pixels. If you omit this
attribute, Flash
automatically sizes the
width. In ColdFusion XSL
skins, use the style attri
bute, instead.

Usage

This tag requires an end tag or a slash before the closing end character of the opening tag, as the following example
shows:



© 2014 Adobe Systems Incorporated. All rights reserved.

499

Adobe ColdFusion Documentation

For more information on using this tag in Flash forms, see Creating Forms in Flash in the Developing ColdFusion
Applications.
Example

The following example shows a simple Flash form by using horizontal rules and text:


    cfformitem Example
    



This simple form has two hrule cfformitem tags around the cfformitem tag that
contains this text.




For a more complex form, see cfformgroup.

© 2014 Adobe Systems Incorporated. All rights reserved.

500

Adobe ColdFusion Documentation

cfftp
Description

Lets users implement File Transfer Protocol (FTP) operations.
Category

File management tags, Internet protocol tags
Syntax

The tag syntax depends on the action attribute value. See the following sections:
cfftp: Opening and closing FTP server connections
cfftp: Opening and closing secure FTP server connections
cfftp: Connection: file and directory operations
cfftp action = "listDir"
See also

cfhttp, cfldap, cfmail, cfpop; Performing file operations with cfftp in Interacting with Remote Servers in the De
veloping ColdFusion Applications
History

ColdFusion 8: Added the fingerprint, key, paraphrase, and secure attributes to support secure FTP. Added
the values ="quote", "site", "allo", and "acct" to the action attribute.ColdFusion MX 7: Added the res
ult attribute for file and directory operations.ColdFusion MX: Deprecated the agentname attribute. It might not
work, and might cause an error, in later releases.
Usage

Use this tag to move files between a ColdFusion server and an FTP server.
This tag does not move files between a ColdFusion server and a client browser. You do this as follows:
To transfer files from a client to a ColdFusion server: cffile action = "upload"
To transfer files from a ColdFusion server to a client: the cfcontent tag
Security settings

ColdFusion security settings can prevent the cfftp tag from executing. If you run ColdFusion applications on a
server that is used by multiple customers, consider the security of the files that the customer can move. For more
information, see the Administering ColdFusion Security section of Configuring and Administering ColdFusion.

© 2014 Adobe Systems Incorporated. All rights reserved.

501

Adobe ColdFusion Documentation

cfftp: Opening and closing FTP server connections
Description

To establish a connection with an FTP server, use the open action with a connection attribute.
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfhttp, cfldap, cfmail, cfpop
Attributes

Attribute

Req/Opt

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

502

Adobe ColdFusion Documentation

action

Required

FTP operation to perform.
open: creates an FTP
connection.
close: terminates an
FTP connection.
quote: sends a
command verbatim to
the FTP server.
site: executes a
site-specific command.
allo: allocates
memory for operations,
such as putting large
files, on the server.
acct: sends account
information on systems
that require it.

actionparam

Optional

Used only when action i
s quote, site, or acct.
Specifies the command
when action is quote or
site; specifies account
information when action
is acct.

buffersize

Optional

Buffer size in bytes.

connection

Optional, but always used
with open or close

Name of the FTP
connection. If you specify
the username, passwor
d, and server attributes,
and if no connection
exists for them,
ColdFusion creates one.
Calls to cfftp with the
same connection name
reuse the connection.

passive

Optional

password

Required if action =
"open"

port

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

no

yes: enables passive
mode.
no
Password to log in the
user.

21

Remote port to which to
connect.

503

Adobe ColdFusion Documentation

proxyServer

Optional

String. Name of proxy
server (or servers) to use,
if proxy access is
specified.

retryCount

Optional

server

Required if action =
"open"

stopOnError

Optional

yes

timeout

Optional

30

username

Required if action =
"open"

1

Number of retries until
failure is reported.
FTP server to which to
connect; for example, ftp
.myserver.com.
yes: halts processing,
displays an appropriate
error.
no: if secure="no",
populates these
variables:
cfftp.succeeded: y
es or no.
cfftp.errorCode:
error number. See the
IETF Network Working
Group RFC 959: File
Transfer Protocol (FTP)
at www.ietf.org/rfc/rfc09
59.txt.
cfftp.errorText:
Message text.
For conditional
operations, use cfftp.
errorCode. Do not
use cfftp.errorTex
t for this purpose.
Value in seconds for the
time-out of all operations,
including individual data
request operations.
User name to pass in the
FTP operation.

Usage

When you establish a connection with cfftp action="open" and specify a name in the connection attribute,
ColdFusion caches the connection so that you can reuse it to perform additional FTP operations. When you use a
cached connection for subsequent FTP operations, you do not have to specify the username, password, or serve
r connection attributes. The FTP operations that use the same connection name automatically use the
information stored in the cached connection. Using a cached connection helps save connection time and improves

© 2014 Adobe Systems Incorporated. All rights reserved.

504

Adobe ColdFusion Documentation

file transfer performance. You do not need to open a connection for single, simple, FTP operations, such as GetFil
e or PutFile.
With any action except close, you can set the internal buffer size by specifying buffersize. If you specify quote,
site, allo, or acct as the action and set secure="yes" an error is generated. You specify the command to
send to the FTP server in the actionparam attribute when you specify site or quote as the action. When site is
the action, you use the actionparam attribute to specify the site-specific information.
To keep a connection open throughout a session or longer, put the connection name in the Session or Application
scope; for example, specify connection="Session.FTPConnection". However, if you do this, you must specify
the full variable name in all FTP operations, and you must use the close action when you are finished. Keeping a
connection open prevents others from using the FTP server; so close a connection as soon as possible. If you do
not assign the connection name to Session or Application variable, the connection remains open for the current
page only, and you do not have to close it manually. Changes to a cached connection, such as changing retryCou
nt or timeout values, might require reestablishing the connection.
Example


    cfftp lets users implement File Transfer Protocol operations. By default, cfftp
caches
an open connection to an FTP server.
    

    cfftp operations are usually of two types:
    

      

    • Establishing a connection

    • Performing file and directory operations

    

    This example opens and verifies a connection, lists the files in a directory, and
closes
the connection.
    

    Open a connection
    


    Did it succeed? #cfftp.succeeded#

    List the files in a directory:


#name#
    
    

    Close the connection:
    


    Did it succeed? #cfftp.succeeded#

© 2014 Adobe Systems Incorporated. All rights reserved.

505

Adobe ColdFusion Documentation

cfftp: Opening and closing secure FTP server connections
Description

To establish a connection with a secure FTP server, use the open action with a connection attribute, specify that
secure = "yes", and specify the key, passphrase, and fingerprint as appropriate.


passphrase = "passphrase"
password = "password"
port = "port"
proxyServer = "proxy server"
retryCount = "number"
secure = "yes|no"
server = "server"
stopOnError = "yes|no"
timeout = "time-out in seconds"
username = "name">

Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfhttp, cfldap, cfmail, cfpop
Attributes

Attribute

Req/Opt

action

Required

Default

Description
FTP operation to perform.
open: creates an FTP
connection.
close: terminates an
FTP connection.

© 2014 Adobe Systems Incorporated. All rights reserved.

506

Adobe ColdFusion Documentation

connection

Optional, but always used
with open or close

Name of the FTP
connection. If you specify
the username, passwor
d, and server attributes,
and if no connection
exists for them,
ColdFusion creates one.
Calls to cfftp with the
same connection name
reuse the connection.

fingerprint

Optional. Used only when
server, username, and
password are supplied

Fingerprint of the host key
in the form ssh-dss.ssh
-rsa, which is a 16-byte
unique identifier for the se
rver attribute that you
specify, The fingerprin
t consists of eight pairs of
hexadecimal values in the
form hh:hh:hh:hh::hh
:hh:hh:hh. ColdFusion
checks the fingerprint
of the remote server only
if the fingerprint value
is specified.

key

Required if action="ope
n" (}}When
{{secure="yes", eithe
r password or key is
required.)

Public-key based
authentication. Refers to
the absolute path to the
private key of the user.
Possession of a private
key provides
authentication by sending
a signature created with a
private key. The server
must ensure that the key
is a valid authentication
for the user and that the
signature is valid. Both
must be valid to accept
the authentication.

passive

Optional

no

Valid only if secure="no
".
yes: enables passive
mode.
no

© 2014 Adobe Systems Incorporated. All rights reserved.

507

Adobe ColdFusion Documentation

passphrase

Optional. Used when key
is specified

Because private keys are
stored in an encrypted
form on the client host,
the user must supply a
passphrase to enable
generating the signature.

password

Required if action="ope
n" (}}When
{{secure="yes", either
password or key is
required.)

Password to log in the
user.

port

Optional

proxyServer

Optional

retryCount

Optional

1

secure

Optional

no

server

Required if action="ope
n"

© 2014 Adobe Systems Incorporated. All rights reserved.

21

Remote port to which to
connect.
String. Name of proxy
server (or servers) to use,
if proxy access is
specified.
Number of retries until
failure is reported.
yes: enables secure
FTP
no
FTP server to which to
connect; for example, ftp
.myserver.com.

508

Adobe ColdFusion Documentation

stopOnError

Optional

no

timeout

Optional

30

username

Required if action="ope
n"

yes: halts processing,
displays an appropriate
error.
no: if secure="yes",
populates the following
variables:
If ColdFusion fails to
connect to the secure
FTP server, it halts
processing and displays
the appropriate error
message
cfftp.succeeded: y
es or no
cfftp.errorCode:
error number
cfftp.errorText:
message text
For all file operations,
returns the following
error codes:
SSH-CONNECT 25
SSH_MSG_USERAUT
H_FAILURE 51
SSH_MSG_USERAUT
H_SUCCESS 52
SSH_MSG_REQUEST
_SUCCESS 81
SSH_MSG_REQUEST
_FAILURE 82For
conditional operations,
use cfftp.errorCod
e. Do not use cfftp.e
rrorText for this
purpose.
Value in seconds for the
time-out of all operations,
including individual data
request operations.
User name to pass in the
FTP operation.

Usage

The cfftp tag lets you open a connection to a Secure Shell (SSH) server by using either symmetric or asymmetric
encryption. To use symmetric encryption, you specify secure="yes", the user name, password, connection, and
fingerprint. To use asymmetric encryption, first generate private-public key pairs for each user authorized to have
access to the server. Each authorized user's public key is stored on the server; each user's private key is encrypted
and stored on that user's computer. To open a connection to the SSH server, you specify secure="yes", the user

© 2014 Adobe Systems Incorporated. All rights reserved.

509

Adobe ColdFusion Documentation

name, the password, or the private key and the passphrase that the server uses to decrypt the private key,
connection, and fingerprint. After you open the connection to the SSH server, you can use that connection for any
action supported by the cfftp tag. To keep a connection open throughout a session or longer, put the connection
name in the Session or Application scope; for example, specify connection="Session.FTPConnection".
However, if you do this, specify the full variable name in all FTP operations, and use the close action when you are
finished. Keeping a connection open prevents others from using the FTP server; so close a connection as soon as
possible. If you do not assign the connection name to Session or Application variable, the connection remains open
for the current page only, and you do not have to close it manually. Changes to a cached connection, such as
changing retryCount or timeout values, might require reestablishing the connection.
Example





    Did it succeed? #cfftp.succeeded#









    Did it succeed? #cfftp.succeeded#



Example

© 2014 Adobe Systems Incorporated. All rights reserved.

510

Adobe ColdFusion Documentation





    Did it succeed? #cfftp.succeeded#











© 2014 Adobe Systems Incorporated. All rights reserved.

511

Adobe ColdFusion Documentation

cfftp: Connection: file and directory operations
Description

To perform file and directory operations with cfftp, use this form of the cfftp tag.
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfhttp, cfldap, cfmail, cfpop
Attributes

Attribute

Req/Opt

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

512

Adobe ColdFusion Documentation

action

Required if connection is
not cached

FTP operation to perform:
changedir
createDir
listDir
removeDir
getFile
putFile
rename
remove
getCurrentDir
getCurrentURL
existsDir
existsFile
exists

ASCIIExtensionList

Optional

connection

Required if action = "op
en" or "closed"

The name of the FTP
connection.Used to cache
a new FTP connection or
to reuse an existing
connection.

directory

Required if action =
"changedir", "create
Dir", "listDir", or "
existsDir"

Directory on which to
perform an operation.

existing

Required if action =
"rename"

Current name of the file or
directory on the remote
server.

failIfExists

Optional

item

Required if action =
"exists" or "remove"

Object of these actions:
file or directory.

localFile

Required if action =
"getFile" or "putFile
"

Name of the file on the
local file system. For more
information, see Usage.

name

Required if action =
"listDir"

Query name of directory
listing.

© 2014 Adobe Systems Incorporated. All rights reserved.

txt;htm;html; cfm;cf
ml;shtm;
shtml;css;asp;asa

yes

Delimited list of file
extensions that force
ASCII transfer mode, if tr
ansferMode = "auto".

yes: If a local file with
same name exists, the
getFile action fails.
no

513

Adobe ColdFusion Documentation

new

Required if action =
"rename"

New name of file or
directory on the remote
server.

passive

Optional

password

Required if action =
"open"

Password to log in the
user.

proxyServer

Optional

String. Name of the proxy
servers to use, if proxy
access is specified.

remoteFile

Required if action =
"getFile", "putFile",
or "existsFile"

Name of the file on the
FTP server file system.

result

Optional

Specifies a name for the
structure in which cfftp
stores the returnValue
variable. If set, this value
replaces cfftp as the
prefix to use when
accessing returnVaria
ble. For more
information, see Usage.

server

Required if FTP
connection is not cached

FTP server to which to
connect; for example, ftp
.myserver.com.

timeout

Optional

30 seconds

transferMode

Optional

auto

username

Required if connection is
not cached

no

yes: enables passive
mode.
no

The length of time, in
seconds, that ColdFusion
waits for a response from
the FTP server.Used with
action = "open" for a
cached connection.
ASCII FTP transfer
mode
Binary FTP transfer
mode
Auto FTP transfer mode
User name to pass in the
FTP operation.

Usage

© 2014 Adobe Systems Incorporated. All rights reserved.

514

Adobe ColdFusion Documentation

If you use connection caching to an active FTP connection, you do not have to respecify the username, password,
or server connection attributes.Changing a cached connection, such as changing retryCount or timeout value
s, might require reestablishing the connection. If action = "listDir", the attributes column returns direct
ory or normal. Other platform-specific values, such as hidden and system, are no longer supported.
If action = "listDir", a mode column is returned. The column contains an octal string representation of UNIX
permissions; for example, "777."The cfftp.returnValue variable provides the return value for these actions:
getCurrentDir
getCurrentURL
existsDir
existsFile
exists
For more information, see the Developing ColdFusion Applications.
For more information, see the section Performing file operations with cfftp in Developing ColdFusion
Applications.
localFile attribute

Use the following syntax to specify an in-memory file, which is not written to disk, as the local file. In-memory files
speed processing of transient data.

ram:///filepath

The filepath can include directories, for example ram:///petStore/images/poodle.jpg. Create the directories
in the path before you specify the file. For more information on using in-memory files, see Working with in-memory
files in Optimizing ColdFusion applications in the Developing ColdFusion Applications.
Action (cfftp.ReturnValue variable)

The results of an action determine the value of the returnValue variable, as the following table shows:
cfftp action

Value of cfftp.returnValue

getCurrentDir

String. Current directory.

getCurrentURL

String. Current URL.

existsDir

yes or no.

existsFile

yes or no.

exists

yes or no.

To access the returnValue variable, you must prefix it with either cfftp or the value specified by the result attr
ibute, if it is set. The result attribute provides a way for cfftp calls from multiple pages, possibly at the same
time, to avoid overwriting the results of one with another. If you set the result attribute to myResult, for example,
you would access the returnVariable variable as myResult.returnVariable. Otherwise, you would access
it as cfftp.returnVariable.

© 2014 Adobe Systems Incorporated. All rights reserved.

515

Adobe ColdFusion Documentation
Example

The following example opens a connection and gets a file that lists file or directory name, path, URL, length, and
modification date:


    Open a connection


    Did it succeed? #cfftp.succeeded#


    FTP Directory Listing:
    









    Move Image File to Remote Server:
    



    Did it succeed? #cfftp.succeeded#

    Close the connection:


    Did it succeed? #cfftp.succeeded#

© 2014 Adobe Systems Incorporated. All rights reserved.

516

Adobe ColdFusion Documentation

cfftp action = "listDir"
Description

To access the columns in a query object, use this tag with action = "listDir".
Usage

When you use this action, specify a value for the name attribute. This value holds the results of the listDir action
in a query object. The query object consists of columns that you can reference, in the form queryname.columnam
erow, where queryname is the name of the query, specified in the name attribute; and columnname is a column
returned in the query object. The value row is the row number of each file/directory entry returned by the listDir o
peration. A separate row is created for each entry:
cfftp query object column

Description

Name

Filename of the current element.

Path

File path (without drive designation) of the current
element.

URL

Complete URL for the current element (file or
directory).

Length

File size of the current element.

LastModified

Unformatted date/time value of the current element.

Attributes

String. Attributes of the current element: normal or
Directory.

IsDirectory

Boolean. Whether object is a file or directory.

Mode

Applies only to UNIX and Linux. Permissions. Octal
string.

Note
Previously supported query column values that pertain to system-specific information are not
supported; for example, hidden and system.

© 2014 Adobe Systems Incorporated. All rights reserved.

517

Adobe ColdFusion Documentation

cfform
Description

Builds a form with CFML custom control tags; these provide more functionality than standard HTML form input
elements. You can include the resulting form on the client page as HTML or Adobe Flash content, and generate the
form by using XML and XSLT.
Category

Forms tags
Syntax



onSubmit =

...


Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfajaximport, cfapplet, cfcalendar, cfformgroup, cfformitem, cfgrid, cfinput, cfselect, cfslid
er, cftextarea, cftree; Requesting and Presenting Information in the Developing ColdFusion Applications
History

ColdFusion 8:

© 2014 Adobe Systems Incorporated. All rights reserved.

518

Adobe ColdFusion Documentation

Added support for adding interactive fields in PDF forms.
Added the onSuccess attribute and support in AJAX controls for the onError attribute

ColdFusion MX 7:
Added ability to set the default value of the scriptSrc attribute in the ColdFusion Administrator.
Deprecated the passthrough attribute. The tag now supports all HTML form tag attributes directly.
Added the method attribute and support for the GET method.
Added support for Flash and XML output, including the format, height, width, preloader, timeout, wM
ode, accessible, and skin attributes.
Added cfformgroup, cfformitem, and cftextarea child tags.
Added the onReset attribute.

ColdFusion MX:
Deprecated the enableCAB attribute. It might not work, and might cause an error, in later releases.
Changed the name and action attributes to optional.
Changed integer validation to require an integer value. In previous releases it would convert a floating point
value to an integer.
Attributes

The following table lists attributes that ColdFusion uses directly. For HTML format forms, this tag also supports the
standard HTML form tag attributes that are not on this list, and passes them directly to the browser. ColdFusion
also includes all supported HTML attributes in the XML.
Attribute

Applies to

Req/Opt

Default

Description

accessible

Flash

Opt

no

Specifies whether to
include support
screen readers in
the Flash form.
Screen reader
support adds
approximately 80
KB to the SWF file
sent to the client.

© 2014 Adobe Systems Incorporated. All rights reserved.

519

Adobe ColdFusion Documentation

action

FlashHTMLXML

Opt

See Description

Name of ColdFusion
page to execute
when the form is
submitted for
processing.
If you omit this
attribute and the
method is get, the
form posts to the
page identified by
the
CGI.SCRIPT_NAME
variable (the
requested page that
resulted in
displaying the form).
If the method is
post, the form posts
to the page
identified by the
CGI.QUERY_STRI
NG variables.

archive

applets in HTML
and XML

Opt

/CFIDE/classes/cfap
plets.jar

URL of
downloadable Java
classes for cfgrid,
cfslider, and cft
ree applet controls.

codeBase

applets in HTML
and XML

Opt

/CFIDE/classes/cf-j2
re-win.cab

URL of
downloadable JRE
plug-in for Internet
Explorer; used for c
fgrid, cfslider,
and cftree Java
applet controls.

© 2014 Adobe Systems Incorporated. All rights reserved.

520

Adobe ColdFusion Documentation

format

FlashHTMLXML

Opt

HTML

HTML: generates
an HTML form
and send it to the
client. cfgrid an
d cftree child
controls can be in
Flash or applet
format.
Flash: generates
a Flash form and
send it to the
client. All controls
are in Flash
format.
XML: generates
XForms-compliant
XML and save the
results in a
variable specified
by the name attrib
ute. By default,
ColdFusion also
applies an XSL
skin and displays
the result. For
more information,
see the skin attri
bute.

height

FlashXML

Opt

100%

The height of the
form. Use a number
to specify pixels. In
Flash, you can use
a percentage value,
such as "height=6
0%" to specify a
percentage of the
available width. The
displayed height
might be less than
the specified size.
Note: The width a
nd height attribute
s are required for
Flash forms, if they
are used inside of a
table.

name attribute value

the HTML id of the
form.

id

© 2014 Adobe Systems Incorporated. All rights reserved.

521

Adobe ColdFusion Documentation

method

FlashHTML XML

Opt

post

The method the
browser uses to
send the form data
to the server:
post: sends the
data using the
HTTP post
method. This
method sends the
data in a separate
message to the
server.
get: sends the
data using the
HTTP get method,
which puts the
form field contents
in the URL query
string.

name

FlashHTMLXML

© 2014 Adobe Systems Incorporated. All rights reserved.

Opt

CFForm_n

A name for the form.
In HTML format, if
you omit this
attribute and specify
an id attribute,
ColdFusion does not
include a name
attribute in the
HTML sent to the
browser; this
behavior lets you
use the cfform tag
to create
XHTML-compliant
forms. If you omit
the name attribute
and the id attribute,
ColdFusion
generates a name of
the form CFForm_n
where n is a number
that is assigned
serially to the forms
on a page.

522

Adobe ColdFusion Documentation

onError

FlashHTML

Opt

For Flash format
forms: Applies only
for onSubmit or
onBlur validation;
has no effect for
onServer validation.
An ActionScript
expression or
expressions to
execute if the user
submits a form with
one or more
validation errors.
For HTML format
forms: Applies only
to forms inside cfd
iv, cflayout, cfp
od, or cfwindow co
ntrols. The name of
a JavaScript
function that runs if
an asynchronous
form submission
fails. For more
information, see the
Usage section.

onLoad

HTMLXML

Opt

JavaScript to
execute when the
form loads.

onReset

HTMLXML

Opt

JavaScript to
execute when the
user clicks a reset
button.

onSubmit

FlashHTMLXML

Opt

JavaScript or
ActionScript function
to execute to
preprocess data
before form is
submitted. If any
child tags specify on
Submit field
validation,
ColdFusion does the
validation before
executing this
JavaScript.

© 2014 Adobe Systems Incorporated. All rights reserved.

523

Adobe ColdFusion Documentation

onSuccess

HTML

Opt

preloader

Flash

Opt

© 2014 Adobe Systems Incorporated. All rights reserved.

Applies only to
forms inside cfdiv,
cflayout, cfpod,
or cfwindow contro
ls. The name of a
JavaScript function
that runs when an
asynchronous form
submission
succeeds. For more
information see the
Usage section.
yes

Specifies whether to
display a progress
bar when loading
the Flash form.

524

Adobe ColdFusion Documentation

preserveData

HTMLXML

Opt

no

When the cfform a
ction attribute
posts back to the
page that contains
the form, this
attribute determines
whether to override
the control values
with the submitted
values.
no: uses values
specified in the
control tag
attributes.
yes: uses
corresponding
submitted values.
Applies to these
controls:
cfinput, cfsli
der, cftextinp
ut: overrides the
value attribute
value.
cfselect control
s that are
populated from
queries: overrides
the selected att
ribute. See cfsel
ect.
cftree controls:
overrides the cft
reeitem expand
attribute. If yes,
expands
previously-selecte
d elements. The c
ftree complete
Path attribute
must be set to ye
s.
cfgrid controls:
has no effect.
(This avoids
confusion as to
whether data has
been resubmitted
to the database
by the control.)

© 2014 Adobe Systems Incorporated. All rights reserved.

525

Adobe ColdFusion Documentation

scriptSrc

FlashHTMLXML

© 2014 Adobe Systems Incorporated. All rights reserved.

Opt

See Description

Specifies the URL,
relative to the web
root, of the directory
that contains
ColdFusion
JavaScript files,
including the
cfform.js file with the
client-side
JavaScript used by
this tag and its child
tags. For XML
format forms, this
directory is also the
default directory for
XSLT skins. When
you use this
attribute, the
specified directory
must have the same
structure as the
/CFIDE/scripts
directory. For
example, if you
specify scriptsrc
="/resources/my
Scripts", the
JavaScript files used
by ColdFusion AJAX
features must be in
the
/resources/myScript
s/ajax directory.
This attribute is
useful if the file is
not in the default
location. This
attribute may be
required in some
hosting
environments and
configurations that
block access to the
/CFIDE directory.
The location is set in
the ColdFusion
Administrator; by
default, it is
/CFIDE/scripts.
Notes: If you
specify this attribute,
copy the
CF_RunActiveConte

526

Adobe ColdFusion Documentation

nt.js file from the
CFIDE/scripts
directory to the
specified directory.
You can have only
one scriptsrc attr
ibute on a page,
including any cfaja
ximport tag scrip
tsrc}}attribute
. If you have
multiple
{{cfform tags, you
can specify the scr
iptsrc attribute in

© 2014 Adobe Systems Incorporated. All rights reserved.

527

Adobe ColdFusion Documentation

a cfajaximport ta
g and it applies to all
HTML format forms.
skin

FlashXML

Opt

Flash:
{{haloGreen}}XML:
default.xsl

Flash: Use a halo
color to stylize the
output. The skin
determines the color
used for highlighted
and selected
elements.
haloSilver
haloBlue
haloGreen
haloOrange
XML: Specifies
whether to apply
an XSL skin and
display the
resulting HTML to
the client. Can be
any of the
following:
ColdFusion skin
name: applies the
specified skin.
XSL file name:
applies the skin
located in the
specified path.
none: does not
apply an XSL
skin. Your CFML
page must
process the XML
that ColdFusion
saves in the
variable specified
by the name attrib
ute, and display
any results.
omitted or defau
lt: uses the
ColdFusion
default skin.
You can specify
the following
ColdFusion skins
(located in the cf_
webroot
x
basic

© 2014 Adobe Systems Incorporated. All rights reserved.

528

Adobe ColdFusion Documentation

basiccss
beige
blue
lightgray
red
silver
A filename can be
any of the
following:
absolute URL
URL relative to
the web root
absolute file path
name of a file in
the scripts folder
or a subdirectory
of the cf_webroot\
CFIDE\scripts
directory. In this
case, do not
specify the .xsl
suffix.
style

HTML, Flash, XML

© 2014 Adobe Systems Incorporated. All rights reserved.

Opt

Styles to apply to
the form. In HTML
or XML format,
ColdFusion passes
the style attribute to
the browser or XML.
In Flash format,
must be a style
specification in CSS
format. For detailed
information on
specifying Flash
styles, see Creating
Forms in Flash in
the Developing
ColdFusion
Applications.

529

Adobe ColdFusion Documentation

timeout

Flash

Opt

0

Integer number of
seconds for which to
keep the form data
in the Flash cache
on the server. A
value of 0 prevents
the data from being
cached. For more
information, see
Caching data in
Flash forms in Best
practices for Flash
forms in the Develo
ping ColdFusion
Applications.

width

FlashXML

Opt

100%

The width of the
form. Use a number
to specify pixels. In
Flash, you can use
a percentage value,
such as "width=60
%" to specify a
percentage of the
available
width.Note: The wid
th and height attri
butes are required
for Flash forms, if
they are used inside
of a table.

© 2014 Adobe Systems Incorporated. All rights reserved.

530

Adobe ColdFusion Documentation

Flash

wMode

Opt

window

Specifies how the
Flash form appears
relative to other
displayable content
that occupies the
same space on an
HTML page.
window: the
Flash form is the
topmost layer on
the page and
obscures anything
that would share
the space, such
as drop-down
dynamic HTML
lists.
transparent:
the Flash form
honors the
z-index of dhtml
so you can float
items above it. If
the Flash form is
above any item,
transparent
regions in the
form show the
content that is
below it.
opaque: the
Flash form honors
the z-index of
dhtml so you can
float items above
it. If the Flash
form is above any
item, it blocks any
content that is
below it.

Note
Attributes that are not marked as supported in XML are not handled by the skins provided with
ColdFusion. They are, however, included in the generated XML as html namespace attributes to
the form tag.

Usage

This tag requires an end tag.
You can use the following ColdFusion form control tags in the cfform tag:

© 2014 Adobe Systems Incorporated. All rights reserved.

531

Adobe ColdFusion Documentation

cfapplet: Used in HTML and XML format only; embeds a registered Java applet.
cfformgroup: Used in Flash and XML format only; groups and arranges child controls.
cfformitem: Used in Flash and XML format only; adds horizontal rules, vertical rules, and text to the form.
cfgrid: Creates a grid control to display tabular data.
cfinput: Creates and an input element.
cfselect: Creates a drop-down list box.
cfslider: Used in HTML and XML format only; creates a slider control.
cftextarea: Creates a multiline text input box.
cftree: Creates a tree control.

In HTML format, all tags, and in Flash format the cftree and cfgrid tags, require JavaScript support on
the browser. The cfapplet tag and applet format cfgrid, cfslider, and cftree tags require the client
to download a Java applet. If you specify Flash format in the cfform tag, ColdFusion ignores any HTML in
the form body. Use ColdFusion tags, such as cfinput, for all form controls. You can include individual Flash
format cfgrid and cftree controls in an HTML format cfform tag.
In Flash format, if your forms do not request sensitive data (such as credit card numbers), consider setting
the timeout attribute. This can prevent users from getting "The form data has expired. Please reload this
page in your browser" errors if they use the browser back button to return to the form. For more information, s
ee Caching data in Flash forms in Best practices for Flash forms in the Developing ColdFusion Applications.
Note
In Flash format, if you do not specify height and width attributes, Flash reserves
browser space equal to the area of the browser window. If any other output follows the
form, users must scroll to see it. Therefore, if you follow a Flash form with additional
output, specify the height and width values. The width and height attributes are
required for Flash forms, if they are used inside of a table.

If attribute value text must include quotation marks, escape them by doubling them.
Using the onError attribute in Flash forms

If you use onSubmit or onBlur validation, the onError attribute lets you specify ActionScript code to execute if the
user tries to submit a Flash form with validation errors, as follows:
If you specify one or more valid Flash expressions, Flash executes the expressions.
If you omit the attribute, Flash displays a dialog box with all applicable error messages.
If you specify onError="" (an empty string) Flash does not display any message, but does not submit the
form.
Your ActionScript can use the errors variable to determine the fields and errors. The errors object has the
following fields:
Field

Contents

name

The name attribute of the control's CFML tag.

field

The internal name used by Flash for the field name (for
example, _level0.field1).

value

The value in the field.

© 2014 Adobe Systems Incorporated. All rights reserved.

532

Adobe ColdFusion Documentation

message

The message attribute of the control's CFML tag.

The following example shows cfform tags with an onError attribute that selects the tab in an accordion or tab
navigator that contains a lastName field with an invalid entry:



Incorporating HTML form tags and attributes

In HTML format, the cfform tag lets you incorporate the following standard HTML elements. They are not available
in Flash format:
Standard HTML form tag attributes and values. The attributes and values are included in the form tag that c
fform outputs in the page. For example, you can use form tag attributes like target or onMouseOver with
cfform.
HTML tags that can ordinarily be put within the HTML form tag. For example, you can use the HTML input
tag to create a submit button in a cfform, without the other features of cfinput:





Using forms in cfdiv, cflayout, cffpod, and cfwindow controls

The cfdiv, cflayout, cffpod, and cfwindow tags create AJAX-based controls that can serve as containers for
interactive forms. When you use such a structure, you do not want submitting form information to cause a new page
to be displayed; instead, you want dynamic code to modify the existing page without causing a complete reload. You
can do this by using the onSuccess and onError attributes.
The function specified by the onSuccess attribute gets called if the form data is submitted successfully. This
function is responsible for updating the pod, layout, or window to reflect the results of the submission, for example,
to display additional data or pop up a confirmation window. This function must not take any argumentsThe function
specified by the onError attribute gets called if an error occurs when the form data is submitted. This function is
responsible for handling the error, such as displaying an error message. This function must take two arguments: an
error number and an error message.
Incorporating interactive fields in PDF forms

ColdFusion lets you use the cfform tag to create PDF forms that contain static and interactive form fields. The cff
orm tag must exist within a cfdocument tag (where format="pdf"). Only one cfform tag can exist within a cfd
ocument tag.Completed forms can be posted to the server as an HTTP Post, or the entire PDF can be submitted as
binary stream. If the PDF is submitted, you can use the cffile tag to save completed PDF form to a hard drive:}}The output can
be manipulated and extracted by using the tag. Only the following {{cfform attributes are
supported in generating PDF forms:
action
format

© 2014 Adobe Systems Incorporated. All rights reserved.

533

Adobe ColdFusion Documentation

method
name
onSubmit
skin
style
To embed an existing PDF form generated by LiveCycle Designer or Acrobat, use the tag.
Example

© 2014 Adobe Systems Incorporated. All rights reserved.

534

Adobe ColdFusion Documentation


    cfform Example
    




    Results of Radio Button Test
    
Your radio button answer was yes
Your radio button answer was no

    

    Results of Checkbox Test
    

Your checkbox answer was yes

Your checkbox answer was no



    Results of Credit Card Input
    
Your credit card number, #Form.textSample#,
was valid under the MOD 10 algorithm.
    



    You gave this page a rating of #Form.sampleSlider#
    
    
    

    
    



    This example displays radio button input type for cfinput.
    
Yes 
No 

    This example displays checkbox input type for cfinput.
    


    This shows client-side validation for cfinput text boxes.
    
(This item is optional)
    
Please enter a credit card number:


    This example shows the use of the cfslider tag.
    
Rate your approval of this example from 1 to 10 by sliding control.
    
1  10

    

    
    

A simple XML form

The following example shows a simple XML-format form. It uses the default.xsl transform that is supplied with
ColdFusion to generate the HTML output for display:

© 2014 Adobe Systems Incorporated. All rights reserved.

535

Adobe ColdFusion Documentation
















this is sample text.


A simple PDF form



...
...







...
...



© 2014 Adobe Systems Incorporated. All rights reserved.

536

Adobe ColdFusion Documentation

cffunction
Description

Defines a function that you can call in CFML. Required to define ColdFusion component methods.
History

ColdFusion 10: restPath, httpMethod, produces, {{consumes}}
ColdFusion 8:
Added returnformat, secureJSON, and verifyClient attributes
Added component as a valid value for the ReturnType attribute.
ColdFusion MX 7: Added the description attribute, and added the XML value to the returntype attribute
.ColdFusion MX: Added this tag.
Category

Extensibility tags
Syntax



See also

cfargument, cfcomponent, cfinterface, cfinvoke, cfinvokeargument, cfobject, cfproperty, cfret
urn, SerializeJSON
Attributes

Attribute

Req/Opt

name

Required

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description
A string; a component
method that is used in the
cfcomponent tag.

537

Adobe ColdFusion Documentation

access

Optional

public

The client security context
from which the method
can be invoked. The
following values are valid:
private: available
only to the component
that declares the
method and any
components that extend
the component in which
it is defined.
package: available
only to the component
that declares the
method, components
that extend the
component, or any
other components in the
package. Methods are
available to the CFC
pages in the same
package.
public: available to a
locally executing page
or component method.
remote: available to a
locally or remotely
executing page or
component method, or
a remote client through
a URL, Flash, or a web
service. To publish the
function as a web
service, this option is
required.

description

Optional

Supplies a short text
description of the function.

displayname

Optional

Meaningful only for CFC
method parameters. A
value to be displayed in
parentheses following the
function name when using
introspection to show
information about the
CFC.

© 2014 Adobe Systems Incorporated. All rights reserved.

538

Adobe ColdFusion Documentation

hint

Optional

output

Optional

Meaningful only for CFC
method parameters. Text
to be displayed when
using introspection to
show information about
the CFC. The hint attrib
ute value follows the
syntax line in the function
description.
Function body is
processed as standard
CFML

Specifies under which
conditions the function
can generate HTML
output.
The following values are
valid:
yes: the entire function
body is processed as if
it were in a cfoutput t
ag. Variables names
surrounded by number
signs (#) are
automatically replaced
with their values.
no: the function is
processed as if it were
within a cfsilent tag.
If you do not specify this
attribute, the function
body is processed as
standard CFML. Any
variables must be in cf
output tags.

returnformat

© 2014 Adobe Systems Incorporated. All rights reserved.

Return as WDDX or XML;
see description.

The format in which to
return values to a remote
caller. This attribute has
no effect on values
returned to a local caller.
The following values are
valid:

539

Adobe ColdFusion Documentation

json: serialize the
return value into JSON
format before returning
it remotely.
wddx: serialize the
return value into WDDX
format before returning
it remotely.
plain: ensure that the
return value is a type
that ColdFusion can
convert directly to a
string, and return the
string value without
serialization. Valid types
include all simple types,
such as numbers, and
XML objects. If the
return value is a
complex type, such as
an array, or a binary
value, ColdFusion
generates an error. If
you specify a returnt
ype attribute, its value
must be any, boolean,
date, guid, numeric,
string, uuid, variab
lename, or XML;
otherwise, ColdFusion
generates an error.
By default, ColdFusion
serializes all return
types (including simple
return types), except
XML, into WDDX
format, and returns
XML data as XML text.
You can also use retu
rnformat as an HTTP
request parameter
when calling a remote
CFC function. This
parameter has the
same effect as the ret
urnformat attribute
and overrides any retu
rnformat attribute
value specified in the c
ffunction tag.

© 2014 Adobe Systems Incorporated. All rights reserved.

540

Adobe ColdFusion Documentation

returnType

Required for a web
service; Optional,
otherwise.

any

String; a type name; data
type of the function return
value:
any
array
binary
boolean
component: the return
value must be a
ColdFusion component.
date
guid: the argument
must be a UUID or
GUID of the form xxxxx
xxx-xxxx-xxxx-xxxx-xxx
xxxxxxxxx where each_
x_ is a character that
represents a
hexadecimal number
(0-9A-F).
numeric
query
string
struct
uuid: the argument
must be a ColdFusion
UUID of the form xxxxx
xxx-xxxx-xxxx-xxxxxxxx
xxxxxxxx where each_
x_ is a character that
represents a
hexadecimal number
(0-9A-F).
variableName: a
string formatted
according to
ColdFusion variable
naming conventions.
void: does not return a
value.
xml: allows web service
functions to return
CFML XML objects and
XML strings.

© 2014 Adobe Systems Incorporated. All rights reserved.

541

Adobe ColdFusion Documentation

A component name: If
the returntype attribu
te value is not one of
the preceding items,
ColdFusion treats it as
the name of a
ColdFusion component.
When the function
executes, it generates
an error if the value that
is returned is not a CFC
with the specified name.
Note: If a function does
not return a value and
the returnType value
is string, ColdFusion
generates an error;
ColdFusion does not
generate an error for
other types.
roles

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

"" (empty)

A comma-delimited list of
ColdFusion security roles
that can invoke the
method. Only users who
are logged in with the
specified roles can
execute the function. If
this attribute is omitted, all
users can invoke the
method.

542

Adobe ColdFusion Documentation

secureJSON

Optional

See Description

A Boolean value that
specifies whether to add a
security prefix in front of
any value that the function
returns in JSON-format in
response to a remote call.
The default value is the
value of any This.secur
eJSON variable in the
Application.cfc file or the s
ecureJSON attribute of
the cfapplication tag,
or if there is
no{{secureJSON}}
application setting, the
Prefix Serialized JSON
setting in the
Administrator Server
Settings > Settings page,
which defaults to false.
For more information see I
mproving security in Ajax
programming rules and
techniques in the Developi
ng ColdFusion
Applications.

verifyClient

Optional

no

A Boolean value that
specifies whether to
require remote function
calls to include an
encrypted security token.
For use with ColdFusion
AJAX applications only.
For more information see I
mproving security in Ajax
programming rules and
techniques in the Developi
ng ColdFusion
Applications.

© 2014 Adobe Systems Incorporated. All rights reserved.

543

Adobe ColdFusion Documentation

restPath

Optional

httpMethod

Specify to use a subresource path for the
CFC.
The path is
case-sensitive. Also, it is
preferable to avoid special
characters when you
specify the path. You can
include regular
expressions in the path.
For details of the
expressions that you can
specify, see the attribute r
estPath in cfcomponen
t.
The HTTP method to use,
must be one of the
following:
GET: Requests
information from the
server. Any data that
the server requires to
identify the requested
information must be in
the URL or in {{cfhttp
type="URL"}}tag.
POST: Sends
information to the
server for processing.
Requires one or more c
fhttpparam tags.
Often used for
submitting form-like
data.
PUT: Requests the
server to store the
message body at the
specified URL. Use this
method to send files to
the server.
DELETE: Requests the
server to delete the
specified URL.

© 2014 Adobe Systems Incorporated. All rights reserved.

544

Adobe ColdFusion Documentation

HEAD: Identical to the G
ET method, but the
server does not send a
message body in the
response. Use this
method for testing
hypertext links for
validity and
accessibility,
determining the type or
modification time of a
document, or
determining the type of
server. If you have not
specified HEAD, by
default, GET method is
called. However,
message body is not
sent in the response.
OPTIONS: A request for
information about the
communication options
available for the server
or the specified URL.
This method enables
the ColdFusion
application to determine
the options and
requirements
associated with a URL,
or the capabilities of a
server, without
requesting any
additional activity by the
server. If you have not
specified OPTIONS,
then ColdFusion sends
a response.
Overrides the value that
you specify at
component level.

© 2014 Adobe Systems Incorporated. All rights reserved.

545

Adobe ColdFusion Documentation

produces

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

/

Comma-separated list of
acceptable MIME types.
Used to specify the MIME
media type of
representation a resource
can produce, for example,
{{produces="text/plain,text
/html"}}If a resource can
produce more than one
MIME media type, the
function chosen
corresponds to the most
acceptable media type as
declared by the client.
If no value is specified, / i
s taken by default, which
means, all MIME types
are consumed. Overrides
the value that you specify
at the component level.

546

Adobe ColdFusion Documentation

consumes

Optional

/

Comma-separated list of
acceptable MIME types,
for example consumes="
text/plain,text/htm
l".Used to specify which
MIME media types of
representation a resource
can accept, or consume,
from the client. This
attribute overrides the
same attribute at the
component level.
If no value is specified, / i
s taken by default, which
means, all MIME types
are consumed. Adobe
recommends that you
avoid conflict scenarios
while specifying the
attributes produces and
consumes. For example,
avoid situations such as
the following: In function
1, you specify produces
as text/xml and consu
mes as text/ and in
function 2, produces as
text/ and consumes as
text/xml. Here, both the
functions are valid for the
request with accept =
text/xml and consume
s as text/xml.

Usage

The cffunction tag can define a function that you call in the same manner as a ColdFusion built-in function. To
define a ColdFusion component (CFC) method, use a cffunction tag. The following example shows cffunctio
n tag attributes for a simple CFC method that returns a ColdFusion Query object.



For detailed information on using the cffunction tag for ColdFusion components, see Building and Using
ColdFusion Components in the Developing ColdFusion Applications.

© 2014 Adobe Systems Incorporated. All rights reserved.

547

Adobe ColdFusion Documentation

If you specify returnformat="json" and the function returns a query, ColdFusion serializes the query into a
JSON Object with two entries, and array of column names, and an array of column data arrays. For more
information see SerializeJSON.
If you specify a roles attribute, the function executes only if a user is logged in and belongs to one of the specified
roles.
If you specify variableName for the returnType attribute, the function must return a string that is in ColdFusion
variable name format; that is, the function must return a string that starts with a letter, underscore, or Unicode
currency symbol, and consist of letters, numbers, and underscores (_), periods, and Unicode currency symbols,
only. ColdFusion does not check whether the value corresponds to an existing ColdFusion variable.
Example




SELECT FIRSTNAME, LASTNAME, EMAIL
FROM tblEmployees





SELECT *
FROM tblDepartments





#back to top

© 2014 Adobe Systems Incorporated. All rights reserved.

548

Adobe ColdFusion Documentation

Tags g-h
This section lists tags starting with alphabets G-H with their description.
cfgraph
cfgraphdata
cfgrid
cfgridcolumn
cfgridrow
cfgridupdate
cfheader
cfhtmlhead
cfhtmltopdf
cfhtmltopdfitem
cfhttp
cfhttpparam

© 2014 Adobe Systems Incorporated. All rights reserved.

549

Adobe ColdFusion Documentation

cfgraph
Description

This tag is deprecated. Use the cfchart, cfchartdata, and cfchartseries tags instead.Displays data
graphically.
History

ColdFusion 11: Removed this tag.
ColdFusion MX: Deprecated this tag. It works differently than it did in ColdFusion 5, and it might not work in later
releases.
The incompatibilities between the ColdFusion MX implementation and earlier implementations of this tag are as
follows:
cfgraph tag attribute

ColdFusion MX functionality

Title

Ignored.

Titlefont

Ignored.

Barspacing

Ignored.

Bordercolor

Color used for border, gridlines, and text displays.

Colorlist

List of colors to use for each data point for bar,
pyramid, area, horizontalbar, cone, cylinder, step, and
pie charts.

Valuelabelfont

Sets value label text font. If the Valuelabelfont, It
emlabelfont, and Legendfont values differ,
ColdFusion uses the last value that you specify in the
tag.Arial is not supported; it is mapped to Dialog.

Itemlabelfont

Sets item label text font. If the Valuelabelfont, Ite
mlabelfont, and Legendfont values differ,
ColdFusion uses the last value that you specify in the
tag.Arial is not supported; it is mapped to Dialog.

Legendfont

Sets legend text font. If the Valuelabelfont, Iteml
abelfont, and Legendfont values differ, ColdFusion
uses the last value that you specify in the tagArial is not
supported; it is mapped to Dialog.

ShowLegend

© 2014 Adobe Systems Incorporated. All rights reserved.

above, below, left, right: these options cause the
legend to display, but have no effect on its location.
none: prevents display of a legend.

550

Adobe ColdFusion Documentation

Valuelabelsize

Sets value label text size. If the Valuelabelsize and
Itemlabelsize values differ, ColdFusion uses the
last value that you specify in the tag.

Itemlabelsize

Sets item label text size.

Itemlabelorientation

Ignored. ColdFusion calculates best orientation based
on label and graph size.

Borderwidth

a nonzero number: default-width border, regardless
of number value.
0: no border.

Depth

0: displays graph with two-dimensional appearance.
any other value: displays graph with
three-dimensional appearance.

Linewidth
Showvaluelabel

Ignored.
yes: displays values on mouse-click.
no: suppresses value displays.
rollover: displays values on mouse-over.

Valuelocation

Ignored.

url

URL of page to open if any item in the graph is clicked.
The following variables may be used within the URL;
they are substituted with real values before the URL is
accessed:
"$value$": selected row/column value or an empty
string.
"$itemlabel$": selected item (column) value or
an empty string.
"$serieslabel$": selected series (row) value or
an empty string.
"javascript:...": executes client side scripts.

Urlcolumn

Ignored.

Type="HorizontalBar"

The (0,0) coordinate is located at the lower left.

ScaleFrom

If the smallest value in the data is less than scaleFro
m or the largest value in the data is greater than scale
To, the respective data value is used as the minimum
or maximum on the Y scale. Therefore, regardless of
the scaleFrom or scaleTo value, all data values
display.

© 2014 Adobe Systems Incorporated. All rights reserved.

551

Adobe ColdFusion Documentation

cfgraphdata
Description

This tag is deprecated. Use the cfchart, cfchartdata, and cfchartseries tags instead. Displays a data point
in a graph. Used within the cfgraph tag.
History

ColdFusion 11: Removed this tag.
ColdFusion MX: Deprecated this tag. It works differently than in ColdFusion 5 and might not work in later releases.

© 2014 Adobe Systems Incorporated. All rights reserved.

552

Adobe ColdFusion Documentation

cfgrid
Description

Used in the cfform tag. Puts a grid control (a table of data) in a ColdFusion form. To specify grid columns and row
data, use the cfgridcolumn and cfgridrow tags, or use the query attribute, with or without cfgridcolumn tag
s.
For CFC methods that returns numeric data with a leading zero, for example, zip code 02674, the zero is
interpreted by the bind expression as an octal number and its decimal equivalent (in this case 1468) even if you set
returnformat="string". To resolve this issue, for URL binds or binds routed by way of a JavaScript function
(for example, using cfajaxproxy), you can set returnformat=plain to retain the numeric value. Also, leading
zeros are stripped from the suggestion list for autosuggest controls.
Category

Forms tags
Syntax


zero or more cfgridcolumn and cfgridrow tags

© 2014 Adobe Systems Incorporated. All rights reserved.

554

Adobe ColdFusion Documentation



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfajaximport, cfapplet, cfcalendar, cfgridcolumn, cfgridrow, cfgridupdate, cfform, cfformgrou
p, cfformitem, cfinput, cfselect, cfslider, cftextarea, cftree, Using HTML grids in the Developing
ColdFusion Applications
History

ColdFusion9.0.1: Added the attribute multirowselect, supported only in HTML grids.
ColdFusion 9:
Added collapsible, groupfield, onLoad, and title attributes, supported in HTML grids only.
Added ability to use the insert attribute in HTML grids.
ColdFusion 8: Added support for HTML format grids, including the html value of the format attribute and
the following attributes: bind, bindOnLoad, pageSize, preservePageOnSort, stripeRows, stripeRo
wColor.ColdFusion MX 7.01: Added support for the onBlur and onFocus events.ColdFusion MX 7:
Added the format attribute and support for Flash and XML output.
Added enabled, onChange, style, tooltip, and visible attributes (Flash format only).
ColdFusion MX: Changed the rowHeaderWidth attribute: ColdFusion does not use the rowHeaderWidth a
ttribute. You can omit it.
Attributes

Note
In XML format, ColdFusion passes all attributes to the XML. The supplied XSLT skins do not
handle or display XML format grids, but do display applet and Flash format grids.

Attribute

Req/Opt; formats

name

Required; all

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description
Name of the grid control.

555

Adobe ColdFusion Documentation

align

Optional;applet

Alignment of the grid cell
contents:
Top
Left
Bottom
Baseline
Texttop
Absbottom
Middle
Absmiddle
Right

appendKey

Optional;HTML, applet

yes

yes: when used with hr
ef, appends "CFGRIDK
EY=" and information
about the selected
items. For details, see
the section Using the
href attribute.
no

autoWidth

Optional;HTML, applet

no

yes: sets column
widths so that all
columns display within
the grid width. Widths
are equal or the
proportions are
determined by the
relative cfgridcolumn
width attribute values.
Horizontal scroll bars
are not available.
no: sets columns to
equal widths or the
values specified in the c
fgridcolumn width a
ttributes.

© 2014 Adobe Systems Incorporated. All rights reserved.

556

Adobe ColdFusion Documentation

bgColor

Optional; all

Background color of the
control. For most formats,
can be a hexa-decimal
format or a named color.
For a hexadecimal value,
use the form "##xxxxxx
", where x = 0-9 or A-F;
use two number signs or
none. For a list of the
supported named colors,
see cfchart.
Limitations: for HTML
format, must be a valid
web color; for Flash
format, must be a
hexadecimal value.
Flash format only: to
specify background
colors for alternating
rows, separate the two
colors with a comma.

bind

Optional; HTML

© 2014 Adobe Systems Incorporated. All rights reserved.

A bind expression used to
fill the contents of the grid.
Cannot be used with the q
uery attribute. For more
information, see Binding
data to form fields in Usin
g Ajax Data and
Development Features in
the Developing
ColdFusion Applications.

557

Adobe ColdFusion Documentation

bindOnLoad

Optional; HTML

yes

yes: executes the bind
attribute expression
when first loading the
form.
no: does not execute
the bind attribute
expression until the first
bound event.
Ignored if there is no bi
nd attribute.
For more information,
see Using the
bindOnLoad attribute in
Using Ajax form
controls and features int
he Developing
ColdFusion Applications
.

bold

Optional; all

no

yes: displays text in
bold.
no

colHeaderAlign

Optional;applet

left

left: left-aligns the
column header text.
right: right-aligns the
column header text.
center: centers the
column header text.

colHeaderBold

Optional; all

no

yes: displays column
headers in bold.
no

colHeaderFont

Optional; all

Font of column header.

colHeaderFontSize

Optional; all

Size of column header
text, in points.

colHeaderItalic

Optional; all

no

yes: displays column
headers in italic.
no

colHeaders

Optional; Applet, Flash

yes

yes: displays column
headers.
no

© 2014 Adobe Systems Incorporated. All rights reserved.

558

Adobe ColdFusion Documentation

colHeaderTextColor

Optional; all

Color of column headers.
Options: same as for te
xtColor attribute.

collapsible

Optional; HTML

False

delete

Optional;HTML,applet

no

deleteButton

Optional;HTML, applet

Delete

Text for the Delete button;
takes effect only if selec
tmode="edit".

enabled

Optional;Flash

yes

Flash format only:
Boolean value that
specifies whether the
control is enabled. A
disabled control appears
in light gray.

font

Optional; all

Font of text.

fontSize

Optional; all

Size of text, in points.

© 2014 Adobe Systems Incorporated. All rights reserved.

A Boolean value
specifying whether the
user can collapse the
entire grid by clicking an
arrow on the title bar.
Specifying this attribute
adds a title bar to the grid.
yes: users can delete
row data from the grid;
takes effect only if sele
ctmode="edit".
no

559

Adobe ColdFusion Documentation

format

Optional; all

applet

applet: generates a
Java applet.
Flash: generates a
Flash grid control.
html: generates an
AJAX-based HTML grid
control that supports
data binding.
xml: generates an XML
representation of the
grid.
In XML format forms,
includes the generated
XML in the form.
In HTML format forms,
puts the XML in a string
variable with the name
specified by the name at
tribute.

gridDataAlign

Optional;applet

left

left: left-aligns data
within the column.
right: right-aligns data
within the column.
center: centers data
within the column.

gridLines

Optional; applet, Flash

yes

yes: enables row and
column rules.
no

© 2014 Adobe Systems Incorporated. All rights reserved.

560

Adobe ColdFusion Documentation

groupField

Optional; HTML

Don't group

Puts the grid rows into
groups, organized by the
column specified in this
attribute. Each group is
collapsible and has a
header with the column
name, group field value,
and number of entries in
the group.
If you set this option, the
column pull-down menu
shows two grouping
options: The show in
Groups option turns
column grouping on and
off. The Group By This
Field option sets the
grouping to use the
selected column. Users
display the pull-down
menu by moving the
mouse over a column
head and clicking the
down arrow that appears
You can use this attribute
with static grids only, do
not use it with dynamic
grids that get their data
using bind expressions.

height

Optional; all

300 (applet only)

Height of the control, in
pixels.
If you omit the attribute in
Flash format, the grid
sizes automatically.

highlightHref

Optional;applet

yes

href

Optional;HTML,. applet

© 2014 Adobe Systems Incorporated. All rights reserved.

yes: highlights links
associated with an hre
f attribute value.
no
URL or name of a query
column that contains
URLs to hyperlink each
grid cell with.

561

Adobe ColdFusion Documentation

hrefKey

Optional;HTML,. applet

A query column to use for
the value appended to the
href URL of each cell, if
appendKey="True". If
you use cfgridcolumn t
ags, the column must be
specified in one of these
tags.

hSpace

Optional;applet

Horizontal space to the
left and right of the
control, in pixels.

insert

Optional;applet, HTML

no

insertButton

Optional;applet

Insert

italic

Optional; all

no

maxRows

Optional; all

multirowselect

Optional; HTML

yes: users can insert
row data in the grid;
takes effect only if sele
ctmode="edit".
no
Text for the Insert button;
takes effect only if selec
tmode="edit".
yes: displays text in
italic.
no
Maximum number of rows
to display in the grid.

no

Allows selection of
multiple rows. This is
particularly useful in the
cases where batch
processing is required, for
example, moving multiple
records at a time.
If yes, a check box
appears as the first
column of the grid,
enabling selection of
multiple records. A Select
All/Deselect All option
also appears.
Note
If mul
tirow
selec
t="ye

© 2014 Adobe Systems Incorporated. All rights reserved.

562

Adobe ColdFusion Documentation

s",
then
row
data is
sent
as an
array
of
structs
as
oppos
ed to a
struct
if muti
rowse
lect=
"no".
Also, if
the
grid
data is
manip
ulated
by the
user,
for
examp
le,
using
JavaS
cript,
to
move
record
s when
a
button
is
clicked
, set
the
metho
d to
POST.
This is
require
d as a
GET
metho
d
impos
es
restrict

© 2014 Adobe Systems Incorporated. All rights reserved.

563

Adobe ColdFusion Documentation

ions
on the
amoun
t of
data

© 2014 Adobe Systems Incorporated. All rights reserved.

564

Adobe ColdFusion Documentation

that
can be
sent.

notSupported

Optional;applet

onBlur

Optional, Flash

ActionScript that runs
when the grid loses focus.

onChange

Optional;HTML, Flash

Flash format: ActionScrip
t to run when the control
changes due to user
action in the control.HTML
format: Required for
HTML format grids that
specify a bind attribute
and a selectMode value
of edit. A bind
expression that calls a
CFC method, JavaScript
function, or URL to update
the data source. If a URL
is called, since the data is
passed in JSON format to
the URL page, use the
function DeserializeJS
ON. The arguments cfgr
idrow and cfgridchan
ged must be serialized to
JSON strings if a
JavaScript bind is used to
pass these arguments to
a URL.

onError

Optional;HTML, applet

In HTML format grids,
name of a JavaScript
function to execute if an
error occurs.
In applet format grids,
name of a JavaScript
function to execute if
validation fails.

© 2014 Adobe Systems Incorporated. All rights reserved.

See Description

Text to display if the
browser does not support
Java or has Java support
disabled. Default: "
Browser must support
Java to view ColdFusion
Java Applets"

565

Adobe ColdFusion Documentation

onFocus

Optional,Flash

ActionScript that runs
when the grid gets focus.

onLoad

Optional

A custom JavaScript
function to execute when
the grid is loaded and
rendered.

onValidate

Optional;applet

A JavaScript function to
validate user input. The
form object, input object,
and input object value are
passed to the function,
which must return true if
validation succeeds; fals
e otherwise.

pageSize

Optional;HTML

10

The number of rows to
display per page for a
dynamic grid. If the
number of available rows
exceeds the page size,
the grid displays only the
specified number of
entries on a single page,
and the user navigates
between pages to show
all data. The grid retrieves
data for each page only
when it is required for
display.
This attribute is ignored if
you specify a query attrib
ute.

pictureBar

Optional;applet

no

yes: puts images (and
no text) on the Insert,
Delete, and Sort
buttons.
no: puts text (and no
images) on the Insert,
Delete, and Sort
buttons.

© 2014 Adobe Systems Incorporated. All rights reserved.

566

Adobe ColdFusion Documentation

preservePageOnSort

Optional; HTML

query

Optional; all

rowHeaderAlign

Optional;applet

left

left: left-aligns the
row header text.
right: right-aligns the
row header text.
center: centers the
row header text.

rowHeaderBold

Optional;applet

no

yes: displays row label
text in bold.
no

rowHeaderFont

Optional;applet

Font for the row labels.

rowHeaderFontSize

Optional;applet

Text size of the row
labels, in points.

rowHeaderItalic

Optional;applet

no

yes: displays row label
text in italic.
no

rowHeaders

Optional;applet

yes

yes: displays a column
of numeric row labels.
no

rowHeaderTextColor

Optional;applet

black

no

Specifies whether to
display the page with the
current page number, or
display page 1, after
sorting (or resorting) the
grid. If this attribute is yes
, selections are preserved
when the grid sorts.
Name of the query
associated with the
control. Cannot be used
with the bind attribute.

Text color of grid control
row headers.
Options: same as for
the textColor attribut
e.

rowHeight

Optional; Applet, Flash,
XML

© 2014 Adobe Systems Incorporated. All rights reserved.

Minimum row height, in
pixels. Used with cfgrid
column type = "Image"
; defines space for
graphics to display in row.

567

Adobe ColdFusion Documentation

selectColor

Optional; all

Background color for a
selected item.
Options: same as for te
xtColor attribute

selectMode

Optional; all

Applet format: Browse;HT
ML, Flash format: Row

Selection mode for items
in the control.
Edit: the user can edit
grid data. Selecting a
cell lets the user edit
the cell.
Row: user selections
automatically extend to
the row that contains
selected cell.
The following are used
in applet format only;
HTML and Flash
formats interpret these
as Row:
Single: user selections
are limited to the
selected cell.
Column: user selections
automatically extend to
the column that
contains selected cell.
Browse: the user can
only browse grid data.

selectOnLoad

Optional; HTML

© 2014 Adobe Systems Incorporated. All rights reserved.

yes

yes: selects the first
row of the grid when the
gird loads.
no: does not select any
rows when the grid
loads.

568

Adobe ColdFusion Documentation

sort

Optional;applet

no

Adds sort buttons to
perform simple text sorts
on a user-selected
column:
yes: put sort buttons on
the grid control.
no
Independent of this
setting, users can sort
columns by clicking the
column head. If select
Mode="browse", the
table cannot be sorted.

sortAscendingButton

Optional;applet

A > Z

Text for the Sort button.

sortDescendingButto
n

Optional;applet

Z > A

Text for the Sort button.

stripeRowColor

Optional; HTML

stripeRows

Optional; HTML

style

Optional;Flash

Must be a style
specification in CSS
format. Ignored for type=
"text".

target

Optional;HTML, applet

The target frame or
window in which to display
the href URL; for
example, "_blank".

© 2014 Adobe Systems Incorporated. All rights reserved.

The color to use for one of
the alternating stripes.
The bgColor setting
determines the other
color.
no

Boolean value that
indicates whether to make
the rows stripes in
alternating colors.

569

Adobe ColdFusion Documentation

textColor

OptionalFlash, applet

Color of text. Can be a
hexadecimal value or a
named color. For a
hexadecimal value, use
the form "##xxxxxx",
where x = 0-9 or A-F; use
two number signs or
none. For a list of the
supported named colors,
see cfchart.

title

Optional; HTML

Text to display as a title at
the top of the grid.
Specifying this attribute
adds a title bar to the grid.

tooltip

Optional;Flash

Flash format only: text to
display when the mouse
pointer hovers over the
control.

visible

Optional;Flash

vSpace

Optional;applet

width

Optional; all

yes

Flash format only:
Boolean value that
specifies whether to show
the control. Space that
would be occupied by an
invisible control is blank.
Vertical space above and
below the control, in
pixels.

300 (applet only)

Width of the control.
In Flash and applet
format, must be a number
of pixels. In HTML format,
can be in any valid CSS
measurement unit, and a
numeric-only value
specifies pixels.
If you omit the attribute in
Flash or HTML format; the
grid sizes automatically.

Usage

Most of the following paragraphs describe grid features that apply to all, or at least two, grid formats. For information
that is specific to Flash forms, see Creating Forms in Flash in the Developing ColdFusion Applications. For
information that is specific to HTML format grids, see Using HTML grids in the Developing ColdFusion Applications.
This tag must be in a cfform tag block. An applet format grid requires the client to download a Java applet. Also, if
the client does not have an up-to-date Java plug-in installed, the system might also have to download an updated

© 2014 Adobe Systems Incorporated. All rights reserved.

570

Adobe ColdFusion Documentation

Java plug-in to display an applet format grid. A Flash format grid generates a Flash control, and can be embedded in
an HTML format cfform tag. For this tag to work properly in either Flash or applet format, the browser must also be
JavaScript-enabled.
Note
If you specify Flash format for this tag in an HTML format form, and you do not specify height a
nd width attributes, Flash takes up more than the remaining visible area on the screen. If any
other output follows the grid, including any form controls, users must scroll to see it. Therefore, if
you follow a Flash grid in an HTML form with additional output, specify height and width value
s.

You can populate a cfgrid with data from a cfquery. If you do not specify any cfgridcolumn tags in the cfgri
d body, ColdFusion generates a grid with the following:
A column for each column in the query.
A default header for each column, created by replacing hyphen or underscore characters in the table column
name with spaces. The first character, and any character after a space, are changed to uppercase; all other
characters are lowercase.
This tag requires an end tag.
Note
Clicking the submit button while editing a grid cell occasionally causes the cell changes to
be lost. To ensure that changes are submitted properly, Adobe recommends that after
user updates data in a cell, they click another cell before submitting the form.

Returning cfgrid data to the action page

The following information applies to all cfgrid formats. Also, HTML format grids can dynamically get data by using
a bind expression. For more information, see Using HTML grids in the Developing ColdFusion Applications.
When a user submits a form, the cfgrid tag sends information about user actions by setting form variables in the
data submitted to the form's action page. Because the data can vary, depending on the tag's SelectMode attribute
value, the form variables that are returned also vary depending on this value. In general, the data returned falls into
one of these categories:
Simple data, returned from simple select operations
Complex data, returned from insert, update, and delete operations
Simple selection data (SelectMode = Single, Column, or Row)

The data that form variables return to the cfform's action page contains information about which cells the user
selected. In general, ColdFusion makes this data available in the action page, as ColdFusion variables in the Form
scope, with the naming convention form.#GridName#.#ColumnName#.}}Each {{SelectMode returns these
form variables:

© 2014 Adobe Systems Incorporated. All rights reserved.

571

Adobe ColdFusion Documentation

SelectMode="single"
form.#GridName#.#ColumnName# = "SelectedCellValue"
SelectMode="column"
form.#GridName#.#ColumnName# = "ValueOfCellRow1,
ValueOfCellRow2, ValueOfCellRowN"
SelectMode="row"
form.#GridName#.#Column1Name# = "ValueOfCellInSelectedRow"
form.#GridName#.#Column2Name# = "ValueOfCellInSelectedRow"
form.#GridName#.#ColumnNName# = "ValueOfCellInSelectedRow"

Complex update data (SelectMode = Edit)

The grid returns a large amount of data, to inform the action page of inserts, updates, or deletes that the user made
to the grid. In most cases, you can use the cfgridupdate tag to automatically gather the data from the form
variables; the tag collects data, writes SQL calls, and updates the data source. If you cannot use cfgridupdate (if,
for example, you must distribute the returned data to more than one data source), write code to read form variables.
In this mode, ColdFusion creates the following array variables in the Form scope for each cfgrid:

form.#GridName#.#ColumnName#
form.#GridName#.original.#ColumnName#
form.#GridName#.RowStatus.Action

Each table row that contains an update, insert, or deletion has a parallel entry in each of these arrays. To view all
the information for all the changes, you can traverse the arrays, as in this example. To make it work with a cfgrid
on a submitted cfform, set the GridName variable to the name of the grid and the ColNameList to a list of the grid
columns.

© 2014 Adobe Systems Incorporated. All rights reserved.

572

Adobe ColdFusion Documentation




    form.#GridName#.#ColName#:
    




The form variable is not an array!
    



Result Array Size is #size#.
    
Contents:
    
    

The array is empty.
    







    

    
Loop Index
Action
Old Value
New Value

    

    
#LoopCount#
#Val_Action#
#Val_Orig#
#Val_New#

    



    
    
    

form.#GridName#.#ColName#: NotSet!
    
    
    

Using the href attribute

When specifying a URL with grid items using the href attribute, the selectMode attribute value determines
whether the appended key value is limited to one grid item or extends to a grid column or row. When a user clicks a
linked grid item, a cfgridkey variable is appended to the URL, in this form:

© 2014 Adobe Systems Incorporated. All rights reserved.

573

Adobe ColdFusion Documentation

http://myserver.com?cfgridkey=selection

If the appendKey attribute is set to no, no grid values are appended to the URL. The value of selection is
determined by the value of the selectMode and attribute:
If you specify a hrefKey attribute, selection is the field value of the column specified by the attribute.
Otherwise, it is one of the following:
If selectMode="Single", selection is the value of the column clicked.
If selectMode="Row", selection is a comma-delimited list of column values in the clicked row, beginning
with the value of the first cell in the row.
If selectMode="Column", selection is a comma-delimited list of row values in the clicked column,
beginning with the value of the first cell in the column.
When you use an href attribute, you can also specify a target attribute with any of the standard HTML
target specifiers, _blank, _parent, _self, and _top, or with a specific frame name.
Enhancements made in ColdFusion 9.0.1

In ColdFusion 9, data for the first row is available on form submission in a form with dynamic grid. In
ColdFusion 9.0.1, the data is not available.
If the type is Boolean and selectmode is browse, or select=false, the column is shown as a check box
where click does not take effect.
Example

The following example creates a Flash form that displays a set of available courses from the CourseList table in the
cfdocexamples database. For more complex examples that use the cfgrid tag, see cfgridcolumn, cfgridrow,
and cfgridupdate.



SELECT Course_ID, Dept_ID, CorNumber,
CorName, CorLevel
FROM CourseList
ORDER by Dept_ID ASC, CorNumber ASC


    cfgrid Example
    
Currently available courses






© 2014 Adobe Systems Incorporated. All rights reserved.

574

Adobe ColdFusion Documentation

cfgridcolumn
Description

Used with the cfgrid tag in a cfform. Formats a column and optionally populates the column from a query. The f
ont and alignment attributes used in cfgridcolumn override global font or alignment settings defined in cfgri
d.
Category

Forms tags
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

© 2014 Adobe Systems Incorporated. All rights reserved.

575

Adobe ColdFusion Documentation

cfgrid, cfgridrow, cfgridupdate, cfform, cfapplet, cfinput, cfselect, cfslider, cftextarea, cft
ree
History

ColdFusion 9.0.1: Added the attributes autoExpand and headerMenu supported only in HTML grids.
ColdFusion 9: Added boolean, date, numeric, and string_noCase to the type attribute values supported in
HTML grids.
ColdFusion MX 7: Added the mask attribute, and the currency type attribute value.ColdFusion MX: Changed
behavior if select="no": a user cannot select and edit the cell data, regardless of the cfgrid selectmode attri
bute value. When clicked, the cell border (and, depending on the selectColor value, the cell background)
changes color, but the cell data cannot be edited.
Attributes

Note
In XML format, ColdFusion passes all attributes to the XML. The supplied XSLT skins do not
handle or display XML format grids, but do display applet and Flash format grids.

Attribute

Req/Opt; formats

Default

Description

autoExpand

Optional;HTML

yes for first column and n
o for remaining columns

On a particular column, it
lets you expand the
specified column. Setting
autoExpand="yes" for
multiple columns results in
error. Also, if the attribute
display is set to no,
then autoExpand cannot
be yes; else, it results in
error.

name

Required;all

Name of the grid column
element. If the grid uses a
query, this attribute must
be the name of the query
column that populates the
grid column.

bgColor

Optional;all

Color of background of
grid column.
Options: same as for
the textColor attribut
e.

bold

Optional;all

© 2014 Adobe Systems Incorporated. All rights reserved.

As specified by cfgrid

yes: displays grid
control text in bold.
no

576

Adobe ColdFusion Documentation

Optional;applet, Flash,
HTML

As specified by cfgrid

display

Optional;all

yes

font

Optional;all

As specified by cfgrid

Font of data in column.

fontSize

Optional;all

As specified by cfgrid

Size of text in column.

header

Optional;all

yes

Text for the column
header. Used only if the c
fgrid colHeaders attri
bute is yes. The default
value is yes.

headerAlign

Optional;applet

As specified by cfgrid

Column header text
alignment:

dataAlign

Column data alignment:
left
right
center
yes
no: hides the column.

left
right
center
headerBold

Optional;HTML, applet

As specified by cfgrid

headerFont

Optional;HTML, applet

As specified by cfgrid

Font for the column
header.

headerFontSize

Optional;HTML, applet

As specified by cfgrid

Size of text for the column
header, in pixels.

headerIcon

Optional

{{headerMenu}}Added in
ColdFusion 9.0.1

Optional;HTML

© 2014 Adobe Systems Incorporated. All rights reserved.

yes: displays header in
bold.
no

Location of an image file
to use as the icon for
header column of the grid.
no

Lets you turn on/off the
header menu of the grid
column.Header menu is
the drop-down list that
appears on grid header
columns on mouse hover.
The attribute is helpful
when you have images for
grid headers.

577

Adobe ColdFusion Documentation

headerItalic

Optional;HTML, applet

headerTextColor

Optional;HTML, applet

As specified by cfgrid

yes: displays column
header in italic.
no
Color of grid control
column header text.
Options: same as for
the textColor attribut
e.

href

Optional;HTML, applet

URL or query column
name that contains a URL
to hyperlink each grid
column with.

hrefKey

Optional;HTML, applet

The query column to use
for the value appended to
the href URL of each
column, instead of the
column's value.

italic

Optional;all

© 2014 Adobe Systems Incorporated. All rights reserved.

As specified by cfgrid

yes: displays grid
control text in italic.
no

578

Adobe ColdFusion Documentation

mask

Optional;Flash, HTML

A mask pattern that
controls the character
pattern that the form
displays or allows users to
input and sends to
ColdFusion.
For columns with the
currency type attribute,
the mask specifies the
currency symbol.
ColdFusion automatically
inserts the character
before the numeric value.
For columns with text or
numeric values, mask spe
cifies the format to display
or allow users to input, as
follows:
A = A-Za-z
X = A-Za-z0-9
9 = 0-9
? = Any character
All other characters =
ColdFusion inserts the
literal character.
If the column values are
dates or timestamps,
ColdFusion uses the
mask pattern to format
the selected date.
For details of the
date/time mask format,
see the section date/tim
e formats in mask
attribute.Masking
supports HTML grids.
The default format is m/
d/y, for example
05/06/75. where m is
month with leading
zeros, d is day with
leading zeros, and y is
two-digit representation
of year. For further
details, go to the
following URL:http://ww
w.extjs.com/deploy/dev/
docs/output/Date.html

© 2014 Adobe Systems Incorporated. All rights reserved.

579

Adobe ColdFusion Documentation

numberFormat

Optional;Applet

select

Optional;all

Format for displaying
numeric data in the grid.
See the following table of
numberFormat attribute
mask characters.
yes

Determines selection
behavior if the cfgrid se
lectmode attribute value
is column, edit, or sing
le; ignored for row or
browse values.
yes: users can select
the column or select or
edit cells in the column,
as specified by the sel
ectmode attribute.
no: users cannot select
the column or select or
edit cells in the column.

target

Optional;HTML, Applet

© 2014 Adobe Systems Incorporated. All rights reserved.

Frame or standard HTML
target in which to open
link specified in href.

580

Adobe ColdFusion Documentation

textColor

Optional;Applet, Flash,
HTML

Color of grid element text
in column as a
hexadecimal number or
text name.
To enter a hexadecimal
value, use the form "##xx
xxxx", where x = 0-9 or
A-F; use two number
signs or none. Limitations:
In HTML format, must
specify a valid HTML
color. In Applet format,
must be one of the
following:
Any color, in
hexadecimal format
Black
Red
Blue
Magenta
Cyan
Orange
Darkgray
Pink
Gray
White
Lightgray
Yellow

type

Optional;all

You can specify the
following values in all
formats:
boolean: column
displays as check box;
if cell is editable, user
can change the check
mark. In an onchange
event, for static and
dynamic grids, the data
that is passed is
converted to the format
in which the boolean
values are represented
in the database.
combobox: displays a
drop-down list with the
values you specify for
the attributes values
and valuedisplay as
options.

© 2014 Adobe Systems Incorporated. All rights reserved.

581

Adobe ColdFusion Documentation

numeric: user can sort
grid data numerically. In
HTML format, if the cell
is editable, the user can
enter numeric values
string_noCase: user
can sort grid data as
case-insensitive text. In
HTML format, if the cell
is editable, the user can
enter text values.
You can specify the
following value in applet
and Flash formats; it
does not work in HTML
format:
image: grid displays
the image specified by
the URL in the column.
If you use a relative
URL, the image must
be in the CFIDE\classes
directory or a
subdirectory. If the
image is larger than the
column cell, it is clipped
to fit. Flash images
must be JPEG files.
Applet images can be
JPEG or GIF files.
You can specify the
following value in applet
format; it does not work
in Flash or HTML
format.
image: you can use the
following built-in
ColdFusion image
names, in addition to
paths to image files, in
the column values: cd,
computer, document,
element, folder, floppy,
fixed, remote.
You can specify the
following value in Flash
format; it does not work
in applet or HTML
format:

© 2014 Adobe Systems Incorporated. All rights reserved.

582

Adobe ColdFusion Documentation

currency: formats the
column data as
currency, aligning it
around the decimal
point. If users sort the
grid by using this
column, it sorts
correctly for the
currency, Use the mask
attribute to specify a
currency symbol; the
default value is the
dollar sign ($).
You can specify the
following value in HTML
format; it does not work
in applet or Flash
format:
date: The column
contains date values. If
the grid selectMode at
tribute value is edit,
the cell is editable.
When you click an
editable cell, an icon
appears that you can
click to open a date
picker and select a
date.
values

Optional;HTML, applet

Formats cells in column
as drop-down list boxes;
specify items in
drop-down list, for
example:

{{values =
"arthur,
scott,
charles,
1-20,
mabel"}}

valuesDelimiter

Optional;HTML, applet

© 2014 Adobe Systems Incorporated. All rights reserved.

, (comma)

Delimiter in values and v
aluesDisplay attributes
.

583

Adobe ColdFusion Documentation

valuesDisplay

Optional;HTML, applet

width

Optional;all

Maps elements in the val
ues attribute to string to
display in the drop-down
list. Delimited strings
and/or numeric ranges.
Column head width

Column width, in pixels.

The following matrix describes the behavior of type="boolean".
Before

After

Y

N

T

F

1

0

true (for static grids)

false (for static grids)

true (for dynamic grids)

NO (for dynamic grids)

For non-boolean or null

Y

In applet format only, you can use the following numberFormat attribute mask characters to format output in U.S.
numeric and currency styles. For more information on using these mask characters, see NumberFormat. (The cfgr
idcolumn tag does not support international number formatting.)
Character

Meaning

_

(Underscore) Digit placeholder.

9

Digit placeholder.

.

(Period) Location of mandatory decimal point.

0

Located to left or right of mandatory decimal point;
pads with zeros.

()

Puts parentheses around mask if number is less than
0.

+

Puts plus sign before positive numbers, minus sign
before negative numbers.

-

Puts space before positive numbers, minus sign before
negative numbers.

© 2014 Adobe Systems Incorporated. All rights reserved.

584

Adobe ColdFusion Documentation

,

(Comma) Separates every third decimal-place with a
comma.

L,C

Left-justify or center-justify number within width of mask
column. First character of mask must be L or C.
Default: right-justified.

$

Puts dollar sign before formatted number. Must be the
first character of mask.

^

(Caret) Separates left from right formatting.

date/time formats in mask attribute

By default, Flash displays date/time values in grid columns with a format that shows values such as Oct 29 2004
11:03:21. Use the mask attribute to display the date or time in a different format, as described in the following table:
Pattern letter

Description

Y

Year. If the number of pattern letters is two, the year is
truncated to two digits; otherwise, it appears as four
digits. The year can be zero-padded, as the third
example shows in the following set of examples:
Examples:YY = 03YYYY = 2003YYYYY = 02003

M

Month in year. The format depends on the following
criteria:
If the number of pattern letters is one, the format is
interpreted as numeric in one or two digits.
If the number of pattern letters is two, the format is
interpreted as numeric in two digits.
If the number of pattern letters is three, the format is
interpreted as short text.
If the number of pattern letters is four, the format is
interpreted as full text.
Examples:M = 7MM= 07MMM=JulMMMM= July

D

© 2014 Adobe Systems Incorporated. All rights reserved.

Day in month. Examples:D=4DD=04DD=10

585

Adobe ColdFusion Documentation

E

Day in week. The format depends on the following
criteria:
If the number of pattern letters is one, the format is
interpreted as numeric in one or two digits.
If the number of pattern letters is two, the format is
interpreted as numeric in two digits.
If the number of pattern letters is three, the format is
interpreted as short text.
If the number of pattern letters is four, the format is
interpreted as full text.
Examples:E = 1EE = 01EEE = MonEEEE = Monday

A

AM/PM indicator.

J

Hour in day (0-23).

H

Hour in day (1-24).

K

Hour in am/pm (0-11).

L

Hour in am/pm (1-12).

N

Minute in hour. Examples:N = 3NN = 03

S

Second in minute.

Other text

You can add other text into the pattern string to further
format the string. You can use punctuation, numbers,
and all lowercase letters. Avoid upper case letters
because they may be interpreted as pattern
letters.Example:EEEE, MMM. D, YYYY at H:NN A =
Tuesday, Sept. 8, 2003 at 1:26 PM

Example

The following example lets you update certain fields of the CourseList table in the cfdocexamples database. It uses
cfgridcolumn tags to structure the table.

© 2014 Adobe Systems Incorporated. All rights reserved.

586

Adobe ColdFusion Documentation







SELECT Course_ID, Dept_ID, CorNumber,CorName, CorLevel, CorDesc
FROM CourseList
ORDER by Dept_ID ASC, CorNumber ASC



cfgrid Example



    cfgrid Example
    
You can update the Name, Level, and Description information for courses.














    

    



© 2014 Adobe Systems Incorporated. All rights reserved.

587

Adobe ColdFusion Documentation

cfgridrow
Description

Lets you define a cfgrid control that does not use a query as source for row data. If a query attribute is specified in
the cfgrid tag, the cfgridrow tags are ignored.
Category

Forms tags
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfgrid, cfgridcolumn, cfgridupdate, cfform, cfinput, cfselect, cfslider, cftextarea, cftree
Attributes

Attribute

Req/Opt

data

Required

delimiter

Optional

Default

Description
Delimited list of column
values. If a value contains
a delimiter character, it
must be escaped with
another delimiter
character.

, (comma)

Separator between
column values.

Example

The following example shows how you use the cfgridrow tag can populate a cfgrid tag from list data:

© 2014 Adobe Systems Incorporated. All rights reserved.

588

Adobe ColdFusion Documentation














    
    

© 2014 Adobe Systems Incorporated. All rights reserved.

589

Adobe ColdFusion Documentation

cfgridupdate
Description

Used with a cfgrid tag. Updates data sources directly from edited grid data. This tag provides a direct interface
with your data source.
This tag applies delete row actions first, then insert row actions, then update row actions. If it encounters an
error, it stops processing rows.
Category

Forms tags
Syntax


password = "data source password"
tableOwner = "table owner"
tableQualifier = "qualifier"
username = "data source user name">

Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfgrid, cfgridcolumn, cfgridrow, cfform, cfapplet, cfinput, cfselect, cfslider, cftextinput, cf
tree
History

ColdFusion 10: Added the clientInfo attribute.ColdFusion MX: Deprecated the connectString, dbName, dbSe
rver, dbtype, provider, and providerDSN attributes. They do not work, and might cause an error, in releases
later than ColdFusion 5.
Attributes

Attribute

Req/Opt

clientInfo

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description
Structure containing
properties of the client to
be set on the database
connection.

590

Adobe ColdFusion Documentation

grid

Required

Name of the cfgrid form
element that is the source
for the update action.

dataSource

Required

Name of the data source
for the update action.

tableName

Required

Name of the table to
update.
For ORACLE drivers,
entry must be upper-case.
For Sybase driver, entry is
case sensitive; must be
same case as used when
table was created.

keyOnly

no

Applies to the update act
ion:
yes: the WHERE
criteria are limited to the
key values.
no: the WHERE criteria
include key values and
the original values of
changed fields.

password

Optional

Overrides password valu
e specified in ODBC
setup.

tableOwner

Optional

Table owner, if supported.

tableQualifier

Optional

Table qualifier, if
supported. Purpose:
SQL Server and Oracle
driver: name of
database that contains
the table.
Intersolv dBASE driver:
directory of DBF files.

username

Optional

Overrides username valu
e specified in ODBC
setup.

Example

The following example lets you update a database by using a cfgrid tag to add and delete entire records or to
update the data in individual cells. The cfgridupdate tag processes the data from the submitted form and

© 2014 Adobe Systems Incorporated. All rights reserved.

591

Adobe ColdFusion Documentation

updates the database.







SELECT Course_ID, Dept_ID, CorNumber, CorName, CorLevel, CorDesc
FROM CourseList
ORDER by Dept_ID ASC, CorNumber ASC


    cfgrid Example
    
Try adding a course to the database, and then deleting it.



    

    ...

© 2014 Adobe Systems Incorporated. All rights reserved.

592

Adobe ColdFusion Documentation

cfheader
Description

Generates custom HTTP response headers to return to the client.
Category

Data output tags, Page processing tags
Syntax


OR


Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfcache, cfflush, cfhtmlhead, cfinclude, cfsetting, cfsilent, cfcontent
History

ColdFusion MX 6.1: Changed behavior for the name attribute: cfheader name="Content-Disposition" uses the
default file character encoding to encode this header's value, so the name of a file can include characters in the
character encoding used in the file.
Attributes

Attribute

Req/Opt

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

593

Adobe ColdFusion Documentation

charset

Optional

UTF-8

The character encoding in
which to encode the
header value. The
following list includes
commonly used values:
utf-8
iso-8859-1
windows-1252
us-ascii
shift_jis
iso-2022-jp
euc-jp
euc-kr
big5
euc-cn
utf-16
For more information
about character
encodings, see www.w3
.org/International/O-cha
rset.html.

name

Required if statusCode
not specified

Header name.

statusCode

Required if name not
specified

Number. HTTP status
code.

statusText

Optional

Explains the status code.

value

Optional

HTTP header value.

Usage

If you use this tag after the cfflush tag on a page, an error is thrown.
Example


    cfheader Example
    

    cfheader generates custom HTTP response headers to return to the client.

    This example forces browser client to purge its cache of requested file.


© 2014 Adobe Systems Incorporated. All rights reserved.

594

Adobe ColdFusion Documentation

cfhtmlhead
Description

Writes text to the head section of a generated HTML page.
Category

Page processing tags
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfcache, cfflush, cfheader, cfinclude, cfsetting, cfsilent
Attributes

Attribute

Req/Opt

text

Required

Default

Description
Text to add to the 
area of an HTML page.

Usage

Use this tag for embedding JavaScript code, or putting other HTML tags, such as meta, link, title, or base in
an HTML page header. If you use this tag after the cfflush tag on a page, an error is thrown.
Example




© 2014 Adobe Systems Incorporated. All rights reserved.

595

Adobe ColdFusion Documentation

cfhtmltopdf
 creates high quality PDF output from a text block containing CFML and HTML using the PDF Service
Manager.
The WebKit implementation for  is referred as PDFG (acronym of PDF Generator) which is shipped as
part of the Jetty installer. The component running inside the Jetty server is referred as the service manager, which
takes request for PDF conversion from one or many ColdFusion server/s. (In Windows, the service runs as the
ColdFusion 11 Add-on service, which processes both Solr and PDFG requests.)
The WebKit implementation for :
Encapsulates the PDF conversion library.
Performs HTML to PDF conversion in process.

When you generate a PDF using HTML or CFML, you have to ensure that XSS vulnerabilities cannot be exploited.
Hence, you must take relevant measures to protect your system against such vulnerabilities. Also, note that
ColdFusion provides encoding functions for XSS protection. See the following functions:
EncodeForHTML
Canonicalize
Category

Data output tags
See Also

cfhtmltopdfitem
Syntax

© 2014 Adobe Systems Incorporated. All rights reserved.

596

Adobe ColdFusion Documentation



Attributes

Attribute

Req/Opt

Default

Description

encryption

Optional

none

AES_128
RC4_40
RC4_128
RC4_128M
None

destination

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

Pathname of a file to
contain the PDF output. If
you omit the destinati
on attribute, ColdFusion
displays the output in the
browser.

597

Adobe ColdFusion Documentation

marginBottom

Optional

Bottom margin in inches
(default) or centimeters.
To specify the bottom
margin in centimeters,
include the unit=cm attri
bute.

marginLeft

Optional

Left margin in inches
(default) or centimeters.
To specify the left margin
in centimeters, include the
unit=cm attribute.

marginRight

Optional

Right margin in inches
(default) or centimeters.
To specify the right
margin in centimeters,
include the unit=cm attri
bute.

marginTop

Optional

Top margin in inches
(default) or centimeters.
To specify the top margin
in centimeters, include the
unit=cm attribute.

name

Optional

Name of an existing
variable into which the tag
stores the PDF.

orientation

Optional

portrait

Page orientation:
portrait
landscape

overwrite

Optional

ownerPassword

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

no

Specifies whether
ColdFusion overwrites an
existing file. Used in
conjunction with the dest
ination attribute.
Specifies the owner
password. Cannot be
same as userPassword.

598

Adobe ColdFusion Documentation

pageHeight

Optional

pageType

Optional

Page height in inches
(default) or centimeters.
This attribute is only valid
if pagetype=custom. To
specify page height in
centimeters, include the u
nit=cm attribute.
letter

Page type into which
ColdFusion generates the
report:

legal: 8.5 inches x 14
inches.
letter: 8.5 inches x 11
inches.
A4: 8.27 inches x 11.69
inches.
A5: 5.81 inches x 8.25
inches.
B4: 9.88 inches x 13.88
inches.
B5: 7 inches x 9.88
inches.
B4-JIS: 10.13 inches x
14.31 inches.
B5-JIS: 7.19 inches x
10.13 inches.
custom: custom height
and width.
If you specify custom, also
specify the pageHeight
and pageWidth attribute
s, can optionally specify m
argin attributes and
whether the units are
inches or centimeters.

© 2014 Adobe Systems Incorporated. All rights reserved.

599

Adobe ColdFusion Documentation

pageWidth

Optional

Page width in inches
(default) or centimeters.
This attribute is only valid
if pageType=custom. To
specify page width in
centimeters, include the u
nit=cm attribute.

permissions

Optional

(format="PDF" only)
Sets one or more of the
following permissions:
AllowPrinting
AllowModifyContents
AllowCopy
AllowModifyAnnotati
ons
AllowFillIn
AllowScreenReaders
AllowAssembly
AllowDegradedPrinti
ng
AllowSecure
All
None
Separate multiple
permissions with commas.

saveAsName

Optional

unit

Optional

The filename that appears
in the SaveAs dialog
when a user saves a PDF
file written to the browser.
in

Default unit for the pageH
eight, pageWidth, and
margin attributes:
in: inches.
cm: centimeters.

© 2014 Adobe Systems Incorporated. All rights reserved.

600

Adobe ColdFusion Documentation

userPassword

Optional

Specifies a user
password. Cannot be
same as ownerPasswor
d.

Note:  is added to support adding header/footer/pagebreak in the generated PDF. See The new
 tag.

Examples

The following example shows the most basic usage of , to create a PDF from CFML code, returning a
PDF for display:


This is a test #now()#


The following example shows the most basic usage of , to create a PDF from content returned from a
URL, returning a PDF for display:



The following example shows using options to control height, width, and save the content to a file instead of for
display. The file is saved (by default) into the same directory as the template containing the code:



The following example shows how you can set margins, and also adds code to display the resulting file to the user
using CFContent:

© 2014 Adobe Systems Incorporated. All rights reserved.

601

Adobe ColdFusion Documentation




The following example shows how you can protect the PDF, requiring the user to enter a password to open the file:



© 2014 Adobe Systems Incorporated. All rights reserved.

602

Adobe ColdFusion Documentation

cfhtmltopdfitem
 specifies the action items for a PDF document created by the < cfhtmltopdf> tag. The type
attribute takes the following values:
header
footer
pagebreak
Category

Data output tags
Syntax



Attributes
Attribute

Req/Opt

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

603

Adobe ColdFusion Documentation

type

Required

none

Specifies the action:
header: uses the
text/image specified
between the
 and
 tags
as the running header.
footer: uses the
text/image between the
 and
 tags
as the the running
footer.
pagebreak: can be used
to insert a pagebreak in
the generated PDF.
When  is
used as a service,
pagebreak will not work.
Note:
When
the
type is
"heade
r", the
margin
bottom
attribut
e will
not be
suppor
ted.
Similar
ly,
when
type is
"footer
", the
margin
top attr
ibute
will not
be
suppor
ted.

isBase64

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

Yes/No. Use this only
when the image attribute
is given a base64 image
string.

604

Adobe ColdFusion Documentation

showonprint

Optional

align

Optional

Center

Alignment of the text. Left,
Right, or Center.

marginleft

Optional

1.0

Left margin in inches
(default) or centimeters.
To specify the left margin
in centimeters, include the
unit=cm attribute.

marginright

Optional

1.0

Right margin in inches
(default) or centimeters.
To specify the left margin
in centimeters, include the
unit=cm attribute.

margintop

Optional

0.5

Top margin in inches
(default) or centimeters.
To specify the left margin
in centimeters, include the
unit=cm attribute.

marginbottom

Optional

0.5

Bottom margin in inches
(default) or centimeters.
To specify the bottom
margin in centimeters,
include the unit=cm attri
bute.

opacity

Optional

10

Opacity of the
header/footer. Specify a
valid number. A number
between 1 and 10.

numberformat

Optional

Numeric

The page number format
to be used.
LOWERCASEROMAN|N
UMERIC|UPPERCASER
OMAN

© 2014 Adobe Systems Incorporated. All rights reserved.

Show or hide
header/footer when the
document is printed.

605

Adobe ColdFusion Documentation

image

Optional

The image file name or
object to be used as
header or footer.
The following parameters
are supported:
A path to the image file
A Base-64 string
A byte array
A  object

Examples



Page: _PAGENUMBER of _LASTPAGENUMBER






You can access the following scope variables in  content:
_PAGENUMBER – Add current page number.
_LASTPAGENUMBER – Add last page number.

© 2014 Adobe Systems Incorporated. All rights reserved.

606

Adobe ColdFusion Documentation

cfhttp
Description

Generates an HTTP request and handles the response from the server.
Category

Internet protocol tags
Syntax


cfhttpparam tags [optional for some methods]


Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

© 2014 Adobe Systems Incorporated. All rights reserved.

607

Adobe ColdFusion Documentation

cfhttpparam, GetHttpRequestData, cfftp, cfldap, cfmail, cfpop
History

ColdFusion 11: Added support for NTLM authentication. Three attributes added - authType, domain, and
workstation. Also, this tag supports SNI (server name indication) only if ColdFusion is running on an Oracle 1.7+
JVM.
ColdFusion 8: Added the clientCert and clientCertPassword attributes.
ColdFusion MX 7.01: Added the "never" value of the getAsBinary attribute.
ColdFusion MX 7: Added the result attribute.
ColdFusion MX 6.1:
Added support for the following methods: HEAD, PUT, DELETE, OPTIONS, TRACE.
Added multipart, getAsBinary, proxyUser, and proxyPassword attributes.
Changed httpparam behavior: all operations can have httpparam tags.
Added the cfhttp.errorDetail return variable.
Modified response body content types considered to be text.
Changed behavior for multiple headers: multiple headers of the same type are returned in an array.
Added support for HTTPS proxy tunneling.
Fixed bugs in code and documentation.
ColdFusion MX:
Added the charset and firstrowasheaders attributes.
Changed Secure Sockets Layer (SSL) support: ColdFusion uses the Sun JSSE library, which supports
128-bit encryption, to support SSL.
Attributes

The following attributes control the HTTP transaction and can be used for all HTTP methods:
Attribute

Req/Opt

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

608

Adobe ColdFusion Documentation

url

Required

Uses the http protocol

Address of the resource
on the server that handles
the request. The URL
must include the
hostname or IP address.
If you do not specify the
transaction protocol
(http:// or
https://
), ColdFusion uses the
default protocol, http.
If you specify a port
number in this attribute, it
overrides any port attribu
te value.
The cfhttpparam tag U
RL attribute appends
query string
attribute-value pairs to the
URL.

charset

Optional

For request: UTF-8 For
response: charset speci
fied by response ContentType header, or UTF-8 if
response does not specify
charset.

The character encoding of
the request, including the
URL query string and form
or file data, and the
response. The following
list includes commonly
used values:
utf-8
iso-8859-1
windows-1252
us-ascii
shift_jis
iso-2022-jp
euc-jp
euc-kr
big5
euc-cn
utf-16
For more information
character encodings,
see www.w3.org/Intern
ational/O-charset.html.

clientCert

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

The full path to a PKCS12
format file that contains
the client certificate for the
request.

609

Adobe ColdFusion Documentation

clientCertPassword

Optional

Password used to decrypt
the client certificate.

compression

Optional

The target webserver's
compression status. The
only supported value is
none. If the target website
runs on IIS with HTTP
compression enabled, use
this attribute to avoid a
connection failure while
performing GET or POST
operations.

© 2014 Adobe Systems Incorporated. All rights reserved.

610

Adobe ColdFusion Documentation

getAsBinary

Optional

no

method

Optional

GET

© 2014 Adobe Systems Incorporated. All rights reserved.

no: if ColdFusion does
not recognize the
response body type as
text, converts it to a
ColdFusion object.
auto: if ColdFusion
does not recognize the
response body type as
text, converts it to
ColdFusion Binary type
data.
yes: always converts
the response body
content into ColdFusion
Binary type data, even if
ColdFusion recognizes
the response body type
as text.
never: prevents the
automatic conversion of
certain MIME types to
the ColdFusion Binary
type data; treats the
returned content as
text.
ColdFusion recognizes
the response body as
text if:
the header does not
specify a content type.
the content type starts
with "text".
the content type starts
with "message".
the content type is
"application/octet-strea
m".
If ColdFusion does not
recognize the body as
text and converts it to
an object, but the body
consists of text, the cfo
utput tag can display
it. The cfoutput tag
cannot display Binary
type data. (To convert
binary data to text, use
the ToString function.
)

611

Adobe ColdFusion Documentation

GET: requests
information from the
server. Any data that
the server requires to
identify the requested
information must be in
the URL or in cfhttp t
ype="URL" tags.
POST: sends
information to the
server for processing.
Requires one or more c
fhttpparam tags.
Often used for
submitting form-like
data.
PUT: requests the
server to store the
message body at the
specified URL. Use this
method to send files to
the server.
DELETE: requests the
server to delete the
specified URL.
HEAD: identical to the G
ET method, but the
server does not send a
message body in the
response. Use this
method for testing
hypertext links for
validity and
accessibility,
determining the type or
modification time of a
document, or
determining the type of
server.

© 2014 Adobe Systems Incorporated. All rights reserved.

612

Adobe ColdFusion Documentation

TRACE: requests that
the server echo the
received HTTP headers
back to the sender in
the response body.
Trace requests cannot
have bodies. This
method enables the
ColdFusion application
to see what is being
received at the server,
and use that data for
testing or diagnostic
information.
OPTIONS: a request for
information about the
communication options
available for the server
or the specified URL.
This method enables
the ColdFusion
application to determine
the options and
requirements
associated with a URL,
or the capabilities of a
server, without
requesting any
additional activity by the
server.
password

Optional

port

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

Use to pass a password
to the target URL for
Basic Authentication.
Combined with username
to form a base64 encoded
string that is passed in the
Authenticate header.
Does not provide support
for Integrated Windows,
NTLM, or Kerebos
authentication.
80 for http443 for https

Port number on the server
to which to send the
request. A port value in
the url attribute overrides
this value.

613

Adobe ColdFusion Documentation

proxyServer

Optional

Host name or IP address
of a proxy server to which
to send the request.

proxyPort

Optional

proxyUser

Optional

User name to provide to
the proxy server.

proxyPassword

Optional

Password to provide to
the proxy server.

redirect

Optional

80

yes

Port number to use on the
proxy server.

If the response header
includes a Location field
AND ColdFusion receives
a 300-series (redirection)
status code, specifies
whether to redirect
execution to the URL
specified in the field:
yes: redirects execution
to the specified page.
no: stops execution and
returns the response
information in the cfht
tp variable, or throws
an error if the throwOn
Error attribute is True.
The cfhttp.respons
eHeader.Location v
ariable contains the
redirection path.
ColdFusion follows a
maximum of four
redirects on a request.
If there are more,
ColdFusion functions as
if redirect = "no".
Note: The cflocatio
n tag generates an
HTTP 302 response
with the url attribute as
the Location header
value.

© 2014 Adobe Systems Incorporated. All rights reserved.

614

Adobe ColdFusion Documentation

resolveURL

Optional

result

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

no

no: does not resolve
URLs in the response
body. As a result, any
relative URL links in the
response body do not
work.
yes: resolves URLs in
the response body to
absolute URLs,
including the port
number, so that links in
a retrieved page remain
functional. Applies to
these HTML tags:
img
src
a href
form action
applet code
script src
embed src
embed pluginspace
body background
frame src
bgsound src
object data
object classid
object codebase
object usemap
Does not resolve URLs
if the file and path at
tributes are used.
Lets you specify an
alternate variable in which
to receive a result.

615

Adobe ColdFusion Documentation

throwOnError

Optional

timeout

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

no

yes: if the server
returns an error
response code, throws
an exception that can
be caught using the cf
try and cfcatch or
ColdFusion error pages.
no: does not throw an
exception if an error
response is returned. In
this case, your
application can use the
cfhttp.StatusCode
variable to determine if
there was an error and
its cause.
Value, in seconds, that is
the maximum time the
request can take. If the
time-out passes without a
response, ColdFusion
considers the request to
have failed. If the client
specifies a time-out in the
URL search parameter
(for example,
?RequestTime=120)
ColdFusion uses the
lesser of the URL time-out
and the timeout attribute
value; this ensures that
the request times out
before, or at the same
time as, the page.
If the URL does not
specify a time-out,
ColdFusion uses the
lesser of the Administrator
time-out and the timeout
attribute value.
If the time-out is not set in
any of these, ColdFusion
waits indefinitely for the c
fhttp request to
process.

616

Adobe ColdFusion Documentation

userAgent

Optional

username

Optional

authType

Optional

ColdFusion

Text to put in the user
agent request header.
Used to identify the
request client software.
Can make the ColdFusion
application appear to be a
browser.
Use to pass a user name
to the target URL for
Basic Authentication.
Combined with password
to form a base64 encoded
string that is passed in the
Authenticate header.
Does not provide support
for Integrated Windows,
NTLM, or Kerberos
authentication.

BASIC

The supported values are:
BASIC
NTLM
Note: For NTLM, to work,
the redirect attribute must
be set to false.

domain

Optional

The domain name for
authentication. (Use for
NTLM-based
authentication)

workstation

Optional

The workstation name for
authentication. (Use for
NTLM-based
authentication)

The following attribute is used with the PUT method to determine how to send data specified with httpparam
type="formField":
Attribute

Req/Opt

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

617

Adobe ColdFusion Documentation

multipart

Optional

no (Sends as multipart
only if request includes
File type data.)

Tells ColdFusion to send
all data specified by cfht
tpparam
type="formField" tag
s as multipart form data,
with a Content-Type of
multipart/form-data. By
default, ColdFusion sends
cfhttp requests that
contain only formField
data with a Content Type
of
application/x-www-form-ur
lencoded. (If the request
also includes File type
data, ColdFusion uses the
multipart/form-data
content type for all parts.)
If yes, ColdFusion also
sends the request's
charset in each
Content-Type description.
All form field data must be
encoded in this character
encoding, and ColdFusion
does not URLEncode the
data. (The field name
must be in ISO-88591-1
or ASCII.) Some http
parsers, including the one
used by previous versions
of ColdFusion, ignore the
multipart form field
character encoding
description.

The following attribute sets a multipart header field and is used, for example, for uploading videos on YouTube.
Attribute

Req/Opt

Default

Description

multipartType

Optional

form-data

Allows you to set the
multipart header field to r
elated or form-data.
By default, the value is fo
rm-data.

Example:




© 2014 Adobe Systems Incorporated. All rights reserved.

618

Adobe ColdFusion Documentation

























WithOutQuotes
Test Description
People

yourvideo


















© 2014 Adobe Systems Incorporated. All rights reserved.

619

Adobe ColdFusion Documentation




The following attribute allows you to specify the name of the variable in which you would like the results of the
operation returned. The name you specify replaces cfhttp as the prefix by which you access the returned
variables. For example, if you set the result attribute to myResult, you would access FileContent as #myResu
lt.FileContent#.
The result attribute allows functions or CFCs that are called from multiple pages at the same time to avoid
overwriting the results of one call with another. For information about the variables returned by a cfhttp get
operation, see the section Variables returned by a cfhttp get operation in the Usage section.
Attribute

Req/Opt

result

Optional

Default

Description
Specifies the name of the
variable in which you want
the result returned.

The following attributes tell ColdFusion to put the HTTP response body in a file. You can put the response body in a
file for GET, POST, PUT, DELETE, OPTIONS, and TRACE methods, but it is generally not useful with the DELETE
or OPTIONS method.
Attribute

Req/Opt

Default

Description

file

Required if path is
specified and not a GET
method

See Description

Name of the file in which
to store the response
body. For a GET
operation, the default is
the file requested in the
URL, if there is one. For
example, if the URL in a
GET method is
http:www.myco.com/test.h
tm, the default file is
test.htm. Do not specify
the path to the directory in
this attribute; use the pat
h attribute.

path

Required if file is
specified.

Tells ColdFusion to save
the HTTP response body
in a file. Contains the
absolute path to the
directory in which to store
the file.

Use the following syntax in the path attribute to specify an in-memory directory for your files. In-memory files speed
processing of transient data.

© 2014 Adobe Systems Incorporated. All rights reserved.

620

Adobe ColdFusion Documentation

ram:///filepath

The filepath can include multiple directories, for example ram:///petStore/images. Create the directories in the
path before you can use them. For more information on using in-memory files, see Working with in-memory files in
Optimizing ColdFusion applications in the Developing ColdFusion Applications.
The following attributes tell ColdFusion to convert the HTTP response body into a ColdFusion query object. They
can be used with the GET and POST methods only.
Attribute

Req/Opt

Default

Description

columns

Optional

First row of response
contains column names.

The column names for the
query, separated by
commas, with no spaces.
Column names must start
with a letter. The
remaining characters can
be letters, numbers, or
underscore characters (_).
If there are no column
name headers in the
response, specify this
attribute to identify the
column names. If you
specify this attribute, and
the firstrowasHeader
attribute is True (the
default), the column
names specified by this
attribute replace the first
line of the response. You
can use this behavior to
replace the column names
retrieved by the request
with your own names.
If a duplicate column
heading is encountered in
either this attribute or in
the column names from
the response, ColdFusion
appends an underscore to
the name to make it
unique.
If the number of columns
specified by this attribute
does not equal the
number of columns in the
HTTP response body,
ColdFusion generates an
error.

© 2014 Adobe Systems Incorporated. All rights reserved.

621

Adobe ColdFusion Documentation

delimiter

Optional

, (comma)

A character that separates
query columns. The
response body must use
this character to separate
the query columns.

firstrowasheaders

Optional

yes

Determines how
ColdFusion processes the
first row of the query
record set:
yes: processes the first
row as column heads. If
you specify a columns
attribute, ColdFusion
ignores the first row of
the file.
no: processes the first
row as data. If you do
not specify a columns
attribute, ColdFusion
generates column
names by appending
numbers to the word
"column"; for example,
"column_1".

name

Optional

textQualifier

Optional

Tells ColdFusion to create
a query object with the
given name from the
returned HTTP response
body.
" double-quotation mark

A character that,
optionally, specifies the
start and end of a text
column. This character
must surround any text
fields in the response
body that contain the
delimiter character as part
of the field value.
To include this character
in column text, escape it
by using two characters in
place of one. For
example, if the qualifier is
a double-quotation mark,
escape it as "".

Usage

© 2014 Adobe Systems Incorporated. All rights reserved.

622

Adobe ColdFusion Documentation

The cfhttp tag is a general-purpose tool for creating HTTP requests and handling the returned results. It enables
you to generate most standard HTTP request types. You use embedded cfhttpparam tags to specify request
headers and body content.
When ColdFusion receives a response to a cfhttp request, it can put the response body (if any) in a file or the cfh
ttp.FileContent string variable. If the body text is structured as a result set, ColdFusion can put the body text in
query object. You can also access the values of all returned headers and specify how to handle error status and
redirections, and specify a time-out to prevent requests from hanging.
The HTTP protocol is the backbone of the World Wide Web and is used for every web transaction. Because the cfh
ttp tag can generate most types of requests, it provides significant flexibility. Possible uses include:
Interacting with dynamic web sites and services that are not available as web services. (Use the cfinvoke t
ag to access SOAP web services.)
Getting the contents of an HTML page or other file such as an image on a web server for use in your CFML
page or storage in a file.
Sending a secure request to a server by specifying the https protocol in the url attribute.
Using the POST method to send a multipart/form-data style post to any URL that can handle such data and
return results, including CGI executables or even other ColdFusion pages.
Using the PUT method to upload files to a server that does not accept FTP requests.
This tag can, and for PUT and POST requests must, have a body that contains cfhttpparam tags. If this
tag has cfhttpparam tags, it must have a  end tag.
To use HTTPS with the cfhttp tag, you might need to manually import the certificate for each web server
into the keystore for the JRE that ColdFusion uses. This procedure should not be necessary if the certificate
is signed (issued) by an authority that the JSSE (Java Secure Sockets Extension) recognizes (for example,
Verisign); that is, if the signing authority is in the cacerts already. However, you might need to use the
procedure if you are issuing SSL (secure sockets layer) certificates yourself.
Manually import a certificate

1.
2.
3.
4.
5.
6.
7.

Go to a page on the SSL server in question.
Double-click the lock icon.
Click the Details tab.
Click Copy To File.
Select the base64 option and save the file.
Copy the CER file into C:\ColdFusion9\runtime\jre\lib\security (or whichever JRE ColdFusion is using).
Run the following command in the same directory (keytool.exe is located in C:\ColdFusion9\runtime\jre\bin):

keytool -import -keystore cacerts -alias giveUniqueName -file filename.cer

Variables returned by a cfhttp get operation

The cfhttp tag returns the following variables. If you set the result attribute, the name you assign replaces cfht
tp as the prefix. For additional information, see the result attribute.
Name

Description

cfhttp.charSet

Response character character set (character encoding)
specified by the response Content-Type header.

© 2014 Adobe Systems Incorporated. All rights reserved.

623

Adobe ColdFusion Documentation

cfhttp.errorDetail

If the connection to the HTTP server fails, contains
details about the failure. For instance: "Unknown host:
my.co.com"; otherwise, the empty string. recommends
that you check this variable for an error condition
before checking other variables.

cfhttp.fileContent

Response body; for example, the contents of an html
page retrieved by a GET operation. Empty if you save
the response in a file.

cfhttp.header

Raw response header containing all header information
in a single string. Contains the same information as the
cfhttp.responseHeader variable.

cfhttp.mimeType

MIME type specified by the response Content-Type
header; for example, text/html.

cfhttp.responseHeader

The response headers formatted into a structure. Each
element key is the header name, such as Content-Type
or Status_Code. If there is more than one instance of a
header type, the type values are put in an array. One
common technique is to dynamically access the
cfhttp.responseHeader structure as a dynamic array;
for example, #cfhttp.resonseHeaderfieldVaria
ble#.

cfhttp.statusCode

The HTTP status_code header value followed by the
HTTP Explanation header value; for example, "200
OK".

cfhttp.text

Boolean; true if the response body content type is
text. ColdFusion recognizes the response body as text
in the following situations:
if the header does not specify a content type
if the content type starts with "text"
if the content type starts with "message"
if the content type is "application/octet-stream"

Building a query from a delimited text file

The cfhttp tag can create a ColdFusion query object form the response body. To do so, the response body must
consist of lines of text, with each line having fields that are delimited by a character that identifies the column breaks.
The default delimiter is a comma (,). The response data can also use a text qualifier; the default is a
double-quotation mark ("). If you surround a string field in the text qualifier, the field can contain the delimiter
character. To include the text qualifier in field text, escape it by using a double character. The following line shows a
two-line request body that is converted into a query. It has three comma-delimited fields:

© 2014 Adobe Systems Incorporated. All rights reserved.

624

Adobe ColdFusion Documentation

Field1,Field2,Field3
"A comma, in text","A quote: ""Oh My!""",Plain text

Run the following code to show how ColdFusion treats this data:



    

Column names can be specified in three ways:
By default, ColdFusion uses the first row of the response as the column names.
If you specify a comma-delimited columns attribute, ColdFusion uses the names specified in the attribute as
the column names. Set firstRowAsHeaders="no" if the first row of the response contains data.
Otherwise, ColdFusion ignores the first row.
If you do not specify a columns attribute and set firstrowasheaders="no", ColdFusion generates
column names of the form Column_1, Column2, etc.
The cfhttp tag checks to ensure that column names in the data returned by the tag start with a letter and
contain only letters, numbers, and underscore characters ().ColdFusion checks for invalid column names.
Column names must start with a letter. The remaining characters can be letters, numbers, or underscores ( ).
If a column name is not valid, ColdFusion generates an error.
Notes

For the ColdFusion Administrator time-out and the URL time-out to take effect, enable the time-out in the
ColdFusion Administrator, Server Settings page. For more information, see Configuring and Administering
ColdFusion.
The cfhttp tag supports Basic Authentication for all operations.
The cfhttp tag uses SSL to negotiate secure transactions.
If you put the HTTP response body in a file, ColdFusion does not put it in the CFHTTP.FileContent variable or
generate a query object. If you do not put the response body in a file, ColdFusion puts it in the
CFHTTP.FileContent variable; if you specify a name attribute ColdFusion generates a query object.
The cfhttp tag does not support NTLM or Digest Authentication.
If you are using Microsoft IIS, there is no HTTP header size limit. To specify an HTTP header size limit, set it
in IIS.
Example

© 2014 Adobe Systems Incorporated. All rights reserved.

625

Adobe ColdFusion Documentation














#item.title.xmltext#
    
Author  #item.author.xmltext#
    
Applies to these products
    

#item.xmlChildren[i].xmlAttributes.Name#
    
    

    
    
    

© 2014 Adobe Systems Incorporated. All rights reserved.

626

Adobe ColdFusion Documentation

cfhttpparam
Description

Allowed inside cfhttp tag bodies only. Required for cfhttp POST operations. Optional for all others. Specifies
parameters to build an HTTP request.
Category

Internet protocol tags
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfhttp, GetHttpRequestData, cfftp, cfldap, cfmail, cfmailparam, cfpop
History

ColdFusion MX 6.1:
Added the header and body types.
Added the encoded and mimeType attributes.
Changed HTTP method behavior: all HTTP methods can have httpparam tags.
Changed the name attribute requirements: it is not required for all types.
Attributes

Attribute

Req/Opt

type

Required

Default

Description
Information type:
header: specifies an
HTTP header.
ColdFusion does not
URL encode the
header.

© 2014 Adobe Systems Incorporated. All rights reserved.

627

Adobe ColdFusion Documentation

CGI: specifies an HTTP
header. ColdFusion
URL encodes the
header by default.
body: specifies the
body of the HTTP
request. ColdFusion
does not automatically
set a content-type
header or URL encode
the body contents. To
specify the
content-type, use a
separate cfhttppara
m tag with type=heade
r.
XML: identifies the
request as having a
content-type of text/xml.
Specifies that the valu
e attribute contains the
body of the HTTP
request. Used to send
XML to the destination
URL. ColdFusion does
not URL encode the
XML data.
file: tells ColdFusion
to send the contents of
the specified file.
ColdFusion does not
URL encode the file
contents.
URL: specifies a URL
query string name-value
pair to append to the cf
http url attribute.
ColdFusion URL
encodes the query
string.
formField: specifies a
form field to send.
ColdFusion URL
encodes the Form field
by default.
cookie: specifies a
cookie to send as an
HTTP header.
ColdFusion URL
encodes the cookie.

© 2014 Adobe Systems Incorporated. All rights reserved.

628

Adobe ColdFusion Documentation

encoded

Optional

file

Required only if type="F
ile"

Applies to File type;
ignored for all other types.
The absolute path to the
file that is sent in the
request body.

mimeType

Optional

Applies to File type;
invalid for all other types.
Specifies the MIME media
type of the file contents.
The content type can
include an identifier for the
character encoding of the
file; for example, text/html;
charset=ISO-8859-1
indicates that the file is
HTML text in the ISO
Latin-1 character
encoding.

name

Required. Optional (and
ignored) for Body and
XML types

Variable name for data
that is passed. Ignored for
Body and XML types. For
File type, specifies the
filename to send in the
request.

value

Required. Optional (and
ignored) for File type

Value of the data that is
sent. Ignored for File type.
The value must contain
string data or data that
ColdFusion can convert to
a string for all type attrib
utes except Body. Body
types can have string or
binary values.

yes

Applies to FormField and
CGI types; ignored for all
other types. Specifies
whether to URL encode
the form field or header.

Usage

Specifies header or body data to send in the HTTP request. The type attribute identifies the information that the
parameter specifies. A cfhttp tag can have multiple cfhttpparam tags, subject to the following limitations:
An XML type attribute cannot be used with additional XML type attributes, or with body, file, or formFiel
d type attributes.
A body type attribute cannot be used with additional body type attributes, or with XML, file, or formFiel

© 2014 Adobe Systems Incorporated. All rights reserved.

629

Adobe ColdFusion Documentation

d type attributes.
The XML and body type attributes cannot be used with the cfhttp tag TRACE method.
The file type attribute is only meaningful**with the cfhttp tag POST and PUT methods.
The formField type attribute is only meaningful**with the cfhttp tag POST and GET methods.
If you send an HTTP request to a ColdFusion page, all HTTP headers, not just those sent using the CGI type,
are available as CGI scope variables, However, any custom variables (such as "myVar") do not appear in a
dump of the CGI scope.
When you send a file using the type="file" attribute, the file content is sent in the body of a
multipart/form-data request. If you send the file to a ColdFusion page, the Form scope of the receiving page
contains an entry with the name you specified in the cfhttpparam tag name attribute as the key. The value
of this variable is the path to a temporary file containing the file that you sent. If you also send Form field data,
the location of the filename in the form.fieldnames key list depends on the position of the cfhttpparam tag
with the file relative to the cfhttp tags with the form data.URL-encoding preserves special characters (such
as the ampersand) when they are passed to the server. For more information, see the function URLEncoded
Format. To send arbitrary data in a "raw" HTTP message, use a cfhttpparam tag with a type="body" attri
bute to specify the body content and use cfhttpparam tags with a type="header" attributes to specify
the headers.
Example

© 2014 Adobe Systems Incorporated. All rights reserved.

630

Adobe ColdFusion Documentation











#cfhttp.fileContent#




    Output the passed variables
    

Form variable: #form.form_test#

    URL variable: #URL.url_test#

    Cookie variable: #Cookie.cookie_test#

    CGI variable: #CGI.cgi_test#
    

    Note that the CGI variable is URL encoded.
    

#back to top

© 2014 Adobe Systems Incorporated. All rights reserved.

631

Adobe ColdFusion Documentation

Tags i
This section lists tags starting with alphabet I with their description.
cfif
cfimage
cfimap
cfimapfilter
cfimpersonate
cfimport
cfinclude
cfindex
cfinput
cfinsert
cfinterface
cfinvoke
cfinvokeargument

© 2014 Adobe Systems Incorporated. All rights reserved.

632

Adobe ColdFusion Documentation

cfif
Description

Creates simple and compound conditional statements in CFML. Tests an expression, variable, function return value,
or string. Used, optionally, with the cfelse and cfelseif tags.
Category

Flow-control tags
Syntax


HTML and CFML tags
HTML and CFML tags

HTML and CFML tags




See also

cfelse, cfelseif, cfabort, cfbreak, cfexecute, cfexit, cflocation, cfloop, cfswitch, cfthrow, cf
try
Usage

If the value of the expression in the cfif tag is true, ColdFusion processes all the code that follows, up to any cfe
lseif or cfelse tag, and then skips to the cfif end tag. Otherwise, ColdFusion does not process the code that
immediately follows the cfif tag, and continues processing at any cfelseif or cfelse tag, or with the code that
follows the cfif end tag.
When testing the return value of a function that returns a Boolean, you do not have to define the True condition
explicitly. This example uses the IsArray function:



If successful, IsArray evaluates to yes, the string equivalent of the Boolean True. This is preferred over explicitly
defining the True condition this way:



This tag requires an end tag.
Example

In this example, variables are shown within number signs. This is not required.



© 2014 Adobe Systems Incorporated. All rights reserved.

633

Adobe ColdFusion Documentation



SELECT Center_ID, Name, Address1, Address2, City, State, Country, PostalCode,
Phone, Contact
FROM Centers
ORDER by City, State, Name


    CFIF gives us the ability to perform conditional logic based on a condition
or set of conditions.
    

    For example, we can output the list of Centers from the snippets datasource
by group and only display them IF City = San Diego.
    

    


    The following centers are in San Diego:
    



    Name/Address:#Name#, #Address1#, #City#, #State#

    Contact: #Contact#

    
    
    

    

    If we would like more than one condition to be the case, we can ask for a list of
the
centers in San Diego OR Santa Ana. If the center does not follow this
condition, we
can use CFELSE to show only the names and cities of the other centers.
    

    Notice how a nested CFIF is used to specify the location of the
featured site (Santa Ana or San Diego).
    


    Complete information is shown for centers in San Diego or Santa Ana.
All other centers are listed in italic:
    



    Featured Center in

San Diego

Santa Ana


     Name/Address:#Name#, #Address1#, #City#, #State#

    Contact: #Contact#
    


    #Name#, #City#
    
    

    

    Finally, we can use CFELSEIF to cycle through a number of conditions and
produce varying output. Note that you can use CFCASE and CFSWITCH for a more
elegant representation of this behavior.




    #Name#, #City# (this one is in
San Diego
Santa Ana
)

© 2014 Adobe Systems Incorporated. All rights reserved.

634

Adobe ColdFusion Documentation



    #Name#, #City# (this one is in San Francisco)


    #Name#, #City# (this one is in Suisun)
 
    #Name#
Not in a city we track
    
    

© 2014 Adobe Systems Incorporated. All rights reserved.

635

Adobe ColdFusion Documentation

cfimage
Description

Creates a ColdFusion image. You can use the cfimage tag to perform common image manipulation operations as
a shortcut to Image functions. You can use the cfimage tag independently or in conjunction with Image functions.
History

ColdFusion 10: Added the attribute interpolation to {{cfimage action = "resize"}}
ColdFusion 8: Added this tag.
Category

Other tag
Syntax

Add a border to an image

Create a CAPTCHA image

Convert an image file format

Retrieve information about an image

Read an image into memory

Resize an image

interpolation = "interpolation algorithm"
Rotate an image

Write an image to a file

Write an image to the browser


Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

ImageAddBorder, ImageCreateCaptcha, ImageInfo,
ImageNew, ImageRead, ImageReadBase64, ImageResi
ze, ImageRotate, ImageWrite, ImageWriteBase64,
Creating and Manipulating ColdFusion Images in
the Developing ColdFusion Applications
Attributes

Attribute

Action

Req/Opt

Default

Description

action

N/A

Optional

read

Action to take. Must
be one of the
following:
border
captcha
convert
info
read
resize
rotate
write
writeToBrowse
r
The default action
is read, which
you do not need
to specify
explicitly.

angle

rotate

© 2014 Adobe Systems Incorporated. All rights reserved.

Required

Angle in degrees to
rotate the
image.Specify an
integer for the value.

639

Adobe ColdFusion Documentation

color

border

© 2014 Adobe Systems Incorporated. All rights reserved.

Optional

black

Border
color.Hexadecimal
value or supported
named color; see
the name list in
Valid HTML named
colors section. For a
hexadecimal value,
use the form "##xx
xxxx" or "xxxxxx"
, where x = 0-9 or
A-F; use two
number signs or
none.

640

Adobe ColdFusion Documentation

destination

border captcha c
onvert resize ro
tate write

Optional (see
Description)

Absolute or relative
pathname where the
image output is
written. The image
format is determined
by the file extension.
The convert and w
rite actions
require a destinat
ion attribute. The b
order, captcha, r
esize, and rotate
actions require a na
me attribute or a de
stination attribut
e. You can specify
both. ColdFusion
supports only
CAPTCHA images
in PNG format.
Where the
CAPTCHA image is
placed depends on
the following:
If destination i
s specified, image
is written to the
file (based on the
absolute or
relative pathname
you specify).
If name is
specified, image
is written to the
image variable.
If neither destin
ation nor name i
s specified, image
is written to the
browser.

difficulty

captcha

Optional

low

Level of complexity
of the CAPTCHA
text. Specify one of
the following levels
of text distortion:
low
medium
high

© 2014 Adobe Systems Incorporated. All rights reserved.

641

Adobe ColdFusion Documentation

fonts

captcha

Optional

fontSize

captcha

Optional

24

Font size of the text
in the CAPTCHA
image.
The value must be
an integer.

format

writeToBrowser

Optional

PNG

Format of the image
displayed in the
browser. If you do
not specify a format,
the image is
displayed in PNG
format.
You cannot display
a GIF image in a
browser. GIF
images are
displayed in PNG
format.

height

captcha resize

Required

© 2014 Adobe Systems Incorporated. All rights reserved.

One or more valid
fonts to use for the
CAPTCHA text.
Separate multiple
fonts with commas.
If the specified font
is not available, falls
back to system
fonts.

Height in pixels of
the image.
For the resize attri
bute, you also can
specify the height as
a percentage (an
integer followed by
the percent (%)symb
ol).
When you resize an
image, if you specify
a value for the
width, you can let
ColdFusion
calculate the aspect
ratio by specifying ""
as the height.
If specified, the
value must be an
integer.

642

Adobe ColdFusion Documentation

interpolation

resize

Optional

highestQuality

Specify a specific
interpolation
algorithm by name
(for example, hammi
ng), by image
quality (for example,
mediumQuality),
or by performance
(for example, highe
stPerformance).
The following are
the valid values:
highestQualit
y
highQuality
mediumQuality
highestPerfor
mance
highPerforman
ce
mediumPerform
ance
nearest
bilinear
bicubic
bessel
blackman
hamming
hanning
hermite
lanczos
mitchell
quadratic

isBase64

border convert i
nfo read resize
rotate writewri
teToBrowser

© 2014 Adobe Systems Incorporated. All rights reserved.

Optional

no

Specifies whether
the source is a
Base64 string:
yes: the source is
a Base64 string.
no: the source is
not a Base64
string.

643

Adobe ColdFusion Documentation

name

borderconvertreadre
sizerotate

Optional(see
Description)

overwrite

bordercaptchaconve
rtreadresizerotate w
rite

Optional

Name of the
ColdFusion image
variable to create.
The read action
requires a name attri
bute.
The border, resi
ze, and rotate acti
ons require a name
attribute or a desti
nation attribute.
You can specify
both.
no

Valid only if the des
tination attribute
is specified. The ov
erwrite values
are:
yes: overwrites
the destination
file.
no: does not
overwrite the
destination file.
If the destination
file exists,
ColdFusion
generates an
error if the overw
rite action is not
set to yes.

quality

write

© 2014 Adobe Systems Incorporated. All rights reserved.

Optional

0.75

Quality of the JPEG
destination file.
Applies only to files
with an extension of
JPG or JPEG. Valid
values are fractions
that range from 0
through 1 (the lower
the number, the
lower the quality).

644

Adobe ColdFusion Documentation

source

border convert i
nfo read resize
rotate write wri
teToBrowser

Required

structName

info

Required

Name of the
ColdFusion
structure to be
created.

text

captcha

Required

Text string displayed
in the CAPTCHA
image. Use capital
letters for better
readability. Do not
include spaces
because users
cannot detect them
in the resulting
CAPTCHA image.

© 2014 Adobe Systems Incorporated. All rights reserved.

URL of the source
image; for
example, "{{ http://
www.google.com/i
mages/logo.gif }}"
Absolute
pathname or a
pathname relative
to the web root;
for example: "c:
\images\logo.
jpg"
ColdFusion image
variable
containing
another image,
BLOB, or byte
array; for
example, "#myIm
age#"
Base64 string; for
example,
"data:image/jpg;b
ase64,/9j/4AAQS
kZJRgABAQA......
........"

645

Adobe ColdFusion Documentation

thickness

border

Optional

width

captcha resize

Required

1

Border thickness in
pixels. The border is
added to the outside
edge of the source
image, increasing
the image area
accordingly.
The value must be
an integer.
Width in pixels of
the image.
For resize, you
also can specify the
width as a
percentage (an
integer followed by
the % symbol).
When you resize an
image, if you specify
a value for the
height, you can let
ColdFusion
calculate the aspect
ratio by specifying ""
as the width.
If specified, the
value must be an
integer.

Usage

ColdFusion provides the cfimage tag and the ColdFusion image, a construct native to ColdFusion that contains
image data. You can manipulate ColdFusion images in memory and write them to a file, a database, or directly to a
browser. You use the cfimage tag to create ColdFusion images from existing image files and perform simple image
actions, such as rotating or resizing. Alternatively, you can use the ImageNew function to create a ColdFusion image
from the beginning or from an existing image. You can use the Image functions to perform complex image
manipulation operations on ColdFusion images that you create with the cfimage tag or with the ImageNew function
.
You can perform the following tasks with ColdFusion images:
Convert an image from one file format to another. For example, you can convert a BMP file to a JPEG file or
a Base64 string to a GIF.
Enforce consistent sizes on files uploaded to the server.
Enforce size limits on JPEG images (by changing the quality of the image).
Save a ColdFusion image to a file or write the image directly to a browser.
Use the ImageGetBlob function within the cfquery tag to insert a ColdFusion image as a Binary Large
Object Bitmap (BLOB) in a database. Also, you can extract a BLOB from a database and generate a
ColdFusion image from it.
Create watermark images.
Create thumbnail images.
Create a Completely Automated Public Turing test to tell Computers and Humans Apart (CAPTCHA) image,

© 2014 Adobe Systems Incorporated. All rights reserved.

646

Adobe ColdFusion Documentation

a distorted text image that is human-readable, but not machine-readable, used in a challenge-response test
for preventing spam.
For more detailed examples, see Creating and Manipulating ColdFusion Images in the Developing
ColdFusion Applications.
File attributes

Use the following syntax to specify an in-memory file, which is not written to disk in the destination and source
attributes. In-memory files speed processing of transient data.

ram:///filepath

The filepath can include directories, for example ram:///petStore/images/poodle.jpg. Create the directories
in the path before you specify the file. For more information on using in-memory files, see Working with in-memory
files in Optimizing ColdFusion applications in the Developing ColdFusion Applications.
Supported image file formats

The cfimage tag operates on a number of different file formats. To list the formats that are supported on the server
where the ColdFusion application is deployed, use the GetReadableImageFormats function and the GetWritea
bleImageFormats function.ColdFusion supports the following default image formats on Macintosh, Windows, and
Unix operating systems:
JPEG
GIF
TIFF
PNG
BMP
ColdFusion does not support the following image formats:
Animated GIF
Multipage TIFF
PSD
AI
CMYK support

The cfimage tag supports reading and writing CMYK images, but does not support actions that require converting
the images. For example, you can use CMYK images with the read, write, writeToBrowser, resize, rotate,
and info actions. You cannot use CMYK images with the convert, captcha, and border actions. The same rule
applies to image functions. For example, the ImageNew, ImageRead, and ImageWrite functions support CMYK
images, but the ImageAddBorder function does not.
Valid HTML named colors

The following table lists the W3C HTML 4 named color value or hexadecimal values that the color attribute
accepts:
Color name

RGB value

Black

##000000

© 2014 Adobe Systems Incorporated. All rights reserved.

647

Adobe ColdFusion Documentation

Blue

##0000FF

Red

##FF0000

Gray

##808080

LightGray

##D3D3D3

DarkGray

##A9A9A9

Green

##008000

Pink

##FFC0CB

Cyan

##00FFFF

Magenta

##FF00FF

Orange

##FFA500

White

##FFFFFF

Yellow

##FFFF00

For all other color values, enter the hexadecimal value. Enter a six-digit value, which specifies the RGB value.
Values between 00 and FF are allowed.
Image quality

By default, the cfimage tag generates images with antialiasing turned on (to remove the appearance of jagged
edges). The interpolation method is set to highestQuality: this produces a high-quality image, but decreases
processing speed. To turn off antialiasing, use the ImageSetAntialiasing function. To change the interpolation
method or for more control over image attributes, use the following functions:
ImageResize
ImageRotate
ImageScaleToFit
ImageShear
ImageTranslate
border action Use the border action to create a rectangular border around the outer edge of an image. You
can control the thickness of the border and its color. For more control, use the ImageAddBorderfunction.
The following example shows how to set the thickness and color of a border:

© 2014 Adobe Systems Incorporated. All rights reserved.

648

Adobe ColdFusion Documentation




captcha action Use the captchaaction to create a distorted text image that is human-readable but not
machine-readable. When you create a CAPTCHA image, you specify the text that is displayed in the
CAPTCHA image; ColdFusion randomly distorts the text. You can specify the height and width of the text
area, which affects the spacing between letters, the font size, the fonts used for the CAPTCHA text, and the
level of difficulty, which affects readability. The following example shows how to write a CAPTCHA image
directly to the browser:



Note
For the CAPTCHA image to display, the width value must be greater than: fontSize ti
mes the number of characters specified in text times 1.08. In this example, the minimum
width is 162.

ColdFusion supports CAPTCHA images in PNG format only.
Note
Use unique names for the CAPTCHA image files so that when multiple users access the
CAPTCHA images, the files are not overwritten.

The following example shows how to create CAPTCHA images with a medium level of difficulty that are
written to files:





For a detailed example, see the Creating and Manipulating ColdFusion Images in the Developing ColdFusion
Applications.
convert action Use the convertaction to convert an image from one file format to another. For more
information on file formats, see the section Supported image file formats. The following example shows how

© 2014 Adobe Systems Incorporated. All rights reserved.

649

Adobe ColdFusion Documentation

to convert a JPEG file to a PNG file:




Note
Converting images between one file format to another is time-consuming. Also, image
quality can degrade; for example, PNG images support 24-bit color, but GIF images
support only 256 colors. Converting transparent images (images with alpha) can degrade
image quality.
info action Use the info action to create a ColdFusion structure that contains information about the image,
including the color model, height, width, and source of the image. The structure is the same as returned by
the ImageInfofunction. The following example shows how to retrieve all of the information about an image:







    height: #viatoInfo.height# pixels
    

    width: #viatoInfo.width# pixels
    

    source: #viatoInfo.source#
    

    transparency: #viatoInfo.colormodel.transparency#
    

    pixel size: #viatoInfo.colormodel.pixel_size#
    

    color model: #viatoInfo.colormodel.colormodel_type#
    

    alpha channel support: #viatoInfo.colormodel.alpha_channel_support#
    

    color space: #viatoInfo.colormodel.colorspace#
    


read action Use the read action to read an image from the specified local file pathname or URL, and create
a ColdFusion image in memory. You can use the ColdFusion image variable as the source for another cfima
ge tag or for Image functions. The read action performs the same operation as the ImageRead function.
The following example shows how to create a ColdFusion image from a JPEG file and manipulate it using the
ImageGrayscalefunction:

© 2014 Adobe Systems Incorporated. All rights reserved.

650

Adobe ColdFusion Documentation








resize action Use the resizeaction to resize an image to the specified height and width. You can specify
the height and width in pixels or as a percentage:








For more control of resize attributes, use the ImageResize function.
rotate action Use the rotateaction to rotate an image by degrees:






For more control of the rotate attributes, use the ImageRotate function.
write action Use the write action to write an image to the specified path. The new image is converted to the
file type specified in the destination attribute. The write action performs the same operation as the ImageWr
ite function. When you write an image to a JPEG file, the image quality is set to 75% of the original image
by default. To control the image size, use the quality attribute of the write action.
You can use the write action to change the quality of a JPEG image to reduce file size. The following example
shows how to change image quality to .5:

© 2014 Adobe Systems Incorporated. All rights reserved.

651

Adobe ColdFusion Documentation








writeToBrowser action Use the writeToBrowseraction to display one or more ColdFusion images directly
to the browser without writing them to files. Images are displayed in PNG format. The following example
shows how to reduce the size of an image and display it in the browser:





Example

This example shows how to create a ColdFusion image and manipulate it by using Image functions:










© 2014 Adobe Systems Incorporated. All rights reserved.

652

Adobe ColdFusion Documentation

cfimap
Description

Queries an IMAP server to retrieve and manage mails within multiple folders.
Category

Communications tags, Internet protocol tags
Syntax



See Also

cfmailparam, cfmailparam, cfmailpart, cfpop, cfftp, cfhttp, cfldap, Wrap; Using ColdFusion with mail
servers in Sending and Receiving E-Mail in the Developing ColdFusion Applications
History

New tag introduced in ColdFusion 9.
Attributes

Attribute

Req/Opt

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

653

Adobe ColdFusion Documentation

action

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

GetHeaderOnly

Returns the message
header information for all
retrieved mail. Other
values for this attribute
are:GetAll: Returns
mail. The information
includes the message
header information,
message text, and any
attachments. Set the
AttachmentPath attribute
to retrieve attachments. D
elete: Deletes
messages from a folder.O
pen: Initiates an open
session or connection with
the IMAP server.Close:
Terminates the open
session or connection with
the IMAP server.MarkRea
d: Marks all messages
read from a folder.Creat
eFolder: Creates a
folder in the Mailbox.Dele
teFolder: Deletes a
folder in the Mailbox.Rena
meFolder: Renames an
existing user-defined
folder.ListAllFolders:
Displays a list of all
existing folders in the
mailbox or under the
folder name defined by
the Folder attribute.MoveM
ail: Moves mail from one
folder to another.

654

Adobe ColdFusion Documentation

attachmentpath

Optional for GetAll action

Specifies the name of the
folder where ColdFusion
retrieves attachments. If
this folder does not exist,
ColdFusion creates. If you
do not specify the folder,
then the attachment is not
saved.Note: If you specify
a relative path, then
attachments are saved in
a temporary folder. This
folder is same as one
returned by the
GetTempDirectory
function.

Connection

Required for the following
actions: Open and Close

Specifies the variable
name for the
connection/session. If the
server attribute has an
invalid IP address or
invalid domain name, then
the connection fails and
ColdFusion returns an
error message.

Folder

Required for the following
actions: DeleteFolder,
CreateFolder, and
RenameFolderOptional
for LISTALLFOLDERS,
MOVEMAIL,
MARKREAD, GETALL,
GETHEADERONLY,
DELETE.

© 2014 Adobe Systems Incorporated. All rights reserved.

INBOX(For ListAllFolders
action, the default folder is
mailbox)

For mail actions: Specifies
the folder name where
messages are retrieved,
moved, or deleted. If
folder name is invalid,
ColdFusion defaults to
INBOX.
For folder actions:
Specifies the folder name
that is deleted
(DeleteFolder) or created
(CreateFolder) or
renamed
(RenameFolder).
When selecting a
subfolder, use the period
(.) character as
appropriate. For example,
when deleting mail in
folder Module in folder
Product.Version.Module,
define the Folder attribute
as
Product.Version.Module.

655

Adobe ColdFusion Documentation

GenerateUniqueFilen
ames

Optional

Ensures that unique file
names are generated for
each attachment file. The
goal is to avoid name
conflicts for attachments
that have the same
filename.

MaxRows

Optional

Specifies the number of
rows to be marked as
read, deleted, or moved
across folders. When the
value is 1, it signals the
row determined by
StartRow. Any
incremental value marks
rows starting from the
StartRow.
If you have specified the
UID or MessageNumber
attribute, then MaxRows
is ignored.

MessageNumber

Optional

Specifies the message
number or a comma
delimited list of message
numbers for retrieval,
deletion, marking mail as
read, or moving mails. If
you set an invalid
message number, then
the IMAP operation is
ignored. For example, if
you specify that cfimap
deletes a specified
message number, and if
that message number
does not exist, then the
operation is ignored. If
you have specified the
UID attribute, then
MessageNumber attribute
is ignored.

Name

OptionalRequired for the
following actions: GetAll,
GetHeaderOnly, and
ListAllFolders

Specifies the name for the
query object that contains
the retrieved message
information.

© 2014 Adobe Systems Incorporated. All rights reserved.

656

Adobe ColdFusion Documentation

NewFolder

OptionalRequired for the
following actions:
RenameFolder, MoveMail

Specifies the name of the
new folder when you
rename a folder or the
name of the destination
folder where all mails
move.

Password

OptionalRequired when
action="open" username
and password must be
specified.

Specifies the password for
assessing the users'
e-mail account.

Port

Optional

143 or 993

Specifies the IMAP port
number. Use 143 for
non-secure connections
and 993 for secured
connections.

Recurse

Optional

False

Specifies whether
ColdFusion runs the
CFIMAP command in
subfolders. Recurse
works for
action="ListAllFolders".
When recurse is set to
"true", ColdFusion parses
through all folders and
subfolders and returns
folder/subfolder names
and mail information.

Secure

Optional

False

Specifies whether the
IMAP server uses a
Secure Sockets Layer.

Server

OptionalRequired for the
Open action

Specifies the IMAP server
identifier. You can assign
a host name or an IP
address as the IMAP
server identifier.

StartRow

Optional

Defines the first row
number for reading or
deleting. If you have
specified the UID or
MessageNumber
attribute, then StartRow is
ignored. You can also
specify StartRow for
moving mails.

© 2014 Adobe Systems Incorporated. All rights reserved.

657

Adobe ColdFusion Documentation

StopOnError

Optional

True

Specifies whether to
ignore the exceptions for
this operation. When the
value is true, it stops
processing, displays an
appropriate error.

Timeout

Optional

60

Specifies the number of
seconds to wait before
timing out connection to
IMAP server. An error
message is displayed
when timeout occurs.

Uid

Optional

Specifies the unique ID or
a comma-delimited list of
Uids to retrieve, delete,
and move mails. If you set
invalid Uids, then they are
ignored.

Username

Optional

Specifies the user name.
Typically, the user name
is same the e-mail login.

Usage

Open a session or connection with an IMAP server. To open a session, define the server, user name, and password
attributes. You can open a connection with an IMAP server by specifying values for the server, user name,
password, and connection attributes. For a secure connection, specify secure="true". You can reuse the connection
attribute in subsequent CFIMAP tags, without having to specify the server, user name, or password attributes. Once
you have established a connection, you can perform the following actions:
Retrieve mail: Retrieve mail using the GetHeaderOnly or GetAll attributes and store the information in a query
object. Use the cfdump command to display the content of the query object. You can also download
attachments in temporary ColdFusion folder or a new folder as defined by the AttachmentPath attribute.
Delete any unnecessary mail or delete folders. You can delete any user-created folders. Standard folders,
such as INBOX, OUTBOX, SEND, cannot be deleted.
Mark multiple mail as read.
Manage mail folders by creating folders, renaming them or moving mail across folders. If you are using sub
folders, then use periods (.) to specify the exact path.
Once you have performed all actions, close the session or connection with the IMAP server. For example,
mail from your e-mail account in Gmail can be retrieved by setting a connection to the Gmail IMAP server.
You can define the login (user name) and set a secure connection. Next, you can quickly retrieve a top-level
snapshot of e-mails using the GetHeaderOnly attribute or access full information about e-mails using the
GetAll attribute.
Note
Gmail is not a complete IMAP implementation so some of the features of a regular IMAP
server may not work with Gmail.

© 2014 Adobe Systems Incorporated. All rights reserved.

658

Adobe ColdFusion Documentation

The following table lists the query information (column names) returned by various cfimap attributes.
Values for "action" attribute

Columns

GetHeaderOnly

ANSWERED, CC, DELETED, DRAFT, FLAGGED,
FROM, HEADER, LINES, MESSAGEID,
MESSAGENUMBER, RECENT, REPLYTO,
RXDDATE, SEEN, SENTDATE, SIZE, SUBJECT, TO,
UID

GetAll

ANSWERED, ATTACHMENTFILES, ATTACHMENTS,
BODY, CC, CIDS, DELETED, DRAFT, FLAGGED,
FROM, HEADER, HTMLBODY, LINES, MESSAGEID,
MESSAGENUMBER, RECENT, REPLYTO,
RXDDATE, SEEN,SENTDATE, SIZE, SUBJECT,
TEXTBODY, TO, UID.CID is used to find the correct
place of an image in an HTML e-mail message that the
CFIMAP tag retrieves. If the e-mail message contains
more than one embedded image, only the last
embedded image is available.

ListAllFolders

FULLNAME (specifies the entire directory structure),
NAME, NEW, TOTALMESSAGES, and UNREAD

Note
The cfimap command works best on IMAP4 revision1. IMAP4 revision1 is backwards compatible
with IMAP2 and IMAP2bis versions. Any previous versions are no more actively used.

You can get errors in following scenarios:
Accessing an invalid server connection is established. Check the network conditions and whether you are
using appropriate server IP address and domain names. Use valid e-mail user names and passwords.
Accessing non-existent folders: Check whether the folder you are accessing exists. Create or rename folders
with valid names. You cannot rename core folders. Move mail within existing folders.
Slow network: Verify if the timeout attribute needs a higher value. Actions such as CreateFolder may need
longer time to execute. In such cases, adjust the value of the timeout attribute.
Incorrect usage of cfimap attributes: Check if you are using the correct attribute. For example, if you have 15
e-mails in a folder and if the startrow or maxrow attribute has value of 18 then ColdFusion returns an error.
The e-mail client does not recognize IMAP access. Verify whether your e-mail is set up to allow IMAP access.
Complete the necessary IMAP access in connection settings section of your e-mail client.
Using incorrect syntax for attributes: Verify that all attributes are defined per syntax.
Example: 1

© 2014 Adobe Systems Incorporated. All rights reserved.

659

Adobe ColdFusion Documentation




IMAP Mail Client




username = "yourname"
action="open"
secure="yes"
password = "yourpassword"
connection = "test.cf.gmail">







Example: 2

© 2014 Adobe Systems Incorporated. All rights reserved.

660

Adobe ColdFusion Documentation




IMAP Mail Client
















Example: 3

© 2014 Adobe Systems Incorporated. All rights reserved.

661

Adobe ColdFusion Documentation




IMAP Mail Client








    Folders in your Inbox #form.username#
    

      


    1. #NAME# - #TOTALMESSAGES# (#UNREAD#)
      2. 
      

    


    


    

    

    
Enter IMAP mail server

    

    
Enter your username

    

    
Enter your password

    

    


    

    

    
    



© 2014 Adobe Systems Incorporated. All rights reserved.

662

Adobe ColdFusion Documentation

cfimapfilter
Description

Specifies filter parameters that control the actions of cfimap, get operations.
History

ColdFusion 11: Added this tag.
Category

Communications tags
Syntax


OR


Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfimap, Getting Exchange items and attachments in the Developing ColdFusion Applications
Attributes

Attribute

Req/Opt

name

Required

Default

Description
The type of filter to use.
The supported filters in
ColdFusion 11 are:
Name

© 2014 Adobe Systems Incorporated. All rights reserved.

Possi
ble
Attrib
utes

Possi
ble
Value
s

663

Adobe ColdFusion Documentation

Subje
ct

Value

String
to
searc
h in
Subje
ct

From

Value

From
ID

To

Value

Rece
pient
ID

Flag

Value
F
l
a
g
v
a
l
u
e

© 2014 Adobe Systems Incorporated. All rights reserved.

D
e
s
c
r
i
p
t
i
o
n

664

Adobe ColdFusion Documentation

A
N
S
W
E
R
E
D

© 2014 Adobe Systems Incorporated. All rights reserved.

M
e
s
s
a
g
e
s
w
i
t
h
t
h
e
A
n
s
w
e
r
e
d
f
l
a
g
s
e
t
.

665

Adobe ColdFusion Documentation

F
L
A
G
G
E
D

© 2014 Adobe Systems Incorporated. All rights reserved.

M
e
s
s
a
g
e
s
w
i
t
h
t
h
e
F
l
a
g
g
e
d
f
l
a
g
s
e
t
.

666

Adobe ColdFusion Documentation

S
E
E
N

© 2014 Adobe Systems Incorporated. All rights reserved.

M
e
s
s
a
g
e
s
t
h
a
t
h
a
v
e
t
h
e
S
e
e
n
f
l
a
g
s
e
t
.

667

Adobe ColdFusion Documentation

U
N
A
N
S
W
E
R
E
D

© 2014 Adobe Systems Incorporated. All rights reserved.

M
e
s
s
a
g
e
s
t
h
a
t
d
o
n
o
t
h
a
v
e
t
h
e
A
n
s
w
e
r
e
d
f
l
a
g
s
e
t
.

668

Adobe ColdFusion Documentation

U
N
D
E
L
E
T
E
D

© 2014 Adobe Systems Incorporated. All rights reserved.

M
e
s
s
a
g
e
s
t
h
a
t
d
o
n
o
t
h
a
v
e
t
h
e
D
e
l
e
t
e
d
f
l
a
g
s
e
t
.

669

Adobe ColdFusion Documentation

U
N
D
R
A
F
T

© 2014 Adobe Systems Incorporated. All rights reserved.

M
e
s
s
a
g
e
s
t
h
a
t
d
o
n
o
t
h
a
v
e
t
h
e
D
r
a
f
t
f
l
a
g
s
e
t
.

670

Adobe ColdFusion Documentation

U
N
S
E
E
N

Time
Recei
ved

© 2014 Adobe Systems Incorporated. All rights reserved.

From,
To

M
e
s
s
a
g
e
s
t
h
a
t
d
o
n
o
t
h
a
v
e
t
h
e
S
e
e
n
f
l
a
g
s
e
t
.

Start
and
End
date
for
Time
Recei
ved

671

Adobe ColdFusion Documentation

Time
Sent

From,
To

Start
and
End
date
for
Time
Sent

from

Optional

The start date or date/time
combination of the range
to use for filtering. Cannot
be used with the value at
tribute. If you specify a fr
om attribute without a to a
ttribute, the filter selects
for all entries on or after
the specified date or time.
The value can be in any
date/time format
recognized by
ColdFusion, but must
correspond to a value that
is appropriate for the filter
type.

to

Optional

The end date or date/time
combination for the range
used for filtering. Cannot
be used with the value at
tribute. If you specify a to
attribute without a from at
tribute, the filter selects for
all entries on or before the
specified date or time.
The value can be in any
date/time format
recognized by
ColdFusion, but must
correspond to a value that
is appropriate for the filter
type.

© 2014 Adobe Systems Incorporated. All rights reserved.

672

Adobe ColdFusion Documentation

Optional

value

The filter value for all
filters that do not take a
date or time range.
Cannot be used with the f
rom and to attributes.Col
dFusion generates an
error if you specify this
attribute with an empty
contents. Therefore, you
cannot use the empty
string to search for empty
values.
If you set this attribute to
the empty string (""),
ColdFusion searches for
entries where the
specified field is empty.
6.07

Example





© 2014 Adobe Systems Incorporated. All rights reserved.

673

Adobe ColdFusion Documentation

cfimpersonate
Description

This tag is obsolete. Use the newer security tools; see Conversion functions and Securing Applications in the Develo
ping ColdFusion Applications.
History

ColdFusion MX: This tag is obsolete. It does not work in ColdFusion MX and later releases.

© 2014 Adobe Systems Incorporated. All rights reserved.

674

Adobe ColdFusion Documentation

cfimport
Description

You can use the cfimport tag to import either of the following:
All ColdFusion pages in a directory, as a tag custom tag library.
A Java Server Page (JSP) tag library. A JSP tag library is a packaged set of tag handlers that conform to the
JSP 1.1 tag extension API.
Category

Application framework tags
Syntax



See also

cfapplication
History

ColdFusion 9: Added the path attribute.
ColdFusion MX: Added this tag.
Attributes

Attribute

Req/Opt

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

675

Adobe ColdFusion Documentation

taglib

Required

Tag library URI. The path
must be relative to the
web root (and start with /),
the current page location,
or a directory specified in
the Administrator
ColdFusion mappings
page.
A directory in which
custom ColdFusion tags
are stored. In this case,
all the cfm pages in this
directory are treated as
custom tags in a tag
library.
A path to a JAR in a
web-application, for
example,
"/WEB-INF/lib/sometag
s.jar"
A path to a tag library
descriptor, for example,
"/sometags.tld"
Note: You must put
JSP custom tag
libraries in the
/WEB-INF/lib directory.
This limitation does not
apply to ColdFusion
pages.

prefix

Required

Prefix by which to access
the imported custom
CFML tags JSP tags. If
you import a CFML
custom tag directory and
specify an empty value, "
", for this attribute, you
can call the custom tags
without using a prefix.
Specify and use a prefix
for a JSP tag library.

path

Optional

Use this attribute to import
a CFC namespace.

Usage

The following example imports the tags from the directory myCustomTags:

© 2014 Adobe Systems Incorporated. All rights reserved.

676

Adobe ColdFusion Documentation






You can import multiple tag libraries using one prefix. If there are duplicate tags in a library, the first one takes
precedence.JSP tags have fixed attributes; however, if the tag supports runtime attribute expressions, most tag
libraries support the use of the syntax #expressions#. To reference a JSP tag in a CFML page, use the syntax 
    . Set the prefix value in the prefix attribute.
Use JSP custom tags in a ColdFusion page

1. Put a JSP tag library JAR file (for example, myjsptags.jar) into the ColdFusion server directory
wwwroot/WEB-INF/lib. If the tag library has a separate TLD file, put it in the same directory as the JAR file.
2. At the top of a CFML page, insert code such as the following:



To reference a JSP tag from a JAR file, use the following syntax:





The cfimport tag must be on the page that uses the imported tags. For example, if you use a cfimport ta
g on a page that you include with the cfinclude call, you cannot use the imported tags on the page that has
the cfinclude tag. Similarly, if you have a cfimport tag on your Application.cfm page, the imported tags
are available on the Application.cfm page only, not on the other pages in the application. ColdFusion does not
throw an error in these situations, but the imported tags do not run. You cannot use the cfimport tag to
suppress output from a tag library.
For more information, see the Java Server Page 1.1 specification.
Example

© 2014 Adobe Systems Incorporated. All rights reserved.

677

Adobe ColdFusion Documentation


    cfimport example
    

    This example uses the random JSP tag library that is available from the
Jakarta Taglibs project, at http://jakarta.apache.org/taglibs/
    




Your password is #myPassword#
    
    

You can also instantiate a component using the new operator:



© 2014 Adobe Systems Incorporated. All rights reserved.

678

Adobe ColdFusion Documentation

cfinclude
Description

Embeds references to ColdFusion pages in CFML. You can embed cfinclude tags recursively. For another way
to encapsulate CFML, see cfmessagebox. (A ColdFusion page was formerly sometimes called a ColdFusion
template or a template.)
Category

Flow-control tags, Page processing tags
Syntax



Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfcache, cfflush, cfheader, cfhtmlhead, cfsetting, cfsilent
History

ColdFusion 11: The compileextforinclude attribute of the  tag affects the behavior of the 
tag.
By default only files with the cfm and cfml extensions get compiled when included using the  tag.
All other files when included using the cfinclude tag will not get compiled but their content will be statically
included. No error will be thrown.
A server-level setting and an application-level setting has been added to specify a list of file extensions that
can contain the CFM code. While processing the  tag, ColdFusion checks for this
Application-level/server-level setting to decide whether to compile the content or to statically include it. The
setting value is comma separated list of file extensions. If file extensions are specified at application-level, the
server-level file extension list will be ignored and the application-level file extension list will be used.
Specifying a special value wildcard (*) in the file extension list makes the cfinclude tag to compile any file.
The server-level setting can be modified using the ColdFusion Administrator. The setting can be found at
Server Settings > Settings page. A new key/tag attribute compileextforinclude added to the application
cfc/cfm to specify this file extension list.
ColdFusion 10: Added the attribute {{runOnce}}
ColdFusion MX: Changed error behavior: if you use this tag to include a CFML page whose length is zero bytes, you
do not get an error.
Attributes

© 2014 Adobe Systems Incorporated. All rights reserved.

679

Adobe ColdFusion Documentation

Attribute

Req/Opt

template

Required

runOnce

Optional

Default

Description
A logical path to a
ColdFusion page.

false

If set to true, the given
template (if already
processed) is not
processed again for a
given request.

Usage

ColdFusion searches for included files in the following locations:
1. In the directory of the current page or a directory relative to the current page
2. In directories mapped in the ColdFusion Administrator
You cannot specify an absolute URL or file system path for the file to include. You can only use paths relative
to the directory of the including page or a directory that is registered in the ColdFusion Administrator
Mappings. The following cfinclude statements work, assuming that the myinclude.cfmfile exists in the
specified directory:





But the following do not work:




The included file must be a syntactically correct and complete CFML page. For example, to output data from
within the included page, you must have a cfoutput tag, including the end tag, on the included page, not
the referring page. Similarly, you cannot span a cfif tag across the referring page and the included page; it
must be complete within the included page.
You can specify a variable for the templateattribute, as the following example shows:




Example

© 2014 Adobe Systems Incorporated. All rights reserved.

680

Adobe ColdFusion Documentation



    This example includes the dochome.htm page from the CFDOCS directory. The images
do not
display, because they are located in a separate directory. However, the page
appears
fully rendered within the contents of this page.
    


© 2014 Adobe Systems Incorporated. All rights reserved.

681

Adobe ColdFusion Documentation

cfindex
Description

Populates a search engine collection with metadata and creates indexes for searching it. The engine (Solr) can
search physical files of various types or a database query. Indexing database columns that result from a query lets
users search the query data much faster than they could if you used multiple SQL queries to return the same data.
You must define a collection using the ColdFusion Administrator or the cfcollection tag before creating indexes
for the collection.
You also can index a collection using the ColdFusion Administrator. For more information on creating, indexing, and
searching a collection, see Building a Search Interface in the Developing ColdFusion Applications.
Category

Extensibility tags
Syntax

cfindex supports script style syntax:
new index(collection="");


Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfcollection, cfexecute, cfobject, cfreport, cfsearch, cfwddx

© 2014 Adobe Systems Incorporated. All rights reserved.

682

Adobe ColdFusion Documentation
History

ColdFusion 10:
Added new actions fullimport, deltaimport, status, abort
Added the attribute autoCommit, fieldBoost, docBoost

ColdFusion 9: Added Solr search engine support.
ColdFusion MX 7.0.1: Added the prefix attribute.
ColdFusion MX 7:
Added the category, categoryTree, custom3, and custom4 attributes for the update and refresh act
ions.
Added the status attribute for the update, refresh, delete, and purge actions.
Removed reference to external collections.
Removed suggested cflock usage.
ColdFusion MX:
The action attribute value optimize is obsolete. It does not work, and might cause an error, in ColdFusion
MX.
Changed the external attribute behavior: it is not necessary to specify the external attribute. (ColdFusion
automatically detects whether a collection is internal or external.)
Changed Verity operations behavior: ColdFusion supports Verity operations on Acrobat PDF files.
Changed thrown exceptions: this tag can throw the SEARCHENGINE exception.
Changed acceptable collection naming: this tag accepts collection names that include spaces.
Changed query result behavior: the cfindex tag can index the query results from a cfsearch tag.
Attributes

Attribute

Req/Opt

© 2014 Adobe Systems Incorporated. All rights reserved.

Default

Description

683

Adobe ColdFusion Documentation

action

Required

autoCommit

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

update: updates a
collection and adds key
to the index.
delete: removes
collection documents as
specified by the key att
ribute.
purge: deletes all of the
documents in a
collection. Causes the
collection to be taken
offline, preventing
searches.
refresh: deletes all of
the documents in a
collection, and then
performs an update.
fullimport:To index full
database. For instance,
when you index the
database for the first
time.
deltaimport:For partial
indexing. For instance,
for any updates in the
database, instead of a
full import, you can
perform delta import to
update your collection.
status: Provides the
status of indexing, such
as the total number of
documents processed
and status such as idle
or running.
abort: Aborts an
ongoing indexing task.
If yes, automatically
commit the changes to the
search server.
If no, indexed documents
are not committed unless
you specifically commit
using cfindex
action="commit". By
default, the value is set to
true.

684

Adobe ColdFusion Documentation

collection

Required

body

Required if type=custom

category

Optional

A string value that
specifies one or more
search categories for
which to index the data.
You can define multiple
categories, separated by
commas, for a single
index. If you use a query
for your indexed data, this
value can be the name of
a column.

categoryTree

Optional

A string value that
specifies a hierarchical
category or category tree
for searching. It is a series
of categories separated
by forward slashes ("/").
You can specify only one
category tree.

© 2014 Adobe Systems Incorporated. All rights reserved.

Name of a collection that
is registered by
ColdFusion; for example,
"personnel".
ASCII text to index.
Query column names, if
name is specified in
query.
You can specify
columns in a delimited
list, for example: "emp_
name, dept_name,
location".
This attribute is ignored
if type is file or path
, and is invalid if actio
n is delete.

685

Adobe ColdFusion Documentation

custom1

Optional

Use to index discrete
values in collection
records, which lets you
search for specific
records. By contrast,
values specified in the bo
dy attribute are
concatenated and
searched as a body of text
using the specified
criteria.
If type = custom, a
query column name. If ty
pe is file or path, a st
ring.

custom2

Optional

Usage is the same as for
custom1.

custom3

Optional

Usage is the same as for
custom1.

custom4

Optional

Usage is the same as for
custom1.

docBoost

Optional

Boost entire document
while indexing. docBoost
enhances the score of the
documents and thereby
the ranking in the search
results. .

extensions

Optional

© 2014 Adobe Systems Incorporated. All rights reserved.

htm, html,cfm, cfml, dbm,
dbml

Delimited list of file
extensions that
ColdFusion uses to index
files, if type = "Path". "
." returns files with no
extension. "." returns all
files.
For example, the following
code returns files with a
listed extension or no
extension: extensions
= ".htm, .html, .cfm,
.cfml, *."

686

Adobe ColdFusion Documentation

fieldBoost

Optional

htm, html,cfm, cfml, dbm,
dbml

Boost specific fields while
indexing.fieldBoost en
hances the score of the
fields and thereby the
ranking in the search
results. Multiple fields can
be boosted by specifying
the values as a
comma-separated list.

key

Required

(empty string)

The value specified for ke
y depends on the type at
tribute:
If type = "file", the
directory path and
filename for the file,
If type = "path", the
directory path for the
location of the files.
If type = "custom", a
unique identifier that
specifies the location of
the data, For a query,
the name of the column
that holds the primary
key, for example. If not
a query, an identifier
such as the URL for a
web page, for example.

language

Optional

prefix

Optional

Specifies the location of
files to index when the
computer that contains
the K2 Search Service is
not the computer on which
you installed ColdFusion,
and when you index files
with the type attribute set
to path.

query

Optional.

The name of the query
against which the
collection is generated.

© 2014 Adobe Systems Incorporated. All rights reserved.

English

For options, see cfcolle
ction.

687

Adobe ColdFusion Documentation

recurse

Optional

status

Optional

The name of the structure
into which ColdFusion
returns status information.

title

Optional

Provides a title for the
document if one cannot
be extracted from the
document.

type

Optional

URLpath

Optional

no

custom, if query attribut
e is specified. Otherwise,
file.

yes: if type = "path",
indexes qualified files in
directories below the
path specified in the key
attribute.
no

file: applies action
value to filename,
including path. Expects
a filename in the key at
tribute.
path: applies action t
o files in a directory
path that pass the exte
nsions filter. Expects a
directory name in the k
ey attribute.
dih: used for Data
Import Handler.
custom: applies actio
n to custom data; for
example, to data from a
query.
If type is file or path,
specifies the URL path.
During indexing, this
pathname is prefixed to
filenames and returned
from a search as the url.

Usage

The attributes settings that the cfindex tag requires depend on whether you set the query attribute. If you set the
query attribute to a valid query name, it specifies that cfindex is to index the data in the query rather than indexing
documents on a disk. If you do not set the query attribute, cfindex assumes that it is indexing a file (type =
file), a set of files in a directory path (type = path), or text that you provide in the body attribute (type = custo
m). If you set the query attribute to a valid query name, the cfindex tag creates indexes as specified by the
following attributes and their values:

© 2014 Adobe Systems Incorporated. All rights reserved.

688

Adobe ColdFusion Documentation

Type

Attribute values

File

The key attribute is the name of a column in the query
that contains a full filename (including path).

Path

The key attribute is the name of a column in the query
that contains a directory pathname.
The extensions and recurse attributes, if specified,
elaborate on which files are included. If the action is de
lete, cfindex deletes keys for the collection.

Custom

The key attribute specifies a column name that
contains anything you want; for example, the primary
key value in the database. It must be unique because
this is the primary key in the collection. If the action is
delete, the key attribute is the name of a column in the
query that contains the keys to delete.
The body attribute is required and is a
comma-delimited list of the names of the columns that
contain the text data to be indexed.

If you do not set the query attribute, the cfindex tag creates indexes as specified by the following attributes and
their values:
Type

Attribute values

File

The key attribute is required and is a full pathname to
a file.

Path

The key attribute is required and it is a directory
pathname.
The extensions and recurse attributes, if specified,
designate which types of files are included. If the action
is delete, both the keys and the document files are
deleted.

Custom

The key attribute is an identifier that specifies the key.
If the action is delete, the key attribute is the
document key to delete.
The body attribute is required and is the text to be
indexed.

If type is not specified but query is set, ColdFusion sets the type to the default value of custom. If neither type n
or query is set, ColdFusion sets type to the default value of file. If type equals custom, all attributes except for

© 2014 Adobe Systems Incorporated. All rights reserved.

689

Adobe ColdFusion Documentation

key and body can specify a literal value, not only a column name. This allows you to change a field to empty in the
collection.
Status attribute

The status attribute provides the following information and diagnostics about the result of a cfindex operation:
Key

Type

Description

BADKEYS

Struct

A structure of keys with diagnostic
messages about the indexing of
these keys. If there are no bad
keys, this key does not exist.

DELETED

Number

The number of keys deleted.

MESSAGES

Array

An array of diagnostic messages,
including nonfatal errors and
warnings. If there are no messages,
this key does not exist.

INSERTED

Number

The number of keys inserted into
the collection.

UPDATED

Number

The number of keys updated in the
collection.

Example







key=#mySearch.key#
    
title=#mySearch.title#
    
context=#mySearch.context#
    
url=#mySearch.url#
    
    

© 2014 Adobe Systems Incorporated. All rights reserved.

690

Adobe ColdFusion Documentation







key=#mySearch.key#
    
title=#mySearch.title#
    
context=#mySearch.context#
    
url=#mySearch.url#
    
    



SELECT * FROM COURSES


key is Course_ID in the Courses table. ---->
body specifies the columns to be indexed for searching. --->
custom1 specifies the value of the Course_Number column. --->



    Indexing Complete
    





key=#mySearch.key#
    
title=#mySearch.title#
    
context=#mySearch.context#
    
url=#mySearch.url#
    
    



SELECT * FROM EMPLOYEE WHERE EMP_ID = 1






    Indexing Complete
    


key=#mySearch.key#
    
title=#mySearch.title#
    
context=#mySearch.context#
    
url=#mySearch.url#
    
    



SELECT * FROM EMPLOYEE WHERE Emp_ID = 15






    Indexing Complete
    


key=#getEmps.key#
    
title=#getEmps.title#
    
context=#getEmps.context#
    
url=#getEmps.url#
    
    







© 2014 Adobe Systems Incorporated. All rights reserved.

694

Adobe ColdFusion Documentation

cfinput
Description

Used within the cfform tag, to place input controls that support input validation on a form.
Category

Forms tags
Syntax

© 2014 Adobe Systems Incorporated. All rights reserved.

695

Adobe ColdFusion Documentation



Some attributes apply to only specific display formats. For details, see the Attributes table. In HTML format forms,
standard HTML input control attributes not listed above are passed to the HTML and have their normal effect.

© 2014 Adobe Systems Incorporated. All rights reserved.

696

Adobe ColdFusion Documentation

Note
You can specify this tag's attributes in an attributeCollection attribute whose value is a
structure. Specify the structure name in the attributeCollection attribute and use the tag's
attribute names as structure keys.

See also

cfajaximport, cfapplet, cfcalendar, cfform, cfformgroup, cfformitem, cfgrid, cfselect, cfslid
er, cftextarea, cftree, Using Ajax form controls and features in Using Ajax User Interface
Components and Features in the Developing ColdFusion Applications
History

ColdFusion 8
Added autosuggest, autosuggestBindDelay, autosuggestMinLength, delimiter, maxResultsD
isplayed, showAutosuggestLoadingIcon, and typeahead attributes.
Added support for the bind attribute in HTML forms and the bindAttribute and bindOnload, and onBin
dError attributes.
Added the sourceForTooltip attribute
Added support for datefield value of the type attribute in HTML forms.

ColdFusion MX 7:
Added support for button, file, hidden, image, reset, and submit controls.
Added support for generating Flash and XML controls (specified in the cfform tag).
Added datefield type (Flash forms only) and the supporting dayNames and monthNames attributes.
Added bind, enabled, height, label, tooltip, visible, and width attributes for use in Flash forms.
Added support for onBlur and onServer validation, including the validateAt attribute.
Added USdate, range, boolean, email, URL, uuid, guid, maxlength, noblanks, and submitOnce validate attr
ibute values.
Added support for preventing multiple submissions.
Added the mask attribute.
Deprecated the passthrough attribute. The tag now supports all HTML input tag attributes directly.

ColdFusion MX: Changed the cfform tag preserveData attribute behavior: if it is set to True, ColdFusion checks
radio and check box values only if their value matches the posted value for the control. (In earlier releases, if the
posted value did not match any of the cfinput check boxes or radio buttons for the control, the checked attribute
was used.
Attributes

The following table lists attributes that ColdFusion uses directly. The tag also supports all HTML form tag attributes
that are not on this list, and passes them directly to the browser.
Note
Attributes that are not marked as supported in All or XML are not handled by the skins provided
with ColdFusion. They are, however, included in the generated XML.

© 2014 Adobe Systems Incorporated. All rights reserved.

697

Adobe ColdFusion Documentation

Attribute

Req/Opt; formats

Default

Description

name

Required;all

Name for form input
element.

autosuggest

Optional, HTML

Specifies entry completion
suggestions to display as
the user types into a text
input. The user can select
a suggestion to complete
the text entry. The valid
value can be either of the
following:
A string that consists of
the suggestion values
separated by the
delimiter specified by
the delimiter attribut
e.
A bind expression that
gets the suggestion
values based on the
current input text. The
bind expression must
pass a cfautosugges
tvalue bind parameter
to represent the user
input.
Valid only for cfinput
type="text".
For more information,
see Using autosuggest
text input fields in the D
eveloping ColdFusion
Applications

© 2014 Adobe Systems Incorporated. All rights reserved.

698

Adobe ColdFusion Documentation

autosuggestBindDela
y

Optional, HTML

1 second

A nonzero integer that
specifies the minimum
time between autosugge
st bind expression
invocations, in seconds.
This value also specifies
the delay from when the
user first enters a
minimum-length entry in
the field until the
suggestion box appears.
Use this attribute to limit
the number of requests
that are sent to the server
when a user types.Valid
only for cfinput
type="text".
Note: The only way to get
the default behavior is to
omit the attribute.
Otherwise, the delay must
be a nonzero integer
value.

autosuggestMinLengt
h

Optional, HTML

1

The minimum number of
characters required in the
text box before invoking a
bind expression to return
items for suggestion.Valid
only for cfinput
type="text".

bind

Optional; HTML,Flash

bindAttribute

Optional;HTML

© 2014 Adobe Systems Incorporated. All rights reserved.

A bind expression that
dynamically sets an
attribute of the control. For
details, see Usage.
value

Specifies the HTML tag
attribute whose value is
set by the bind attribute.
You can only specify
attributes in the browser's
HTML DOM tree, not
ColdFusion-specific
attributes.
Ignored if there is no bin
d attribute.Valid only for c
finput type="text".

699

Adobe ColdFusion Documentation

bindOnLoad

Optional;HTML

no

A Boolean value that
specifies whether to
execute the bind attribute
expression when first
loading the form. Ignored
if there is no bind attribut
e.Valid only for cfinput
type="text".

checked

Optional;all

no

Selects a radio button or
check box control:
yes
no
For HTML format, you
can indicate that the
item is selected by
specifying the value as
checked or specifying
the attribute with no
value.

dayNames

Optional;all

S, M, T, W, T, F, S

Applies to datefield typ
e only. A
comma-delimited list that
sets the names of the
weekdays displayed in the
calendar. Sunday is the
first day; the rest of the
weekday names follow in
the normal order.

delimiter

Optional, HTML

comma (,)

The delimiter to use to
separate entries in a static
auto-suggest list. This
attribute is meaningful
only if the autosuggest
attribute is a string of
delimited values.

© 2014 Adobe Systems Incorporated. All rights reserved.

700

Adobe ColdFusion Documentation

disabled

Optional;all

not disabled

Disables user input,
making the control
read-only. The attribute
behavior depends on the
format of the form as
follows:
HTML format forms:
ColdFusion passes this
attribute directly to the
HTML. To disable input,
specify disabled with
out a value (HTML
format) or with the value
disabled (XHTML
compliant). To enable
input, omit this attribute.
Flash format forms: To
disable input, specify d
isabled without an
attribute, or disabled
="yes" (or any
ColdFusion positive
Boolean value, such as
true). To enable input,
omit the attribute or
specify disabled="no
" (or any ColdFusion
negative Boolean value,
such as false).

enabled

Optional; Flash

yes

Boolean value that
specifies whether the
control is enabled. A
disabled control appears
in light gray. The inverse
of the disabled attribute.

firstDayOfWeek

Optional;all

0

Applies to datefield typ
e only. Integer in the
range 0-6 that specifies
the first day of the week in
the calendar: 0 indicates
Sunday; 6 indicates
Saturday.

© 2014 Adobe Systems Incorporated. All rights reserved.

701

Adobe ColdFusion Documentation

height

Optional; see Description

Applies to most Flash
types, HTML image type
on some browsers. The
height of the control, in
pixels. The displayed
height might be less than
the specified size.

id

Optional;HTML

label

Optional; Flash, XML

Label to put next to the
control on a Flash form.
Not used for button,
hidden, image, reset, or
submit types.

mask

Optional;Flash, HTML

For tags with type="tex
t". A mask pattern that
controls the character
pattern that users can
enter, or that the form
sends to ColdFusion.
Mask characters and the
corresponding valid input
characters are:

name attribute value

The HTML ID of the form.

A = A-Za-z
X = A-Za-z0-9
9 = 0-9
? = Any character
All other characters =
insert the literal
character
For tags with type="d
atefield", a pattern
that controls the format
of dates that the user
selects in the calendar.
Mask characters are:
D = day; can use 0-2
mask characters.
M = month; can use 0-4
mask characters.
Y = year; can use 0, 2,
or 4 characters.
E = day in week; can
use 0-4 characters.
For more information,
see the Usage section.

© 2014 Adobe Systems Incorporated. All rights reserved.

702

Adobe ColdFusion Documentation

matchContains

Optional

maxLength

Optional;all

maxResultsDisplayed

Optional;HTML

message

Optional;all

monthNames

Optional;all

© 2014 Adobe Systems Incorporated. All rights reserved.

false

If true, the match
returned contains the
query string. By default,
the results that_ start
with_ the query string are
returned.
Maximum length of text
entered, if type = "Text
" or "password". For
complete length
validation, specify maxLe
ngth validation in a vali
date attribute; otherwise,
this attribute prevents
users from typing beyond
the specified length, but
does not prevent them
from pasting in a longer
value.

10

The maximum number
suggestions to display in
the auto-suggest list.Valid
only for cfinput
type="text".
Message text to display if
validation fails.

January, February,
March, April, May,
June, July, August,
September, October,
November, December

Applies to datefield typ
e only. A
comma-delimited list of
the month names that
display at the top of the
calendar.

703

Adobe ColdFusion Documentation

onBindError

Optional;HTML

onChange

Optional;all

JavaScript (HTML/XML)
or ActionScript (Flash) to
run when the control
changes due to user
action. In Flash, applies to
datefield, password, and
text types only.

onClick

Optional;all

JavaScript (HTML/XML)
or ActionScript (Flash) to
run when the user clicks
the control. In Flash,
applies to button,
checkbox, image, radio,
reset, and submit types
only.

onError

Optional;HTML, XML

Name of a custom
JavaScript function to
execute if validation fails.

onKeyDown

Optional;all

JavaScript (HTML/XML)
or ActionScript (Flash)
ActionScript to run when
the user presses a
keyboard key in the
control.

© 2014 Adobe Systems Incorporated. All rights reserved.

See Description

The name of a JavaScript
function to execute if
evaluating a bind
expression, including an
auto-suggest bind
expression, results in an
error. The function must
take two attributes: an
HTTP status code and a
message.
If you omit this attribute,
and have specified a
global error handler (by
using the ColdFusion.s
etGlobalErrorHandle
r function), it displays the
error message; otherwise
a default error pop-up
displays.

704

Adobe ColdFusion Documentation

onKeyUp

Optional;all

JavaScript (HTML/XML)
or ActionScript (Flash) to
run when the user
releases a keyboard key
in the control.

onMouseDown

Optional;all

JavaScript (HTML/XML)
or ActionScript (Flash) to
run when the user
releases a mouse button
in the control.

onMouseUp

Optional;all

JavaScript (HTML/XML)
or ActionScript (Flash) to
run when the user
presses a mouse button in
the control.

onValidate

Optional;HTML, XML

Name of a custom
JavaScript function to
validate user input. The
form object, input object,
and input object values
are passed to the routine,
which should return true
if validation succeeds, and
false otherwise. If used,
the validate attribute is
ignored.

pattern

Required if validate=
"regex";HTML, XML

JavaScript regular
expression pattern to
validate input. ColdFusion
uses this attribute only if
you specify regex in the v
alidate attribute.Omit
leading and trailing
slashes. For examples
and syntax, see Building
Dynamic Forms with
cfform Tags in the Develo
ping ColdFusion
Applications.

© 2014 Adobe Systems Incorporated. All rights reserved.

705

Adobe ColdFusion Documentation

range

Optional;all

Minimum and maximum
allowed numeric values.
ColdFusion uses this
attribute only if you
specify range in the vali
date attribute. If you
specify a single number or
a single number followed
by a comma, it is treated
as a minimum, with no
maximum. If you specify a
comma followed by a
number, the maximum is
set to the specified
number, with no minimum.
Note: ColdFusion does
not process the range att
ribute when you use onsu
bmit or onBlur validatio
n in XML format forms.

readonly

Optional; Flash, HTML

Applies to HTML and
Flash forms.Valid only for
cfinput type= "text".
ColdFusion ignores this
attribute for all other input
types.

required

Optional;all

no

showAutosuggestLoad
ingIcon

Optional; HTML

true

size

Optional;all

© 2014 Adobe Systems Incorporated. All rights reserved.

yes: the field must
contain data.
no: allows an empty
field.
A Boolean value that
specifies whether to
display an animated icon
when loading an
auto-suggest value for a
text input.
Size of input control.
Ignored, if type = "radi
o" or "checkbox". If
specified in a Flash form,
ColdFusion sets the
control width pixel value to
10 times the specified size
and ignores the width att
ribute.

706

Adobe ColdFusion Documentation

sourceForTooltip

Optional; HTML

The URL of a page to
display as a tool tip. The
page can include HTML
markup to control the
format, and the tip can
include images.
If you specify this
attribute, an animated
icon appears with the text
"Loading..." while the tip is
being loaded.

src

Optional;Flash, HTML

Applies to Flash button,
reset, submit, and image
types, and the HTML
image type. URL of an
image to use on the
button.

style

Optional;all

In HTML or XML format,
ColdFusion passes the
style attribute to the
browser or XML.
In Flash format, must be a
style specification in CSS
format. For detailed
information on specifying
Flash styles, see Creating
Forms in Flash in the Dev
eloping ColdFusion
Applications.
In XML format,
ColdFusion passes the
style attribute to the XML.

tooltip

Optional; Flash, HTML

Text to display when the
mouse pointer hovers
over the control.
Ignored if you specify a s
ourceForTooltip attrib
ute.

© 2014 Adobe Systems Incorporated. All rights reserved.

707

Adobe ColdFusion Documentation

type

Optional;all

text

The input control type to
create:
button: push button.
checkbox: check box.
datefield: HTML and
Flash only; date entry
field with an expanding
calendar from which
users select the date or
dates. In HTML format
only, users can also
enter the date by typing
in the field.
file: file selector; not
supported in Flash. Not
supported when you
use Ajax form
submission to submit
the form
asynchronously from
the page.
hidden: invisible
control.
image: clickable button
with an image.
password: password
entry control; hides
input values.
radio: radio button.
reset: form reset
button.
submit: form
submission button.
text: text entry box.
The attribute supports
all HTML 5 input types,
for example, email,
range, or date.

typeahead

Optional;HTML

© 2014 Adobe Systems Incorporated. All rights reserved.

no

A Boolean value that
specifies whether the
auto-suggest feature
should automatically
complete a user's entry
with the first result in the
suggestion list.Valid only
for cfinput
type="text".

708

Adobe ColdFusion Documentation

validate

Optional;all

validateAt

Optional;all

The type or types of
validation to do. Available
validation types and
algorithms depend on the
format. For details, see
Usage.
onSubmit

How to do the validation;
one or more of the
following values:
onSubmit
onServer
onBlur
The onBlur and
onSubmit values are
identical in Flash forms.
For multiple values, use
a comma-delimited list.
For details, see Usage.

value

depends on type
setting;all

visible

Optional; Flash

width

Optional; see Description

HTML: corresponds to the
HTML value attribute. Its
use depends on control
type.
Flash: optional; specifies
text for button type inputs:
button, submit, and
image.
yes

Boolean value that
specifies whether to show
the control. Space that
would be occupied by an
invisible control is blank.
Applies to most Flash
types, and HTML image
type on some browsers.
The width of the control, in
pixels. For Flash forms,
ColdFusion ignores this
attribute if you also
specify a size attribute
value.

Note
Attributes that are marked as not supported in XML are not handled by the skins provided with
ColdFusion. They are, however, included in the generated XML.

© 2014 Adobe Systems Incorporated. All rights reserved.

709

Adobe ColdFusion Documentation
Usage

For this tag to work properly. the browser must be JavaScript-enabled.
If the cfform preserveData attribute is true and the form posts back to the same page, the posted value of the
cfinput control is used, instead of its Value or Checked attribute.
You can use the keyboard to access and select dates from a datefield Flash input: press Tab to go to the field
and press the Spacebar to open the menu. Use the Up, Down, Left, and Right Arrow keys to change the selected
date. Use the Home and End keys to reach the first and last enabled date in a month, respectively. Use the Page Up
and Page Down keys to reach the previous and next month, respectively.
Note
To clear a datefield entry in Flash format forms, select the field to open the menu, and click the
selected date.

For more information, see cfform. For information on using JavaScript regular expressions with this tag, see Buildi
ng Dynamic Forms with cfform Tags in the Developing ColdFusion Applications.
Validation

The following sections describe how to do validation in cfinput tags.
Validation methods ColdFusion provides four methods of validation of cfinput text and password fields
. You can specify one or a combination of the following in the validateAtattribute:
onSubmit: The form page on the browser includes JavaScript functions that perform validation
before the form is submitted to the server. In Flash format forms, this option is identical to onBlur.
onBlur: In HTML format the form page on the browser includes JavaScript functions that perform
validation when the field loses the focus. In Flash format, the attribute is equivalent to onSubmit.
OnBlur validation uses the same algorithms as onSubmit validation. OnBlur validation was added in
ColdFusion MX 7.
onServer: ColdFusion performs the validation on the server. Some onServer algorithms vary from
the onSubmit algorithms. OnServer Date and Time validation allow more patterns than onSubmit
validation. OnServer validation was added in ColdFusion MX 7, and automatically generates hidden
fields to support the validation.
You can also omit a validate attribute and specify the type of validation for the field in a separate
hidden form field. This form of validation is equivalent to onServer validation, but it lets you specify
separate messages for each validation that you do on the field. It is backward compatible with previous
ColdFusion releases. For more information on hidden form field validation, see cfform and Validating
form data using hidden fields in Validating form data using hidden fields in the Developing ColdFusion
Applications.
Validation types Use the following values in the validate attribute to specify input validation for all
validation methods. Most attributes apply only to password or text fields. You can specify multiple validation
types in a comma-delimited list, but only some combinations are meaningful.
Type

Description

date

If validateAt="onServer", allows any date format
that returns true in the IsDate function; otherwise,
same as USdate.

© 2014 Adobe Systems Incorporated. All rights reserved.

710

Adobe ColdFusion Documentation

USdate

A US date of the format mm/dd/yy m