Encoder クラス

定義

名前空間:: System.Text

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

アセンブリ:: mscorlib.dll

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

アセンブリ:: netstandard.dll

重要

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

文字のセットをバイトシーケンスに変換します。

public ref class Encoder abstract

public abstract class Encoder

[System.Serializable]
public abstract class Encoder

[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public abstract class Encoder

type Encoder = class

[<System.Serializable>]
type Encoder = class

[<System.Serializable>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type Encoder = class

Public MustInherit Class Encoder

継承: Object
Encoder

属性: SerializableAttribute ComVisibleAttribute

例

次の例では、指定したエンコードを使用して Unicode 文字の配列をバイトブロックに変換する方法を示します。比較のために、文字の配列は最初に UTF7Encodingを使用してエンコードされます。次に、文字の配列は Encoderを使用してエンコードされます。

using System;
using System.Text;

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

        // Encode characters using an Encoding object.
        Encoding encoding = Encoding.UTF7;
        Console.WriteLine("Using Encoding\n--------------");

        // Encode complete array for comparison.
        Byte[] allCharactersFromEncoding = encoding.GetBytes(chars);
        Console.WriteLine("All characters encoded:");
        ShowArray(allCharactersFromEncoding);

        // Encode characters, one-by-one.
        // The Encoding object will NOT maintain state between calls.
        Byte[] firstchar = encoding.GetBytes(chars, 0, 1);
        Console.WriteLine("First character:");
        ShowArray(firstchar);

        Byte[] secondchar = encoding.GetBytes(chars, 1, 1);
        Console.WriteLine("Second character:");
        ShowArray(secondchar);

        Byte[] thirdchar = encoding.GetBytes(chars, 2, 1);
        Console.WriteLine("Third character:");
        ShowArray(thirdchar);

        Byte[] fourthchar = encoding.GetBytes(chars, 3, 1);
        Console.WriteLine("Fourth character:");
        ShowArray(fourthchar);

        // Now, encode characters using an Encoder object.
        Encoder encoder = encoding.GetEncoder();
        Console.WriteLine("Using Encoder\n-------------");

        // Encode complete array for comparison.
        Byte[] allCharactersFromEncoder = new Byte[encoder.GetByteCount(chars, 0, chars.Length, true)];
        encoder.GetBytes(chars, 0, chars.Length, allCharactersFromEncoder, 0, true);
        Console.WriteLine("All characters encoded:");
        ShowArray(allCharactersFromEncoder);

        // Do not flush state; i.e. maintain state between calls.
        bool bFlushState = false;

        // Encode characters one-by-one.
        // By maintaining state, the Encoder will not store extra bytes in the output.
        Byte[] firstcharNoFlush = new Byte[encoder.GetByteCount(chars, 0, 1, bFlushState)];
        encoder.GetBytes(chars, 0, 1, firstcharNoFlush, 0, bFlushState);
        Console.WriteLine("First character:");
        ShowArray(firstcharNoFlush);

        Byte[] secondcharNoFlush = new Byte[encoder.GetByteCount(chars, 1, 1, bFlushState)];
        encoder.GetBytes(chars, 1, 1, secondcharNoFlush, 0, bFlushState);
        Console.WriteLine("Second character:");
        ShowArray(secondcharNoFlush);

        Byte[] thirdcharNoFlush = new Byte[encoder.GetByteCount(chars, 2, 1, bFlushState)];
        encoder.GetBytes(chars, 2, 1, thirdcharNoFlush, 0, bFlushState);
        Console.WriteLine("Third character:");
        ShowArray(thirdcharNoFlush);

        // Must flush state on last call to GetBytes().
        bFlushState = true;
        
        Byte[] fourthcharNoFlush = new Byte[encoder.GetByteCount(chars, 3, 1, bFlushState)];
        encoder.GetBytes(chars, 3, 1, fourthcharNoFlush, 0, bFlushState);
        Console.WriteLine("Fourth character:");
        ShowArray(fourthcharNoFlush);
    }

    public static void ShowArray(Array theArray) {
        foreach (Object o in theArray) {
            Console.Write("[{0}]", o);
        }
        Console.WriteLine("\n");
    }
}

/* This code example produces the following output.

Using Encoding
--------------
All characters encoded:
[43][65][67][77][65][74][81][79][103][65][54][77][45]

First character:
[43][65][67][77][45]

Second character:
[43][65][67][85][45]

Third character:
[43][65][54][65][45]

Fourth character:
[43][65][54][77][45]

Using Encoder
-------------
All characters encoded:
[43][65][67][77][65][74][81][79][103][65][54][77][45]

First character:
[43][65][67]

Second character:
[77][65][74]

Third character:
[81][79][103]

Fourth character:
[65][54][77][45]


*/

