This is the built-in help made by Microsoft for the command 'Write-Warning', in PowerShell version 2 - as retrieved from
Windows version 'Microsoft® Windows Vista™ Ultimate ' PowerShell help files on 2016-06-23.
For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.
Writes a warning message.
Write-Warning [-Message] <string> [<CommonParameters>]
The Write-Warning cmdlet writes a warning message to the Windows PowerShell host. The response to the warning depends on the value of the user's
$WarningPreference variable and the use of the WarningAction common parameter.
<
Online version: http://go.microsoft.com/fwlink/?LinkID=113430
about_Preference_Variables
about_CommonParameters
Write-Debug
Write-Error
Write-Host
Write-Output
Write-Progress
Write-Verbose
<
-------------------------- EXAMPLE 1 --------------------------
C:\PS>write-warning "This is only a test warning."
Description
-----------
This command displays the message "WARNING: This is only a test warning."
-------------------------- EXAMPLE 2 --------------------------
C:\PS>$w = "This is only a test warning."
C:\PS> $w | write-warning
Description
-----------
This example shows that you can use a pipeline operator (|) to send a string to Write-Warning. You can save the string in a variable, as shown in
this command, or pipe the string directly to Write-Warning.
-------------------------- EXAMPLE 3 --------------------------
C:\PS>$warningpreference
Continue
C:\PS> write-warning "This is only a test warning."
This is only a test warning.
C:\PS> $warningpreference = "SilentlyContinue"
C:\PS> write-warning "This is only a test warning."
C:\PS>
C:\PS> $warningpreference = "Stop"
C:\PS> write-warning "This is only a test warning."
WARNING: This is only a test message.
Write-Warning : Command execution stopped because the shell variable "WarningPreference" is set to Stop.
At line:1 char:14
+ write-warning <<<< "This is only a test message."
Description
-----------
This example shows the effect of the value of the $WarningPreference variable on a Write-Warning command.
The first command displays the default value of the $WarningPreference variable, which is "Continue". As a result, when you write a warning, the
warning message is displayed and execution continues.
When you change the value of the $WarningPreference variable, the effect of the Write-Warning command changes again. A value of "SilentlyContinue
" suppresses the warning. A value of "Stop" displays the warning and then stops execution of the command.
For more information about the $WarningPreference variable, see about_Preference_Variables.
-------------------------- EXAMPLE 4 --------------------------
C:\PS>write-warning "This is only a test warning." -warningaction Inquire
WARNING: This is only a test warning.
Confirm
Continue with this operation?
[Y] Yes [A] Yes to All [H] Halt Command [S] Suspend [?] Help (default is "Y"):
Description
-----------
This example shows the effect of the WarningAction common parameter on a Write-Warning command. You can use the WarningAction common parameter wi
th any cmdlet to determine how Windows PowerShell responds to warnings resulting from that command. The WarningAction common parameter overrides
the value of the $WarningPreference only for that particular command.
This command uses the Write-Warning cmdlet to display a warning. The WarningAction common parameter with a value of "Inquire" directs the system
to prompt the user when the command displays a warning.
For more information about the WarningAction common parameter, see about_CommonParameters.