UTF32Encoding.GetMaxByteCount Method (Int32)

 
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.

Calculates the maximum number of bytes produced by encoding the specified number of characters.

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

override GetMaxByteCount : 
        charCount:int -> int

Parameters

charCount
Type: System.Int32

The number of characters to encode.

Return Value

Type: System.Int32

The maximum number of bytes produced by encoding the specified number of characters.

Exception Condition
ArgumentOutOfRangeException

charCount is less than zero.

-or-

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

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, you call the GetByteCount method. To calculate the maximum array size, you call the GetMaxByteCount method. The GetByteCount method generally allocates less memory, while the GetMaxByteCount method generally executes faster.

GetMaxByteCount is a worst-case number, including the worst case for the currently selected EncoderFallback. If a fallback is chosen with a potentially large string, GetMaxByteCount can return large values.

In most cases, this method returns reasonable numbers for small strings. For large strings, you might have to choose between using very large buffers and catching errors in the rare case that a more reasonable buffer is exceeded. You might also want to consider a different approach and use GetByteCount or Encoder.Convert.

GetMaxByteCount has no relationship to GetChars. If you need a similar function to use with GetChars, use GetMaxCharCount.

System_CAPS_noteNote

GetMaxByteCount(N) is not necessarily the same value as N* GetMaxByteCount(1).

The following example determines the number of bytes required to encode a string, then encodes the string and displays the resulting bytes.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 10
.NET Framework
Available since 2.0
Return to top
Show: