Encoder.Convert Metódus

Definíció

Unicode-karakterek pufferét vagy tömbét kódolt bájtsorozattá alakítja.

Túlterhelések

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

Unicode-karakterek sorozatát kódolt bájtsorozattá alakítja át, és az eredményt egy másik pufferben tárolja.

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

Unicode-karakterek pufferét kódolt bájtsorozattá alakítja át, és az eredményt egy másik pufferben tárolja.

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

Unicode-karakterek tömböt konvertál kódolt bájtsorozattá, és az eredményt bájtok tömbjében tárolja.

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

Forrás:
Encoder.cs
Forrás:
Encoder.cs
Forrás:
Encoder.cs
Forrás:
Encoder.cs
Forrás:
Encoder.cs

Unicode-karakterek sorozatát kódolt bájtsorozattá alakítja át, és az eredményt egy másik pufferben tárolja.

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)

Paraméterek

chars
ReadOnlySpan<Char>

Az átalakítandó UTF-16 kódolt karakterek száma.

bytes
Span<Byte>

A konvertált bájtok tárolására használt span puffer.

flush
Boolean

trueannak jelzésére, hogy nem kell további adatokat konvertálni; egyéb esetben. false

charsUsed
Int32

A metódus visszatérésekor az átalakítás során használt karakterek chars számát tartalmazza. Ez a paraméter nem inicializálva lesz átadva.

bytesUsed
Int32

A metódus visszatérésekor a konvertálás során használt bájtok számát tartalmazza. Ez a paraméter nem inicializálva lesz átadva.

completed
Boolean

A metódus visszatérésekor a program azt tartalmazza true , hogy az összes karakter chars át lett-e alakítva; falseellenkező esetben. Ez a paraméter nem inicializálva lesz átadva.

Megjegyzések

Ne feledje, hogy az objektum menti az Encoder állapotot a következő Converthívás között: . Ha az alkalmazás adatstreamdel van végrehajtva, a flush paramétert true úgy kell beállítania, hogy az állapotinformációk kiürítve legyenek. Ezzel a beállítással a kódoló figyelmen kívül hagyja az adatblokk végén található érvénytelen bájtokat, és törli a belső puffert. A logikai egység részét képező összes fennmaradó feldolgozott adat, például egy helyettesítő pár magas helyettese, a jelenlegi tartalékbeállítások szerint lesz konvertálva.

A Convert metódus úgy lett kialakítva, hogy egy hurokban tetszőleges mennyiségű bemenetet kódoljon, például egy fájlból vagy streamből beolvasott adatokat. A kódolási művelet kimenetét rögzített méretű pufferben tárolja. GetBytes kivételt eredményez, ha a kimeneti puffer nem elég nagy, de Convert a lehető legtöbb helyet kitölti, és visszaadja az olvasási és bájtos karaktereket. További megjegyzésekért lásd a Encoding.GetBytes témakört.

A completed kimeneti paraméter azt jelzi, hogy a bemeneti pufferben lévő összes adat konvertálva lett-e és tárolva lett-e a kimeneti pufferben. Ez a paraméter akkor false van beállítva, ha a paraméter által charCount megadott karakterek száma nem konvertálható a paraméter által byteCount megadott bájtok számának túllépése nélkül. Ebben az esetben az alkalmazásnak a kimeneti puffer tartalmát kell használnia, vagy új kimeneti puffert kell biztosítania, növelnie kell a chars paramétert a charsUsed paraméter által megadott karakterek számával, majd újra meg kell hívnia a Convert metódust a fennmaradó bemenet feldolgozásához.

A completed paraméter is beállítható, annak ellenére, hogy falsea paraméter és a charsUsed "karakter" hossz egyenlő. Ez a helyzet akkor fordul elő, ha még mindig vannak olyan adatok az Encoder objektumban, amelyeket nem tároltak a chars pufferben.

A következőre érvényes:

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

Forrás:
Encoder.cs
Forrás:
Encoder.cs
Forrás:
Encoder.cs
Forrás:
Encoder.cs
Forrás:
Encoder.cs

Fontos

Ez az API nem CLS-kompatibilis.

CLS-kompatibilis alternatíva
System.Text.Encoder.Convert(Char[], Int32, Int32, Byte[], Int32, Int32, Boolean, Int32, Int32, Boolean)

