MACROMEDIA COLFUSION MX 7 - INSTALLING AND USING COLDFUSION MX, Reference

Page: 45 / 1108

cfargument 45
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
Attributes
Attribute Req/Opt Default Description
name Required String; an argument name.
type Optional any String; a type name; data type of the argument.
•
any
•
array
•
binary
•
boolean
•
date
•
guid: the argument must be a UUID or GUID of the form
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx where each x is a
character representing a hexadecimal number (0-9A-F).
•
numeric
•
query
•
string
•
struct
•
uuid: the argument must be a ColdFusion UUID of the form
xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx where each x is a
character representing a hexadecimal number (0-9A-F).
•
variableName: a string formatted according to ColdFusion
variable naming conventions.
• xml: XML objects and XML strings
• a component name: if the type attribute value is not one of
the preceding items, ColdFusion treats it as the name of a
ColdFusion component. When the function executes, it
generates an error if the argument that is passed in is not a
CFC with the specified name.