Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

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
)
public int GetByteCount (
	String s
)
public override function GetByteCount (
	s : String
) : int
Not applicable.

Parameters

s

The String containing the set of characters to encode.

Return Value

The number of bytes produced by encoding the specified characters.

Exception typeCondition

ArgumentNullException

s is a null reference (Nothing in Visual Basic)(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
        );
    }
}

import System.*;
import System.Text.*;

class UnicodeEncodingExample
{
    public static void main(String[] args)
    {
        String chars = "Unicode Encoding Example";
        UnicodeEncoding unicode = new UnicodeEncoding();
        int byteCount = unicode.GetByteCount(chars);
        Console.WriteLine("{0} bytes needed to encode string.", 
            String.valueOf(byteCount));
    } //main
} //UnicodeEncodingExample

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft