UnicodeEncoding.GetEncoder Method ()


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

Namespace:   System.Text
Assembly:  mscorlib (in mscorlib.dll)

override GetEncoder : unit -> Encoder

Return Value

Type: System.Text.Encoder

A Encoder object that converts a sequence of Unicode characters into a UTF-16 encoded sequence of bytes.

The Encoder.GetBytes method converts sequential blocks of characters into sequential blocks of bytes in a manner similar to the GetBytes method of this class. However, a Encoder object maintains state information between calls so that it can correctly encode character sequences that span blocks. The Encoder object 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, GetDecoder and 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 throwOnInvalidBytes parameter of the constructor is set to true, error detection is also enabled in the Encoder object 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.

The following example uses an encoder and a decoder to encode a string into an array of bytes, and then decode the bytes into an array of characters.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 8
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top