UnicodeEncoding.GetByteCount メソッド

定義

名前空間:

System.Text

アセンブリ:

mscorlib.dll

一連の文字をエンコードすることによって生成されるバイト数を計算します。

オーバーロード

名前	説明
GetByteCount(String)	指定した文字列内の文字をエンコードすることによって生成されるバイト数を計算します。
GetByteCount(Char*, Int32)	指定した文字ポインターから始まる一連の文字をエンコードすることによって生成されるバイト数を計算します。
GetByteCount(Char[], Int32, Int32)	指定した文字配列から文字セットをエンコードすることによって生成されるバイト数を計算します。

GetByteCount(String)

指定した文字列内の文字をエンコードすることによって生成されるバイト数を計算します。

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

パラメーター

s

String

エンコードする文字のセットを含む文字列。

返品

Int32

指定した文字をエンコードすることによって生成されるバイト数。

例外

ArgumentNullException

s は nullです。

ArgumentOutOfRangeException

結果のバイト数は、整数として返すことができる最大数を超えています。

ArgumentException

エラー検出が有効になっており、 s に無効な文字シーケンスが含まれています。

EncoderFallbackException

フォールバックが発生しました (詳細については、「 .NET での文字エンコード」を参照してください)

および

EncoderFallback は EncoderExceptionFallback に設定されます。

例

次の例では、 GetMaxByteCount メソッドと GetByteCount(String) メソッドを呼び出して、文字列のエンコードに必要な最大バイト数と実際のバイト数を計算します。 また、バイト 順マークを持つバイト ストリームを格納するために必要な実際のバイト数も表示されます。

using System;
using System.Text;

class UTF8EncodingExample {
    public static void Main() {
        String chars = "UTF-16 Encoding Example";
        Encoding unicode = Encoding.Unicode;

        Console.WriteLine("Bytes needed to encode '{0}':", chars);
        Console.WriteLine("   Maximum:         {0}",
                          unicode.GetMaxByteCount(chars.Length));
        Console.WriteLine("   Actual:          {0}",
                          unicode.GetByteCount(chars));
        Console.WriteLine("   Actual with BOM: {0}",
                          unicode.GetByteCount(chars) + unicode.GetPreamble().Length);
    }
}
// The example displays the following output:
//       Bytes needed to encode 'UTF-16 Encoding Example':
//          Maximum:         48
//          Actual:          46
//          Actual with BOM: 48

Imports System.Text

Module Example
    Public Sub Main()
        Dim chars As String = "UTF-16 Encoding Example"
        Dim unicode As Encoding = Encoding.Unicode

        Console.WriteLine("Bytes needed to encode '{0}':", chars)
        Console.WriteLine("   Maximum:         {0}",
                          unicode.GetMaxByteCount(chars.Length))
        Console.WriteLine("   Actual:          {0}",
                          unicode.GetByteCount(chars))
        Console.WriteLine("   Actual with BOM: {0}",
                          unicode.GetByteCount(chars) + unicode.GetPreamble().Length)
    End Sub
End Module
' The example displays the following output:
'       Bytes needed to encode 'UTF-16 Encoding Example':
'          Maximum:         48
'          Actual:          46
'          Actual with BOM: 48

注釈

結果のバイトを格納するために GetBytes に必要な正確な配列サイズを計算するには、 GetByteCount メソッドを呼び出します。 配列の最大サイズを計算するには、 GetMaxByteCount メソッドを呼び出します。 一般に、 GetByteCount メソッドは割り当てるメモリが少なくなりますが、 GetMaxByteCount メソッドの実行速度は一般に速くなります。

エラー検出では、無効なシーケンスにより、このメソッドは ArgumentExceptionをスローします。 エラー検出がないと、無効なシーケンスは無視され、例外はスローされません。

Important

エンコードされたバイトがファイルまたはストリームとして保存されるときに正しくデコードされるようにするには、エンコードされたバイトのストリームの前にプリアンブルを付けます。 バイト ストリームの先頭 (ファイルに書き込まれる一連のバイトの先頭など) にプリアンブルを挿入するのは開発者の責任であり、プリアンブル内のバイト数は、 GetByteCount(String) メソッドによって返される値には反映されません。

こちらもご覧ください

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

GetByteCount(Char*, Int32)

重要

この API は CLS 準拠ではありません。

指定した文字ポインターから始まる一連の文字をエンコードすることによって生成されるバイト数を計算します。

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

