UTF7Encoding.GetByteCount Method

Definition

Namespace:

System.Text

Assembly:

System.Text.Encoding.Extensions.dll

Calculates the number of bytes produced by encoding a set of characters.

Overloads

GetByteCount(String)	Calculates the number of bytes produced by encoding the characters in the specified String object.
GetByteCount(Char*, Int32)	Calculates the number of bytes produced by encoding a set of characters starting at the specified character pointer.
GetByteCount(Char[], Int32, Int32)	Calculates the number of bytes produced by encoding a set of characters from the specified character array.

GetByteCount(String)

Source:

UTF7Encoding.cs

Calculates the number of bytes produced by encoding the characters in the specified String object.

public:
 override int GetByteCount(System::String ^ s);

public override int GetByteCount (string s);

override this.GetByteCount : string -> int

Public Overrides Function GetByteCount (s As String) As Integer

Parameters

s

String

The String object containing the set of characters to encode.

Returns

Int32

The number of bytes produced by encoding the specified characters.

Exceptions

ArgumentNullException

s is null (Nothing).

ArgumentOutOfRangeException

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

EncoderFallbackException

A fallback occurred (for more information, see Character Encoding in .NET).

-and-

EncoderFallback is set to EncoderExceptionFallback.

Examples

The following code example demonstrates how to use the GetByteCount method to return the number of bytes required to encode a character array.

using namespace System;
using namespace System::Text;
int main()
{
   
   // Unicode characters.
   
   // Pi
   // Sigma
   array<Char>^chars = {L'\u03a0',L'\u03a3',L'\u03a6',L'\u03a9'};
   UTF7Encoding^ utf7 = gcnew UTF7Encoding;
   int byteCount = utf7->GetByteCount( chars, 1, 2 );
   Console::WriteLine( "{0} bytes needed to encode characters.", byteCount );
}

using System;
using System.Text;

class UTF7EncodingExample {
    public static void Main() {
        // Unicode characters.
        Char[] chars = new Char[] {
            '\u0023', // #
            '\u0025', // %
            '\u03a0', // Pi
            '\u03a3'  // Sigma
        };

        UTF7Encoding utf7 = new UTF7Encoding();
        int byteCount = utf7.GetByteCount(chars, 1, 2);
        Console.WriteLine(
            "{0} bytes needed to encode characters.", byteCount
        );
    }
}

Imports System.Text
Imports Microsoft.VisualBasic.Strings

Class UTF7EncodingExample
    
    Public Shared Sub Main()
        ' 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 utf7 As New UTF7Encoding()
        Dim byteCount As Integer = utf7.GetByteCount(chars, 1, 2)
        Console.WriteLine("{0} bytes needed to encode characters.", byteCount)
    End Sub
End Class

Remarks

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

See also

• GetBytes(String, Int32, Int32, Byte[], Int32)
• GetMaxByteCount(Int32)
• GetEncoder()

GetByteCount(Char*, Int32)

Source:

UTF7Encoding.cs

Important

This API is not CLS-compliant.

Calculates the number of bytes produced by encoding a set of characters starting at the specified character pointer.

public:
 override int GetByteCount(char* chars, int count);

[System.CLSCompliant(false)]
public override int GetByteCount (char* chars, int count);

[<System.CLSCompliant(false)>]
override this.GetByteCount : nativeptr<char> * int -> int

Parameters

chars

Char*

A pointer to the first character to encode.

count

Int32

The number of characters to encode.

Returns

Int32

The number of bytes produced by encoding the specified characters.

Attributes

CLSCompliantAttribute

Exceptions

ArgumentNullException

chars is null (Nothing in Visual Basic .NET).

ArgumentOutOfRangeException

count is less than zero.

-or-

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

EncoderFallbackException

A fallback occurred (for more information, see Character Encoding in .NET)

-and-

EncoderFallback is set to EncoderExceptionFallback.

Remarks

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

See also

• GetBytes(String, Int32, Int32, Byte[], Int32)
• GetMaxByteCount(Int32)
• GetEncoder()

GetByteCount(Char[], Int32, Int32)

Source:

UTF7Encoding.cs

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

public:
 override int GetByteCount(cli::array <char> ^ chars, int index, int count);

public override int GetByteCount (char[] chars, int index, int count);

override this.GetByteCount : char[] * int * int -> int

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

Parameters

chars

Char[]

The character array containing the set of characters to encode.

index

Int32

The index of the first character to encode.

count

Int32

The number of characters to encode.

Returns

Int32

The number of bytes produced by encoding the specified characters.

Exceptions

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

EncoderFallbackException

A fallback occurred (for more information, see Character Encoding in .NET)

-and-

EncoderFallback is set to EncoderExceptionFallback.

Examples

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 namespace System;
using namespace System::Text;
int main()
{
   
   // Unicode characters.
   
   // Pi
   // Sigma
   array<Char>^chars = {L'\u03a0',L'\u03a3',L'\u03a6',L'\u03a9'};
   UTF7Encoding^ utf7 = gcnew UTF7Encoding;
   int byteCount = utf7->GetByteCount( chars, 1, 2 );
   Console::WriteLine( "{0} bytes needed to encode characters.", byteCount );
}

using System;
using System.Text;

class UTF7EncodingExample {
    public static void Main() {
        // Unicode characters.
        Char[] chars = new Char[] {
            '\u0023', // #
            '\u0025', // %
            '\u03a0', // Pi
            '\u03a3'  // Sigma
        };

        UTF7Encoding utf7 = new UTF7Encoding();
        int byteCount = utf7.GetByteCount(chars, 1, 2);
        Console.WriteLine(
            "{0} bytes needed to encode characters.", byteCount
        );
    }
}

Imports System.Text
Imports Microsoft.VisualBasic.Strings

Class UTF7EncodingExample
    
    Public Shared Sub Main()
        ' 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 utf7 As New UTF7Encoding()
        Dim byteCount As Integer = utf7.GetByteCount(chars, 1, 2)
        Console.WriteLine("{0} bytes needed to encode characters.", byteCount)
    End Sub
End Class

Remarks

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.

See also

• GetBytes(String, Int32, Int32, Byte[], Int32)
• GetMaxByteCount(Int32)
• GetEncoder()