Decoder.GetChars Method (Byte*, Int32, Char*, Int32, Boolean)
Assembly: mscorlib (in mscorlib.dll)
[ComVisibleAttribute(false)] [CLSCompliantAttribute(false)] public virtual int GetChars ( byte* bytes, int byteCount, char* chars, int charCount, bool flush )
A pointer to the first byte to decode.
The number of bytes to decode.
A pointer to the location at which to start writing the resulting set of characters.
The maximum number of characters to write.
true to clear the internal state of the decoder after the conversion; otherwise, false.
Return ValueThe actual number of characters written at the location indicated by the chars parameter.
bytes is a null reference (Nothing in Visual Basic)(Nothing).
chars is a null reference (Nothing in Visual Basic)(Nothing).
byteCount or charCount is less than zero.
charCount is less than the resulting number of 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 buffer 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.