Unicode-karakterek pufferét kódolt bájtsorozattá alakítja át, és az eredményt egy másik pufferben tárolja.

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)]
[System.Runtime.InteropServices.ComVisible(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)]
[System.Runtime.InteropServices.ComVisible(false)]
[System.Security.SecurityCritical]
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
[<System.CLSCompliant(false)>]
[<System.Runtime.InteropServices.ComVisible(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
[<System.CLSCompliant(false)>]
[<System.Runtime.InteropServices.ComVisible(false)>]
[<System.Security.SecurityCritical>]
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

Paraméterek

chars
Char*

Az átalakítandó UTF-16 kódolt karakterekből álló sztring címe.

charCount
Int32

Az átalakítandó karakterek chars száma.

bytes
Byte*

A konvertált bájtok tárolására használt puffer címe.

byteCount
Int32

Az átalakításhoz használandó bájtok bytes maximális száma.

flush
Boolean

trueannak jelzésére, hogy nem kell további adatokat konvertálni; egyéb esetben. false

charsUsed
Int32

A metódus visszatérésekor az átalakítás során használt karakterek chars számát tartalmazza. Ez a paraméter nem inicializálva lesz átadva.

bytesUsed
Int32

A metódus visszatérésekor a konvertálás során használt bájtok számát tartalmazza. Ez a paraméter nem inicializálva lesz átadva.

completed
Boolean

A metódus visszatérésekor a program azt tartalmazza true , hogy a program az összes megadott charCount karaktert konvertálta-e, falseellenkező esetben. Ez a paraméter nem inicializálva lesz átadva.

Attribútumok

Kivételek

charsvagy bytes (nullNothing).

charCount vagy byteCount kisebb, mint nulla.

A kimeneti puffer túl kicsi ahhoz, hogy a konvertált bemenetek bármelyikét tartalmazza. A kimeneti puffernek nagyobbnak vagy egyenlőnek kell lennie a módszer által GetByteCount jelzett méretnél.

Hiba történt (további információ: Acharacter kódolása a .NET)

-és-

Fallback EncoderExceptionFallbackértékre van állítva.

Megjegyzések

Ne feledje, hogy az objektum menti az Encoder állapotot a következő Converthívás között: . Ha az alkalmazás adatstreamdel van végrehajtva, a flush paramétert true úgy kell beállítania, hogy az állapotinformációk kiürítve legyenek. Ezzel a beállítással a kódoló figyelmen kívül hagyja az adatblokk végén található érvénytelen bájtokat, és törli a belső puffert. A logikai egység részét képező összes fennmaradó feldolgozott adat, például egy helyettesítő pár magas helyettese, a jelenlegi tartalékbeállítások szerint lesz konvertálva.

A Convert metódus úgy lett kialakítva, hogy egy hurokban tetszőleges mennyiségű bemenetet kódoljon, például egy fájlból vagy streamből beolvasott adatokat. A kódolási művelet kimenetét rögzített méretű pufferben tárolja. GetBytes kivételt eredményez, ha a kimeneti puffer nem elég nagy, de Convert a lehető legtöbb helyet kitölti, és visszaadja az olvasási és bájtos karaktereket. További megjegyzésekért lásd a Encoding.GetBytes témakört.

A completed kimeneti paraméter azt jelzi, hogy a bemeneti pufferben lévő összes adat konvertálva lett-e és tárolva lett-e a kimeneti pufferben. Ez a paraméter akkor false van beállítva, ha a paraméter által charCount megadott karakterek száma nem konvertálható a paraméter által byteCount megadott bájtok számának túllépése nélkül. Ebben az esetben az alkalmazásnak a kimeneti puffer tartalmát kell használnia, vagy új kimeneti puffert kell biztosítania, növelnie kell a chars paramétert a charsUsed paraméter által megadott karakterek számával, majd újra meg kell hívnia a Convert metódust a fennmaradó bemenet feldolgozásához.

A completed paraméter is beállítható, annak ellenére, hogy falsea paraméterek és charsUsed a charCount paraméterek egyenlők. Ez a helyzet akkor fordul elő, ha még mindig vannak olyan adatok az Encoder objektumban, amelyeket nem tároltak a chars pufferben.

A következőre érvényes:

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

Forrás:
Encoder.cs
Forrás:
Encoder.cs
Forrás:
Encoder.cs
Forrás:
Encoder.cs
Forrás:
Encoder.cs

Unicode-karakterek tömböt konvertál kódolt bájtsorozattá, és az eredményt bájtok tömbjében tárolja.

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);
[System.Runtime.InteropServices.ComVisible(false)]
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
[<System.Runtime.InteropServices.ComVisible(false)>]
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)

