qed::get_return_value (::quartus::qed)
The following table displays information for the qed::get_return_value Tcl command:
Tcl Package and Version |
Belongs to ::quartus::qed 1.0 |
|||
Syntax | qed::get_return_value [-h | -help] [-long_help] [-return_token <return_token> ] [-timeout <timeout> ] <object> | |||
Arguments | -h | -help | Short help | ||
-long_help | Long help with examples and possible return values | |||
-return_token <return_token> | Token returned by a previous asynchronous run invocation | |||
-timeout <timeout> | Optional timeout for waiting for a return value in ms (default = 0 = no timeout) | |||
<object> | Identifier associated with the object, must be unique | |||
Description |
Returns data from a command that was run without blocking (using the "-async" option). You must specify the token returned from another command such as "qed::launch_connection" or "qed::run_command". Tokens are not interchangeable between objects. The "qed::get_return_value" command returns a Tcl error if the given token was not issued by the given object. The "qed::get_return_value" command blocks until the return value |
|||
Example Usage |
qed::create_object -type project project_A -qpf_path /file/path/to/project.qpf qed::launch_connection project_A set tok [qed::run_command project_A -cmd "after 1000; expr {100 * 100}"] # Waits for ~1 second and returns 10000 qed::get_return_value project_A -return_token $tok |
|||
Return Value | Code Name | Code | String Return | |
TCL_OK | 0 | INFO: Operation successful |