Encoder.GetByteCount メソッド

定義

名前空間:

System.Text

アセンブリ:

System.Runtime.dll

派生クラスでオーバーライドされた場合、文字のセットをエンコードすることによって生成されるバイト数を計算します。

オーバーロード

GetByteCount(ReadOnlySpan<Char>, Boolean)	派生クラスでオーバーライドされた場合、'chars' スパンの文字セットをエンコードすることによって生成されるバイト数を計算します。 パラメーターでは、計算後にエンコーダーの内部状態をクリアするかどうかを示します。
GetByteCount(Char*, Int32, Boolean)	派生クラスでオーバーライドされた場合、指定した文字ポインターから始まる文字のセットをエンコードすることによって生成されるバイト数を計算します。 パラメーターでは、計算後にエンコーダーの内部状態をクリアするかどうかを示します。
GetByteCount(Char[], Int32, Int32, Boolean)	派生クラスでオーバーライドされた場合、指定した文字配列に格納されている文字のセットをエンコードすることによって生成されるバイト数を計算します。 パラメーターでは、計算後にエンコーダーの内部状態をクリアするかどうかを示します。

注釈

このメソッドは、エンコーダーの状態には影響しません。

結果のバイトを格納する必要がある GetBytes 正確な配列サイズを計算するには、アプリケーションで を使用 GetByteCountする必要があります。

を に設定して falseが呼び出されたflush場合GetBytes、エンコーダーはデータ ブロックの末尾にある文字を内部バッファーに格納し、次のエンコード操作で使用します。 アプリケーションは、前のブロックの末尾文字が計算に含まれるように、同じブロックで を呼び出す直前にデータ ブロックを呼び出GetByteCountGetBytesす必要があります。

GetByteCount(ReadOnlySpan<Char>, Boolean)

ソース:

Encoder.cs

派生クラスでオーバーライドされた場合、'chars' スパンの文字セットをエンコードすることによって生成されるバイト数を計算します。 パラメーターでは、計算後にエンコーダーの内部状態をクリアするかどうかを示します。

public:
 virtual int GetByteCount(ReadOnlySpan<char> chars, bool flush);

public virtual int GetByteCount (ReadOnlySpan<char> chars, bool flush);

abstract member GetByteCount : ReadOnlySpan<char> * bool -> int
override this.GetByteCount : ReadOnlySpan<char> * bool -> int

Public Overridable Function GetByteCount (chars As ReadOnlySpan(Of Char), flush As Boolean) As Integer

パラメーター

chars

ReadOnlySpan<Char>

エンコードする文字スパン。

flush

Boolean

計算後にエンコーダーの内部状態をクリアするようシミュレートする場合は true。それ以外の場合は false。

戻り値

Int32

指定した文字、および内部バッファー内の文字をエンコードすることによって生成されるバイト数。

GetByteCount(Char*, Int32, Boolean)

ソース:

Encoder.cs

重要

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

派生クラスでオーバーライドされた場合、指定した文字ポインターから始まる文字のセットをエンコードすることによって生成されるバイト数を計算します。 パラメーターでは、計算後にエンコーダーの内部状態をクリアするかどうかを示します。

public:
 virtual int GetByteCount(char* chars, int count, bool flush);

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

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

パラメーター

chars

Char*

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

count

Int32

エンコードする文字数。

flush

Boolean

計算後にエンコーダーの内部状態をクリアするようシミュレートする場合は true。それ以外の場合は false。

戻り値

Int32

指定した文字、および内部バッファー内の文字をエンコードすることによって生成されるバイト数。

属性

CLSCompliantAttribute

例外

ArgumentNullException

chars が null (Visual Basic .NET の場合は Nothing) です。

ArgumentOutOfRangeException

count が 0 未満です。

EncoderFallbackException

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

および

Fallback が EncoderExceptionFallback に設定されます。

こちらもご覧ください

• GetBytes(Char*, Int32, Byte*, Int32, Boolean)
• Reset()

GetByteCount(Char[], Int32, Int32, Boolean)

ソース:

Encoder.cs

派生クラスでオーバーライドされた場合、指定した文字配列に格納されている文字のセットをエンコードすることによって生成されるバイト数を計算します。 パラメーターでは、計算後にエンコーダーの内部状態をクリアするかどうかを示します。

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

public abstract int GetByteCount (char[] chars, int index, int count, bool flush);

abstract member GetByteCount : char[] * int * int * bool -> int

Public MustOverride Function GetByteCount (chars As Char(), index As Integer, count As Integer, flush As Boolean) As Integer

パラメーター

chars

Char[]

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

index

Int32

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

count

Int32

エンコードする文字数。

flush

Boolean

計算後にエンコーダーの内部状態をクリアするようシミュレートする場合は true。それ以外の場合は false。

戻り値

Int32

指定した文字、および内部バッファー内の文字をエンコードすることによって生成されるバイト数。

例外

ArgumentNullException

chars が nullです。

ArgumentOutOfRangeException

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

または

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

EncoderFallbackException

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

および

Fallback が EncoderExceptionFallback に設定されます。

例

次のコード例では、 メソッドを GetByteCount 使用して、Unicode Encoderを使用して文字の配列をエンコードするために必要なバイト数を返す方法を示します。

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

/* This code example produces the following output. 

8 bytes needed to encode characters.

*/

using System;
using System.Text;

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

        Encoder uniEncoder = Encoding.Unicode.GetEncoder();
        int byteCount = uniEncoder.GetByteCount(chars, 0, chars.Length, true);
        Console.WriteLine(
            "{0} bytes needed to encode characters.", byteCount
        );
    }
}

/* This example produces the following output.

8 bytes needed to encode characters.

*/

Imports System.Text
Imports Microsoft.VisualBasic.Strings

Class EncoderExample
    
    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 uniEncoder As Encoder = Encoding.Unicode.GetEncoder()
        Dim byteCount As Integer = _
            uniEncoder.GetByteCount(chars, 0, chars.Length, True)
        Console.WriteLine("{0} bytes needed to encode characters.", byteCount)
    End Sub
End Class
'
'This example produces the following output.
'
'8 bytes needed to encode characters.
'

こちらもご覧ください

• GetBytes(Char[], Int32, Int32, Byte[], Int32, Boolean)
• Reset()