Console.InputEncoding Property

Reference

Definition

Namespace:: System

Assembly:: System.Console.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Source:: Console.cs

Source:: Console.cs

Source:: Console.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the encoding the console uses to read input.

public:
 static property System::Text::Encoding ^ InputEncoding { System::Text::Encoding ^ get(); void set(System::Text::Encoding ^ value); };

[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public static System.Text.Encoding InputEncoding { get; set; }

[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
[System.Runtime.Versioning.UnsupportedOSPlatform("android")]
[System.Runtime.Versioning.UnsupportedOSPlatform("ios")]
[System.Runtime.Versioning.UnsupportedOSPlatform("tvos")]
public static System.Text.Encoding InputEncoding { get; set; }

public static System.Text.Encoding InputEncoding { get; set; }

[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
static member InputEncoding : System.Text.Encoding with get, set

[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
[<System.Runtime.Versioning.UnsupportedOSPlatform("android")>]
[<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>]
[<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>]
static member InputEncoding : System.Text.Encoding with get, set

static member InputEncoding : System.Text.Encoding with get, set

Public Shared Property InputEncoding As Encoding

Property Value

Encoding

The encoding used to read console input.

Attributes: UnsupportedOSPlatformAttribute

Exceptions

ArgumentNullException

The property value in a set operation is null.

IOException

An error occurred during the execution of this operation.

SecurityException

Your application does not have permission to perform this operation.

Remarks

The console uses the input encoding to translate keyboard input into a corresponding character. The input encoding incorporates a code page that maps 256 keyboard character codes to individual characters. Different code pages include different special characters, typically customized for a language or a group of languages.

Starting with the .NET Framework 4, a property get operation may return a cached value instead of the console's current input encoding. This can occur if the value of the InputEncoding property is modified by some means other than an assignment to the InputEncoding property, such as calling the Windows SetConsoleCP function or using the chcp command from a PowerShell script.

Applies to

Jaa