Paraméterek

chars
Char[]

Átalakítandó karakterek tömbje.

charIndex
Int32

Az átalakítás első eleme chars .

charCount
Int32

Az átalakítandó elemek chars száma.

bytes
Byte[]

Egy tömb, amelyben a konvertált bájtok tárolása történik.

byteIndex
Int32

Az adatok tárolásának bytes első eleme.

byteCount
Int32

Az átalakítás során használandó elemek bytes maximális száma.

flush
Boolean

trueannak jelzésére, hogy nem kell további adatokat konvertálni; egyéb esetben. false

charsUsed
Int32

A metódus visszatérésekor az átalakítás során használt karakterek chars számát tartalmazza. Ez a paraméter nem inicializálva lesz átadva.

bytesUsed
Int32

A metódus visszatérésekor a konvertálás által előállított bájtok számát tartalmazza. Ez a paraméter nem inicializálva lesz átadva.

completed
Boolean

A metódus visszatérésekor a program azt tartalmazza true , hogy a program az összes megadott charCount karaktert konvertálta-e, falseellenkező esetben. Ez a paraméter nem inicializálva lesz átadva.

Attribútumok

Kivételek

charsvagy bytes (nullNothing).

charIndex, charCount, byteIndexvagy byteCount kisebb, mint nulla.

-vagy-

A hossz chars - charIndex kisebb, mint .charCount

-vagy-

A hossz bytes - byteIndex kisebb, mint .byteCount

A kimeneti puffer túl kicsi ahhoz, hogy a konvertált bemenetek bármelyikét tartalmazza. A kimeneti puffernek nagyobbnak vagy egyenlőnek kell lennie a módszer által GetByteCount jelzett méretnél.

Hiba történt (további információ: Acharacter kódolása a .NET)

-és-

Fallback EncoderExceptionFallbackértékre van állítva.

Példák

Az alábbi példa az Convert UTF-16 karakterből álló fájl UTF-8-ra való konvertálását, majd az Convert UTF-8 karakterek UTF-16 karakterre való konvertálását használja.

// 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.)
'

Megjegyzések

Ne feledje, hogy az objektum menti az Encoder állapotot a következő Converthívás között: . Ha az alkalmazás adatstreamdel van végrehajtva, a flush paramétert true úgy kell beállítania, hogy az állapotinformációk kiürítve legyenek. Ezzel a beállítással a kódoló figyelmen kívül hagyja az adatblokk végén található érvénytelen bájtokat, és törli a belső puffert. A logikai egység részét képező összes fennmaradó feldolgozott adat, például egy helyettesítő pár magas helyettese, a jelenlegi tartalékbeállítások szerint lesz konvertálva.

A Convert metódus úgy lett kialakítva, hogy egy hurokban tetszőleges mennyiségű bemenetet kódoljon, például egy fájlból vagy streamből beolvasott adatokat. A kódolási művelet kimenetét rögzített méretű pufferben tárolja. GetBytes kivételt eredményez, ha a kimeneti puffer nem elég nagy, de Convert a lehető legtöbb helyet kitölti, és visszaadja az olvasási és bájtos karaktereket. További megjegyzésekért lásd a Encoding.GetBytes cikket.

A completed kimeneti paraméter azt jelzi, hogy a bemeneti pufferben lévő összes adat konvertálva lett-e és tárolva lett-e a kimeneti pufferben. Ez a paraméter akkor false van beállítva, ha a paraméter által charCount megadott karakterek száma nem konvertálható a paraméter által byteCount megadott bájtok számának túllépése nélkül. Ebben az esetben az alkalmazásnak a kimeneti puffer tartalmát kell használnia, vagy új kimeneti puffert kell biztosítania, növelnie kell a chars paramétert a charsUsed paraméter által megadott karakterek számával, majd újra meg kell hívnia a Convert metódust a fennmaradó bemenet feldolgozásához.

A completed paraméter is beállítható, annak ellenére, hogy falsea paraméterek és charsUsed a charCount paraméterek egyenlők. Ez a helyzet akkor fordul elő, ha még mindig vannak olyan adatok az Encoder objektumban, amelyeket nem tároltak a chars pufferben.

A következőre érvényes: