Decoder Class
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Converts a sequence of encoded bytes into a set of characters.
Assembly: mscorlib (in mscorlib.dll)
The Decoder type exposes the following members.
| Name | Description | |
|---|---|---|
 | Convert(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. |
| Convert(array<Byte>, Int32, Int32, array<Char>, Int32, Int32, Boolean, Int32%, Int32%, Boolean%) | Converts an array of encoded bytes to Unicode characters and stores the result in a byte array. |
| Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetCharCount(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. |
| GetCharCount(array<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. |
| GetCharCount(array<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. |
| GetChars(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. |
| GetChars(array<Byte>, Int32, Int32, array<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. |
| GetChars(array<Byte>, Int32, Int32, array<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. |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Reset | When overridden in a derived class, sets the decoder back to its initial state. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
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.
 Note: |
|---|
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. |
Derived classes must override all the members of the Decoder class.