common::get_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

Get a parameter value.

Syntax

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

Returns

Parameter value.

Usage

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

Categories

PropertyAndParameter

Description

Gets the currently defined value for a specified tool parameter. These parameters are user-definable configuration settings that control various behaviors within the tool. Refer to common::report_param for a description of what each parameter configures or controls.

Arguments

name - (required) The name of the parameter to get the value of. The list of user-definable parameters can be obtained with list_param. This command requires the full name of the desired parameter. It does not perform any pattern matching, and accepts only one parameter at a time.

-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.

Examples

Get the current value of the messaging parameter used for enabling the description:

common::get_param messaging.enableDescription