Imports System.Text
Imports Microsoft.VisualBasic.Strings

Class EncoderTest
    
    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)}
        
        ' Encode characters using an Encoding object.
        Dim encoding As Encoding = Encoding.UTF7
        Console.WriteLine( _
            "Using Encoding" & _
            ControlChars.NewLine & _
            "--------------" _
        )
        
        ' Encode complete array for comparison.
        Dim allCharactersFromEncoding As Byte() = encoding.GetBytes(chars)
        Console.WriteLine("All characters encoded:")
        ShowArray(allCharactersFromEncoding)
        
        ' Encode characters, one-by-one.
        ' The Encoding object will NOT maintain state between calls.
        Dim firstchar As Byte() = encoding.GetBytes(chars, 0, 1)
        Console.WriteLine("First character:")
        ShowArray(firstchar)
        
        Dim secondchar As Byte() = encoding.GetBytes(chars, 1, 1)
        Console.WriteLine("Second character:")
        ShowArray(secondchar)
        
        Dim thirdchar As Byte() = encoding.GetBytes(chars, 2, 1)
        Console.WriteLine("Third character:")
        ShowArray(thirdchar)
        
        Dim fourthchar As Byte() = encoding.GetBytes(chars, 3, 1)
        Console.WriteLine("Fourth character:")
        ShowArray(fourthchar)
        
        
        ' Now, encode characters using an Encoder object.
        Dim encoder As Encoder = encoding.GetEncoder()
        Console.WriteLine( _
            "Using Encoder" & _
            ControlChars.NewLine & _
            "-------------" _
        )
        
        ' Encode complete array for comparison.
        Dim allCharactersFromEncoder( _
            encoder.GetByteCount(chars, 0, chars.Length, True) _
        ) As Byte
        encoder.GetBytes(chars, 0, chars.Length, allCharactersFromEncoder, 0, True)
        Console.WriteLine("All characters encoded:")
        ShowArray(allCharactersFromEncoder)
        
        ' Do not flush state; i.e. maintain state between calls.
        Dim bFlushState As Boolean = False
        
        ' Encode characters one-by-one.
        ' By maintaining state, the Encoder will not store extra bytes in the output.
        Dim firstcharNoFlush( _
            encoder.GetByteCount(chars, 0, 1, bFlushState) _
        ) As Byte
        encoder.GetBytes(chars, 0, 1, firstcharNoFlush, 0, bFlushState)
        Console.WriteLine("First character:")
        ShowArray(firstcharNoFlush)
        
        Dim secondcharNoFlush( _
            encoder.GetByteCount(chars, 1, 1, bFlushState) _
        ) As Byte
        encoder.GetBytes(chars, 1, 1, secondcharNoFlush, 0, bFlushState)
        Console.WriteLine("Second character:")
        ShowArray(secondcharNoFlush)
        
        Dim thirdcharNoFlush( _
            encoder.GetByteCount(chars, 2, 1, bFlushState) _
        ) As Byte
        encoder.GetBytes(chars, 2, 1, thirdcharNoFlush, 0, bFlushState)
        Console.WriteLine("Third character:")
        ShowArray(thirdcharNoFlush)
        
        ' Must flush state on last call to GetBytes().
        bFlushState = True
        
        Dim fourthcharNoFlush( _
            encoder.GetByteCount(chars, 3, 1, bFlushState) _
        ) As Byte
        encoder.GetBytes(chars, 3, 1, fourthcharNoFlush, 0, bFlushState)
        Console.WriteLine("Fourth character:")
        ShowArray(fourthcharNoFlush)
    End Sub
    
    
    Public Shared Sub ShowArray(theArray As Array)
        Dim o As Object
        For Each o In  theArray
            Console.Write("[{0}]", o)
        Next o
        Console.WriteLine(ControlChars.NewLine)
    End Sub
End Class

'This code example produces the following output.
'
'Using Encoding
'--------------
'All characters encoded:
'[43][65][67][77][65][74][81][79][103][65][54][77][45]
'
'First character:
'[43][65][67][77][45]
'
'Second character:
'[43][65][67][85][45]
'
'Third character:
'[43][65][54][65][45]
'
'Fourth character:
'[43][65][54][77][45]
'
'Using Encoder
'-------------
'All characters encoded:
'[43][65][67][77][65][74][81][79][103][65][54][77][45][0]
'
'First character:
'[43][65][67][0]
'
'Second character:
'[77][65][74][0]
'
'Third character:
'[81][79][103][0]
'
'Fourth character:
'[65][54][77][45][0]
'

注釈

Encoder クラスの実装のインスタンスを取得するには、アプリケーションでEncoding実装のGetEncoder メソッドを使用する必要があります。

