This documentation is archived and is not being maintained.

Decoder.GetCharCount Method (Byte*, Int32, Boolean)

When overridden in a derived class, calculates the number of characters produced by decoding a sequence of bytes starting at the specified byte pointer. A parameter indicates whether to clear the internal state of the decoder after the calculation.

This method is not CLS-compliant.  

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

[CLSCompliantAttribute(false)] 
[ComVisibleAttribute(false)] 
public virtual int GetCharCount (
	byte* bytes,
	int count,
	bool flush
)
Not applicable.

Parameters

bytes

A pointer to the first byte to decode.

count

The number of bytes to decode.

flush

true to simulate clearing the internal state of the encoder after the calculation; otherwise, false.

Return Value

The number of characters produced by decoding the specified sequence of bytes and any bytes in the internal buffer.

Exception typeCondition

ArgumentNullException

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

ArgumentOutOfRangeException

count is less than zero.

DecoderFallbackException

A fallback occurred (see Understanding Encodings for fuller explanation)

-and-

Fallback is set to DecoderExceptionFallback.

This method does not affect the state of the decoder.

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 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: