System.Text.UTF8Encoding.GetEncoder Method

Obtains an encoder that converts a sequence of Unicode characters into a UTF-8 encoded sequence of bytes.

Syntax

public override Encoder GetEncoder ()

Returns

A System.Text.Encoder that converts a sequence of Unicode characters into a UTF-8 encoded sequence of bytes.

Remarks

The Encoder.GetBytes(Char[], int, int, Byte[], int, bool) method converts sequential blocks of characters into sequential blocks of bytes, in a manner similar to the UTF8Encoding.GetBytes(string, int, int, Byte[], int) method. However, a System.Text.Encoder maintains state information between calls so it can correctly encode character sequences that span blocks. The System.Text.Encoder also preserves trailing characters at the end of data blocks and uses the trailing characters in the next encoding operation. For example, a data block might end with an unmatched high surrogate, and the matching low surrogate might be in the next data block. Therefore, UTF8Encoding.GetDecoder and UTF8Encoding.GetEncoder are useful for network transmission and file operations, because those operations often deal with blocks of data instead of a complete data stream.

If error detection is enabled, that is, the throwOnInvalidCharacters parameter of the constructor is set to true, error detection is also enabled in the System.Text.Encoder returned by this method. If error detection is enabled and an invalid sequence is encountered, the state of the encoder is undefined and processing must stop.

Requirements

Namespace: System.Text
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0