Write-Verbose
Writes text to the verbose message stream.
Syntax
Write-Verbose
[-Message] <String>
[<CommonParameters>]
Description
The Write-Verbose
cmdlet writes text to the verbose message stream in PowerShell. Typically, the
verbose message stream is used to deliver more in depth information about command processing.
By default, the verbose message stream is not displayed, but you can display it by changing the
value of the $VerbosePreference
variable or using the Verbose common parameter in any
command.
Examples
Example 1: Write a status message
Write-Verbose -Message "Searching the Application Event Log."
Write-Verbose -Message "Searching the Application Event Log." -Verbose
These commands use the Write-Verbose
cmdlet to display a status message. By default, the message
is not displayed.
The second command uses the Verbose common parameter, which displays any verbose messages,
regardless of the value of the $VerbosePreference
variable.
Example 2: Set $VerbosePreference and write a status message
$VerbosePreference = "Continue"
Write-Verbose "Copying file $filename"
These commands use the Write-Verbose
cmdlet to display a status message. By default, the message
is not displayed.
The first command assigns a value of Continue to the $VerbosePreference
preference variable. The
default value, SilentlyContinue
, suppresses verbose messages. The second command writes a verbose
message.
Parameters
-Message
Specifies the message to display. This parameter is required. You can also pipe a message string to
Write-Verbose
.
Type: | String |
Aliases: | Msg |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
You can pipe a string that contains the message to this cmdlet.
Outputs
None
This cmdlet returns no output. It only writes to the verbose message stream.
Notes
- Verbose messages are returned only when the command uses the Verbose common parameter. For more information, see about_CommonParameters.
- In Windows PowerShell background jobs and remote commands, the
$VerbosePreference
variable in the job session and remote session determine whether the verbose message is displayed by default. For more information about the$VerbosePreference
variable, see about_Preference_Variables.