[System.CLSCompliant(false)]
[System.Runtime.InteropServices.ComVisible(false)]
[System.Security.SecurityCritical]
public override int GetByteCount(char* chars, int count);

[<System.CLSCompliant(false)>]
[<System.Runtime.InteropServices.ComVisible(false)>]
[<System.Security.SecurityCritical>]
override this.GetByteCount : nativeptr<char> * int -> int

パラメーター

chars

Char*

エンコードする最初の文字へのポインター。

count

Int32

エンコードする文字数。

返品

Int32

指定した文字をエンコードすることによって生成されるバイト数。

属性

CLSCompliantAttribute ComVisibleAttribute SecurityCriticalAttribute

例外

ArgumentNullException

chars は nullです。

ArgumentOutOfRangeException

count が 0 未満です。

-または-

結果のバイト数は、整数として返すことができる最大数を超えています。

ArgumentException

エラー検出が有効になっており、 chars に無効な文字シーケンスが含まれています。

EncoderFallbackException

フォールバックが発生しました (詳細については、「 .NET での文字エンコード」を参照してください)

および

EncoderFallback は EncoderExceptionFallback に設定されます。

注釈

結果のバイト GetBytes 格納するために必要な正確な配列サイズを計算するには、 GetByteCount メソッドを呼び出します。 配列の最大サイズを計算するには、 GetMaxByteCount メソッドを呼び出します。 一般に、 GetByteCount メソッドは割り当てるメモリが少なくなりますが、 GetMaxByteCount メソッドの実行速度は一般に速くなります。

エラー検出では、無効なシーケンスにより、このメソッドは ArgumentExceptionをスローします。 エラー検出がないと、無効なシーケンスは無視され、例外はスローされません。

Important

エンコードされたバイトがファイルまたはストリームとして保存されるときに正しくデコードされるようにするには、エンコードされたバイトのストリームの前にプリアンブルを付けます。 バイト ストリームの先頭 (ファイルに書き込まれる一連のバイトの先頭など) にプリアンブルを挿入するのは開発者の責任であり、プリアンブル内のバイト数は、 GetByteCount メソッドによって返される値には反映されません。

こちらもご覧ください

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

GetByteCount(Char[], Int32, Int32)

指定した文字配列から文字セットをエンコードすることによって生成されるバイト数を計算します。

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

パラメーター

chars

Char[]

エンコードする文字のセットを含む文字配列。

index

Int32

エンコードする最初の文字のインデックス。

count

Int32

エンコードする文字数。

返品

Int32

指定した文字をエンコードすることによって生成されるバイト数。

例外

ArgumentNullException

chars が null (Nothing) です。

ArgumentOutOfRangeException

index または count が 0 未満です。

-または-

index および count は、 chars内の有効な範囲を示していません。

-または-

結果のバイト数は、整数として返すことができる最大数を超えています。

ArgumentException

エラー検出が有効になっており、 chars に無効な文字シーケンスが含まれています。

EncoderFallbackException

フォールバックが発生しました (詳細については、「 .NET での文字エンコード」を参照してください)

および

EncoderFallback は EncoderExceptionFallback に設定されます。

例

次の例では、配列に英大文字と小文字を設定し、 GetByteCount(Char[], Int32, Int32) メソッドを呼び出して、ラテン小文字のエンコードに必要なバイト数を決定します。 その後、バイトオーダーマークが追加された場合に必要な合計バイト数と共に、この情報が表示されます。 この数値は、 GetMaxByteCount メソッドによって返される値と比較されます。これは、ラテン小文字のエンコードに必要な最大バイト数を示します。 次の例では、ギリシャ文字とキリル文字の組み合わせで配列を設定し、 GetByteCount(Char[], Int32, Int32) メソッドを呼び出して、キリル文字のエンコードに必要なバイト数を決定します。 その後、バイトオーダーマークが追加された場合に必要な合計バイト数と共に、この情報が表示されます。 この数値は、キリル文字のエンコードに必要な最大バイト数を示す、 GetMaxByteCount メソッドによって返される値と比較されます。

using System;
using System.Text;

