This documentation is archived and is not being maintained.

ASCIIEncoding.GetMaxCharCount Method

Updated: March 2011

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

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

public override int GetMaxCharCount(
	int byteCount
)

Parameters

byteCount
Type: System.Int32

The number of bytes to decode.

Return Value

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

ExceptionCondition
ArgumentOutOfRangeException

byteCount is less than zero.

-or-

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

The GetCharCount method calculates the exact array size required by the GetChars method to store the resulting characters, whereas the GetMaxCharCount method calculates the maximum array size. The GetCharCount method generally allocates less memory, but the GetMaxCharCount method generally executes faster.

GetMaxCharCount retrieves a worst-case number, including the worst case for the currently selected DecoderFallback. If a decoder fallback is present that has a maximum fallback length of n, the GetMaxCharCount method returns n * byteCount.

GetMaxCharCount has no relation to GetBytes. If your application needs a similar function to use with GetBytes, it should use GetMaxByteCount.

NoteNote:

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

The following example demonstrates how to use the GetMaxCharCount method to calculate the maximum number of characters needed to decode a specified number of bytes.

using System;
using System.Text;

class ASCIIEncodingExample {
    public static void Main() {
        ASCIIEncoding ascii = new ASCIIEncoding();
        int byteCount = 8;
        int maxCharCount = ascii.GetMaxCharCount(byteCount);
        Console.WriteLine(
            "Maximum of {0} characters needed to decode {1} bytes.",
            maxCharCount,
            byteCount
        );
    }
}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Date

History

Reason

March 2011

Revised the Remarks section.

Information enhancement.

Show: