UnicodeEncoding.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 s
)

Parameters

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

ExceptionCondition
ArgumentNullException

s is null (Nothing).

ArgumentOutOfRangeException

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

ArgumentException

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

EncoderFallbackException

A fallback occurred (see Understanding Encodings for fuller 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.

The following code example demonstrates how to use the GetByteCount method to return the number of bytes required to encode a String using UnicodeEncoding.

using System;
using System.Text;

class UnicodeEncodingExample {
    public static void Main() {
        String chars = "Unicode Encoding Example";

        UnicodeEncoding Unicode = new UnicodeEncoding();
        int byteCount = Unicode.GetByteCount(chars);
        Console.WriteLine(
            "{0} bytes needed to encode string.", 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
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2015 Microsoft