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:
|
|
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> |
NAME | |
Required | |
String; an argument name. |
TYPE | |
Optional | |
Default value: "any"
String; a type name; data type of the argument.
|
REQUIRED | |
Optional | |
Default value: "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 default attribute.
|
DEFAULT | |
Optional | |
If no argument is passed, specifies a default argument value. |
DISPLAYNAME | |
Optional | |
Default value: "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. |