UTF8Encoding.GetByteCount Method (String)

Syntax

'Declaration
<SecuritySafeCriticalAttribute> _
Public Overrides Function GetByteCount ( _
    chars As String _
) As Integer

[SecuritySafeCriticalAttribute]
public override int GetByteCount(
    string chars
)

Exceptions

Remarks

To calculate the exact array size required by the GetBytes method to store the resulting bytes, call the GetByteCount method. To calculate the maximum array size, call the GetMaxByteCount method. The GetByteCount method generally allocates 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.

Note:
To ensure that the encoded bytes are decoded properly, the application should prefix encoded bytes with a preamble.

Examples

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

Imports System.Text

Class Example

   Public Shared Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      Dim chars As String = "UTF8 Encoding Example"

      Dim utf8 As New UTF8Encoding()
      Dim byteCount As Integer = utf8.GetByteCount(chars)
      outputBlock.Text += String.Format("{0} bytes needed to encode string.", byteCount) & vbCrLf
   End Sub 'Main
End Class 'UTF8EncodingExample

using System;
using System.Text;

class Example
{
   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      String chars = "UTF8 Encoding Example";

      UTF8Encoding utf8 = new UTF8Encoding();
      int byteCount = utf8.GetByteCount(chars);
      outputBlock.Text += String.Format(
          "{0} bytes needed to encode string.", byteCount
      ) + "\n";
   }
}

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

See Also

Reference