MACROMEDIA COLFUSION MX 7-CFML Reference page 46

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
•
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="getDescription">
<!--- 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="cfdocexamples">
SELECT Descript
FROM Courses
WHERE Number = '#Course_Number#'
</cfquery>
<!--- Specify the variable that the function returns --->
<cfreturn Description.Descript>
</cffunction>
46 Chapter 2: ColdFusion Tags
Description
no Note: All arguments are required when invoked as a web
service, irrespective of how they are defined.
Specifies whether the parameter is required to execute the
component method. The parameter is not required if you
specify a
• true or "yes"
• false or "no"
If no argument is passed, specifies a default argument value.
Meaningful only for CFC method parameters. A value to be
name
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.
default
attribute value follows the
hint
cffunction
.)
cffunction
in the array.)
displayname
tag body.
.)