< Back
Write-Verbose
Post
NAME Write-Verbose
SYNOPSIS
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 Windows PowerShell. Typically, the verbose message stream is used to deliver
information about command processing that is used for debugging a command.
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.
PARAMETERS
-Message <String>
Specifies the message to display. This parameter is required. You can also pipe a message string to Write-Verbose .
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
You can pipe a string that contains the message to Write-Verbose .
OUTPUTS
None
Write-Verbose writes only 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
(http://go.microsoft.com/fwlink/?LinkID=113216). 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 (http://go.microsoft.com/fwlink/?LinkID=113248).
Example 1: Write a status message
PS C:\\>Write-Verbose -Message "Searching the Application Event Log."
PS C:\\>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
PS C:\\>$VerbosePreference = "Continue"
PS C:\\>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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=821880
Write-Debug
Write-Error
Write-Host
Write-Information
Write-Output
Write-Progress
Write-Warning
SYNOPSIS
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 Windows PowerShell. Typically, the verbose message stream is used to deliver
information about command processing that is used for debugging a command.
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.
PARAMETERS
-Message <String>
Specifies the message to display. This parameter is required. You can also pipe a message string to Write-Verbose .
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
You can pipe a string that contains the message to Write-Verbose .
OUTPUTS
None
Write-Verbose writes only 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
(http://go.microsoft.com/fwlink/?LinkID=113216). 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 (http://go.microsoft.com/fwlink/?LinkID=113248).
Example 1: Write a status message
PS C:\\>Write-Verbose -Message "Searching the Application Event Log."
PS C:\\>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
PS C:\\>$VerbosePreference = "Continue"
PS C:\\>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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=821880
Write-Debug
Write-Error
Write-Host
Write-Information
Write-Output
Write-Progress
Write-Warning