common::reset_property - 2020.2 English

Vitis Unified Software Platform Documentation: Embedded Software Development (UG1400)

Document ID
UG1400
Release Date
2020-12-15
Version
2020.2 English

Description

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

Categories

Object, PropertyAndParameter

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 are returned. Only errors occurring inside the command are 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 archiver property on the specified processor, and then resets the property:

common::set_property CONFIG.archiver armar [get_sw_processor]
common::reset_property CONFIG.archiver armar [get_sw_processor]