Decoder Class

July 28, 2014

Converts a sequence of encoded bytes into a set of characters.

System.Object
  System.Text.Decoder

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

public abstract class Decoder

The Decoder type exposes the following members.

  NameDescription
Protected methodDecoderInitializes a new instance of the Decoder class.
Top

  NameDescription
Public methodConvert(Byte*, Int32, Char*, Int32, Boolean, Int32, Int32, Boolean)Security Critical. Converts a buffer of encoded bytes to UTF-16 encoded characters and stores the result in another buffer.
Public methodConvert(Byte[], Int32, Int32, Char[], Int32, Int32, Boolean, Int32, Int32, Boolean)Converts an array of encoded bytes to Unicode characters and stores the result in a byte array.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetCharCount(Byte*, Int32, Boolean)Security Critical. When overridden in a derived class, calculates the number of characters produced by decoding a sequence of bytes starting at the specified byte pointer. A parameter indicates whether to clear the internal state of the decoder after the calculation.
Public methodGetCharCount(Byte[], Int32, Int32)When overridden in a derived class, calculates the number of characters produced by decoding a sequence of bytes from the specified byte array.
Public methodGetCharCount(Byte[], Int32, Int32, Boolean)When overridden in a derived class, calculates the number of characters produced by decoding a sequence of bytes from the specified byte array. A parameter indicates whether to clear the internal state of the decoder after the calculation.
Public methodGetChars(Byte*, Int32, Char*, Int32, Boolean)Security Critical. When overridden in a derived class, decodes a sequence of bytes starting at the specified byte pointer and any bytes in the internal buffer into a set of characters that are stored starting at the specified character pointer. A parameter indicates whether to clear the internal state of the decoder after the conversion.
Public methodGetChars(Byte[], Int32, Int32, Char[], Int32)When overridden in a derived class, decodes a sequence of bytes from the specified byte array and any bytes in the internal buffer into the specified character array.
Public methodGetChars(Byte[], Int32, Int32, Char[], Int32, Boolean)When overridden in a derived class, decodes a sequence of bytes from the specified byte array and any bytes in the internal buffer into the specified character array. A parameter indicates whether to clear the internal state of the decoder after the conversion.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodResetWhen overridden in a derived class, sets the decoder back to its initial state.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

To obtain an instance of an implementation of the Decoder class, call the GetDecoder method of an Encoding implementation. There are two such implementations available in the .NET Framework for Windows Phone: UTF8Encoding and UnicodeEncoding. The UnicodeEncoding implementation supports both big-endian and little-endian Unicode.

The GetCharCount method determines how many characters result in decoding a sequence of bytes, and the GetChars method performs the actual decoding. The Decoder class includes several overloads of both methods.

A Decoder object maintains state information between successive calls to the GetChars or Convert methods so it can correctly decode byte sequences that span blocks. A Decoder object also preserves trailing bytes at the end of data blocks and uses the trailing bytes in the next decoding operation.

NoteNote:

When the application is done with a stream of data, it should make sure that the state information is flushed by setting the flush parameter to true in the appropriate method call. If an exception occurs or if the application switches streams, it should call Reset to clear the internal state of the Decoder object.

Notes to Inheritors

Derived classes must override all the members of the Decoder class.

The following example demonstrates the use of a Decoder to convert two different byte arrays into a character array. One of the character's bytes spans the arrays.


using System;
using System.Text;
public class Example
{
   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      // These bytes in UTF-8 correspond to 3 different Unicode
      // characters: space (U+0020), # (U+0023), and the biohazard
      // symbol (U+2623).  Note the biohazard symbol requires 3 bytes
      // in UTF-8 (hexadecimal e2, 98, a3).  Decoders store state across
      // multiple calls to GetChars, handling the case when one char
      // is in multiple byte arrays.
      byte[] bytes1 = { 0x20, 0x23, 0xe2 };
      byte[] bytes2 = { 0x98, 0xa3 };

      Decoder d = Encoding.UTF8.GetDecoder();

      int arraySize = d.GetCharCount(bytes1, 0, bytes1.Length);
      arraySize += d.GetCharCount(bytes2, 0, bytes2.Length);  

      char[] chars = new char[arraySize];

      int charLen = d.GetChars(bytes1, 0, bytes1.Length, chars, 0);
      // Use charLen to determine where new characters are written.
      charLen += d.GetChars(bytes2, 0, bytes2.Length, chars, charLen);

      string output = new string(chars, 0, charLen);
      outputBlock.Text += String.Format("'{0}'\n", output);
   }
}


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Show:
© 2014 Microsoft