MACROMEDIA COLDFUSION MX 61-CFML, Reference

Page: 211 / 806

cfinvoke 211
If the
component
attribute specifies a component name, the component with the corresponding
name is instantiated, the requested method is invoked, and then the component instance is
immediately destroyed. If the attribute contains a reference to an instantiated component object,
no instantiation or destruction of the component occurs.
On UNIX systems, ColdFusion searches first for a file with a name that matches the specified
component name, but is all lower case. If it does not find the file, it looks for a file name that
matches the component name exactly, with the identical character casing.
Method arguments can be passed in any of the following ways. If an argument is passed in more
than one way with the same name, this order of precedence applies:
1
Using the
cfinvokeargument
tag
2
Passing directly as attributes of the
cfinvoke
tag (they cannot have the same name as a
registered
cfinvoke
attribute:
method
,
component
,
webservice
,
returnVariable
)
3
Passing as struct keys, using the
argumentCollection
attribute
For example, the
params
struct contains three keys:
a=1
,
b=1
,
c=1
. The following call is evaluated
as if the arguments were passed to the method in the order
a=3
,
b=2
,
c=1
:
<cfinvoke ... a=2 b=2 argumentCollection=params>
<cfinvokeargument name="a" value="3">
</cfinvoke>
Note: The following cfinvoke tag attribute names are reserved; they cannot be used for argument
names:
component
,
method
,
argumentCollection
, and
result
.
Example1
This example uses Syntax 1.
<!--- immediate instantiation and destruction --->
<cfinvoke
component="nasdaq.quote"
method="getLastTradePrice"
returnVariable="res">
<cfinvokeargument
name="symbol"
value="macr">
username Ignored Ignored Optional Ignored Optional
password Ignored Ignored Optional Ignored Optional
webservice Ignored Ignored Required Ignored Required
timeout Invalid Invalid Optional Invalid Optional
proxyServer Invalid Invalid Optional Invalid Optional
proxyPort Invalid Invalid Optional Invalid Optional
proxyUser Invalid Invalid Optional Invalid Optional
proxyPassword Invalid Invalid Optional Invalid Optional
input_params ... Optional Optional Optional Optional Optional
This attribute is
required, optional,
ignored, or invalid:
For this
cfinvoke
tag syntax:
Syntax 1 Syntax 2 Syntax 3 Syntax 4A Syntax 4B