Encoder.Convert Methode
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Konvertiert einen Puffer oder ein Array von Unicode-Zeichen in eine codierte Bytefolge.
Überlädt
| Convert(ReadOnlySpan<Char>, Span<Byte>, Boolean, Int32, Int32, Boolean) |
Konvertiert eine Spanne von Unicode-Zeichen in eine codierte Bytesequenz und speichert das Ergebnis in einem anderen Puffer. |
| Convert(Char*, Int32, Byte*, Int32, Boolean, Int32, Int32, Boolean) |
Konvertiert einen Puffer von Unicode-Zeichen in eine codierte Bytesequenz und speichert das Ergebnis in einem anderen Puffer. |
| Convert(Char[], Int32, Int32, Byte[], Int32, Int32, Boolean, Int32, Int32, Boolean) |
Konvertiert ein Array von Unicode-Zeichen in eine codierte Bytesequenz und speichert das Ergebnis in einem Bytesarray. |
Convert(ReadOnlySpan<Char>, Span<Byte>, Boolean, Int32, Int32, Boolean)
Konvertiert eine Spanne von Unicode-Zeichen in eine codierte Bytesequenz und speichert das Ergebnis in einem anderen Puffer.
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 -> unitPublic 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>
Die Spanne der UTF-16-codierten Zeichen, die konvertiert werden sollen.
- flush
- Boolean
true, um anzugeben, dass keine weiteren Daten konvertiert werden; andernfalls false.
- charsUsed
- Int32
In der Rückgabe dieser Methode ist die Anzahl der Zeichen aus chars enthalten, die von der Konvertierung verwendet wurden. Dieser Parameter wird nicht initialisiert übergeben.
- bytesUsed
- Int32
In der Rückgabe dieser Methode ist die Anzahl der Bytes enthalten, die bei der Konvertierung verwendet wurden. Dieser Parameter wird nicht initialisiert übergeben.
- completed
- Boolean
Enthält nach Ausführung dieser Methode true, wenn alle Zeichen in chars konvertiert wurden, andernfalls false. Dieser Parameter wird nicht initialisiert übergeben.
Hinweise
Denken Sie daran, dass das -Objekt den Encoder Zustand zwischen Aufrufen von Convert speichert. Wenn die Anwendung mit einem Datenstrom fertig ist, sollte der Parameter auf festgelegt flush true werden, um sicherzustellen, dass die Zustandsinformationen geleert werden. Mit dieser Einstellung ignoriert der Encoder ungültige Bytes am Ende des Datenblocks und löscht den internen Puffer. Alle verbleibenden verarbeiteten Daten, die Teil einer logischen Einheit sind, z. B. das hohe Ersatzzeichen eines Ersatzzeichenpaars, werden gemäß den aktuellen Fallbackeinstellungen konvertiert.
Die Convert -Methode ist so konzipiert, dass sie in einer -Schleife verwendet wird, um eine beliebige Menge von Eingaben zu codieren, z. B. aus einer Datei oder einem Stream gelesene Daten. Die Ausgabe des Codierungsvorgangs wird in einem Puffer fester Größe gespeichert. GetBytes löst eine Ausnahme aus, wenn der Ausgabepuffer nicht groß genug ist, füllt jedoch Convert so viel Speicherplatz wie möglich aus und gibt die gelesenen Zeichen und geschriebenen Bytes zurück. Weitere Kommentare finden Sie auch im Encoding.GetBytes Thema.
Der completed Ausgabeparameter gibt an, ob alle Daten im Eingabepuffer konvertiert und im Ausgabepuffer gespeichert wurden. Dieser Parameter wird auf false festgelegt, wenn die vom -Parameter angegebene Anzahl von Zeichen charCount nicht konvertiert werden kann, ohne die vom -Parameter angegebene Anzahl von Bytes zu byteCount überschreiten. In diesem Fall sollte die Anwendung den Inhalt des Ausgabepuffers verwenden oder einen neuen Ausgabepuffer bereitstellen, den chars Parameter um die Anzahl der vom -Parameter angegebenen Zeichen erhöhen und dann die charsUsed Convert -Methode erneut aufrufen, um die verbleibende Eingabe zu verarbeiten.
Der completed -Parameter kann auch auf festgelegt false werden, auch wenn der charsUsed -Parameter und die Char-Spannenlänge gleich sind. Diese Situation tritt auf, wenn sich noch Daten im Encoder -Objekt befinden, die nicht im Puffer gespeichert chars wurden.
Gilt für
Convert(Char*, Int32, Byte*, Int32, Boolean, Int32, Int32, Boolean)
Wichtig
Diese API ist nicht CLS-kompatibel.
- CLS-kompatible Alternative
- System.Text.Encoder.Convert(Char[], Int32, Int32, Byte[], Int32, Int32, Boolean, Int32, Int32, Boolean)
Konvertiert einen Puffer von Unicode-Zeichen in eine codierte Bytesequenz und speichert das Ergebnis in einem anderen Puffer.
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);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 -> unitabstract 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 -> unitParameter
- chars
- Char*
Die Adresse einer Zeichenfolge von UTF-16-codierten Zeichen, die konvertiert werden soll.
- charCount
- Int32
Die Anzahl der Zeichen in chars, die konvertiert werden sollen.
- bytes
- Byte*
Die Adresse eines Puffers zum Speichern der konvertierten Bytes.
- byteCount
- Int32
Die maximale Anzahl der in bytes in der Konversion zu verwendenden Bytes.
- flush
- Boolean
true, um anzugeben, dass keine weiteren Daten konvertiert werden; andernfalls false.
- charsUsed
- Int32
In der Rückgabe dieser Methode ist die Anzahl der Zeichen aus chars enthalten, die von der Konvertierung verwendet wurden. Dieser Parameter wird nicht initialisiert übergeben.
- bytesUsed
- Int32
In der Rückgabe dieser Methode ist die Anzahl der Bytes enthalten, die bei der Konvertierung verwendet wurden. Dieser Parameter wird nicht initialisiert übergeben.
- completed
- Boolean
In der Rückgabe dieser Methode ist true enthalten, wenn alle von charCount angegebenen Zeichen konvertiert wurden; andernfalls false. Dieser Parameter wird nicht initialisiert übergeben.
- Attribute
Ausnahmen
chars oder bytes ist null(Nothing).
charCount oder byteCount ist kleiner als 0.
Der Ausgabepuffer ist zu klein, um die konvertierte Eingabe zu enthalten. Der Ausgabepuffer muss mindestens so groß sein, wie durch die GetByteCount-Methode angegeben.
Es ist ein Fallback aufgetreten (weitere Informationen finden Sie unter Zeichencodierung in .NET).
- und -
Für Fallback ist EncoderExceptionFallback festgelegt.
Hinweise
Denken Sie daran, dass das -Objekt den Encoder Zustand zwischen Aufrufen von Convert speichert. Wenn die Anwendung mit einem Datenstrom fertig ist, sollte der Parameter auf festgelegt flush true werden, um sicherzustellen, dass die Zustandsinformationen geleert werden. Mit dieser Einstellung ignoriert der Encoder ungültige Bytes am Ende des Datenblocks und löscht den internen Puffer. Alle verbleibenden verarbeiteten Daten, die Teil einer logischen Einheit sind, z. B. das hohe Ersatzzeichen eines Ersatzzeichenpaars, werden gemäß den aktuellen Fallbackeinstellungen konvertiert.
Die Convert -Methode ist so konzipiert, dass sie in einer -Schleife verwendet wird, um eine beliebige Menge von Eingaben zu codieren, z. B. aus einer Datei oder einem Stream gelesene Daten. Die Ausgabe des Codierungsvorgangs wird in einem Puffer fester Größe gespeichert. GetBytes löst eine Ausnahme aus, wenn der Ausgabepuffer nicht groß genug ist, füllt jedoch Convert so viel Speicherplatz wie möglich aus und gibt die gelesenen Zeichen und geschriebenen Bytes zurück. Weitere Kommentare finden Sie auch im Encoding.GetBytes Thema.
Der completed Ausgabeparameter gibt an, ob alle Daten im Eingabepuffer konvertiert und im Ausgabepuffer gespeichert wurden. Dieser Parameter wird auf false festgelegt, wenn die vom -Parameter angegebene Anzahl von Zeichen charCount nicht konvertiert werden kann, ohne die vom -Parameter angegebene Anzahl von Bytes zu byteCount überschreiten. In diesem Fall sollte die Anwendung den Inhalt des Ausgabepuffers verwenden oder einen neuen Ausgabepuffer bereitstellen, den chars Parameter um die Anzahl der vom -Parameter angegebenen Zeichen erhöhen und dann die charsUsed Convert -Methode erneut aufrufen, um die verbleibende Eingabe zu verarbeiten.
Der completed -Parameter kann auch auf festgelegt false werden, obwohl die charsUsed Parameter und charCount gleich sind. Diese Situation tritt auf, wenn sich noch Daten im Encoder -Objekt befinden, die nicht im Puffer gespeichert chars wurden.
Gilt für
Convert(Char[], Int32, Int32, Byte[], Int32, Int32, Boolean, Int32, Int32, Boolean)
Konvertiert ein Array von Unicode-Zeichen in eine codierte Bytesequenz und speichert das Ergebnis in einem Bytesarray.
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 -> unitPublic 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[]
Ein Array zu konvertierender Zeichen.
- charIndex
- Int32
Das erste zu konvertierende Element von chars.
- charCount
- Int32
Die Anzahl der zu konvertierenden Elemente aus chars.
- bytes
- Byte[]
Ein Array, in dem die konvertierten Bytes gespeichert werden.
- byteIndex
- Int32
Das erste Element von bytes, in dem Daten gespeichert werden.
- byteCount
- Int32
Die maximale Anzahl der in der Konversion zu verwendenden Elemente von bytes.
- flush
- Boolean
true, um anzugeben, dass keine weiteren Daten konvertiert werden; andernfalls false.
- charsUsed
- Int32
In der Rückgabe dieser Methode ist die Anzahl der Zeichen aus chars enthalten, die von der Konvertierung verwendet wurden. Dieser Parameter wird nicht initialisiert übergeben.
- bytesUsed
- Int32
In der Rückgabe dieser Methode ist die Anzahl der Bytes enthalten, die von der Konvertierung erzeugt wurden. Dieser Parameter wird nicht initialisiert übergeben.
- completed
- Boolean
In der Rückgabe dieser Methode ist true enthalten, wenn alle von charCount angegebenen Zeichen konvertiert wurden; andernfalls false. Dieser Parameter wird nicht initialisiert übergeben.
- Attribute
Ausnahmen
chars oder bytes ist null(Nothing).
charIndex, charCount, byteIndex oder byteCount ist kleiner als 0 (null).
- oder -
Die Länge vonchars - charIndex ist kleiner als charCount.
- oder -
Die Länge vonbytes - byteIndex ist kleiner als byteCount.
Der Ausgabepuffer ist zu klein, um die konvertierte Eingabe zu enthalten. Der Ausgabepuffer muss mindestens so groß sein, wie durch die GetByteCount-Methode angegeben.
Es ist ein Fallback aufgetreten (weitere Informationen finden Sie unter Zeichencodierung in .NET).
- und -
Für Fallback ist EncoderExceptionFallback festgelegt.
Beispiele
Im folgenden Beispiel wird die -Methode verwendet, um eine Datei mit UTF-16-Zeichen in UTF-8 zu konvertieren. Anschließend wird die -Methode verwendet, um die Convert Convert UTF-8-Zeichen zurück in UTF-16-Zeichen zu konvertieren.
// 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.)
'
Hinweise
Denken Sie daran, dass das -Objekt den Encoder Zustand zwischen Aufrufen von Convert speichert. Wenn die Anwendung mit einem Datenstrom fertig ist, sollte der Parameter auf festgelegt flush true werden, um sicherzustellen, dass die Zustandsinformationen geleert werden. Mit dieser Einstellung ignoriert der Encoder ungültige Bytes am Ende des Datenblocks und löscht den internen Puffer. Alle verbleibenden verarbeiteten Daten, die Teil einer logischen Einheit sind, z. B. das hohe Ersatzzeichen eines Ersatzzeichenpaars, werden gemäß den aktuellen Fallbackeinstellungen konvertiert.
Die Convert -Methode ist so konzipiert, dass sie in einer -Schleife verwendet wird, um eine beliebige Menge von Eingaben zu codieren, z. B. aus einer Datei oder einem Stream gelesene Daten. Die Ausgabe des Codierungsvorgangs wird in einem Puffer fester Größe gespeichert. GetBytes löst eine Ausnahme aus, wenn der Ausgabepuffer nicht groß genug ist, füllt jedoch Convert so viel Speicherplatz wie möglich aus und gibt die gelesenen Zeichen und geschriebenen Bytes zurück. Weitere Kommentare finden Sie auch im Encoding.GetBytes Artikel.
Der completed Ausgabeparameter gibt an, ob alle Daten im Eingabepuffer konvertiert und im Ausgabepuffer gespeichert wurden. Dieser Parameter wird auf festgelegt, wenn die vom -Parameter angegebene Anzahl von Zeichen nicht konvertiert werden kann, ohne die vom -Parameter angegebene Anzahl von false charCount Bytes zu byteCount überschreiten. In diesem Fall sollte die Anwendung den Inhalt des Ausgabepuffers verwenden oder einen neuen Ausgabepuffer bereitstellen, den Parameter um die Anzahl von Zeichen erhöhen, die vom -Parameter angegeben wird, und dann die -Methode erneut aufrufen, um die verbleibende Eingabe zu chars charsUsed Convert verarbeiten.
Der completed -Parameter kann auch auf festgelegt false werden, obwohl die Parameter charsUsed und gleich charCount sind. Diese Situation tritt auf, wenn sich noch Daten im -Objekt Encoder befinden, die nicht im Puffer gespeichert chars wurden.