reset_property - 2023.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
UG835
Release Date
2023-05-16
Version
2023.1 English

Reset property on object(s)

Syntax

reset_property [‑quiet] [‑verbose] <property_name> <objects>...

Returns

The value that was set if success, "" if failure.

Usage

Name Description
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
<property_name> Name of property to reset
<objects> Objects to set properties

Description

Restores the specified property to its default value on the specified object or objects. If no default is defined for the property, the property is unassigned on the specified object.

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.

<property_name> - (Required) The name of the property to be reset.

<objects> - (Required) One or more objects on which the property will be restored to its default value.

Examples

The following example sets the DOB_REG property on the specified Block RAM, and then resets the property:

set_property DOB_REG 1 [get_cells usbEngine1/usbEngineSRAM/snoopyRam_reg_19]
reset_property DOB_REG [get_cells usbEngine1/usbEngineSRAM/snoopyRam_reg_19]