• Article

Decoder.GetChars Method (array<Byte[], Int32, Int32, array<Char[], Int32, Boolean)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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. A parameter indicates whether to clear the internal state of the decoder after the conversion.

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

Syntax

'Declaration
Public Overridable Function GetChars ( _
    bytes As Byte(), _
    byteIndex As Integer, _
    byteCount As Integer, _
    chars As Char(), _
    charIndex As Integer, _
    flush As Boolean _
) As Integer

public virtual int GetChars(
    byte[] bytes,
    int byteIndex,
    int byteCount,
    char[] chars,
    int charIndex,
    bool flush
)

Parameters

  • bytes
    Type: array<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: array<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.
  • flush
    Type: System.Boolean
    true to clear the internal state of the decoder after the conversion; otherwise, false.

Return Value

Type: System.Int32
The actual number of characters written into the chars array.

Exceptions

Exception Condition
ArgumentNullException

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

-or-

chars is nulla 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.
DecoderFallbackException

A fallback occurred (see Understanding Encodings for fuller explanation).

Remarks

The Decoder object saves state between calls to GetChars. When the application is done with a stream of data, it should set the flush parameter to true to make sure that the state information is flushed. With this setting, the decoder ignores invalid bytes at the end of the data block and clears the internal buffer.

To calculate the exact array size that GetChars requires to store the decoded characters, call the GetCharCount method.

If GetChars is called with flush set to false, the decoder stores trailing bytes at the end of the data block in an internal buffer and uses them in the next decoding operation. The application should 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.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.