cfset
319
Function local variables
The
var
keyword specifies that the variable being defined is only available inside the body of a
function that you define using the
cffunction
tag. The variable value that is set in one
invocation of the function is not available in any other invocation of the function. The
var
keyword is the equivalent of the
var
statement in CFScript. The following rules apply to the
var
keyword:
•
Any
cfset
tag that uses the
var
keyword must be inside the body of a
cffunction
tag. If you
use the
var
keyword in a
cfset
tag outside a
cffunction
tag body, ColdFusion displays an
error message.
•
You must place all
cfset
tags that use the
var
keyword at the beginning of the
cffunction
tag body, before any other ColdFusion tags.
The following example shows how to use the new keyword:
<cffunction name="myFunct">
<cfset var myVar = "This is a test">
<cfreturn myVar & " Message.">
</cffunction>
<cfoutput>#myFunct()#</cfoutput>
In this example, the variable myVar exists only when the function myFunct executes, and it is not
available elsewhere on the ColdFusion page.
COM objects
In this example, a COM object is created. A
cfset
defines a value for each method or property in
the COM object interface. The last
cfset
creates a variable to store the return value from the
COM object's
SendMail
method.
<cfobject action = "Create"
name = "Mailer"
class = "SMTPsvg.Mailer">
<cfset MAILER.FromName = form.fromname>
<cfset MAILER.RemoteHost = RemoteHost>
<cfset MAILER.FromAddress = form.fromemail>
<cfset MAILER.AddRecipient("form.fromname", "form.fromemail")>
<cfset MAILER.Subject = "Testing cfobject">
<cfset MAILER.BodyText = "form.msgbody">
<cfset Mailer.SMTPLog = "logfile">
<cfset success = MAILER.SendMail()>
<cfoutput> #success# </cfoutput>
Example
<!--- This example shows how to use cfset --->
<cfquery name = "GetMessages" dataSource = "cfsnippets">
SELECT *
FROM Messages
</cfquery>
<h3>cfset Example</h3>
<p>cfset sets and reassigns values to local or global variables within a page.
<cfset NumRecords = GetMessages.recordCount>
<p>For example, the variable NumRecords has been declared on this
page to hold the number of records returned from query
(<cfoutput>#NumRecords#</cfoutput>).
Summary of Contents for COLDFUSION MX 61-CFML
Page 1: ...CFML Reference...
Page 16: ...16 Contents...
Page 32: ...32 Chapter 1 Reserved Words and Variables...
Page 160: ...160 Chapter 2 ColdFusion Tags html...
Page 245: ...cfmail 245 p input type Submit name form...
Page 299: ...cfreturn 299 cffunction cfcomponent...
Page 354: ...354 Chapter 2 ColdFusion Tags cfoutput cfcatch cftry...
Page 357: ...cfupdate 357 cftable cfif body html...
Page 362: ...362 Chapter 2 ColdFusion Tags cfloop MyDoc cfxml cfdump var MyDoc...
Page 397: ...ASin 397 br input type Text name sinNum size 25 p input type Submit name input type RESET form...
Page 486: ...486 Chapter 3 ColdFusion Functions input type Submit NAME form...
Page 492: ...492 Chapter 3 ColdFusion Functions b http_content x content b cfoutput...
Page 504: ...504 Chapter 3 ColdFusion Functions tr table form...
Page 519: ...IIf 519 cfoutput b...
Page 534: ...534 Chapter 3 ColdFusion Functions input type Submit name form...
Page 542: ...542 Chapter 3 ColdFusion Functions cfif cfif...
Page 547: ...IsStruct 547 cfcase cfswitch...
Page 550: ...550 Chapter 3 ColdFusion Functions IsWDDX returns IsWDDX packet br cfoutput...
Page 559: ...Left 559 option value 9 9 select input type Submit name Remove characters form...
Page 620: ...620 Chapter 3 ColdFusion Functions cfoutput cfloop...
Page 681: ...SetVariable 681 p Your variable varName p The value of varName is varNameValue cfoutput cfif...
Page 724: ...724 Chapter 3 ColdFusion Functions cfelse h3 Conversion error h3 cfif...
Page 743: ...XmlNew 743 cfscript cfdump var MyDoc...
Page 786: ...786 Chapter 5 ColdFusion Java CFX Reference...
Page 798: ...798 Chapter 6 WDDX JavaScript Objects...
Page 806: ...806 Chapter 7 ColdFusion ActionScript Functions...
