GetByteCount Method (Char[], Int32, Int32)
Collapse the table of content
Expand the table of content

UnicodeEncoding.GetByteCount Method (Char(), Int32, Int32)

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Calculates the number of bytes produced by encoding a set of characters from the specified character array.

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

'Declaration
Public Overrides Function GetByteCount ( _
	chars As Char(), _
	index As Integer, _
	count As Integer _
) As Integer

Parameters

chars
Type: System.Char ()
The character array containing the set of characters to encode.
index
Type: System.Int32
The zero-based index of the first character to encode.
count
Type: System.Int32
The number of characters to encode.

Return Value

Type: System.Int32
The number of bytes produced by encoding the specified characters.

ExceptionCondition
ArgumentNullException

chars is null (Nothing).

ArgumentOutOfRangeException

index or count is less than zero.

-or-

index and count do not denote a valid range in chars.

-or-

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

ArgumentException

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

EncoderFallbackException

A fallback occurred.

To calculate the exact array size required by GetBytes 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.

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 an array of Unicode characters using UnicodeEncoding.


Imports System.Text
Imports Microsoft.VisualBasic.Strings

Class Example

   Public Shared Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      ' Unicode characters.
      ' ChrW(35)  = #
      ' ChrW(37)  = %
      ' ChrW(928) = Pi
      ' ChrW(931) = Sigma
      Dim chars() As Char = {ChrW(35), ChrW(37), ChrW(928), ChrW(931)}

      Dim uni As New UnicodeEncoding()
      Dim byteCount As Integer = uni.GetByteCount(chars, 1, 2)
      outputBlock.Text += String.Format("{0} bytes needed to encode characters.", byteCount) & vbCrLf
   End Sub 'Main
End Class 'UnicodeEncodingExample


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2017 Microsoft