This documentation is archived and is not being maintained.

Decoder.GetChars Method (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.

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

public abstract int GetChars (
	byte[] bytes,
	int byteIndex,
	int byteCount,
	char[] chars,
	int charIndex
)
public abstract int GetChars (
	byte[] bytes, 
	int byteIndex, 
	int byteCount, 
	char[] chars, 
	int charIndex
)
public abstract function GetChars (
	bytes : byte[], 
	byteIndex : int, 
	byteCount : int, 
	chars : char[], 
	charIndex : int
) : int

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.

Return Value

The actual number of characters written into chars.

Exception typeCondition

ArgumentNullException

bytes is a null reference (Nothing in Visual Basic).

-or-

chars is a null reference (Nothing in Visual Basic).

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

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

To calculate the exact array size required by GetChars to store the resulting characters, use GetCharCount.

If GetChars is called with flush set to false, trailing bytes at the end of the data block are stored in an internal buffer and used in the next decoding operation. Call GetCharCount on a block of data immediately before calling GetChars on the same block, so that any trailing bytes from the previous block are included in the calculation.

If GetChars is called with flush set to true, invalid bytes at the end of the data block are ignored and the internal buffer is cleared.

This method affects the state of the decoder.

The following code example demonstrates how to decode a range of elements from a byte array and store them in a Unicode character array. The GetCharCount method is used to calculate the number of characters needed to store the decoded elements in the array bytes. The GetChars method decodes the specified elements in the byte array and stores them in the new character array.

using System;
using System.Text;

class UnicodeEncodingExample {
    public static void Main() {
        Char[] chars;
        Byte[] bytes = new Byte[] {
            85, 0, 110, 0, 105, 0, 99, 0, 111, 0, 100, 0, 101, 0
        };

        Decoder uniDecoder = Encoding.Unicode.GetDecoder();

        int charCount = uniDecoder.GetCharCount(bytes, 0, bytes.Length);
        chars = new Char[charCount];
        int charsDecodedCount = uniDecoder.GetChars(bytes, 0, bytes.Length, 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();
    }
}

import System.*;
import System.Text.*;

class UnicodeEncodingExample
{
    public static void main(String[] args)
    {
        char chars[];
        ubyte bytes[] = new ubyte[] {
            85, 0, 110, 0, 105, 0, 99, 0, 111, 0, 100, 0, 101, 0};
        Decoder uniDecoder = Encoding.get_Unicode().GetDecoder();
        int charCount = uniDecoder.GetCharCount(bytes, 0, bytes.length);
        chars = new char[charCount];
        int charsDecodedCount = uniDecoder.GetChars(bytes,
                                0, bytes.length, chars, 0);
        Console.WriteLine("{0} characters used to decode bytes.", 
                        String.valueOf(charsDecodedCount));
        Console.Write("Decoded chars: ");
        for(int iCtr = 0; iCtr < chars.length; iCtr++) {
            char c = chars[iCtr];
            Console.Write("[{0}]", String.valueOf(c));
        }
        Console.WriteLine();
    } //main
} //UnicodeEncodingExample

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
Show: