common::report

説明

すべてのパラメーターに関する情報を取得します。

report_param [-file <arg>] [-append] [-non_default] [-return_string] [-quiet] [-verbose] [<pattern>]

パラメーターレポート。


名前	説明
[`-file`]	結果を保存するファイルの名前を指定します。このオプションを使用しない場合、出力はコンソールに表示されます。
[`-append`]	結果をファイルの最後に追加します。上書きはしません。
[`-non_default`]	デフォルト以外の値に設定されているパラメーターのみをレポートします。
[`-return_string`]	レポートを文字列として返します。
[`-quiet`]	コマンドエラーを表示しません。
[`-verbose`]	メッセージの非表示設定を解除し、すべてのメッセージを表示します。
[<pattern>]	検索パターンに一致するパラメーターを取得します。デフォルトは * です。

PropertyAndParameter (プロパティおよびパラメーター)、Report (レポート)

ユーザーが定義可能なパラメーターのリスト、現在の値、パラメーターの設定または制御内容を取得します。

-file <arg> (オプション): レポートを保存するファイルを指定します。-append オプションが指定されていない場合、指定したファイルが既に存在する場合は上書きされます。

注記: パスをファイル名の一部として指定しない場合は、現在の作業ディレクトリまたはツールを起動したディレクトリにファイルが作成されます。

-append (オプション): コマンドの出力を指定したファイルに上書きするのではなく追加します。

注記: -append オプションは、-file オプションを使用している場合にのみ使用可能です。

-return_string (オプション): 出力を Tcl 文字列として返します。Tcl 文字列は、変数定義でキャプチャしたり、解析またはその他の処理が可能です。

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

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

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

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

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

<pattern> (オプション): パラメーターを検索するパターンを指定します。デフォルトの検索パターンはワイルドカード (*) で、すべてのユーザー定義可能なパラメーターが取得されます。

次の例では、すべてのユーザー定義可能なパラメーターの名前、値、説明が返されます。

common::report_param

次の例では、指定した検索パターンに一致するユーザー定義可能なパラメーターの名前、値、および説明が返されます。

common::report_param *coll*