Encoder.Convert Metoda

Definice

Obor názvů:

System.Text

Sestavení:

System.Runtime.dll

Převede vyrovnávací paměť nebo pole znaků Unicode na zakódovanou sekvenci bajtů.

Přetížení

Convert(ReadOnlySpan<Char>, Span<Byte>, Boolean, Int32, Int32, Boolean)	Převede rozsah znaků Unicode na zakódovanou sekvenci bajtů a uloží výsledek do jiné vyrovnávací paměti.
Convert(Char*, Int32, Byte*, Int32, Boolean, Int32, Int32, Boolean)	Převede vyrovnávací paměť znaků Unicode na zakódovanou posloupnost bajtů a uloží výsledek do jiné vyrovnávací paměti.
Convert(Char[], Int32, Int32, Byte[], Int32, Int32, Boolean, Int32, Int32, Boolean)	Převede pole znaků Unicode na zakódovanou sekvenci bajtů a uloží výsledek do pole bajtů.

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

Zdroj:

Encoder.cs

Převede rozsah znaků Unicode na zakódovanou sekvenci bajtů a uloží výsledek do jiné vyrovnávací paměti.

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)

Parametry

chars

ReadOnlySpan<Char>

Rozsah znaků kódovaných UTF-16, které se mají převést.

bytes

Span<Byte>

Vyrovnávací paměť span pro uložení převedených bajtů.

flush

Boolean

trueoznačit, že žádná další data nemají být převedena; v opačném případě . false

charsUsed

Int32

Když tato metoda vrátí, obsahuje počet znaků, chars které byly použity v převodu. Tento parametr se předává neinicializovaný.

bytesUsed

Int32

Když tato metoda vrátí hodnotu , obsahuje počet bajtů, které byly použity v převodu. Tento parametr se předává neinicializovaný.

completed

Boolean

Když tato metoda vrátí, obsahuje true , pokud byly převedeny všechny znaky v chars , falsejinak . Tento parametr se předává neinicializovaný.

Poznámky

Mějte na paměti Encoder , že objekt ukládá stav mezi voláními objektu Convert. Když aplikace dokončí stream dat, měla by nastavit flush parametr na , true aby se zajistilo vyprázdnění informací o stavu. Při tomto nastavení kodér ignoruje neplatné bajty na konci datového bloku a vymaže interní vyrovnávací paměť. Všechna zbývající zpracovávaná data, která jsou součástí logické jednotky, jako je například vysoká míra náhradního páru, se převedou podle aktuálního nastavení náhradní lokality.

Metoda je navržená Convert tak, aby se používala ve smyčce ke kódování libovolného množství vstupu, jako jsou data načtená ze souboru nebo datového proudu. Ukládá výstup operace kódování do vyrovnávací paměti s pevnou velikostí. GetBytes vyvolá výjimku, pokud výstupní vyrovnávací paměť není dostatečně velká, ale Convert zaplní co nejvíce místa a vrátí přečtené znaky a zapsané bajty. Další komentáře najdete také v Encoding.GetBytes tématu.

Výstupní completed parametr označuje, jestli byla všechna data ve vstupní vyrovnávací paměti převedena a uložena ve výstupní vyrovnávací paměti. Tento parametr je nastaven na false hodnotu , pokud počet znaků určený parametrem charCount nelze převést bez překročení počtu bajtů určených parametrem byteCount . V takovém případě by aplikace měla použít obsah výstupní vyrovnávací paměti nebo poskytnout novou výstupní vyrovnávací paměť, zvýšit chars parametr o počet znaků určený parametrem charsUsed a poté znovu volat metodu Convert pro zpracování zbývajícího vstupu.

Parametr completed lze také nastavit na false, i když jsou parametr a délka rozsahu charsUsed char stejné. K této situaci dochází v případě, že v objektu Encoder stále existují data, která nebyla uložena chars ve vyrovnávací paměti.

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

Zdroj:

Encoder.cs

Důležité

