Write-Verbose
テキストを詳細メッセージ ストリームに書き込みます。
構文
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
をパイプすることもできます。
Type: | String |
Aliases: | Msg |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
入力
メッセージ Write-Verbose
を含む文字列をパイプできます。
出力
None
Write-Verbose
は、詳細メッセージ ストリームにのみ書き込みます。
メモ
- 詳細メッセージは、コマンドが Verbose 共通パラメーターを使用する場合のみ返されます。 詳細については、「about_CommonParameters」を参照してください。
- バックグラウンド ジョブとリモート コマンドWindows PowerShell、
$VerbosePreference
ジョブ セッションとリモート セッションの変数によって、詳細メッセージが既定で表示されるかどうかを判断します。 変数の詳細については$VerbosePreference
、「 about_Preference_Variables」を参照してください。