GetChars Method (Byte[], Int32, Int32, Char[], Int32)

Encoding.GetChars Method (Byte[], Int32, Int32, Char[], Int32)


When overridden in a derived class, decodes a sequence of bytes from the specified byte array into the specified character array.

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

abstract GetChars : 
        bytes:byte[] *
        byteIndex:int *
        byteCount:int *
        chars:char[] *
        charIndex:int -> int


Type: System.Byte[]

The byte array containing the sequence of bytes to decode.

Type: System.Int32

The index of the first byte to decode.

Type: System.Int32

The number of bytes to decode.

Type: System.Char[]

The character array to contain the resulting set of characters.

Type: System.Int32

The index at which to start writing the resulting set of characters.

Return Value

Type: System.Int32

The actual number of characters written into chars.

Exception Condition

bytes is null.


chars is null.


byteIndex or byteCount or charIndex is less than zero.


byteindex and byteCount do not denote a valid range in bytes.


charIndex is not a valid index in chars.


chars does not have enough capacity from charIndex to the end of the array to accommodate the resulting characters.


A fallback occurred (see Character Encoding in the .NET Framework for complete explanation)


DecoderFallback is set to DecoderExceptionFallback.

To calculate the exact array size required by GetChars to store the resulting characters, you should use the GetCharCount method. To calculate the maximum array size, use the GetMaxCharCount method. The GetCharCount method generally allows allocation of less memory, while the GetMaxCharCount method generally executes faster.

Encoding.GetChars gets characters from an input byte sequence. Encoding.GetChars is different than Decoder.GetChars because Encoding expects discrete conversions, while Decoder is designed for multiple passes on a single input stream.

If the data to be converted is available only in sequential blocks (such as data read from a stream) or if the amount of data is so large that it needs to be divided into smaller blocks, you should use the Decoder or the Encoder provided by the GetDecoder method or the GetEncoder method, respectively, of a derived class.

Note    This method is intended to operate on Unicode characters, not on arbitrary binary data, such as byte arrays. If you need to encode arbitrary binary data into text, you should use a protocol such as uuencode, which is implemented by methods such as Convert.ToBase64CharArray.

The GetCharCount method determines how many characters result in decoding a sequence of bytes, and the GetChars method performs the actual decoding. The Encoding.GetChars method expects discrete conversions, in contrast to the Decoder.GetChars method, which handles multiple passes on a single input stream.

Several versions of GetCharCount and GetChars are supported. The following are some programming considerations for use of these methods:

  • Your app might need to decode multiple input bytes from a code page and process the bytes using multiple calls. In this case, you probably need to maintain state between calls, because byte sequences can be interrupted when processed in batches. (For example, part of an ISO-2022 shift sequence may end one GetChars call and continue at the beginning of the next GetChars call. Encoding.GetChars will call the fallback for those incomplete sequences, but Decoder will remember those sequences for the next call.)

  • If your app handles string outputs, the GetString method is recommended. Since this method must check string length and allocate a buffer, it is slightly slower, but the resulting String type is to be preferred.

  • The byte version of GetChars(Byte*, Int32, Char*, Int32) allows some fast techniques, particularly with multiple calls to large buffers. Bear in mind, however, that this method version is sometimes unsafe, since pointers are required.

  • If your app must convert a large amount of data, it should reuse the output buffer. In this case, the GetChars(Byte[], Int32, Int32, Char[], Int32) version that supports output character buffers is the best choice.

  • Consider using the Decoder.Convert method instead of GetCharCount. The conversion method converts as much data as possible and throws an exception if the output buffer is too small. For continuous decoding of a stream, this method is often the best choice.

The following example converts a string from one encoding to another.

No code example is currently available or this language may not be supported.

The following example encodes a string into an array of bytes, and then decodes a range of the bytes into an array of characters.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
© 2015 Microsoft