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

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

[SecurityCriticalAttribute]
[CLSCompliantAttribute(false)]
[ComVisibleAttribute(false)]
public virtual unsafe int GetCharCount(
	byte* bytes,
	int count,
	bool flush
)

Parameters

bytes
Type: System.Byte*

A pointer to the first byte to decode.

count
Type: System.Int32

The number of bytes to decode.

flush
Type: System.Boolean

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

Return Value

Type: System.Int32

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

Exception Condition
ArgumentNullException

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

ArgumentOutOfRangeException

count is less than zero.

DecoderFallbackException

A fallback occurred (see Character Encoding in the .NET Framework 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.

SecurityCriticalAttribute

Requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.

.NET Framework
Available since 2.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show: