GetByteCount Method (Char*, Int32, Boolean)
Collapse the table of content
Expand the table of content

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)

[SecurityCriticalAttribute]
[CLSCompliantAttribute(false)]
[ComVisibleAttribute(false)]
public virtual unsafe 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.

Exception Condition
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.

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:
© 2016 Microsoft