common::get_property - 2023.2 简体中文

Vitis 统一软件平台文档 嵌入式软件开发 (UG1400)

Document ID
UG1400
Release Date
2023-12-13
Version
2023.2 简体中文

描述

获取对象的属性。

语法

get_property [-min] [-max] [-quiet] [-verbose] <name> <object> 

返回

属性值。

用法

名称 描述
[-min] 仅返回最小值
[-max] 仅返回最大值
[-quiet] 忽略命令错误
[-verbose] 命令执行期间暂挂消息限制
<name> 属性名称,将检索该属性的值
<object> 要查询其属性的对象

类别

Object 和 PropertyAndParameter

描述

从一个或多个指定对象获取指定属性的当前值。如果指定了多个对象,则返回值的列表。

如果当前未向对象分配属性或者如果已分配的属性不含值,那么 get_property 命令不返回任何结果或者返回空字符串。如果查询多个对象,则在返回的值列表中添加空字符串。

该命令会返回一个值或者返回值的列表,如果命令失败,则返回错误。

实参

-min:(可选)指定多个对象时,该选项会检验指定属性的值,并返回对象列表中的最小值。数字属性按值排序。所有其他属性则都按字符串排序。

-max:(可选)指定多个对象时,该选项会检验指定属性的值,并返回对象列表中的最大值。数字属性按值排序。所有其他属性则都按字符串排序。

-quiet -(可选)以静默方式执行命令,不返回来自该命令的任何消息。此命令还会返回 TCL_OK,忽略执行期间遇到的所有错误。
注释: 启动该命令时,会返回命令行上遇到的任何错误。仅捕获该命令内部发生的错误。
-verbose -(可选)暂时改写任何消息限制,并返回来自该命令的所有消息。
注释: 可使用 set_msg_config 命令定义消息限制。

name:(必需)要返回的属性的名称。此名称不区分大小写。

object:(必需)要为指定属性检验的一个或多个对象。

示例

从指定单元获取 NAME 属性:

common::get_property NAME [lindex [get_cells] 0]

从当前硬件设计获取 BOARD 属性:

common::get_property BOARD [current_hw_design]