Export (0) Print
Expand All

UTF8Encoding.GetByteCount Method (Char*, Int32)

Calculates the number of bytes produced by encoding a set of characters starting at the specified character pointer.

This API is not CLS-compliant. 

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

[CLSCompliantAttribute(false)]
[ComVisibleAttribute(false)]
public override int GetByteCount(
	char* chars,
	int count
)

Parameters

chars
Type: System.Char*

A pointer to the first character to encode.

count
Type: System.Int32

The number of characters to encode.

Return Value

Type: System.Int32
The number of bytes produced by encoding the specified characters.

ExceptionCondition
ArgumentNullException

chars is null.

ArgumentOutOfRangeException

count is less than zero.

-or-

The resulting number of bytes is greater than the maximum number that can be returned as an integer.

ArgumentException

Error detection is enabled, and chars contains an invalid sequence of characters.

EncoderFallbackException

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

-and-

EncoderFallback is set to EncoderExceptionFallback.

To calculate the exact array size required by GetBytes to store the resulting bytes, the application uses GetByteCount. To calculate the maximum array size, the application should use GetMaxByteCount. The GetByteCount method generally allows allocation of less memory, while the GetMaxByteCount method generally executes faster.

With error detection, an invalid sequence causes this method to throw a ArgumentException. Without error detection, invalid sequences are ignored, and no exception is thrown.

NoteNote

To ensure that the encoded bytes are decoded properly, the application should prefix encoded bytes with a preamble.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 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 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft