Cmdlet.WriteVerbose Method

Writes a general user-level message to the pipeline. These messages can help describe what the cmdlet is doing.


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

'Usage
Dim instance As Cmdlet
Dim text As String

instance.WriteVerbose(text)

public void WriteVerbose (
	string text
)
public void WriteVerbose (
	String text
)
public function WriteVerbose (
	text : String
)

Parameters

text

The message to be sent to the host.

Exception typeCondition
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.

This method is used to send general user-level information that is not related to specific error conditions. For example, these messages could inform the user what the cmdlet is doing while it is performing a task. In addition, this method can be used to send information that must be localized.

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

For more information about cmdlets, see Windows PowerShell Cmdlets.


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

 

Target Platforms

Windows Developer Preview, Windows Server Developer Preview

Send comments about this topic to Microsoft.
Show:
© 2014 Microsoft