MACROMEDIA COLDFUSION 4.5-CFML LANGUAGE, Reference

Page: 64 / 608

40 CFML Language Reference
CFEXECUTE
Enables ColdFusion developers to execute any process on the server machine.
Syntax
<CFEXECUTE
NAME=" ApplicationName "
ARGUMENTS="CommandLine Arguments"
OUTPUTFILE="Output file name”
TIMEOUT=”Timeout interval in seconds”>
NAME
Required. The full path name of the application that is to be executed.
Note: On Windows systems, you must specify the extension, for example, .exe, as
part of the application’s name.
ARGUMENTS
Optional. Any command-line arguments that should be passed to the program.
If ARGUMENTS is specified as a string, it is processed as follows:
•
On Windows systems, the entire string is passed to the Windows process
control subsystem for parsing.
•
On UNIX, the string is tokenized into an array of arguments. The default token
separator is a space; arguments with embedded spaces may be delimited by
double quotes.
If ARGUMENTS is passed as an array, it is processed as follows:
•
On Windows systems, the array elements will be concatenated into a string of
tokens, separated by spaces. This string is then passed to the Windows process
control subsystem as above.
•
On UNIX, the elements of the ARGUMENTS array is copied into a
corresponding array of exec() arguments.
OUTPUTFILE
Optional. The file where the output of the program is to be directed. If this is not
specified, the output appears on the page from which it was called.
TIMEOUT
Optional. Indicates how long in seconds the ColdFusion executing thread will wait
for the spawned process. Indicating a timeout of 0 is equivalent to the non-
blocking mode of executing. A very high timeout value is equivalent to a blocking
mode of execution. The default is 0; therefore, the ColdFusion thread spawns a
process and immediately returns without waiting for the process to terminate.
If no output file is specified, and the timeout value is zero, then the program’s
output will be directed to the bit bucket.