Encoder.GetBytes メソッド

定義

名前空間:: System.Text

アセンブリ:: netstandard.dll

アセンブリ:: mscorlib.dll

アセンブリ:: mscorlib.dll, System.Text.Encoding.dll

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

重要

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

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

オーバーロード

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

注釈

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

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

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

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

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

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

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)

重要

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

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

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

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

[System.CLSCompliant(false)]
[System.Runtime.InteropServices.ComVisible(false)]
[System.Security.SecurityCritical]
public virtual int GetBytes(char* chars, int charCount, 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)>]
[<System.Runtime.InteropServices.ComVisible(false)>]
abstract member GetBytes : nativeptr<char> * int * nativeptr<byte> * int * bool -> int
override this.GetBytes : nativeptr<char> * int * nativeptr<byte> * int * bool -> int

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

[<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 ComVisibleAttribute SecurityCriticalAttribute

例外

ArgumentNullException

chars が null (Nothing) です。

-または-

bytes が null (Nothing) です。

ArgumentOutOfRangeException

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

ArgumentException

byteCount が結果のバイト数より小さい。

EncoderFallbackException

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

および

Fallback は EncoderExceptionFallback に設定されます。

適用対象

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

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

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 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]
'

適用対象

フィードバック

このページはお役に立ちましたか?

Encoder.GetBytes メソッド

定義

オーバーロード

注釈

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

パラメーター

返品

適用対象

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

パラメーター

返品

例外

適用対象

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

パラメーター

返品

例外

例

適用対象

フィードバック

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