MACROMEDIA COLDFUSION MX 61-CFML, Reference

Page: 55 / 806

cfargument 55
Usage
This tag must be in a
cffunction
tag, before any other tags in the
cffunction
tag body.
Arguments that are passed when a method is invoked can be accessed from the method body in
the following ways:
•
With shorthand syntax:
#myargument#
(This example accesses the argument
myargument
.)
•
Using the arguments scope as an array:
#arguments[1]#
(This example accesses the first defined argument in the cffunction)
•
Using the arguments scope as a struct:
#arguments.myargument#
(This example accesses the argument
myargument
in the array)
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>
required Optional no Whether the parameter is required to execute the component
method.
•
yes (the parameter is not required if you specify a
default
attribute.)
•
no
default Optional If no argument is passed, specifies a default argument value.
displayname Optional
name
attribute
value
Meaningful only for CFC method parameters. A value to be
displayed when using introspection to show information about
the CFC.
hint Optional Meaningful only for CFC method parameters. Text to be
displayed when using introspection to show information about
the CFC. The
hint
attribute value follows the
displayname
attribute value in the parameter description line. This attribute
can be useful for describing the purpose of the parameter.
Attribute Req/Opt Default Description