Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Cmdlet.WriteWarning Method (String)

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Writes a warning message that can be displayed.

Namespace:   System.Management.Automation
Assembly:  System.Management.Automation (in System.Management.Automation.dll)

public void WriteWarning(
	string text
)

Parameters

text
Type: System.String

The warning message to be displayed.

Exception Condition
PipelineStoppedException

The pipeline is stopped. The pipeline was terminated either before the call was made or while the call was in progress. By default, the cmdlet should allow the caller of the processing record method to catch this exception.

InvalidOperationException

The call cannot be completed at this time or cannot be completed from this thread. For more information, see the following Remarks section.

Use the WriteWarning method to display warnings about the activity of your cmdlet. By default, warning output is discarded, although this can be configured with the WarningPreference shell variable or with the -Verbose and -Debug command-line options.

This method can be called only from within the cmdlet implementation of the BeginProcessing, ProcessRecord, and EndProcessing methods and only from that thread. If the call is made outside one of these implementations or from another thread, an InvalidOperationException exception is thrown.

Cmdlets that are in invoked from within a cmdlet (the invoked cmdlet must derive directly from the Cmdlet class) can implement the ICommandRuntime interface which can be used to override the default behavior of this method.

Return to top

Community Additions

Show: