| external help file | Locale | Module Name | ms.date | online version | schema | title |
|---|---|---|---|---|---|---|
Microsoft.PowerShell.Commands.Utility.dll-Help.xml |
en-US |
Microsoft.PowerShell.Utility |
12/12/2022 |
2.0.0 |
Write-Verbose |
Writes text to the verbose message stream.
Write-Verbose [-Message] <String> [<CommonParameters>]
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.
Write-Verbose -Message "Searching the Application Event Log."
Write-Verbose -Message "Searching the Application Event Log." -VerboseThese 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.
$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.
Specifies the message to display. This parameter is required. You can also pipe a message string to
Write-Verbose.
Type: System.String
Parameter Sets: (All)
Aliases: Msg
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You can pipe a string that contains the message to this cmdlet.
This cmdlet returns no output. It only writes to the verbose message stream.
- 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
$VerbosePreferencevariable in the job session and remote session determine whether the verbose message is displayed by default. For more information about the$VerbosePreferencevariable, see about_Preference_Variables.