System.Text.Encoding.GetChars Method

When overridden in a derived class, decodes a sequence of bytes starting at the specified byte pointer into a set of characters that are stored starting at the specified character pointer.

Syntax

[System.CLSCompliant(false)]
[System.Runtime.InteropServices.ComVisible(false)]
public virtual int GetChars (byte* bytes, int byteCount, char* chars, int charCount)

Parameters

bytes
A pointer to the first byte to decode.
byteCount
The number of bytes to decode.
chars
A pointer to the location at which to start writing the resulting set of characters.
charCount
The maximum number of characters to write.

Returns

The actual number of characters written at the location indicated by the chars parameter.

Remarks

To calculate the exact array size that Encoding.GetChars(Byte[]) requires to store the resulting characters, the application should use Encoding.GetCharCount(Byte[]). To calculate the maximum array size, the application should use Encoding.GetMaxCharCount(int). The Encoding.GetCharCount(Byte[]) method generally allows allocation of less memory, while the Encoding.GetMaxCharCount(int) method generally executes faster.

Encoding.GetChars(Byte*, int, Char*, int) gets characters from an input byte sequence. Encoding.GetChars(Byte*, int, Char*, int) is different than Decoder.GetChars(Byte[], int, int, Char[], int) because System.Text.Encoding expects discrete conversions, while System.Text.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, the application should use the System.Text.Decoder or the System.Text.Encoder object provided by the Encoding.GetDecoder or the Encoding.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 your application needs to encode arbitrary binary data into text, it should use a protocol such as uuencode, which is implemented by methods such as Convert.ToBase64CharArray(Byte[], int, int, Char[], int).

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

Several versions of Encoding.GetCharCount(Byte[]) and Encoding.GetChars(Byte[]) are supported. The following are some programming considerations for use of these methods:

Requirements

Namespace: System.Text
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 2.0.0.0, 4.0.0.0
Since: .NET 2.0