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

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

ArgumentOutOfRangeException

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

ArgumentException

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

To calculate the exact array size required by GetBytes to store the resulting bytes, use GetByteCount. To calculate the maximum array size, use GetMaxByteCount. The GetByteCount method generally allows you to allocate less memory, whereas the GetMaxByteCount method generally executes faster.

With error detection, an invalid sequence causes this method to throw an ArgumentException. Without error detection, invalid sequences are ignored, and no exception is thrown.

Caution noteCaution

To ensure that the encoded bytes are decoded properly, 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 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

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

Community Additions

Show:
© 2014 Microsoft