cfdocs.org /

Description

Returns result values from a component method. Contains an expression returned as result of the function.

Return value

An expression; the result of the function from which this tag is called.

Category

Extensibility tags

Syntax

<cfreturn  
    expr>

See also

cfargument, cfcomponent, cffunction, cfinvoke, cfinvokeargument, cfobject, cfproperty; Building and Using ColdFusion Components in the Developing ColdFusion Applications

History

ColdFusion MX: Added this tag.

Attributes

Attribute

Req/Opt

Default

Description

expr

Required

 

Function result; value of any type.

Usage

This tag is equivalent to a return statement within a cfscript tag. It accepts one return variable argument. To return more than one value, populate a structure with name-value-pairs, and return the structure with this tag.

To access the result value from this tag, you use the variable scope that is the value of the cfinvoke tag returnVariable attribute.

You can code a maximum of one cfreturn tag within a function.

For example code, see Building and Using ColdFusion Components in the Developing ColdFusion Applications.

Example

<cfcomponent> 
    <cffunction name="getEmp"> 
         <cfquery name="empQuery" datasource="ExampleApps" > 
             SELECT FIRSTNAME, LASTNAME, EMAIL 
             FROM tblEmployees 
         </cfquery> 
         <cfreturn empQuery> 
    </cffunction> 
    <cffunction name="getDept"> 
        <cfquery name="deptQuery" datasource="ExampleApps" > 
             SELECT * 
             FROM tblDepartments 
         </cfquery> 
         <cfreturn deptQuery> 
    </cffunction> 
</cfcomponent>