Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 4/01/2024
Public
Document Table of Contents

4.1.2.17. 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

Syntax get_design_rich_description [-h | -help] [-long_help] [-name <name> ] [-source <online|quartus|my_download|all> ] [-version <version> ]
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)
-version <version> The version of the design
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