Encoder.Convert Metode

Definisi

Ruang nama:

System.Text

Rakitan:

System.Runtime.dll

Mengonversi buffer atau array karakter Unicode menjadi urutan byte yang dikodekan.

Overload

Convert(ReadOnlySpan<Char>, Span<Byte>, Boolean, Int32, Int32, Boolean)	Mengonversi rentang karakter Unicode menjadi urutan byte yang dikodekan dan menyimpan hasilnya di buffer lain.
Convert(Char*, Int32, Byte*, Int32, Boolean, Int32, Int32, Boolean)	Mengonversi buffer karakter Unicode ke urutan byte yang dikodekan dan menyimpan hasilnya dalam buffer lain.
Convert(Char[], Int32, Int32, Byte[], Int32, Int32, Boolean, Int32, Int32, Boolean)	Mengonversi array karakter Unicode menjadi urutan byte yang dikodekan dan menyimpan hasilnya dalam array byte.

Convert(ReadOnlySpan<Char>, Span<Byte>, Boolean, Int32, Int32, Boolean)

Sumber:

Encoder.cs

Mengonversi rentang karakter Unicode menjadi urutan byte yang dikodekan dan menyimpan hasilnya di buffer lain.

public:
 virtual void Convert(ReadOnlySpan<char> chars, Span<System::Byte> bytes, bool flush, [Runtime::InteropServices::Out] int % charsUsed, [Runtime::InteropServices::Out] int % bytesUsed, [Runtime::InteropServices::Out] bool % completed);

public virtual void Convert (ReadOnlySpan<char> chars, Span<byte> bytes, bool flush, out int charsUsed, out int bytesUsed, out bool completed);

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

Public Overridable Sub Convert (chars As ReadOnlySpan(Of Char), bytes As Span(Of Byte), flush As Boolean, ByRef charsUsed As Integer, ByRef bytesUsed As Integer, ByRef completed As Boolean)

Parameter

chars

ReadOnlySpan<Char>

Rentang karakter yang dikodekan UTF-16 untuk dikonversi.

bytes

Span<Byte>

Buffer rentang untuk menyimpan byte yang dikonversi.

flush

Boolean

true untuk menunjukkan tidak ada data lebih lanjut yang akan dikonversi; jika tidak, false.

charsUsed

Int32

Ketika metode ini kembali, berisi jumlah karakter dari chars yang digunakan dalam konversi. Parameter ini diteruskan tanpa diinisialisasi.

bytesUsed

Int32

Ketika metode ini kembali, berisi jumlah byte yang digunakan dalam konversi. Parameter ini diteruskan tanpa diinisialisasi.

completed

Boolean

Ketika metode ini kembali, berisi true jika semua karakter dalam dikonversi chars ; jika tidak, false. Parameter ini diteruskan tanpa diinisialisasi.

Keterangan

Ingatlah bahwa Encoder objek menyimpan status antara panggilan ke Convert. Ketika aplikasi selesai dengan aliran data, aplikasi harus mengatur flush parameter ke untuk true memastikan bahwa informasi status dibersihkan. Dengan pengaturan ini, encoder mengabaikan byte yang tidak valid di akhir blok data dan menghapus buffer internal. Setiap data yang diproses yang tersisa yang merupakan bagian dari unit logis, seperti pengganti tinggi pasangan pengganti, dikonversi sesuai dengan pengaturan fallback saat ini.

Metode Convert ini dirancang untuk digunakan dalam perulangan untuk mengodekan jumlah input arbitrer, seperti data yang dibaca dari file atau aliran. Ini menyimpan output operasi pengodean dalam buffer ukuran tetap. GetBytes akan melemparkan pengecualian jika buffer output tidak cukup besar, tetapi Convert akan mengisi ruang sebanyak mungkin dan mengembalikan karakter yang dibaca dan byte yang ditulis. Encoding.GetBytes Lihat juga topik untuk komentar lainnya.

