Decoder.GetChars Method (Byte*, Int32, Char*, Int32, Boolean)
When overridden in a derived class, decodes a sequence of bytes starting at the specified byte pointer and any bytes in the internal buffer into a set of characters that are stored starting at the specified character pointer. A parameter indicates whether to clear the internal state of the decoder after the conversion.
This API is not CLS-compliant. Namespace: System.Text
Assembly: mscorlib (in mscorlib.dll)
[CLSCompliantAttribute(false)] [ComVisibleAttribute(false)] public virtual int GetChars( byte* bytes, int byteCount, char* chars, int charCount, bool flush )
- Type: System.Byte*
A pointer to the first byte to decode.
- Type: System.Int32
The number of bytes to decode.
- Type: System.Char*
A pointer to the location at which to start writing the resulting set of characters.
- Type: System.Int32
The maximum number of characters to write.
- Type: System.Boolean
true to clear the internal state of the decoder after the conversion; otherwise, false.
Return ValueType: System.Int32
The actual number of characters written at the location indicated by the chars parameter.
bytes is null (Nothing).
chars is null (Nothing).
byteCount or charCount is less than zero.
charCount is less than the resulting number of characters.
A fallback occurred (see Character Encoding in the .NET Framework 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.
If your application is to convert many segments of an input stream, consider using the Convert method. GetChars will throw an exception if the output buffer isn't large enough, but Convert will fill as much space as possible and return the bytes read and chars written. Also see the Encoding.GetChars topic for more comments.
.NET FrameworkSupported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0
.NET Framework Client ProfileSupported in: 4, 3.5 SP1
XNA FrameworkSupported in: 3.0, 2.0, 1.0
.NET for Windows Phone appsSupported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8
Portable Class LibrarySupported in: Portable Class Library
Requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.