common::list_property

説明

オブジェクトのプロパティをリストします。

構文

list_property [-class <arg>] [-regexp] [-quiet] [-verbose] [<object>] [<pattern>]

戻り値

プロパティ名のリスト。

使用法


名前	説明
[`-class`]	プロパティを取得するオブジェクトタイプを指定します。オブジェクトを指定した場合は無視されます。
[`-regexp`]	検索パターンを正規表現として処理します。
[`-quiet`]	コマンドエラーを表示しません。
[`-verbose`]	メッセージの非表示設定を解除し、すべてのメッセージを表示します。
[<object>]	プロパティを取得するオブジェクトを指定します。
[<pattern>]	プロパティを検索するパターンを指定します。デフォルトは * です。

カテゴリ

Object (オブジェクト)、PropertyAndParameter (プロパティおよびパラメーター)

説明

指定したオブジェクトまたはクラスのプロパティすべてのリストを取得します。

注記: report_property コマンドでもオブジェクトまたはオブジェクトのクラスのプロパティリストが返されますが、プロパティのタイプと値も含まれます。

引数

-class <arg> (オプション): 指定したオブジェクトのクラスのプロパティを返します。大文字/小文字が区別されます。ほとんどのクラス名は小文字で記述されます。

注記: -class オプションを <object> と共に使用することはできません。

-regexp (オプション): 検索パターンが正規表現で記述されていることを指定します。

-quiet (オプション): コマンドをメッセージを表示せずに実行します。実行中にエラーが発生しても、TCL_OK が返されます。

注記: コマンドを実行したときにコマンドラインで発生したエラーは返されます。コマンド内で発生したエラーのみが非表示になります。

-verbose (オプション): メッセージの非表示設定を一時的に解除し、コマンドからのすべてのメッセージを返します。

注記: メッセージの非表示設定は、set_msg_config コマンドで定義できます。

注記: 複数のオブジェクトを指定すると、エラーメッセージが表示されます。

<pattern> (オプション): 指定した <object> のプロパティまたは -class オプションで指定したオブジェクトクラスのプロパティを検索するパターンを指定します。プロパティ名が指定の検索パターンに一致するプロパティのみが返されます。デフォルトの検索パターンはワイルドカード (*) で、指定したオブジェクトのプロパティすべてのリストが取得されます。

注記: 大文字/小文字が区別されます。ほとんどのプロパティ名は大文字で記述されます。

例

次の例では、指定したセルオブジェクトのプロパティすべてが返されます。

common::list_property [get_cells microblaze_0]