Parameter completed output menunjukkan apakah semua data dalam buffer input dikonversi dan disimpan dalam buffer output. Parameter ini diatur ke false jika jumlah karakter yang ditentukan oleh charCount parameter tidak dapat dikonversi tanpa melebihi jumlah byte yang ditentukan oleh byteCount parameter . Dalam situasi itu, aplikasi harus menggunakan konten buffer output atau menyediakan buffer output baru, menaikkan chars parameter dengan jumlah karakter yang ditentukan oleh charsUsed parameter, lalu memanggil Convert metode lagi untuk memproses input yang tersisa.

Parameter completed juga dapat diatur ke false, meskipun charsUsed parameter dan panjang rentang 'char' sama. Situasi ini terjadi jika masih ada data dalam Encoder objek yang belum disimpan di chars buffer.

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

Sumber:

Encoder.cs

Penting

API ini bukan kompatibel CLS.

Alternatif kompatibel CLS

System.Text.Encoder.Convert(Char[], Int32, Int32, Byte[], Int32, Int32, Boolean, Int32, Int32, Boolean)

Mengonversi buffer karakter Unicode ke urutan byte yang dikodekan dan menyimpan hasilnya dalam buffer lain.

public:
 virtual void Convert(char* chars, int charCount, System::Byte* bytes, int byteCount, bool flush, [Runtime::InteropServices::Out] int % charsUsed, [Runtime::InteropServices::Out] int % bytesUsed, [Runtime::InteropServices::Out] bool % completed);

[System.CLSCompliant(false)]
public virtual void Convert (char* chars, int charCount, byte* bytes, int byteCount, bool flush, out int charsUsed, out int bytesUsed, out bool completed);

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

Parameter

chars

Char*

Alamat string karakter yang dikodekan UTF-16 untuk dikonversi.

charCount

Int32

Jumlah karakter yang akan dikonversi chars .

bytes

Byte*

Alamat buffer untuk menyimpan byte yang dikonversi.

byteCount

Int32

Jumlah maksimum byte yang bytes digunakan dalam konversi.

flush

Boolean

true untuk menunjukkan tidak ada data lebih lanjut yang akan dikonversi; jika tidak, false.

charsUsed

Int32

Ketika metode ini kembali, berisi jumlah karakter dari chars yang digunakan dalam konversi. Parameter ini diteruskan tanpa diinisialisasi.

bytesUsed

Int32

Ketika metode ini kembali, berisi jumlah byte yang digunakan dalam konversi. Parameter ini diteruskan tanpa diinisialisasi.

completed

Boolean

Ketika metode ini kembali, berisi true jika semua karakter yang ditentukan oleh charCount dikonversi; jika tidak, false. Parameter ini diteruskan tanpa diinisialisasi.

Atribut

CLSCompliantAttribute

Pengecualian

ArgumentNullException

chars atau bytes adalah null (Nothing).

ArgumentOutOfRangeException

charCount atau byteCount kurang dari nol.

ArgumentException

Buffer output terlalu kecil untuk berisi salah satu input yang dikonversi. Buffer output harus lebih besar dari atau sama dengan ukuran yang ditunjukkan oleh GetByteCount metode .

EncoderFallbackException

Fallback terjadi (untuk informasi selengkapnya, lihat Pengodean Karakter di .NET)

-dan-

Fallback diatur ke EncoderExceptionFallback.

Keterangan

Ingatlah bahwa Encoder objek menyimpan status antara panggilan ke Convert. Ketika aplikasi selesai dengan aliran data, aplikasi harus mengatur flush parameter ke untuk true memastikan bahwa informasi status dibersihkan. Dengan pengaturan ini, encoder mengabaikan byte yang tidak valid di akhir blok data dan menghapus buffer internal. Setiap data yang diproses yang tersisa yang merupakan bagian dari unit logis, seperti pengganti tinggi pasangan pengganti, dikonversi sesuai dengan pengaturan fallback saat ini.

Metode Convert ini dirancang untuk digunakan dalam perulangan untuk mengodekan jumlah input arbitrer, seperti data yang dibaca dari file atau aliran. Ini menyimpan output operasi pengodean dalam buffer ukuran tetap. GetBytes akan melemparkan pengecualian jika buffer output tidak cukup besar, tetapi Convert akan mengisi ruang sebanyak mungkin dan mengembalikan karakter yang dibaca dan byte yang ditulis. Encoding.GetBytes Lihat juga topik untuk komentar lainnya.

Parameter completed output menunjukkan apakah semua data dalam buffer input dikonversi dan disimpan dalam buffer output. Parameter ini diatur ke false jika jumlah karakter yang ditentukan oleh charCount parameter tidak dapat dikonversi tanpa melebihi jumlah byte yang ditentukan oleh byteCount parameter . Dalam situasi itu, aplikasi harus menggunakan konten buffer output atau menyediakan buffer output baru, menaikkan chars parameter dengan jumlah karakter yang ditentukan oleh charsUsed parameter, lalu memanggil Convert metode lagi untuk memproses input yang tersisa.

Parameter completed juga dapat diatur ke false, meskipun charsUsed parameter dan charCount sama. Situasi ini terjadi jika masih ada data dalam Encoder objek yang belum disimpan di chars buffer.

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

Sumber:

Encoder.cs

Mengonversi array karakter Unicode menjadi urutan byte yang dikodekan dan menyimpan hasilnya dalam array byte.

public:
 virtual void Convert(cli::array <char> ^ chars, int charIndex, int charCount, cli::array <System::Byte> ^ bytes, int byteIndex, int byteCount, bool flush, [Runtime::InteropServices::Out] int % charsUsed, [Runtime::InteropServices::Out] int % bytesUsed, [Runtime::InteropServices::Out] bool % completed);

public virtual void Convert (char[] chars, int charIndex, int charCount, byte[] bytes, int byteIndex, int byteCount, bool flush, out int charsUsed, out int bytesUsed, out bool completed);

abstract member Convert : char[] * int * int * byte[] * int * int * bool * int * int * bool -> unit
override this.Convert : char[] * int * int * byte[] * int * int * bool * int * int * bool -> unit

Public Overridable Sub Convert (chars As Char(), charIndex As Integer, charCount As Integer, bytes As Byte(), byteIndex As Integer, byteCount As Integer, flush As Boolean, ByRef charsUsed As Integer, ByRef bytesUsed As Integer, ByRef completed As Boolean)

Parameter

chars

Char[]

Array karakter yang akan dikonversi.

charIndex

Int32

Elemen pertama yang chars akan dikonversi.

charCount

Int32

Jumlah elemen yang akan dikonversi chars .

bytes

Byte[]

Array tempat byte yang dikonversi disimpan.

byteIndex

Int32

Elemen bytes pertama tempat data disimpan.

byteCount

Int32

Jumlah maksimum elemen yang akan bytes digunakan dalam konversi.

flush

Boolean

true untuk menunjukkan tidak ada data lebih lanjut yang akan dikonversi; jika tidak, false.

charsUsed

Int32

Ketika metode ini kembali, berisi jumlah karakter dari chars yang digunakan dalam konversi. Parameter ini diteruskan tanpa diinisialisasi.

bytesUsed

Int32

Ketika metode ini kembali, berisi jumlah byte yang dihasilkan oleh konversi. Parameter ini diteruskan tanpa diinisialisasi.

completed

Boolean

Ketika metode ini kembali, berisi true jika semua karakter yang ditentukan oleh charCount dikonversi; jika tidak, false. Parameter ini diteruskan tanpa diinisialisasi.

Pengecualian

ArgumentNullException

chars atau bytes adalah null (Nothing).

ArgumentOutOfRangeException

charIndex, , charCountbyteIndex, atau byteCount kurang dari nol.

-atau-

Panjangnya chars - charIndex kurang dari .charCount

-atau-

Panjangnya bytes - byteIndex kurang dari .byteCount

ArgumentException

Buffer output terlalu kecil untuk berisi salah satu input yang dikonversi. Buffer output harus lebih besar dari atau sama dengan ukuran yang ditunjukkan oleh GetByteCount metode .

EncoderFallbackException

Fallback terjadi (untuk informasi selengkapnya, lihat Pengodean Karakter di .NET)

-dan-

Fallback diatur ke EncoderExceptionFallback.

Contoh

