Encoder.GetBytes メソッド

定義

名前空間:

System.Text

アセンブリ:

System.Runtime.dll

派生クラスでオーバーライドされた場合、文字のセットをバイト シーケンスにエンコードします。

オーバーロード

GetBytes(ReadOnlySpan<Char>, Span<Byte>, Boolean)	派生クラスでオーバーライドされた場合、入力文字スパン内の文字セットと内部バッファー内のすべての文字を、入力バイト スパンに格納されるバイト シーケンスにエンコードします。 パラメーターでは、変換後にエンコーダーの内部状態をクリアするかどうかを示します。
GetBytes(Char*, Int32, Byte*, Int32, Boolean)	派生クラスでオーバーライドされた場合、指定した文字ポインターで始まる文字のセット、および内部バッファー内の文字を、指定したバイト ポインターを開始位置として格納されるバイト シーケンスにエンコードします。 パラメーターでは、変換後にエンコーダーの内部状態をクリアするかどうかを示します。
GetBytes(Char[], Int32, Int32, Byte[], Int32, Boolean)	派生クラスでオーバーライドされた場合、指定した文字配列に格納されている文字のセット、および内部バッファー内の文字を、指定したバイト配列にエンコードします。 パラメーターでは、変換後にエンコーダーの内部状態をクリアするかどうかを示します。

注釈

オブジェクトは への Encoder 呼び出しの間に状態を GetBytes保存します。 データストリームを使用してアプリケーションを実行する場合は、最後の呼び出しGetBytesで パラメーターを にtrue設定flushして、状態情報がフラッシュされ、エンコードされたバイトが正しく終了されるようにする必要があります。 この設定では、一致しないサロゲートや不完全な結合シーケンスなど、データ ブロックの末尾にある無効なバイトがエンコーダーによって無視され、内部バッファーがクリアされます。

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

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

アプリケーションで入力ストリームの多数のセグメントを変換する場合は、 メソッドの使用を Convert 検討してください。 GetBytes は、出力バッファーが十分な大きさでない場合は例外をスローしますが Convert 、可能な限り多くの領域を埋め、読み取りと書き込まれたバイト数を返します。 その他のコメントについては、 Encoding.GetBytes トピックも参照してください。

GetBytes(ReadOnlySpan<Char>, Span<Byte>, Boolean)

ソース:

Encoder.cs

派生クラスでオーバーライドされた場合、入力文字スパン内の文字セットと内部バッファー内のすべての文字を、入力バイト スパンに格納されるバイト シーケンスにエンコードします。 パラメーターでは、変換後にエンコーダーの内部状態をクリアするかどうかを示します。

public:
 virtual int GetBytes(ReadOnlySpan<char> chars, Span<System::Byte> bytes, bool flush);

public virtual int GetBytes (ReadOnlySpan<char> chars, Span<byte> bytes, bool flush);

abstract member GetBytes : ReadOnlySpan<char> * Span<byte> * bool -> int
override this.GetBytes : ReadOnlySpan<char> * Span<byte> * bool -> int

Public Overridable Function GetBytes (chars As ReadOnlySpan(Of Char), bytes As Span(Of Byte), flush As Boolean) As Integer

パラメーター

chars

ReadOnlySpan<Char>

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

bytes

Span<Byte>

結果のバイト シーケンスを書き込むバイト スパン。

flush

Boolean

変換後にエンコーダーの内部状態をクリアする場合は true。それ以外の場合は false。

戻り値

Int32

bytes パラメーターによって示される位置に書き込む実際のバイト数。

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

ソース:

Encoder.cs

重要

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

派生クラスでオーバーライドされた場合、指定した文字ポインターで始まる文字のセット、および内部バッファー内の文字を、指定したバイト ポインターを開始位置として格納されるバイト シーケンスにエンコードします。 パラメーターでは、変換後にエンコーダーの内部状態をクリアするかどうかを示します。

public:
 virtual int GetBytes(char* chars, int charCount, System::Byte* bytes, int byteCount, bool flush);

[System.CLSCompliant(false)]
public virtual int GetBytes (char* chars, int charCount, byte* bytes, int byteCount, bool flush);

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

パラメーター

chars

Char*

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

charCount

Int32

エンコードする文字数。

bytes

Byte*

結果のバイト シーケンスの書き込みを開始する位置へのポインター。

byteCount

Int32

書き込む最大バイト数。

flush

Boolean

変換後にエンコーダーの内部状態をクリアする場合は true。それ以外の場合は false。

戻り値

Int32

