This documentation is archived and is not being maintained.

Encoder.GetByteCount Method (Char*, Int32, Boolean)

When overridden in a derived class, calculates the number of bytes produced by encoding a set of characters starting at the specified character pointer. A parameter indicates whether to clear the internal state of the encoder after the calculation.

This API is not CLS-compliant. 

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

[CLSCompliantAttribute(false)]
[ComVisibleAttribute(false)]
public virtual int GetByteCount(
	char* chars,
	int count,
	bool flush
)

Parameters

chars
Type: System.Char*
A pointer to the first character to encode.
count
Type: System.Int32
The number of characters to encode.
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 bytes produced by encoding the specified characters and any characters in the internal buffer.

ExceptionCondition
ArgumentNullException

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

ArgumentOutOfRangeException

count is less than zero.

EncoderFallbackException

A fallback occurred (see Character Encoding in the .NET Framework for fuller explanation)

-and-

Fallback is set to EncoderExceptionFallback.

This method does not affect the state of the encoder.

To calculate the exact array size that GetBytes requires to store the resulting bytes, the application should use GetByteCount.

If GetBytes is called with flush set to false, the encoder stores trailing characters at the end of the data block in an internal buffer and uses them in the next encoding operation. The application should call GetByteCount on a block of data immediately before calling GetBytes on the same block, so that any trailing characters from the previous block are included in the calculation.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

  • SecurityCriticalAttribute 

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

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: