MACROMEDIA COLDFUSION MX 61-CFML Reference page 55

Attribute Req/Opt Default
required Optional
default Optional
displayname Optional
hint Optional
Usage
This tag must be in a
Arguments that are passed when a method is invoked can be accessed from the method body in
the following ways:
•
With shorthand syntax:
(This example accesses the argument
•
Using the arguments scope as an array:
(This example accesses the first defined argument in the cffunction)
•
Using the arguments scope as a struct:
(This example accesses the argument
Example
<!--- This example defines a function that takes a course number parameter
and returns the course description. --->
<cffunction name="getDescript">
<!--- Identify argument --->
<cfargument name="Course_Number" type="numeric" required="true">
<!--- Use the argument to get a course description from the database --->
<cfquery name="Description" datasource="cfsnippets">
SELECT Descript
FROM Courses
WHERE Number = '#Course_Number#'
</cfquery>
<!--- Specify the variable that the function returns --->
<cfreturn Description.Descript>
</cffunction>
Description
no Whether the parameter is required to execute the component
method.
• yes (the parameter is not required if you specify a
attribute.)
• no
If no argument is passed, specifies a default argument value.
name Meaningful only for CFC method parameters. A value to be
attribute displayed when using introspection to show information about
value the CFC.
Meaningful only for CFC method parameters. Text to be
displayed when using introspection to show information about
the CFC. The
attribute value in the parameter description line. This attribute
can be useful for describing the purpose of the parameter.
tag, before any other tags in the
cffunction
#myargument#
myargument
#arguments[1]#
#arguments.myargument#
myargument
attribute value follows the
hint
cffunction
.)
in the array)
default
displayname
tag body.
cfargument 55