UTF8Encoding.GetByteCount メソッド

リファレンス

定義

名前空間:: System.Text

アセンブリ:: System.Text.Encoding.Extensions.dll

アセンブリ:: mscorlib.dll

アセンブリ:: netstandard.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

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

オーバーロード

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

GetByteCount(ReadOnlySpan<Char>)

ソース:: UTF8Encoding.cs

ソース:: UTF8Encoding.cs

ソース:: UTF8Encoding.cs

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

public:
 override int GetByteCount(ReadOnlySpan<char> chars);

public override int GetByteCount (ReadOnlySpan<char> chars);

override this.GetByteCount : ReadOnlySpan<char> -> int

Public Overrides Function GetByteCount (chars As ReadOnlySpan(Of Char)) As Integer

パラメーター

chars: ReadOnlySpan<Char>

エンコードする文字のセットを格納するスパン。

戻り値

Int32

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

例外

ArgumentException

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

EncoderFallbackException

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

および

EncoderFallback が EncoderExceptionFallback に設定されます。

注釈

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

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

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

適用対象

GetByteCount(String)

ソース:: UTF8Encoding.cs

ソース:: UTF8Encoding.cs

ソース:: UTF8Encoding.cs

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

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

public override int GetByteCount (string chars);

override this.GetByteCount : string -> int

Public Overrides Function GetByteCount (chars As String) As Integer

パラメーター

chars: String

エンコード対象の文字のセットを格納している String。

戻り値

Int32

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

例外

ArgumentNullException

chars が nullです。

ArgumentOutOfRangeException

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

ArgumentException

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

EncoderFallbackException

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

および

EncoderFallback が EncoderExceptionFallback に設定されます。

例

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

using System;
using System.Text;

class UTF8EncodingExample {
    public static void Main() {
        String chars = "UTF8 Encoding Example";
        Encoding utf8 = Encoding.UTF8;

        Console.WriteLine("Bytes needed to encode '{0}':", chars);
        Console.WriteLine("   Maximum:         {0}",
                          utf8.GetMaxByteCount(chars.Length));
        Console.WriteLine("   Actual:          {0}",
                          utf8.GetByteCount(chars));
        Console.WriteLine("   Actual with BOM: {0}",
                          utf8.GetByteCount(chars) + utf8.GetPreamble().Length);
    }
}
// The example displays the following output:
//       Bytes needed to encode 'UTF8 Encoding Example':
//          Maximum:         66
//          Actual:          21
//          Actual with BOM: 24

Imports System.Text

Module Example
    Public Sub Main()
        Dim chars As String = "UTF8 Encoding Example"
        Dim utf8 As Encoding = Encoding.UTF8

        Console.WriteLine("Bytes needed to encode '{0}':", chars)
        Console.WriteLine("   Maximum:         {0}",
                          utf8.GetMaxByteCount(chars.Length))
        Console.WriteLine("   Actual:          {0}",
                          utf8.GetByteCount(chars))
        Console.WriteLine("   Actual with BOM: {0}",
                          utf8.GetByteCount(chars) + utf8.GetPreamble().Length)
    End Sub
End Module
' The example displays the following output:
'       Bytes needed to encode 'UTF8 Encoding Example':
'          Maximum:         66
'          Actual:          21
'          Actual with BOM: 24

注釈

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

こちらもご覧ください

適用対象

GetByteCount(Char*, Int32)

ソース:: UTF8Encoding.cs

ソース:: UTF8Encoding.cs

ソース:: UTF8Encoding.cs

重要

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

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

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

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

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

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

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

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

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

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

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

パラメーター

chars: Char*

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

count: Int32

エンコードする文字数。

戻り値

Int32

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

属性: CLSCompliantAttribute SecurityCriticalAttribute ComVisibleAttribute

例外

ArgumentNullException

chars は null です。

ArgumentOutOfRangeException

count が 0 未満です。

または

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

ArgumentException

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

EncoderFallbackException

フォールバックが発生しました (詳細な説明は、「.NET での文字エンコード」をご覧ください)。

および

EncoderFallback が EncoderExceptionFallback に設定されます。

注釈

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

こちらもご覧ください

適用対象

GetByteCount(Char[], Int32, Int32)

ソース:: UTF8Encoding.cs

ソース:: UTF8Encoding.cs

ソース:: UTF8Encoding.cs

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

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です。

ArgumentOutOfRangeException

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

または

index および count は charsにおいて有効な範囲を表していません。

または

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

ArgumentException

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

EncoderFallbackException

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

および

EncoderFallback プロパティが EncoderExceptionFallback に設定されています。

例

次の例では、配列に英大文字と小文字を設定し、メソッドを 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 utf8 = new UTF8Encoding(true);

      // 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}",
                        utf8.GetMaxByteCount(lowercaseEnd - lowercaseStart + 1));
      Console.WriteLine("   Actual:          {0,5:N0}",
                        utf8.GetByteCount(chars, uppercaseEnd - uppercaseStart + 1,
                                          lowercaseEnd - lowercaseStart + 1));
      Console.WriteLine("   Actual with BOM: {0,5:N0}",
                        utf8.GetByteCount(chars, uppercaseEnd - uppercaseStart + 1,
                                          lowercaseEnd - lowercaseStart + 1) +
                                          utf8.GetPreamble().Length);
   }
}
// The example displays the following output:
//       Bytes needed for lowercase Latin characters:
//          Maximum:            81
//          Actual:             26
//          Actual with BOM:    29

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 utf8 As New UTF8Encoding(True)
      
      ' 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}",
                          utf8.GetMaxByteCount(lowercaseEnd - lowercaseStart + 1))
        Console.WriteLine("   Actual:          {0,5:N0}",
                          utf8.GetByteCount(chars, uppercaseEnd - uppercaseStart + 1,
                                            lowercaseEnd - lowercaseStart + 1))
        Console.WriteLine("   Actual with BOM: {0,5:N0}",
                          utf8.GetByteCount(chars, uppercaseEnd - uppercaseStart + 1,
                                            lowercaseEnd - lowercaseStart + 1) +
                                            utf8.GetPreamble().Length)
   End Sub
End Module
' The example displays the following output:
'       Bytes needed for lowercase Latin characters:
'          Maximum:            81
'          Actual:             26
'          Actual with BOM:    29

注釈

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

こちらもご覧ください

適用対象

次の方法で共有

UTF8Encoding.GetByteCount メソッド

定義

オーバーロード

GetByteCount(ReadOnlySpan<Char>)

パラメーター

戻り値

例外

注釈

適用対象

GetByteCount(String)

パラメーター

戻り値

例外

例

注釈

こちらもご覧ください

適用対象

GetByteCount(Char*, Int32)

パラメーター

戻り値

例外

注釈

こちらもご覧ください

適用対象

GetByteCount(Char[], Int32, Int32)

パラメーター

戻り値

例外

例

注釈

こちらもご覧ください

適用対象

その他のリソース