Toto rozhraní API neodpovídá specifikaci CLS.

Alternativa odpovídající specifikaci CLS

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

Převede vyrovnávací paměť znaků Unicode na zakódovanou posloupnost bajtů a uloží výsledek do jiné vyrovnávací paměti.

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

Parametry

chars

Char*

Adresa řetězce znaků kódovaných UTF-16, které se mají převést.

charCount

Int32

Počet znaků, chars které se mají převést.

bytes

Byte*

Adresa vyrovnávací paměti pro uložení převedených bajtů.

byteCount

Int32

Maximální počet bajtů v bytes převodu.

flush

Boolean

trueoznačit, že žádná další data nemají být převedena; v opačném případě . false

charsUsed

Int32

Když tato metoda vrátí, obsahuje počet znaků, chars které byly použity v převodu. Tento parametr se předává neinicializovaný.

bytesUsed

Int32

Když tato metoda vrátí hodnotu , obsahuje počet bajtů, které byly použity v převodu. Tento parametr se předává neinicializovaný.

completed

Boolean

Když tato metoda vrátí, obsahuje true , pokud byly převedeny všechny znaky zadané parametrem charCount . V opačném případě false. Tento parametr se předává neinicializovaný.

Atributy

CLSCompliantAttribute

Výjimky

ArgumentNullException

chars nebo bytes je null (Nothing).

ArgumentOutOfRangeException

charCount nebo byteCount je menší než nula.

ArgumentException

Výstupní vyrovnávací paměť je příliš malá na to, aby obsahovala jakýkoli převedený vstup. Výstupní vyrovnávací paměť by měla být větší nebo rovna velikosti uvedené metodou GetByteCount .

EncoderFallbackException

Došlo k náhradnímu použití (další informace najdete v tématu Kódování znaků v .NET)

-A-

Fallback je nastavená na EncoderExceptionFallbackhodnotu .

Poznámky

Mějte na paměti Encoder , že objekt ukládá stav mezi voláními objektu Convert. Když aplikace dokončí stream dat, měla by nastavit flush parametr na , true aby se zajistilo vyprázdnění informací o stavu. Při tomto nastavení kodér ignoruje neplatné bajty na konci datového bloku a vymaže interní vyrovnávací paměť. Všechna zbývající zpracovávaná data, která jsou součástí logické jednotky, jako je například vysoká míra náhradního páru, se převedou podle aktuálního nastavení náhradní lokality.

Metoda je navržená Convert tak, aby se používala ve smyčce ke kódování libovolného množství vstupu, jako jsou data načtená ze souboru nebo datového proudu. Ukládá výstup operace kódování do vyrovnávací paměti s pevnou velikostí. GetBytes vyvolá výjimku, pokud výstupní vyrovnávací paměť není dostatečně velká, ale Convert zaplní co nejvíce místa a vrátí přečtené znaky a zapsané bajty. Další komentáře najdete také v Encoding.GetBytes tématu.

Výstupní completed parametr označuje, jestli byla všechna data ve vstupní vyrovnávací paměti převedena a uložena ve výstupní vyrovnávací paměti. Tento parametr je nastaven na false hodnotu , pokud počet znaků určený parametrem charCount nelze převést bez překročení počtu bajtů určených parametrem byteCount . V takovém případě by aplikace měla použít obsah výstupní vyrovnávací paměti nebo poskytnout novou výstupní vyrovnávací paměť, zvýšit chars parametr o počet znaků určený parametrem charsUsed a poté znovu volat metodu Convert pro zpracování zbývajícího vstupu.

Parametr completed lze také nastavit na false, i když charsUsed jsou parametry a charCount stejné. K této situaci dochází v případě, že v objektu Encoder stále existují data, která nebyla uložena chars ve vyrovnávací paměti.

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

Zdroj:

Encoder.cs

Převede pole znaků Unicode na zakódovanou sekvenci bajtů a uloží výsledek do pole bajtů.

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)

