common::get_param
説明
パラメーター値を取得します。
構文
get_param [-quiet] [-verbose] <name> 戻り値
パラメーター値を指定します。
使用法
| 名前 | 説明 |
|---|---|
[-quiet] |
コマンド エラーを表示しません。 |
[-verbose] |
メッセージの非表示設定を解除し、すべてのメッセージを表示します。 |
<name> |
パラメーター名を指定します。 |
カテゴリ
PropertyAndParameter (プロパティおよびパラメーター)
説明
指定したツール パラメーターに現在定義されている値を取得します。これらのパラメーターは、ツールのさまざまな動作を制御するためのユーザー定義可能な環境設定です。各パラメーターが何を設定または制御するかは、common::report_param を参照してください。
引数
<name> (必須): 値を取得するパラメーターの名前を指定します。ユーザー定義可能なパラメーターのリストは、list_param を実行すると確認できます。このコマンドでは、パラメーターの完全な名前を指定する必要があります。パターン一致は実行されず、1 つのパラメーターのみ指定可能です。
-quiet (オプション): コマンドをメッセージを表示せずに実行します。実行中にエラーが発生しても、TCL_OK が返されます。 注記: コマンドを実行したときにコマンド ラインで発生したエラーは返されます。コマンド内で発生したエラーのみが非表示になります。
-verbose (オプション): メッセージの非表示設定を一時的に解除し、コマンドからのすべてのメッセージを返します。注記: メッセージの非表示設定は、
set_msg_config コマンドで定義できます。例
説明をイネーブルにするメッセージ パラメーターの現在の値を取得します。
common::get_param messaging.enableDescription