UnicodeEncoding.GetChars Method (Byte(), Int32, Int32, Char(), Int32)
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Decodes a sequence of bytes from the specified byte array into the specified character array.
Assembly: mscorlib (in mscorlib.dll)
'Declaration Public Overrides Function GetChars ( _ bytes As Byte(), _ byteIndex As Integer, _ byteCount As Integer, _ chars As Char(), _ charIndex As Integer _ ) As Integer
Parameters
- bytes
- Type:
System.Byte
()
The byte array containing the sequence of bytes to decode.
- byteIndex
- Type: System.Int32
The zero-based index of the first byte to decode.
- byteCount
- Type: System.Int32
The number of bytes to decode.
- chars
- Type:
System.Char
()
The character array to contain the resulting set of characters.
- charIndex
- Type: System.Int32
The zero-based index at which to start writing the resulting set of characters.
| Exception | Condition |
|---|---|
| ArgumentNullException | bytes is null (Nothing). -or- chars is null (Nothing). |
| 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 | Error detection is enabled, and bytes contains an invalid sequence of bytes. -or- chars does not have enough capacity from charIndex to the end of the array to accommodate the resulting characters. |
| DecoderFallbackException | A fallback occurred. |
To calculate the exact array size required by GetChars to store the resulting characters, call the GetCharCount method. To calculate the maximum array size, call the GetMaxCharCount method. The GetCharCount method generally allocates less memory, while the GetMaxCharCount 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 should use the Decoder or the Encoder provided by the GetDecoder method or the GetEncoder method, respectively.
The following code example demonstrates how to use the GetChars method to decode a range of elements in a byte array and store the result in a character array.
Imports System.Text Class Example Public Shared Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock) Dim chars() As Char Dim bytes() As Byte = {85, 0, 110, 0, 105, 0, 99, 0, 111, 0, 100, 0, 101, 0} Dim uni As New UnicodeEncoding() Dim charCount As Integer = uni.GetCharCount(bytes, 2, 8) chars = New Char(charCount - 1) {} Dim charsDecodedCount As Integer = uni.GetChars(bytes, 2, 8, chars, 0) outputBlock.Text += String.Format("{0} characters used to decode bytes.", charsDecodedCount) & vbCrLf outputBlock.Text &= "Decoded chars: " Dim c As Char For Each c In chars outputBlock.Text += String.Format("[{0}]", c) Next c outputBlock.Text &= vbCrLf End Sub 'Main End Class 'UnicodeEncodingExample