GetByteCountメソッドは、Unicode 文字のセットをエンコードする結果のバイト数を決定し、GetBytes メソッドは実際のエンコードを実行します。 Encoder クラスでは、これらの両方のメソッドのいくつかのバージョンを使用できます。詳細については、Encoding.GetBytesを参照してください。

Encoder オブジェクトは、ブロックにまたがる文字シーケンスを正しくエンコードできるように、GetBytes メソッドまたは Convert メソッドの連続する呼び出しの間で状態情報を保持します。また、 Encoder では、データブロックの末尾に末尾の文字が保持され、次のエンコード操作で末尾の文字が使用されます。たとえば、データブロックが一致しない高サロゲートで終わり、一致する低サロゲートが次のデータブロックにある可能性があります。そのため、 GetDecoder と GetEncoder は、ネットワーク転送とファイル操作に役立ちます。これらの操作は、多くの場合、完全なデータストリームではなくデータブロックを処理するためです。

Note

アプリケーションがデータストリームを使用して完了したら、 flush パラメーターを適切なメソッド呼び出しで true に設定して、状態情報がフラッシュされていることを確認する必要があります。例外が発生した場合、またはアプリケーションがストリームを切り替えた場合は、 Reset を呼び出して、 Encoder オブジェクトの内部状態をクリアする必要があります。

注意 (実装者)

アプリケーションがこのクラスから継承する場合は、すべてのメンバーをオーバーライドする必要があります。

コンストラクター

名前	説明
Encoder()	Encoder クラスの新しいインスタンスを初期化します。

プロパティ

名前	説明
Fallback	現在のEncoder オブジェクトのEncoderFallback オブジェクトを取得または設定します。
FallbackBuffer	現在のEncoder オブジェクトに関連付けられているEncoderFallbackBuffer オブジェクトを取得します。

メソッド

名前	説明
Convert(Char[], Int32, Int32, Byte[], Int32, Int32, Boolean, Int32, Int32, Boolean)	Unicode 文字の配列をエンコードされたバイトシーケンスに変換し、結果をバイト配列に格納します。
Convert(Char, Int32, Byte, Int32, Boolean, Int32, Int32, Boolean)	Unicode 文字のバッファーをエンコードされたバイトシーケンスに変換し、結果を別のバッファーに格納します。
Convert(ReadOnlySpan<Char>, Span<Byte>, Boolean, Int32, Int32, Boolean)	Unicode 文字のスパンをエンコードされたバイトシーケンスに変換し、結果を別のバッファーに格納します。
Equals(Object)	指定したオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetByteCount(Char[], Int32, Int32, Boolean)	派生クラスでオーバーライドされた場合、指定した文字配列から文字セットをエンコードすることによって生成されるバイト数を計算します。パラメーターは、計算後にエンコーダーの内部状態をクリアするかどうかを示します。
GetByteCount(Char*, Int32, Boolean)	派生クラスでオーバーライドされると、指定した文字ポインターから始まる文字のセットをエンコードすることによって生成されるバイト数を計算します。パラメーターは、計算後にエンコーダーの内部状態をクリアするかどうかを示します。
GetByteCount(ReadOnlySpan<Char>, Boolean)	派生クラスでオーバーライドされた場合、'chars' スパンの文字セットをエンコードすることによって生成されるバイト数を計算します。パラメーターは、計算後にエンコーダーの内部状態をクリアするかどうかを示します。
GetBytes(Char[], Int32, Int32, Byte[], Int32, Boolean)	派生クラスでオーバーライドされると、指定した文字配列の文字セットと、内部バッファー内の任意の文字を、指定したバイト配列にエンコードします。パラメーターは、変換後にエンコーダーの内部状態をクリアするかどうかを示します。
GetBytes(Char, Int32, Byte, Int32, Boolean)	派生クラスでオーバーライドされると、指定した文字ポインターから始まる文字のセットと、内部バッファー内の任意の文字を、指定したバイトポインターから始めて格納されるバイトシーケンスにエンコードします。パラメーターは、変換後にエンコーダーの内部状態をクリアするかどうかを示します。
GetBytes(ReadOnlySpan<Char>, Span<Byte>, Boolean)	派生クラスでオーバーライドされると、入力文字スパン内の文字セットと内部バッファー内の任意の文字を、入力バイトスパンに格納されているバイトシーケンスにエンコードします。パラメーターは、変換後にエンコーダーの内部状態をクリアするかどうかを示します。
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
MemberwiseClone()	現在の Objectの簡易コピーを作成します。 (継承元 Object)
Reset()	派生クラスでオーバーライドされた場合は、エンコーダーを初期状態に戻します。
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

適用対象

こちらもご覧ください

フィードバック

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