Write-Verbose
テキストを詳細メッセージ ストリームに書き込みます。
構文
Write-Verbose
[-Message] <String>
[<CommonParameters>]説明
Write-Verbose コマンドレットは、Windows PowerShell の詳細メッセージ ストリームにテキストを書き込みます。 通常、詳細メッセージ・ストリームは、コマンドのデバッグに使用されるコマンド処理に関する情報を配信するために使用されます。
デフォルトでは、詳細メッセージ・ストリームは表示されませんが、 $VerbosePreference 変数の値を変更するか、任意のコマンドで Verbose 共通パラメーターを使用して表示できます。
例
例 1: ステータス メッセージを書き込む
PS C:\> Write-Verbose -Message "Searching the Application Event Log."
PS C:\> Write-Verbose -Message "Searching the Application Event Log." -Verboseこれらのコマンドでは、 Write-Verbose コマンドレットを使用してステータス メッセージを表示します。 既定では、メッセージは表示されません。
2 番目のコマンドは、$VerbosePreference 変数の値に関係なく、任意の詳細メッセージを表示する Verbose 共通パラメーターを使用します。
例 2: $VerbosePreferenceを設定し、ステータス メッセージを書き込む
PS C:\> $VerbosePreference = "Continue"
PS C:\> Write-Verbose "Copying file $filename"これらのコマンドでは、 Write-Verbose コマンドレットを使用してステータス メッセージを表示します。 既定では、メッセージは表示されません。
最初のコマンドは、$VerbosePreference 設定変数に Continue の値を割り当てます。 デフォルト値の SilentlyContinue は、詳細メッセージを抑制します。 2 番目のコマンドは、詳細なメッセージを出力します。
パラメーター
-Message
表示するメッセージを指定します。 このパラメーターは必須です。 メッセージ文字列を Write-Verbose にパイプすることもできます。
| 型: | String |
| Aliases: | Msg |
| 配置: | 0 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
入力
メッセージを含む文字列を Write-Verbose にパイプ処理できます。
出力
None
Write-Verbose は、詳細メッセージストリームにのみ書き込みます。
メモ
- 詳細メッセージは、コマンドに Verbose 共通パラメーターを使用した場合にのみ返されます。 詳細については、about_CommonParametersを参照してください。
- Windows PowerShell のバックグラウンド ジョブとリモート コマンドでは、ジョブ セッションとリモート セッションの $VerbosePreference 変数によって、詳細メッセージが既定で表示されるかどうかが決まります。 $VerbosePreference変数の詳細については、about_Preference_Variablesを参照してください。