User manual MACROMEDIA COLFUSION MX 7 -CFML QUICK REFERENCE

COLDFUSION MX 7 ® CFML Quick Reference Trademarks 1 Step RoboPDF, ActiveEdit, ActiveTest, Authorware, Blue Sky Software, Blue Sky, Breeze, Breezo, Captivate, Central, ColdFusion, Contribute, Database Explorer, Director, Dreamweaver, Fireworks, Flash, FlashCast, FlashHelp, Flash Lite, FlashPaper, Flex, Flex Builder, Fontographer, FreeHand, Generator, HomeSite, JRun, MacRecorder, Macromedia, MXML, RoboEngine, RoboHelp, RoboInfo, RoboPDF, Roundtrip, Roundtrip HTML, Shockwave, SoundEdit, Studio MX, UltraDev, and WebHelp are either registered trademarks or trademarks of Macromedia, Inc. and may be registered in the United States or in other jurisdictions including internationally. Other product names, logos, designs, titles, words, or phrases mentioned within this publication may be trademarks, service marks, or trade names of Macromedia, Inc. or other entities and may be registered in certain jurisdictions including internationally.This product includes code licensed from RSA Data Security. Third-Party Information This guide contains links to third-party websites that are not under the control of Macromedia, and Macromedia is not responsible for the content on any linked site. If you access a third-party website mentioned in this guide, then you do so at your own risk. Macromedia provides these links only as a convenience, and the inclusion of the link does not imply that Macromedia endorses or accepts any responsibility for the content on those third-party sites. Copyright © 2005 Macromedia, Inc. All rights reserved. U.S. Patents Pending. This manual may not be copied, photocopied, reproduced, translated, or converted to any electronic or machine-readable form in whole or in part without written approval from Macromedia, Inc. Notwithstanding the foregoing, the owner or authorized user of a valid copy of the software with which this manual was provided may print out one copy of this manual from an electronic version of this manual for the sole purpose of such owner or authorized user learning to use such software, provided that no part of this manual may be printed out, reproduced, distributed, resold, or transmitted for any other purposes, including, without limitation, commercial purposes, such as selling copies of this documentation or providing paid-for support services. Part Number ZCF70M300 Project Management: Randy Nielsen Editing: Linda Adler Production Management: Patrice O'Neill Media Design and Production: John Francis, Adam Barnett Special thanks to Sawako Gensure, Seungmin Lee, Takashi Koto, Nozomi Kugita, Masayo Noda, Hiroshi Okugawa, Bowne Global Solutions First Edition: January 2005 Macromedia, Inc. 600 Townsend St. San Francisco, CA 94103 CONTENTS CFML tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 CFML functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Array functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Conversion functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Date and time functions . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Decision functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Display and formatting functions . . . . . . . . . . . . . . . . . . . 26 Dynamic evaluation functions . . . . . . . . . . . . . . . . . . . . . 26 Extensibility functions . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 International functions . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 List functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Mathematical functions . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Other functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Query functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Security functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 String functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Structure functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 System functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 XML functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Gateway interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Methods to implement . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 IM Gateway CFC incoming message methods . . . . . . . . . 32 IM Gateway message sending commands . . . . . . . . . . . . . 32 Application.cfc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Methods to implement . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 ColdFusion variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Variable scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Caller scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Client variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Server variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Application and session variables . . . . . . . . . . . . . . . . . . . 33 Custom tag variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Request variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Form variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 ColdFusion tag-specific variables . . . . . . . . . . . . . . . . . . . . . 34 ColdFusion query variables . . . . . . . . . . . . . . . . . . . . . . . . 34 CFCATCH variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 CFDIRECTORY variables . . . . . . . . . . . . . . . . . . . . . . . . 35 CFERROR variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 CFFILE ACTION=Upload variables . . . . . . . . . . . . . . . . 35 CFFTP error variables . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 CFFTP ReturnValue variable . . . . . . . . . . . . . . . . . . . . . . 36 CFFTP query object columns . . . . . . . . . . . . . . . . . . . . . 36 CFHTTP variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 CFLDAP variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 CFML Quick Reference 3 CFPOP variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 CFQUERY and CFSTOREDPROC variables . . . . . . . . . 37 CFREGISTRY variables . . . . . . . . . . . . . . . . . . . . . . . . . . 37 CFSEARCH variables . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Standard CGI variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 CGI environment variables . . . . . . . . . . . . . . . . . . . . . . . . . 38 CGI server variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 CGI client variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 CGI client certificate variables . . . . . . . . . . . . . . . . . . . . . 38 4 CFML Quick Reference CFML tags cfabort cfapplet cfapplication cfargument cfassociate cfbreak cfcache cfcalendar CFML Quick Reference 5 cfcase cfcatch Exception processing code here cfchart Syntax 1 Syntax 2 pieSliceStyle = "solid, sliced" scaleFrom = "integer minimum value" scaleTo = "integer maximum value" seriesPlacement = "default, cluster, stacked, percent" show3D = "yes" or "no" showBorder = "yes" or "no" showLegend = "yes" or "no" showMarkers = "yes" or "no" showXGridlines = "yes" or "no" showYGridlines = "yes" or "no" sortXAxis = "yes" or "no" tipBGColor = "hex value or web color" tipStyle = "MouseDown, MouseOver, none" title = "title of chart" url = "onClick destination page" xAxisTitle = "title text" xAxisType = "scale or category" xOffset = "number between -1 and 1" yAxisTitle = "title text" yAxisType = "scale or category" yOffset = "number between -1 and 1" cfchartdata cfchartseries itemColumn="queryColumn" markerStyle="style" paintStyle="plain, raise, shade, light" query="queryName" seriesColor="Hex value or Web color" seriesLabel="Label Text" type="type" valueColumn="queryColumn" dataLabelStyle="style" cfcol 6 CFML Quick Reference cfcollection cfcomponent hint = "text string"> Variable declarations ... ... cfcontent cfcookie cfdefaultcase cfdirectory cfdocument CFML Quick Reference 7 HTML and CFML code cfdocumentitem Syntax 1 Syntax 2 Header/footer text cfdocumentsection HTML, CFML, and cfdocumentitem tags cfdump cfelse HTML and CFML tags HTML and CFML tags HTML and CFML tags cfelseif HTML and CFML tags HTML and CFML tags HTML and CFML tags cferror cfexecute ... cfexit cffile 8 CFML Quick Reference result = "result_name" cfflush cfform ... cfformgroup width = "pixels" height = "pixels" enabled = "Yes" or "No" visible = "Yes" or "No" OnChange = "ActionScript expression" toolTip = "Tip text" ...ColdFusion forms controls OR ...ColdFusion forms controls cfformitem OR ...text cfftp cfftp: Opening and closing FTP server connections cfftp: Connection: file and directory operations result = "result_name" cfftp action = "listDir" cffunction cfgraph See cfchart cfgraphdata See cfchartdata cfgrid Zero or more cfgridcolumn and cfgridrow tags cfgridcolumn cfgridrow cfgridupdate cfheader OR cfhtmlhead cfhttp cfhttpparam cfif HTML and CFML tags HTML and CFML tags HTML and CFML tags cfimport cfinclude cfindex status = "status"> cfinput cfinsert cfinvoke Syntax 1 OR Syntax 2 OR Syntax 3 OR Syntax 4A component = "#mystringname for instantiated component#" method = "method name" returnVariable = "variable name" argumentCollection = "argument collection" ...> OR 14 CFML Quick Reference Syntax 4B webservice = "#my stringname for instantiated web service#" timeout = "request timeout in seconds" proxyServer = "WSDL proxy server url proxyPort = "numeric port on proxy server" proxyUser = "string user id for proxy server" servicePort = "WSDL port name" proxyPassword = "string user password for proxy server"> cfinvokeargument cfldap cflocation cflock cflog cflogin ...> cfloginuser cflogout cfloop cfloop: index loop HTML or CFML code cfloop: conditional loop ... cfloop: looping over a date or time range cfloop: looping over a query cfloop: looping over a list or file ... cfloop: looping over a COM collection or structure #file2.name#
cfmail 16 CFML Quick Reference (Optional) Mail message body and/or cfhttpparam tags cfmailparam OR ... cfmailpart (Optional cfmailparam entries) Mail part contents ... cfmodule cfNTauthenticate cfobject cfobject: COM object cfobject: component object cfobject: CORBA object cfobject: Java or EJB object CFML Quick Reference 17 cfobject: web service object cfobjectcache cfoutput cfparam cfpop cfprocessingdirective OR CFML tags cfprocparam cfprocresult cfproperty cfquery result = "result_name" cfqueryparam SQL STATEMENT column_name = AND/OR ...additional criteria of the WHERE clause... cfregistry cfregistry action = "getAll" cfregistry action = "get" cfregistry action = "set" cfregistry action = "delete" cfreport Syntax 1 OR CFML Quick Reference 19 Syntax 2 cfreportparam cfrethrow cfreturn cfsavecontent the content cfschedule proxyUser = "username" proxyPassword = "password" resolveURL = "yes" or "no" cfscript cfscript code here cfsearch