Decoder.GetChars Method (Byte, Int32, Int32, Char, Int32, Boolean)
Assembly: mscorlib (in mscorlib.dll)
public virtual int GetChars ( byte bytes, int byteIndex, int byteCount, char chars, int charIndex, bool flush )
public int GetChars ( byte bytes, int byteIndex, int byteCount, char chars, int charIndex, boolean flush )
public function GetChars ( bytes : byte, byteIndex : int, byteCount : int, chars : char, charIndex : int, flush : boolean ) : int
The byte array containing the sequence of bytes to decode.
The index of the first byte to decode.
The number of bytes to decode.
The character array to contain the resulting set of characters.
The index at which to start writing the resulting set of characters.
true to clear the internal state of the decoder after the conversion; otherwise, false.
Return ValueThe actual number of characters written into the chars parameter.
bytes is a null reference (Nothing in Visual Basic)(Nothing).
chars is a null reference (Nothing in Visual Basic)(Nothing).
byteIndex or byteCount or charIndex is less than zero.
byteindex and byteCount do not denote a valid range in bytes.
charIndex is not a valid index in chars.
chars does not have enough capacity from charIndex to the end of the array to accommodate the resulting characters.
A fallback occurred (see Understanding Encodings for fuller explanation)
Remember that 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 resulting characters, the application should use GetCharCount.
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.
Windows 98, Windows Server 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 EditionThe Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.