VirtualTerminalEnableColor Method

Enables color support using virtual terminal sequences for the console attached to the specified stream.

Definition

Namespace: Ookii.CommandLine.Terminal
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.1.0+9df03b6173b5fc9d44dc39638758964dd7a0f4c7

C#

public static VirtualTerminalSupport EnableColor(
	StandardStream stream
)

VB

Public Shared Function EnableColor ( 
	stream As StandardStream
) As VirtualTerminalSupport

Dim stream As StandardStream

Dim returnValue As VirtualTerminalSupport

returnValue = VirtualTerminal.EnableColor(stream)

C++

public:
static VirtualTerminalSupport^ EnableColor(
	StandardStream stream
)

Parameters

stream StandardStream: The StandardStream to enable color sequences for.

Return Value

VirtualTerminalSupport
An instance of the VirtualTerminalSupport class that will disable virtual terminal support when disposed or destructed. Use the VirtualTerminalSupportIsSupported property to check if virtual terminal sequences are supported.

Remarks

If an environment variable named "NO_COLOR" exists, this function will not enable VT sequences. Otherwise, this function calls the EnableVirtualTerminalSequences(StandardStream) method and returns its result.

VirtualTerminalEnableColor Method

Definition

Parameters

Return Value

Remarks

See Also

Reference