cfargument

Overview ColdFusion Open BlueDragon Lucee

Creates a parameter definition within a component definition. Defines a function argument. Used within a cffunction tag.

Attributes

Name Required Type Default Description
default No String If no argument is passed, specifies a default argument value.
displayname No String Meaningful only for CFC method parameters. A value to be displayed when using introspection to show information about the CFC.
hint No String 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
name Yes String An argument name.
3
passby No should the argument passed as reference (default) or as a value
required No Boolean Whether the parameter is required to execute the component method.
10
restargname No String The name that can be mapped to the argument name.If restArgName is not specified, the name of the argument is used to extract the parameter value
10
restargsource No String Extracts request parameters in a REST request. Request can be passed in the path, query, matrix, cookie, and form
type No String A type name; data type of the argument.