Parametry

chars

Char[]

Pole znaků, které chcete převést.

charIndex

Int32

První prvek pro chars převod.

charCount

Int32

Počet prvků, které chars se mají převést.

bytes

Byte[]

Pole, ve kterém jsou převedené bajty uloženy.

byteIndex

Int32

První prvek, bytes ve kterém jsou data uložena.

byteCount

Int32

Maximální počet prvků, které bytes se mají použít v převodu.

flush

Boolean

trueoznačit, že žádná další data nemají být převedena; v opačném případě . false

charsUsed

Int32

Když tato metoda vrátí, obsahuje počet znaků, chars které byly použity v převodu. Tento parametr se předává neinicializovaný.

bytesUsed

Int32

Když tato metoda vrátí hodnotu , obsahuje počet bajtů, které byly vytvořeny při převodu. Tento parametr se předává neinicializovaný.

completed

Boolean

Když tato metoda vrátí, obsahuje true , pokud byly převedeny všechny znaky zadané parametrem charCount . V opačném případě false. Tento parametr se předává neinicializovaný.

Výjimky

ArgumentNullException

chars nebo bytes je null (Nothing).

ArgumentOutOfRangeException

charIndex, charCount, byteIndexnebo byteCount je menší než nula.

-nebo-

Délka je chars - charIndex menší než .charCount

-nebo-

Délka je bytes - byteIndex menší než .byteCount

ArgumentException

Výstupní vyrovnávací paměť je příliš malá na to, aby obsahovala jakýkoli převedený vstup. Výstupní vyrovnávací paměť by měla být větší nebo rovna velikosti uvedené metodou GetByteCount .

EncoderFallbackException

Došlo k náhradnímu použití (další informace najdete v tématu Kódování znaků v .NET)

-A-

Fallback je nastavená na EncoderExceptionFallbackhodnotu .

Příklady

Následující příklad používá metodu Convert k převodu souboru obsahujícího UTF-16 znaků na UTF-8 a pak pomocí Convert metody převede znaky UTF-8 zpět na znaky 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.)
'

Poznámky

Mějte na paměti Encoder , že objekt ukládá stav mezi voláními objektu Convert. Když aplikace dokončí stream dat, měla by nastavit flush parametr na , true aby se zajistilo vyprázdnění informací o stavu. Při tomto nastavení kodér ignoruje neplatné bajty na konci datového bloku a vymaže interní vyrovnávací paměť. Všechna zbývající zpracovávaná data, která jsou součástí logické jednotky, jako je například vysoká míra náhradního páru, se převedou podle aktuálního nastavení náhradní lokality.

Metoda je navržená Convert tak, aby se používala ve smyčce ke kódování libovolného množství vstupu, jako jsou data načtená ze souboru nebo datového proudu. Ukládá výstup operace kódování do vyrovnávací paměti s pevnou velikostí. GetBytes vyvolá výjimku, pokud výstupní vyrovnávací paměť není dostatečně velká, ale Convert zaplní co nejvíce místa a vrátí přečtené znaky a zapsané bajty. Další komentáře najdete také v Encoding.GetBytes článku.

Výstupní completed parametr označuje, jestli byla všechna data ve vstupní vyrovnávací paměti převedena a uložena ve výstupní vyrovnávací paměti. Tento parametr je nastaven na false hodnotu , pokud počet znaků určený parametrem charCount nelze převést bez překročení počtu bajtů určených parametrem byteCount . V takovém případě by aplikace měla použít obsah výstupní vyrovnávací paměti nebo poskytnout novou výstupní vyrovnávací paměť, zvýšit chars parametr o počet znaků určený parametrem charsUsed a poté znovu volat metodu Convert pro zpracování zbývajícího vstupu.

Parametr completed lze také nastavit na false, i když charsUsed jsou parametry a charCount stejné. K této situaci dochází v případě, že v objektu Encoder stále existují data, která nebyla uložena chars ve vyrovnávací paměti.