Contoh berikut menggunakan Convert metode untuk mengonversi file karakter UTF-16 ke UTF-8, lalu menggunakan Convert metode untuk mengonversi karakter UTF-8 kembali ke karakter UTF-16.

// This code example demonstrates the Encoder.Convert() and Decoder.Convert methods.
// This example uses files for input and output, but any source that can be expressed
// as a stream can be used instead.

    using System;
    using System.Text;
    using System.IO;

    public class Sample
    {
    static void Main(string[] args)
        {
// Create a large file of UTF-16 encoded Unicode characters. The file is named Example.txt,
// and is used as input to the Encoder.Convert() method.

            CreateTestFile("Example.txt");

// Using an input file of UTF-16 encoded characters named Example.txt, create an output file
// of UTF-8 encoded bytes named UTF8.txt.

            EncoderConvert("Example.txt", "UTF8.txt", Encoding.UTF8);

// Using an input file of UTF-8 encoded bytes named UTF8.txt, create an output file
// of UTF-16 encoded characters named UTF16.txt.

            DecoderConvert("UTF8.txt", "UTF16.txt", Encoding.UTF8);
        }

// --------------------------------------------------------------------------------------------
// Use the Encoder.Convert() method to convert a file of characters to a file of encoded bytes.
// --------------------------------------------------------------------------------------------
        static void EncoderConvert(String inputFileName, String outputFileName, Encoding enc)
        {
// Convert an input file of characters to an output file of encoded bytes.
// StreamWriter could convert the input file for us, but we'll perform the conversion
// ourselves.

            FileStream fs = new FileStream(outputFileName, FileMode.Create);
            BinaryWriter outputFile = new BinaryWriter(fs);

// StreamReader will detect Unicode encoding from the Byte Order Mark that heads the input file.
            StreamReader inputFile = new StreamReader(inputFileName);

// Get an Encoder.
            Encoder encoder = enc.GetEncoder();

// Guarantee the output buffer large enough to convert a few characters.
            int UseBufferSize = 64;
            if (UseBufferSize < enc.GetMaxByteCount(10))
                    UseBufferSize = enc.GetMaxByteCount(10);
            byte[] bytes = new byte[UseBufferSize];

// Intentionally make the input character buffer larger than the output byte buffer so the
// conversion loop executes more than one cycle.

            char[] chars = new char[UseBufferSize * 4];
            int charsRead;
            do
            {
// Read at most the number of characters that will fit in the input buffer. The return
// value is the actual number of characters read, or zero if no characters remain.
                charsRead = inputFile.Read(chars, 0, UseBufferSize * 4);

                bool completed = false;
                int charIndex = 0;
                int charsUsed;
                int bytesUsed;

                while (!completed)
                {
// If this is the last input data, flush the encoder's internal buffer and state.

                    bool flush = (charsRead == 0);
                    encoder.Convert(chars, charIndex, charsRead - charIndex,
                                    bytes, 0, UseBufferSize, flush,
                                    out charsUsed, out bytesUsed, out completed);

// The conversion produced the number of bytes indicated by bytesUsed. Write that number
// of bytes to the output file.
                    outputFile.Write(bytes, 0, bytesUsed);

// Increment charIndex to the next block of characters in the input buffer, if any, to convert.
                    charIndex += charsUsed;
                }
            }
            while(charsRead != 0);

            outputFile.Close();
            fs.Close();
            inputFile.Close();
        }

// --------------------------------------------------------------------------------------------
// Use the Decoder.Convert() method to convert a file of encoded bytes to a file of characters.
// --------------------------------------------------------------------------------------------
        static void DecoderConvert(String inputFileName, String outputFileName, Encoding enc)
        {
// Convert an input file of of encoded bytes to an output file characters.
// StreamWriter could convert the input file for us, but we'll perform the conversion
// ourselves.

            StreamWriter outputFile = new StreamWriter(outputFileName, false, Encoding.Unicode);

// Read the input as a binary file so we can detect the Byte Order Mark.
            FileStream fs = new FileStream(inputFileName, FileMode.Open);
            BinaryReader inputFile = new BinaryReader(fs);

// Get a Decoder.
            Decoder decoder = enc.GetDecoder();

// Guarantee the output buffer large enough to convert a few characters.
            int UseBufferSize = 64;
            if (UseBufferSize < enc.GetMaxCharCount(10))
                    UseBufferSize = enc.GetMaxCharCount(10);
            char[] chars = new char[UseBufferSize];

// Intentionally make the input byte buffer larger than the output character buffer so the
// conversion loop executes more than one cycle.

            byte[] bytes = new byte[UseBufferSize * 4];
            int bytesRead;
            do
            {
// Read at most the number of bytes that will fit in the input buffer. The
// return value is the actual number of bytes read, or zero if no bytes remain.

                bytesRead = inputFile.Read(bytes, 0, UseBufferSize * 4);

                bool completed = false;
                int byteIndex = 0;
                int bytesUsed;
                int charsUsed;

                while (!completed)
                {
// If this is the last input data, flush the decoder's internal buffer and state.

                    bool flush = (bytesRead == 0);
                    decoder.Convert(bytes, byteIndex, bytesRead - byteIndex,
                                    chars, 0, UseBufferSize, flush,
                                    out bytesUsed, out charsUsed, out completed);

// The conversion produced the number of characters indicated by charsUsed. Write that number
// of characters to the output file.

                    outputFile.Write(chars, 0, charsUsed);

// Increment byteIndex to the next block of bytes in the input buffer, if any, to convert.
                    byteIndex += bytesUsed;
                }
            }
            while(bytesRead != 0);

            outputFile.Close();
            fs.Close();
            inputFile.Close();
        }

// --------------------------------------------------------------------------------------------
// Create a large file of UTF-16 encoded Unicode characters.
// --------------------------------------------------------------------------------------------
        static void CreateTestFile(String FileName)
        {
// StreamWriter defaults to UTF-8 encoding so explicitly specify Unicode, that is,
// UTF-16, encoding.
            StreamWriter file = new StreamWriter(FileName, false, Encoding.Unicode);

// Write a line of text 100 times.
            for (int i = 0; i < 100; i++)
            {
                file.WriteLine("This is an example input file used by the convert example.");
            }

// Write Unicode characters from U+0000 to, but not including, the surrogate character range.
            for (char c = (char)0; c < (char)0xD800; c++)
            {
                file.Write(c);
            }
            file.Close();
        }
    }