public class Example
{
   public static void Main()
   {
      int uppercaseStart = 0x0041;
      int uppercaseEnd = 0x005a;
      int lowercaseStart = 0x0061;
      int lowercaseEnd = 0x007a;
      // Instantiate a UTF8 encoding object with BOM support.
      Encoding unicode = Encoding.Unicode;

      // Populate array with characters.
      char[] chars = new char[lowercaseEnd - lowercaseStart + uppercaseEnd - uppercaseStart + 2];
      int index = 0;
      for (int ctr = uppercaseStart; ctr <= uppercaseEnd; ctr++) {
         chars[index] = (char)ctr;
         index++;
      }
      for (int ctr = lowercaseStart; ctr <= lowercaseEnd; ctr++) {
         chars[index] = (char)ctr;
         index++;
      }

      // Display the bytes needed for the lowercase characters.
      Console.WriteLine("Bytes needed for lowercase Latin characters:");
      Console.WriteLine("   Maximum:         {0,5:N0}",
                        unicode.GetMaxByteCount(lowercaseEnd - lowercaseStart + 1));
      Console.WriteLine("   Actual:          {0,5:N0}",
                        unicode.GetByteCount(chars, uppercaseEnd - uppercaseStart + 1,
                                          lowercaseEnd - lowercaseStart + 1));
      Console.WriteLine("   Actual with BOM: {0,5:N0}",
                        unicode.GetByteCount(chars, uppercaseEnd - uppercaseStart + 1,
                                          lowercaseEnd - lowercaseStart + 1) +
                                          unicode.GetPreamble().Length);
   }
}
// The example displays the following output:
//       Bytes needed for lowercase Latin characters:
//          Maximum:            54
//          Actual:             52
//          Actual with BOM:    54

Imports System.Text

Module Example
   Public Sub Main()
      Dim uppercaseStart As Integer = &h0041
      Dim uppercaseEnd As Integer = &h005a
      Dim lowercaseStart As Integer = &h0061
      Dim lowercaseEnd As Integer = &h007a
      ' Instantiate a UTF8 encoding object with BOM support.
      Dim unicode As Encoding = Encoding.Unicode
      
      ' Populate array with characters.
      Dim chars(lowercaseEnd - lowercaseStart + uppercaseEnd - uppercaseStart + 1) As Char
      Dim index As Integer = 0
      For ctr As Integer = uppercaseStart To uppercaseEnd
         chars(index) = ChrW(ctr)
         index += 1
      Next
      For ctr As Integer = lowercaseStart To lowercaseEnd
         chars(index) = ChrW(ctr)
         index += 1
      Next

      ' Display the bytes needed for the lowercase characters.
        Console.WriteLine("Bytes needed for lowercase Latin characters:")
        Console.WriteLine("   Maximum:         {0,5:N0}",
                          unicode.GetMaxByteCount(lowercaseEnd - lowercaseStart + 1))
        Console.WriteLine("   Actual:          {0,5:N0}",
                          unicode.GetByteCount(chars, uppercaseEnd - uppercaseStart + 1,
                                            lowercaseEnd - lowercaseStart + 1))
        Console.WriteLine("   Actual with BOM: {0,5:N0}",
                          unicode.GetByteCount(chars, uppercaseEnd - uppercaseStart + 1,
                                            lowercaseEnd - lowercaseStart + 1) +
                                            unicode.GetPreamble().Length)
   End Sub
End Module
' The example displays the following output:
'       Bytes needed for lowercase Latin characters:
'          Maximum:            54
'          Actual:             52
'          Actual with BOM:    54

注釈

結果のバイトを格納するために GetBytes に必要な正確な配列サイズを計算するために、アプリケーションは GetByteCountを使用します。 配列の最大サイズを計算するには、 GetMaxByteCount メソッドを呼び出します。 一般に、 GetByteCount メソッドは割り当てるメモリが少なくなりますが、 GetMaxByteCount メソッドの実行速度は一般に速くなります。

エラー検出が有効になっている場合、無効なシーケンスにより、このメソッドは ArgumentExceptionをスローします。 エラー検出がないと、無効なシーケンスは無視され、例外はスローされません。

エンコードされたバイトがファイルまたはストリームとして保存されるときに正しくデコードされるようにするには、エンコードされたバイトのストリームの前にプリアンブルを付けます。 バイト ストリームの先頭 (ファイルに書き込まれる一連のバイトの先頭など) にプリアンブルを挿入するのは開発者の責任であり、プリアンブル内のバイト数は、 GetByteCount(Char[], Int32, Int32) メソッドによって返される値には反映されません。

こちらもご覧ください

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