System.Text.UTF8Encoding.GetChars Method

Decodes a sequence of bytes from the specified byte array into the specified character array.

Syntax

public override int GetChars (byte[] bytes, int byteIndex, int byteCount, char[] chars, int charIndex)

Parameters

bytes
The byte array containing the sequence of bytes to decode.
byteIndex
The index of the first byte to decode.
byteCount
The number of bytes to decode.
chars
The character array to contain the resulting set of characters.
charIndex
The index at which to start writing the resulting set of characters.

Returns

The actual number of characters written into chars.

Exceptions

TypeReason
ArgumentException

chars does not contain sufficient space to store the decoded characters.

-or-

Error-checking is turned on for the current instance and bytes contains an invalid surrogate sequence.

ArgumentNullException bytes or chars is null.
ArgumentOutOfRangeException

byteIndex, byteCount, or charIndex is less than zero.

-or-

(bytes.Length - byteIndex) < byteCount.

-or-

charIndex > chars.Length.

Remarks

To calculate the exact array size required by UTF8Encoding.GetChars(Byte[], int, int, Char[], int) to store the resulting characters, the application uses UTF8Encoding.GetCharCount(Byte[], int, int). To calculate the maximum array size, the application should use UTF8Encoding.GetMaxCharCount(int). The UTF8Encoding.GetCharCount(Byte[], int, int) method generally allows allocation of less memory, while the UTF8Encoding.GetMaxCharCount(int) 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 System.Text.Decoder or the System.Text.Encoder provided by the UTF8Encoding.GetDecoder method or the UTF8Encoding.GetEncoder method, respectively.

Requirements

Namespace: System.Text
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0