/*
This code example produces the following results:

(Execute the -dir- console window command and examine the files created.)

Example.txt, which contains 122,594 bytes (61,297 UTF-16 encoded characters).
UTF8.txt, which contains 169,712 UTF-8 encoded bytes.
UTF16.txt, which contains 122,594 bytes (61,297 UTF-16 encoded characters).

(Execute the -comp- console window command and compare the two Unicode files.)

>comp example.txt utf16.txt /L
Comparing example.txt and utf16.txt...
Files compare OK

(The two files are equal.)

*/

' This code example demonstrates the Encoder.Convert() and Decoder.Convert methods. 
' This example uses files for input and output, but any source that can be expressed
' as a stream can be used instead.

Imports System.Text
Imports System.IO

Public Class Sample
    Shared Sub Main(ByVal args() As String) 
        ' Create a large file of UTF-16 encoded Unicode characters. The file is named Example.txt, 
        ' and is used as input to the Encoder.Convert() method. 
        CreateTestFile("Example.txt")
        
        
        ' Using an input file of UTF-16 encoded characters named Example.txt, create an output file 
        ' of UTF-8 encoded bytes named UTF8.txt.
        EncoderConvert("Example.txt", "UTF8.txt", Encoding.UTF8)
        
        ' Using an input file of UTF-8 encoded bytes named UTF8.txt, create an output file 
        ' of UTF-16 encoded characters named UTF16.txt.
        DecoderConvert("UTF8.txt", "UTF16.txt", Encoding.UTF8)
    
    End Sub
    
    ' --------------------------------------------------------------------------------------------
    ' Use the Encoder.Convert() method to convert a file of characters to a file of encoded bytes.
    ' --------------------------------------------------------------------------------------------
    Shared Sub EncoderConvert(ByVal inputFileName As String, ByVal outputFileName As String, ByVal enc As Encoding) 
        ' Convert an input file of characters to an output file of encoded bytes.
        ' StreamWriter could convert the input file for us, but we'll perform the conversion 
        ' ourselves.
        Dim fs As New FileStream(outputFileName, FileMode.Create)
        Dim outputFile As New BinaryWriter(fs)
        
        ' StreamReader will detect Unicode encoding from the Byte Order Mark that heads the input file.
        Dim inputFile As New StreamReader(inputFileName)
        
        ' Get an Encoder.
        Dim encoder As Encoder = enc.GetEncoder()
        
        ' Guarantee the output buffer large enough to convert a few characters.
        Dim UseBufferSize As Integer = 64
        If UseBufferSize < enc.GetMaxByteCount(10) Then
            UseBufferSize = enc.GetMaxByteCount(10)
        End If
        Dim bytes(UseBufferSize) As Byte
        
        ' Intentionally make the input character buffer larger than the output byte buffer so the 
        ' conversion loop executes more than one cycle. 
        Dim chars(UseBufferSize * 4) As Char
        Dim charsRead As Integer
        Do
            ' Read at most the number of characters that will fit in the input buffer. The return 
            ' value is the actual number of characters read, or zero if no characters remain. 
            charsRead = inputFile.Read(chars, 0, UseBufferSize * 4)
            
            Dim completed As Boolean = False
            Dim charIndex As Integer = 0
            Dim charsUsed As Integer
            Dim bytesUsed As Integer
            
            While Not completed
                ' If this is the last input data, flush the encoder's internal buffer and state.
                Dim flush As Boolean = charsRead = 0
                encoder.Convert(chars, charIndex, charsRead - charIndex, bytes, 0, UseBufferSize, flush, charsUsed, bytesUsed, completed)
                
                ' The conversion produced the number of bytes indicated by bytesUsed. Write that number
                ' of bytes to the output file.
                outputFile.Write(bytes, 0, bytesUsed)
                
                ' Increment charIndex to the next block of characters in the input buffer, if any, to convert.
                charIndex += charsUsed
            End While
        Loop While charsRead <> 0
        
        outputFile.Close()
        fs.Close()
        inputFile.Close()
    
    End Sub
    
    ' --------------------------------------------------------------------------------------------
    ' Use the Decoder.Convert() method to convert a file of encoded bytes to a file of characters.
    ' --------------------------------------------------------------------------------------------
    Shared Sub DecoderConvert(ByVal inputFileName As String, ByVal outputFileName As String, ByVal enc As Encoding) 
        ' Convert an input file of of encoded bytes to an output file characters.
        ' StreamWriter could convert the input file for us, but we'll perform the conversion 
        ' ourselves.
        Dim outputFile As New StreamWriter(outputFileName, False, Encoding.Unicode)
        
        ' Read the input as a binary file so we can detect the Byte Order Mark.
        Dim fs As New FileStream(inputFileName, FileMode.Open)
        Dim inputFile As New BinaryReader(fs)
        
        ' Get a Decoder.
        Dim decoder As Decoder = enc.GetDecoder()
        
        ' Guarantee the output buffer large enough to convert a few characters.
        Dim UseBufferSize As Integer = 64
        If UseBufferSize < enc.GetMaxCharCount(10) Then
            UseBufferSize = enc.GetMaxCharCount(10)
        End If
        Dim chars(UseBufferSize) As Char
        
        ' Intentionally make the input byte buffer larger than the output character buffer so the 
        ' conversion loop executes more than one cycle. 
        Dim bytes(UseBufferSize * 4) As Byte
        Dim bytesRead As Integer
        Do
            ' Read at most the number of bytes that will fit in the input buffer. The 
            ' return value is the actual number of bytes read, or zero if no bytes remain. 
            bytesRead = inputFile.Read(bytes, 0, UseBufferSize * 4)
            
            Dim completed As Boolean = False
            Dim byteIndex As Integer = 0
            Dim bytesUsed As Integer
            Dim charsUsed As Integer
            
            While Not completed
                ' If this is the last input data, flush the decoder's internal buffer and state.
                Dim flush As Boolean = bytesRead = 0
                decoder.Convert(bytes, byteIndex, bytesRead - byteIndex, chars, 0, UseBufferSize, flush, bytesUsed, charsUsed, completed)
                
                ' The conversion produced the number of characters indicated by charsUsed. Write that number
                ' of characters to the output file.
                outputFile.Write(chars, 0, charsUsed)
                
                ' Increment byteIndex to the next block of bytes in the input buffer, if any, to convert.
                byteIndex += bytesUsed
            End While
        Loop While bytesRead <> 0
        
        outputFile.Close()
        fs.Close()
        inputFile.Close()
    
    End Sub
    
    ' --------------------------------------------------------------------------------------------
    ' Create a large file of UTF-16 encoded Unicode characters. 
    ' --------------------------------------------------------------------------------------------
    Shared Sub CreateTestFile(ByVal FileName As String) 
        ' StreamWriter defaults to UTF-8 encoding so explicitly specify Unicode, that is, 
        ' UTF-16, encoding.
        Dim file As New StreamWriter(FileName, False, Encoding.Unicode)
        
        ' Write a line of text 100 times.
        Dim i As Integer
        For i = 0 To 99
            file.WriteLine("This is an example input file used by the convert example.")
        Next i
        
        ' Write Unicode characters from U+0000 to, but not including, the surrogate character range.
        Dim c As Integer
        For c = 0 To &HD800
            file.Write(ChrW(c))
        Next c
        file.Close()
    
    End Sub
