This documentation is archived and is not being maintained.

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 method is not CLS-compliant.  

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

[ComVisibleAttribute(false)] 
[CLSCompliantAttribute(false)] 
public virtual int GetChars (
	byte* bytes,
	int byteCount,
	char* chars,
	int charCount,
	bool flush
)
Not applicable.

Parameters

bytes

A pointer to the first byte to decode.

byteCount

The number of bytes to decode.

chars

A pointer to the location at which to start writing the resulting set of characters.

charCount

The maximum number of characters to write.

flush

true to clear the internal state of the decoder after the conversion; otherwise, false.

Return Value

The actual number of characters written at the location indicated by the chars parameter.

Exception typeCondition

ArgumentNullException

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

-or-

chars is a null reference (Nothing in Visual Basic)(Nothing).

ArgumentOutOfRangeException

byteCount or charCount is less than zero.

ArgumentException

charCount is less than the resulting number of characters.

DecoderFallbackException

A fallback occurred (see Understanding Encodings for fuller explanation)

-and-

Fallback is set to DecoderExceptionFallback.

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 Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

.NET Compact Framework

Supported in: 2.0

XNA Framework

Supported in: 1.0
Show: