get_design_documents_info (::quartus::board)
The following table displays information for the get_design_documents_info Tcl command:
| Tcl Package and Version |
Belongs to ::quartus::board 1.0 |
|||
| Syntax | get_design_documents_info [-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 document title(s) and URL(s) of documentation(s) of designs that contain the given design name. If no argument is supplied, the command will return the design documentation of all the available designs. |
|||
| Example Usage |
set docs [::board::get_design_documents_info -name memory] |
|||
| Return Value | Code Name | Code | String Return | |
| TCL_OK | 0 | INFO: Operation successful | ||