CFFUNCTION

"-->

 <cffunction          name = "methodName"          returnType = "dataType"          roles = "securityRoles"          access = "methodAccess"          output = "yes" or "no"          exceptions = "exception1, exception2, ..."> 

Description

Used to create functionality within a CFC usually written in CFML.

Attributes

name (Required)

Defines the component method that is used within the CFCOMPONENT tag. The valid types are query, string, numeric, boolean, date, struct, array, binary, xml, customFunction, object, any, or the name of a component.

returnType (Optional)

The value that is returned by the function.

roles (Optional)

Default: "" (empty), which is a comma-delimited list of ColdFusion security roles that can invoke the method. If this attribute is omitted, all roles can invoke the method.

access (Optional)

Default: public

• private. Available only to the component that declares the method.

• package. Available only to the component that declares the method or to another component 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 to a remote client through a URL, Flash, or web service.

output (Optional)

Default: Function is processed as standard CFML.

• Yes. The function is processed as if it were within a CFOUTPUT tag.

• No. The function is processed as if it were within a CFSILENT tag.

exceptions (Optional)

Comma-delimited list of exceptions.