get_design_rich_description (::quartus::board)
The following table displays information for the get_design_rich_description Tcl command:
| Tcl Package and Version |
Belongs to ::quartus::board 1.0 |
|||
| Syntax | get_design_rich_description [-h | -help] [-long_help] [-name <name> ] [-source <online|quartus|my_download|all> ] | |||
| Arguments | -h | -help | Short help | ||
| -long_help | Long help with examples and possible return values | |||
| -name <name> | The name of the design | |||
| -source <online|quartus|my_download|all> | The Load From sources of the designs (Online, Pre-installed, Downloaded or All) | |||
| Description |
This commands returns the rich-text description information of designs that contain the given design name. If no argument is supplied, the command will return the rich-text description of all the available designs. |
|||
| Example Usage |
set rich_description [::board::get_design_rich_description] |
|||
| Return Value | Code Name | Code | String Return | |
| TCL_OK | 0 | INFO: Operation successful | ||