UTF8Encoding.GetChars Method (Byte[], Int32, Int32, Char[], Int32)
Decodes a sequence of bytes from the specified byte array into the specified character array.
Assembly: mscorlib (in mscorlib.dll)
public override int GetChars( byte[] bytes, int byteIndex, int byteCount, char[] chars, int charIndex )
Parameters
- bytes
- Type: System.Byte[]
The byte array containing the sequence of bytes to decode.
- byteIndex
- Type: System.Int32
The index of the first byte to decode.
- byteCount
- Type: System.Int32
The number of bytes to decode.
- chars
- Type: System.Char[]
The character array to contain the resulting set of characters.
- charIndex
- Type: System.Int32
The index at which to start writing the resulting set of characters.
| Exception | Condition |
|---|---|
| ArgumentNullException | bytes is null. -or- chars is null. |
| ArgumentOutOfRangeException | byteIndex or byteCount or charIndex is less than zero. -or- byteindex and byteCount do not denote a valid range in bytes. -or- charIndex is not a valid index in chars. |
| ArgumentException | Error detection is enabled, and bytes contains an invalid sequence of bytes. -or- chars does not have enough capacity from charIndex to the end of the array to accommodate the resulting characters. |
| DecoderFallbackException | A fallback occurred (see Character Encoding in the .NET Framework for complete explanation) -and- DecoderFallback is set to DecoderExceptionFallback. |
To calculate the exact array size required by GetChars to store the resulting characters, the application uses GetCharCount. To calculate the maximum array size, the application should use GetMaxCharCount. The GetCharCount method generally allows allocation of less memory, while the GetMaxCharCount method generally executes faster.
With error detection, an invalid sequence causes this method to throw a ArgumentException. Without error detection, invalid sequences are ignored, and no exception is thrown.
Data to be converted, such as data read from a stream, might be available only in sequential blocks. In this case, or if the amount of data is so large that it needs to be divided into smaller blocks, the application uses the Decoder or the Encoder provided by the GetDecoder method or the GetEncoder method, respectively.
The following example demonstrates how to use the GetChars method to decode a range of elements in a byte array and store the result in a character array.
using System; using System.Text; class UTF8EncodingExample { public static void Main() { Char[] chars; Byte[] bytes = new Byte[] { 85, 84, 70, 56, 32, 69, 110, 99, 111, 100, 105, 110, 103, 32, 69, 120, 97, 109, 112, 108, 101 }; UTF8Encoding utf8 = new UTF8Encoding(); int charCount = utf8.GetCharCount(bytes, 2, 13); chars = new Char[charCount]; int charsDecodedCount = utf8.GetChars(bytes, 2, 13, chars, 0); Console.WriteLine( "{0} characters used to decode bytes.", charsDecodedCount ); Console.Write("Decoded chars: "); foreach (Char c in chars) { Console.Write("[{0}]", c); } Console.WriteLine(); } }
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.