get_dashboard_gadgets - 2022.2 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
UG835
Release Date
2022-10-19
Version
2022.2 English

Create the Project summary dashboard

Syntax

get_dashboard_gadgets [‑quiet] [‑verbose] [<patterns>...]

Usage

Name Description
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<patterns>] Match gadget names against patterns Default: * Values: The default search pattern is the wildcard *

Categories

Object, Project

Description

Gets a list of the dashboard gadgets in the current project.

Arguments

-quiet - (Optional) Execute the command quietly, returning no messages from the command. The command also returns TCL_OK regardless of any errors encountered during execution.
Note: Any errors encountered on the command-line, while launching the command, will be returned. Only errors occurring inside the command will be trapped.
-verbose - (Optional) Temporarily override any message limits and return all messages from this command.
Note: Message limits can be defined with the set_msg_config command.

<patterns> - (Optional) Match dashboard gadget names against the specified patterns. The default pattern is the wildcard '*' which gets all dashboard gadgets. More than one pattern can be specified to find dashboard gadgets based on multiple search criteria.

Examples

The following example returns the dashboard gadgets in the current project:
get_dashboard_gadgets