Encoding.GetEncoder Encoding.GetEncoder Encoding.GetEncoder Encoding.GetEncoder Method

Definition

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

public:
 virtual System::Text::Encoder ^ GetEncoder();
public virtual System.Text.Encoder GetEncoder ();
abstract member GetEncoder : unit -> System.Text.Encoder
override this.GetEncoder : unit -> System.Text.Encoder
Public Overridable Function GetEncoder () As Encoder

Returns

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 Inheritors

The default implementation returns a Encoder that calls the GetByteCount(Char[]) and GetBytes(Char[]) methods of the current Encoding. You must override this method to return a Encoder that maintains its state between calls.

Applies to

See also