CFARGUMENT |
|
 |
Description
|
Creates a parameter definition within a component definition. Defines a function argument. Used within a cffunction tag.
|
|
Category
|
Extensibility tags
|
|
Syntax<cfargument
name="string"
type="data type"
required="Yes or No"
default="default value"
displayname="descriptive name"
hint="extended description"
>
|
|
See also
|
cfcomponent, cffunction, cfinvoke, cfinvokeargument, cfobject, cfproperty, cfreturn
|
|
|
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>
|