MACROMEDIA COLFUSION MX 7-CFML Reference page 181

Attribute Req/Opt
access Optional
description Optional
output Optional
displayname Optional
hint Optional
Usage
The tag can define a function that you call in the same manner as a ColdFusion
cffunction
built-in function.
To define a ColdFusion component (CFC) method, you must use a
The following example shows
ColdFusion Query object.
<cffunction
name="getEmployees"
access="remote"
returnType="query"
hint="This query returns all records in the employee database. It can
drill-down or narrow the search, based on optional input parameters.">
Default Description
public The client security context from which the method can
be invoked:
• 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.
• 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.
Supplies a short text description of the function.
Function Specifies under which conditions the function can
body is generate HTML output.
processed
• yes: the entire function body is processed as if it were
as standard
within a
CFML
number signs (#) are automatically replaced with their
values.
• no: the function is processed as if it were within a
cfsilent
If you do not specify this attribute, the function body is
processed as standard CFML. Any variables must be in
cfoutput
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.
Meaningful only for CFC method parameters. Text to be
displayed when using introspection to show information
about the CFC. The
syntax line in the function description.
tag attributes for a simple CFC method that returns a
cffunction
tag. Variables names surrounded by
cfoutput
tag
tags.
attribute value follows the
hint
cffunction
tag.
cffunction 181