• Article

Encoding.GetEncoder Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

When overridden in a derived class, obtains an encoder that converts a sequence of Unicode characters into an encoded sequence of bytes.

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

Syntax

'Declaration
Public Overridable Function GetEncoder As Encoder

public virtual Encoder GetEncoder()

Return Value

Type: System.Text.Encoder
A Encoder that converts a sequence of Unicode characters into an encoded sequence of bytes.

Remarks

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 maintains state information between calls so it correctly encodes character sequences that span blocks. The 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, 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.

Notes to Implementers

The default implementation returns a Encoder that calls the GetByteCount and GetBytes methods of the current Encoding. Your application must override this method to return a Encoder that maintains its state between calls.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.