Write-Verbose
詳細メッセージ ストリームにテキストを書き込みます。
構文
Default (既定)
Write-Verbose
[-Message] <String>
[<CommonParameters>]
説明
Write-Verbose コマンドレットは、PowerShell で詳細メッセージ ストリームにテキストを書き込みます。 通常、詳細メッセージ ストリームは、コマンド処理に関するより詳細な情報を提供するために使用されます。
既定では、詳細メッセージ ストリームは表示されませんが、 $VerbosePreference 変数の値を変更するか、コマンドで Verbose 共通パラメーターを使用して表示できます。
例
例 1: ステータス メッセージを書き込む
Write-Verbose -Message "Searching the Application Event Log."
Write-Verbose -Message "Searching the Application Event Log." -Verbose
これらのコマンドは、 Write-Verbose コマンドレットを使用してステータス メッセージを表示します。 既定では、メッセージは表示されません。
2 番目のコマンドでは、 verbose 共通パラメーターを使用します。これは、 $VerbosePreference 変数の値に関係なく、詳細メッセージを表示します。
例 2: $VerbosePreferenceを設定し、ステータス メッセージを書き込む
$VerbosePreference = "Continue"
Write-Verbose "Copying file $filename"
これらのコマンドは、 Write-Verbose コマンドレットを使用してステータス メッセージを表示します。 既定では、メッセージは表示されません。
最初のコマンドは、Continue の値を $VerbosePreference ユーザー設定変数に割り当てます。 既定値の SilentlyContinueは、詳細メッセージを抑制します。 2 番目のコマンドは、詳細メッセージを書き込みます。
パラメーター
-Message
表示するメッセージを指定します。 このパラメーターは必須です。 メッセージ文字列をパイプして Write-Verboseすることもできます。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| エイリアス: | メッセージ |
パラメーター セット
(All)
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、about_CommonParametersを参照してください。
入力
String
メッセージを含む文字列をこのコマンドレットにパイプできます。
出力
None
このコマンドレットは出力を返しません。 詳細メッセージ ストリームにのみ書き込まれます。
メモ
- 詳細メッセージは、コマンドが Verbose 共通パラメーターを使用する場合にのみ返されます。 詳細については、about_CommonParametersを参照してください。
- powerShell バックグラウンド ジョブとリモート コマンドWindows、ジョブ セッションとリモート セッションの
$VerbosePreference変数によって、詳細メッセージが既定で表示されるかどうかが決まります。$VerbosePreference変数の詳細については、about_Preference_Variablesを参照してください。