Lucee Tag Reference
Tag <CFEXECUTE>
Enables developers to execute a process on a server computer.
Body
This tag must have a body.
Example
<cfexecute [arguments="any"] [errorfile="string"] [errorvariable="string"] [name="string"] [outputfile="string"] [terminateontimeout="boolean"] [timeout="number"] [variable="string"]> </cfexecute>
This tag is also supported within cfscript
<cfscript> execute [arguments="any"] [errorfile="string"] [errorvariable="string"] [name="string"] [outputfile="string"] [terminateontimeout="boolean"] [timeout="number"] [variable="string"] { } </cfscript>
Attributes
The attributes for this tag are fixed. Except for the following attributes no other attributes are allowed.
Name | Type | Required | Description |
---|---|---|---|
arguments | any | No | Command-line arguments passed to the application. |
errorfile | string | No | The file to which to direct the error stream of the program. If neither errorFile nor errorVariable is specified, the error stream is discarded. |
errorvariable | string | No | Variable in which to put program error stream output. If neither errorFile nor errorVariable is specified, the error stream is discarded. |
name | string | No | The full pathname of the application to execute. Note: On Windows, you must specify the extension as part of the application's name. For example, myapp.exe, |
outputfile | string | No | The file to which to direct the output of the program. If not specified, the output is displayed on the page from which it was called. |
terminateontimeout | boolean | No | terminate execution of process when timeout occur |
timeout | number | No | Indicates how long, in seconds, the executing thread waits for the spawned process. 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 thread spawns a process and returns without waiting for the process to terminate.If no output file is specified, and the timeout value is 0, the program output is discarded. |
variable | string | No | Variable in which to put program output. If no output file or variable attribute is specified, output is displayed on page from which it was called. |