Write-Verbose

  • リファレンス
モジュール:
Microsoft.PowerShell.Utility

テキストを詳細メッセージ ストリームに書き込みます。

構文

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

入力

String

メッセージを含む文字列をこのコマンドレットにパイプできます。

出力

None

このコマンドレットは、出力を返しません。 詳細メッセージ ストリームにのみ書き込まれます。

メモ

  • 詳細メッセージは、コマンドが Verbose 共通パラメーターを使用する場合にのみ返されます。 詳細については、「about_CommonParameters」を参照してください。
  • Windows PowerShell のバックグラウンド ジョブとリモート コマンドでは、 $VerbosePreference ジョブ セッションとリモート セッションの変数によって、詳細メッセージが既定で表示されるかどうかが決まります。 $VerbosePreference 変数の詳細については、「about_Preference_Variables」を参照してください。