NGWS SDK Documentation  

This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!

UnicodeEncoding.GetChars

Decodes a range of bytes in a byte array into a range of characters in a character array.

[Visual Basic]
Overrides Public Function GetChars( _
   ByVal bytes() As Byte, _
   ByVal byteIndex As Integer, _
   ByVal byteCount As Integer, _
   ByVal chars() As Char, _
   ByVal charIndex As Integer _
) As Integer
[C#]
public override int GetChars(
   byte[] bytes,
   int byteIndex,
   int byteCount,
   char[] chars,
   int charIndex
);
[C++]
public: override int GetChars(
   unsigned char* bytes[],
   int byteIndex,
   int byteCount,
   __wchar_t* chars[],
   int charIndex
);
[JScript]
public override function GetChars(
   bytes : Byte[],
   byteIndex : int,
   byteCount : int,
   chars : Char[],
   charIndex : int
) : int;

Parameters

bytes
The byte array to decode.
byteIndex
The starting index of the byte array to decode.
byteCount
The number of bytes to decode.
chars
The character array to decode into.
charIndex
The starting index of the resulting decoding in the character array.

Return Value

The number of characters stored into the character array.

Exceptions

Exception Type Condition
ArgumentNullException The bytes or chars parameter is a null reference (in Visual Basic Nothing).
ArgumentOutOfRangeException The byteIndex, byteCount or charIndex parameter is less than zero.
ArgumentOutOfRangeException The sum of the byteIndex and byteCount parameters is greater than the length of the byte array.
ArgumentOutOfRangeException The sum of the charIndex and byteCount parameters is greater than the length of the character array.

Remarks

This method overrides GetChars.

This method can be used to determine the exact number of characters that will be produced for a given range of bytes. Alternatively, GetMaxCharCount can be used to determine the maximum number of characters that will be produced for a given number of bytes, regardless of the actual byte values.

See Also

UnicodeEncoding Class | UnicodeEncoding Members | System.Text Namespace | GetCharCount | GetMaxCharCount | GetChars