bytes パラメーターによって示される位置に書き込む実際のバイト数。

属性

CLSCompliantAttribute

例外

ArgumentNullException

chars が null (Nothing) です。

または

bytes が null (Nothing) です。

ArgumentOutOfRangeException

charCount または byteCount が 0 未満です。

ArgumentException

byteCount が結果のバイト数より少なくなっています。

EncoderFallbackException

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

および

Fallback が EncoderExceptionFallback に設定されます。

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

ソース:

Encoder.cs

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

public:
 abstract int GetBytes(cli::array <char> ^ chars, int charIndex, int charCount, cli::array <System::Byte> ^ bytes, int byteIndex, bool flush);

public abstract int GetBytes (char[] chars, int charIndex, int charCount, byte[] bytes, int byteIndex, bool flush);

abstract member GetBytes : char[] * int * int * byte[] * int * bool -> int

Public MustOverride Function GetBytes (chars As Char(), charIndex As Integer, charCount As Integer, bytes As Byte(), byteIndex As Integer, flush As Boolean) As Integer

パラメーター

chars

Char[]

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

charIndex

Int32

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

charCount

Int32

エンコードする文字数。

bytes

Byte[]

結果のバイト シーケンスを格納するバイト配列。

byteIndex

Int32

結果のバイト シーケンスを書き込む開始位置のインデックス。

flush

Boolean

変換後にエンコーダーの内部状態をクリアする場合は true。それ以外の場合は false。

戻り値

Int32

bytes に書き込まれた実際のバイト数。

例外

ArgumentNullException

chars が null (Nothing) です。

または

bytes が null (Nothing) です。

ArgumentOutOfRangeException

charIndex、charCount、または byteIndex が 0 未満です。

または

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

または

byteIndex が bytes の有効なインデックスではありません。

ArgumentException

bytes には、byteIndex から配列の末尾までに十分なサイズがなく、結果のバイトを格納できません。

EncoderFallbackException

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

および

Fallback が EncoderExceptionFallback に設定されます。

例

次の例では、文字配列から要素の範囲をエンコードし、エンコードされたバイトをバイト配列内の要素の範囲に格納する方法を示します。 メソッドは GetByteCount 、 で GetBytes必要な配列のサイズを決定するために使用されます。

using namespace System;
using namespace System::Text;
using namespace System::Collections;
int main()
{
   array<Byte>^bytes;
   
   // 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 );
   bytes = gcnew array<Byte>(byteCount);
   int bytesEncodedCount = uniEncoder->GetBytes( chars, 0, chars->Length, bytes, 0, true );
   Console::WriteLine( "{0} bytes used to encode characters.", bytesEncodedCount );
   Console::Write( "Encoded bytes: " );
   IEnumerator^ myEnum = bytes->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      Byte b = safe_cast<Byte>(myEnum->Current);
      Console::Write( "[{0}]", b );
   }

   Console::WriteLine();
}

/* This code example produces the following output.

8 bytes used to encode characters.
Encoded bytes: [160][3][163][3][166][3][169][3]

*/

using System;
using System.Text;

class EncoderExample {
    public static void Main() {
        Byte[] bytes;
        // 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);
        bytes = new Byte[byteCount];
        int bytesEncodedCount = uniEncoder.GetBytes(chars, 0, chars.Length, bytes, 0, true);
        
        Console.WriteLine(
            "{0} bytes used to encode characters.", bytesEncodedCount
        );

        Console.Write("Encoded bytes: ");
        foreach (Byte b in bytes) {
            Console.Write("[{0}]", b);
        }
        Console.WriteLine();
    }
}

/* This code example produces the following output.

8 bytes used to encode characters.
Encoded bytes: [35][0][37][0][160][3][163][3]

*/

Imports System.Text
Imports Microsoft.VisualBasic.Strings

Class EncoderExample
    
    Public Shared Sub Main()
        Dim bytes() As Byte
        ' 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)
        bytes = New Byte(byteCount - 1) {}
        Dim bytesEncodedCount As Integer = _
            uniEncoder.GetBytes(chars, 0, chars.Length, bytes, 0, True)
        
        Console.WriteLine( _
            "{0} bytes used to encode characters.", _
            bytesEncodedCount _
        )
        
        Console.Write("Encoded bytes: ")
        Dim b As Byte
        For Each b In  bytes
            Console.Write("[{0}]", b)
        Next b
        Console.WriteLine()
    End Sub
End Class

'This code example produces the following output.
'8 bytes used to encode characters.
'Encoded bytes: [35][0][37][0][160][3][163][3]
'