Edit

Encoder.Reset Method

  • Reference

Definition

Namespace:
System.Text
Assembly:
System.Text.Encoding.dll
Assembly:
System.Runtime.dll
Assembly:
mscorlib.dll
Assembly:
netstandard.dll
Source:
Encoder.cs
Source:
Encoder.cs
Source:
Encoder.cs

When overridden in a derived class, sets the encoder back to its initial state.

public:
 virtual void Reset();
public virtual void Reset ();
[System.Runtime.InteropServices.ComVisible(false)]
public virtual void Reset ();
abstract member Reset : unit -> unit
override this.Reset : unit -> unit
[<System.Runtime.InteropServices.ComVisible(false)>]
abstract member Reset : unit -> unit
override this.Reset : unit -> unit
Public Overridable Sub Reset ()
Attributes
ComVisibleAttribute

Remarks

This method clears the internal state of the Encoder object. The method clears any state information preserved from a previous call to GetBytes or Convert, including trailing characters at the end of the previous data block, such as an unmatched high surrogate.

Your application should call the Reset method if it wants to reuse the same encoder even after an exception is thrown by GetBytes or GetByteCount, or if the application switches streams.

Applies to