common::reset_param - 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 a parameter.

Syntax

reset_param [-quiet] [-verbose] <name> 

Returns

Original value.

Usage

Name Description
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
<name> Parameter name

Categories

PropertyAndParameter

Description

Restores a user-definable configuration parameter that has been changed with the set_param command to its default value.

You can use the report_param command to see which parameters are currently defined.

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.

<name> - (required) The name of a parameter to reset. You can only reset one parameter at a time.

Examples

The following example restores the tcl.statsThreshold parameter to its default value:

common::reset_param tcl.statsThreshold