End Class

'
'This code example produces the following results:
'
'(Execute the -dir- console window command and examine the files created.)
'
'Example.txt, which contains 122,594 bytes (61,297 UTF-16 encoded characters).
'UTF8.txt, which contains 169,712 UTF-8 encoded bytes.
'UTF16.txt, which contains 122,594 bytes (61,297 UTF-16 encoded characters).
'
'(Execute the -comp- console window command and compare the two Unicode files.)
'
'>comp example.txt utf16.txt /L
'Comparing example.txt and utf16.txt...
'Files compare OK
'
'(The two files are equal.)
'

Keterangan

Ingatlah bahwa Encoder objek menyimpan status antara panggilan ke Convert. Ketika aplikasi selesai dengan aliran data, aplikasi harus mengatur flush parameter ke untuk true memastikan bahwa informasi status dibersihkan. Dengan pengaturan ini, encoder mengabaikan byte yang tidak valid di akhir blok data dan menghapus buffer internal. Setiap data yang diproses yang tersisa yang merupakan bagian dari unit logis, seperti pengganti tinggi pasangan pengganti, dikonversi sesuai dengan pengaturan fallback saat ini.

Metode Convert ini dirancang untuk digunakan dalam perulangan untuk mengodekan jumlah input arbitrer, seperti data yang dibaca dari file atau aliran. Ini menyimpan output operasi pengodean dalam buffer ukuran tetap. GetBytes akan melemparkan pengecualian jika buffer output tidak cukup besar, tetapi Convert akan mengisi ruang sebanyak mungkin dan mengembalikan karakter yang dibaca dan byte yang ditulis. Encoding.GetBytes Lihat juga artikel untuk komentar lainnya.

Parameter completed output menunjukkan apakah semua data dalam buffer input dikonversi dan disimpan dalam buffer output. Parameter ini diatur ke false jika jumlah karakter yang ditentukan oleh charCount parameter tidak dapat dikonversi tanpa melebihi jumlah byte yang ditentukan oleh byteCount parameter . Dalam situasi itu, aplikasi harus menggunakan konten buffer output atau menyediakan buffer output baru, menambah chars parameter dengan jumlah karakter yang ditentukan oleh charsUsed parameter, lalu memanggil Convert metode lagi untuk memproses input yang tersisa.

Parameter completed juga dapat diatur ke false, meskipun charsUsed parameter dan charCount sama. Situasi ini terjadi jika masih ada data dalam Encoder objek yang belum disimpan di chars buffer.