TAG:CFFUNCTION

last edited byusericondenny on 01-Oct-2011

Contents

Return to Tags or Functions

cffunction

Syntax

<cffunction
	[abstract="boolean"]
	[access="string"]
	[description="string"]
	[displayname="string"]
	[hint="string"]
	name="string"
	[output="boolean"]
	[returnformat="string"]
	[returntype="string"]
	[roles="string"]
	[securejson="boolean"]
	[verifyclient="boolean"] ... >
&</cffunction>

[] = Optional attribute

Description

Defines table column header, width, alignment, and text. Used only inside a cftable.

Body

This tag must have a body.

Attributes

This tag has a fixed definition of attributes (see below). In addition it allowes to use any additional attribute.

Name Type Required Description
abstract boolean No is the function abstract or not, abstract functions are only allowed inside interface or component tags
access string No This attribute is used only for a component.
The client security context from which the method can be invoked
description string No Supplies a short text description of the function.
displayname string No Display Name of the Function
hint string No Hint of the Function
name string Yes A string; a component method that is used within the cfcomponent tag.
output boolean No This attribute is used only for a component.
yes: the function is processed as if it were within a cfoutput tag
no: the function is processed as if it were within a cfsilent tag
returnformat string No The format in which to return values to a remote caller.
returntype string No String; a type name; data type of the function return value
roles string No This attribute is used only for a component. If this attribute is omitted, all roles can invoke the method.
securejson boolean No A Boolean value that specifies whether to add a security prefix in front of any value that the function returns in JSON-format in response to a remote call.
verifyclient boolean No A Boolean value that specifies whether to require remote function calls to include an encrypted security token. For use with AJAX applications only.

 
Download in other Formats:
markup Markup | pdf PDF | html HTML | word Word