StandardStreamExtensionsGetWriter Method

Gets the TextWriter for either StandardStreamOutput or StandardStreamError.

Definition

Namespace: Ookii.CommandLine.Terminal
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.2.0+a4d3631e4dcc0970081ed435288efdebc1325f83

C#

public static TextWriter GetWriter(
	this StandardStream stream
)

VB

<ExtensionAttribute>
Public Shared Function GetWriter ( 
	stream As StandardStream
) As TextWriter

Dim stream As StandardStream
Dim returnValue As TextWriter

returnValue = stream.GetWriter()

C++

public:
[ExtensionAttribute]
static TextWriter^ GetWriter(
	StandardStream stream
)

Parameters

stream StandardStream: A StandardStream value.

Return Value

TextWriter
The value of either ConsoleOut or ConsoleError.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type StandardStream. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

The returned TextWriter instance should not be disposed by the caller.

Exceptions

ArgumentException

stream was a value other than StandardStreamOutput or StandardStreamError.