The following table displays information for the get_assignment Tcl command:
Tcl Package and Version | Belongs to ::quartus::names 1.0 |
||
Syntax | get_assignment [-h | -help] [-long_help] -dict -name <ASSIGNMENT_NAME> [-to <ASSIGNMENT_TO>] | ||
Arguments | -h | -help | Short help | |
-long_help | Long help with examples and possible return values | ||
-dict | Indicates this command should return it's result as a Tcl dict object. | ||
-name <ASSIGNMENT_NAME> | The assignment name to get the value of. | ||
-to <ASSIGNMENT_TO> | The node to retrieve the assignment value from (omitting this will retrieve the global assignment value, if any). | ||
Description |
Gets the assignment's value. If -to is specified, tries to get the assignment value on the given node, as long as the assignment targeted the node using it's -to field. If -to is not specified, the global value is returned (if any). If the assignment is not found, a Tcl error is produced. If the assignment is found and the -dict option is given, a Tcl dict object is returned with the assignment 'name' (the given input), and the 'value' retrieved from the found assignment. In addition, if the assignment has a 'to' or 'from' field, those fields will also exist in the returned dict. |
||
Example Usage |
# Returns fitter seed get_assignment SEED |
||
Return Value | Code Name | Code | String Return |
TCL_OK | 0 | INFO: Operation successful | |
TCL_ERROR | 1 | ERROR: No assignment matching the name <string> was found. |