unselect_objects - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
UG835
Release Date
2024-05-30
Version
2024.1 English

Unselect items that are currently selected

Syntax

unselect_objects [‑quiet] [‑verbose] [<objects>]

Usage

Name Description
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<objects>] Objects to unselect

Categories

GUIControl

Description

Unselects the specified object or objects that were previously selected by the select_objects command.

This command will unselect both primary and secondary selected objects. The selection of secondary objects is controlled through the use of Selection Rules defined in the Tools > Settings command. Refer to the Vivado Design Suite User Guide: Using the IDE (UG893) for more information on Setting Selection Rules.

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.

<objects> - (Optional) One or more objects to be unselected. If no objects are specified, all selected objects will be unselected.

Examples

The following example unselects the specified site on the device:

unselect_objects [get_sites SLICE_X56Y214]

The following example unselects all currently selected objects:

unselect_objects