ASCIIEncoding.GetByteCount Method (String)

 

Calculates the number of bytes produced by encoding the characters in the specified String.

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

public override int GetByteCount(
	string chars
)

Parameters

chars
Type: System.String

The String containing the set of characters to encode.

Return Value

Type: System.Int32

The number of bytes produced by encoding the specified characters.

Exception Condition
ArgumentNullException

chars is null.

ArgumentOutOfRangeException

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, 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.

The following example demonstrates how to use the GetByteCount method to return the number of bytes required to encode a string using ASCIIEncoding.

using System;
using System.Text;

class ASCIIEncodingExample {
    public static void Main() {
        String chars = "ASCII Encoding Example";

        ASCIIEncoding ascii = new ASCIIEncoding();
        int byteCount = ascii.GetByteCount(chars);
        Console.WriteLine(
            "{0} bytes needed to encode string.", byteCount
        );
    }
}

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