Encoder.Convert Metoda
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Konwertuje bufor lub tablicę znaków Unicode na zakodowaną sekwencję bajtów.
Przeciążenia
Convert(ReadOnlySpan<Char>, Span<Byte>, Boolean, Int32, Int32, Boolean) |
Konwertuje zakres znaków Unicode na zakodowaną sekwencję bajtów i zapisuje wynik w innym buforze. |
Convert(Char*, Int32, Byte*, Int32, Boolean, Int32, Int32, Boolean) |
Konwertuje bufor znaków Unicode na zakodowaną sekwencję bajtów i zapisuje wynik w innym buforze. |
Convert(Char[], Int32, Int32, Byte[], Int32, Int32, Boolean, Int32, Int32, Boolean) |
Konwertuje tablicę znaków Unicode na zakodowaną sekwencję bajtów i zapisuje wynik w tablicy bajtów. |
Convert(ReadOnlySpan<Char>, Span<Byte>, Boolean, Int32, Int32, Boolean)
Konwertuje zakres znaków Unicode na zakodowaną sekwencję bajtów i zapisuje wynik w innym buforze.
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>
Zakres znaków zakodowanych w formacie UTF-16 do konwersji.
- flush
- Boolean
true
, aby wskazać, że nie ma być konwertowanych żadnych dalszych danych; w przeciwnym razie false
.
- charsUsed
- Int32
Gdy ta metoda zwraca wartość , zawiera liczbę znaków z metody chars
, które zostały użyte w konwersji. Ten parametr jest przekazywany jako niezainicjowany.
- bytesUsed
- Int32
Gdy ta metoda zwraca wartość , zawiera liczbę bajtów użytych w konwersji. Ten parametr jest przekazywany jako niezainicjowany.
- completed
- Boolean
Gdy ta metoda zwraca wartość , zawiera wartość , jeśli wszystkie znaki w metodzie true
chars
zostały przekonwertowane; w przeciwnym razie wartość false
. Ten parametr jest przekazywany jako niezainicjowany.
Uwagi
Należy pamiętać, Encoder że obiekt zapisuje stan między wywołaniami Convert . Gdy aplikacja jest wykonywana przy użyciu strumienia danych, powinna ustawić parametr na , aby upewnić się, że informacje o flush
true
stanie są opróżnione. W przypadku tego ustawienia koder ignoruje nieprawidłowe bajty na końcu bloku danych i czyszczy bufor wewnętrzny. Wszystkie pozostałe przetworzone dane, które są częścią jednostki logicznej, takie jak wysoki surogat pary zastępczej, są konwertowane zgodnie z bieżącymi ustawieniami rezerwy.
Metoda jest przeznaczona do przetwarzania w pętli w celu zakodowania dowolnej ilości danych wejściowych, takich jak dane odczytane Convert
z pliku lub strumienia. Dane wyjściowe operacji kodowania są przechowywane w buforze o stałym rozmiarze. GetBytes zwrócą wyjątek, jeśli bufor wyjściowy nie jest wystarczająco duży, ale wypełni jak najwięcej miejsca i zwróci odczytane znaki oraz zapisane Convert bajty. Zobacz też Encoding.GetBytes temat, aby uzyskać więcej komentarzy.
Parametr wyjściowy wskazuje, czy wszystkie dane w buforze wejściowym została przekonwertowana i completed
zapisana w buforze wyjściowym. Ten parametr jest ustawiony na, jeśli liczba znaków określona przez parametr nie może zostać przekonwertowana bez przekroczenia liczby bajtów określonej false
charCount
przez byteCount
parametr. W takiej sytuacji aplikacja powinna użyć zawartości buforu wyjściowego lub podać nowy bufor danych wyjściowych, zwiększyć parametr o liczbę znaków określoną przez parametr, a następnie ponownie wywołać metodę , aby przetworzyć pozostałe dane chars
charsUsed
Convert
wejściowe.
Parametr można również ustawić na wartość , nawet jeśli długość zakresu parametrów i znaków completed
false
jest charsUsed
równa. Taka sytuacja występuje, jeśli w obiekcie nadal istnieją Encoder dane, które nie zostały zapisane w chars
buforze.
Dotyczy
Convert(Char*, Int32, Byte*, Int32, Boolean, Int32, Int32, Boolean)
Ważne
Ten interfejs API nie jest zgodny ze specyfikacją CLS.
- Alternatywa zgodna ze specyfikacją CLS
- System.Text.Encoder.Convert(Char[], Int32, Int32, Byte[], Int32, Int32, Boolean, Int32, Int32, Boolean)
Konwertuje bufor znaków Unicode na zakodowaną sekwencję bajtów i zapisuje wynik w innym buforze.
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 -> unit
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
Parametry
- chars
- Char*
Adres ciągu znaków zakodowanych w formacie UTF-16 do konwersji.
- charCount
- Int32
Liczba znaków w do chars
konwersji.
- bytes
- Byte*
Adres buforu do przechowywania przekonwertowanych bajtów.
- byteCount
- Int32
Maksymalna liczba bajtów w bytes
programie do użycia w konwersji.
- flush
- Boolean
true
, aby wskazać, że nie ma być konwertowanych żadnych dalszych danych; w przeciwnym razie false
.
- charsUsed
- Int32
Gdy ta metoda zwraca wartość , zawiera liczbę znaków z metody chars
, które zostały użyte w konwersji. Ten parametr jest przekazywany jako niezainicjowany.
- bytesUsed
- Int32
Gdy ta metoda zwraca wartość , zawiera liczbę bajtów użytych w konwersji. Ten parametr jest przekazywany jako niezainicjowany.
- completed
- Boolean
Gdy ta metoda zwraca wartość , zawiera wartość , jeśli wszystkie znaki określone przez metodę true
charCount
zostały przekonwertowane. W przeciwnym razie wartość false
. Ten parametr jest przekazywany jako niezainicjowany.
- Atrybuty
Wyjątki
chars
lub bytes
jest null
( Nothing
).
charCount
wartość lub byteCount
jest mniejsza niż zero.
Bufor wyjściowy jest zbyt mały, aby zawierał dowolne przekonwertowane dane wejściowe. Bufor wyjściowy powinien być większy lub równy rozmiarowi wskazanego przez GetByteCount metodę.
Wystąpił rezerwowy błąd (aby uzyskać więcej informacji, zobacz Kodowanie znaków na platformie .NET)
-and-
Fallback jest ustawiona na EncoderExceptionFallback wartość .
Uwagi
Należy pamiętać, Encoder że obiekt zapisuje stan między wywołaniami Convert . Gdy aplikacja jest wykonywana przy użyciu strumienia danych, powinna ustawić parametr na , aby upewnić się, że informacje o flush
true
stanie są opróżnione. W przypadku tego ustawienia koder ignoruje nieprawidłowe bajty na końcu bloku danych i czyszczy bufor wewnętrzny. Wszystkie pozostałe przetworzone dane, które są częścią jednostki logicznej, takie jak wysoki surogat pary zastępczej, są konwertowane zgodnie z bieżącymi ustawieniami rezerwy.
Metoda jest przeznaczona do przetwarzania w pętli w celu zakodowania dowolnej ilości danych wejściowych, takich jak dane odczytane Convert
z pliku lub strumienia. Dane wyjściowe operacji kodowania są przechowywane w buforze o stałym rozmiarze. GetBytes zwrócą wyjątek, jeśli bufor wyjściowy nie jest wystarczająco duży, ale wypełni jak najwięcej miejsca i zwróci odczytane znaki oraz zapisane Convert bajty. Zobacz też Encoding.GetBytes temat, aby uzyskać więcej komentarzy.
Parametr wyjściowy wskazuje, czy wszystkie dane w buforze wejściowym została przekonwertowana i completed
zapisana w buforze wyjściowym. Ten parametr jest ustawiony na, jeśli liczba znaków określona przez parametr nie może zostać przekonwertowana bez przekroczenia liczby bajtów określonej false
charCount
przez byteCount
parametr. W takiej sytuacji aplikacja powinna użyć zawartości buforu wyjściowego lub podać nowy bufor danych wyjściowych, zwiększyć parametr o liczbę znaków określoną przez parametr, a następnie ponownie wywołać metodę , aby przetworzyć pozostałe dane chars
charsUsed
Convert
wejściowe.
Parametr completed
można również ustawić na wartość , nawet jeśli parametry i są false
charsUsed
charCount
równe. Taka sytuacja występuje, jeśli w obiekcie nadal istnieją Encoder dane, które nie zostały zapisane w chars
buforze.
Dotyczy
Convert(Char[], Int32, Int32, Byte[], Int32, Int32, Boolean, Int32, Int32, Boolean)
Konwertuje tablicę znaków Unicode na zakodowaną sekwencję bajtów i zapisuje wynik w tablicy bajtów.
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)
Parametry
- chars
- Char[]
Tablica znaków do przekonwertowania.
- charIndex
- Int32
Pierwszy element do chars
konwersji.
- charCount
- Int32
Liczba elementów do chars
przekonwertowania.
- bytes
- Byte[]
Tablica, w której są przechowywane przekonwertowane bajty.
- byteIndex
- Int32
Pierwszy element elementu bytes
, w którym są przechowywane dane.
- byteCount
- Int32
Maksymalna liczba elementów do bytes
użycia w konwersji.
- flush
- Boolean
true
, aby wskazać, że nie ma być konwertowanych żadnych dalszych danych; w przeciwnym razie false
.
- charsUsed
- Int32
Gdy ta metoda zwraca wartość , zawiera liczbę znaków z metody chars
, które zostały użyte w konwersji. Ten parametr jest przekazywany jako niezainicjowany.
- bytesUsed
- Int32
Gdy ta metoda zwraca wartość , zawiera liczbę bajtów, które zostały wytłaczane przez konwersję. Ten parametr jest przekazywany jako niezainicjowany.
- completed
- Boolean
Gdy ta metoda zwraca wartość , zawiera wartość , jeśli wszystkie znaki określone przez metodę true
charCount
zostały przekonwertowane. W przeciwnym razie wartość false
. Ten parametr jest przekazywany jako niezainicjowany.
- Atrybuty
Wyjątki
chars
lub bytes
jest null
( Nothing
).
charIndex
Wartość charCount
, , lub jest mniejsza niż byteIndex
byteCount
zero.
-lub-
Długość jest chars
- charIndex
mniejsza niż charCount
.
-lub-
Długość jest bytes
- byteIndex
mniejsza niż byteCount
.
Bufor wyjściowy jest zbyt mały, aby zawierał dowolne przekonwertowane dane wejściowe. Bufor wyjściowy powinien być większy lub równy rozmiarowi wskazanego przez GetByteCount metodę.
Wystąpił rezerwowy błąd (aby uzyskać więcej informacji, zobacz Kodowanie znaków na platformie .NET)
-and-
Fallback Jest ustawiona na EncoderExceptionFallback wartość .
Przykłady
W poniższym przykładzie użyto metody , aby przekonwertować plik Convert z kodem UTF-16 znaków na utf-8, a następnie użyto metody w celu przekonwertowania znaków UTF-8 z powrotem na znaki Convert 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.)
'
Uwagi
Należy pamiętać, Encoder że obiekt zapisuje stan między wywołaniami Convert . Gdy aplikacja jest wykonywana przy użyciu strumienia danych, powinna ustawić parametr na , aby upewnić się, że informacje o flush
true
stanie są opróżnione. W przypadku tego ustawienia koder ignoruje nieprawidłowe bajty na końcu bloku danych i czyszczy bufor wewnętrzny. Wszystkie pozostałe przetworzone dane, które są częścią jednostki logicznej, takie jak wysoki surogat pary zastępczej, są konwertowane zgodnie z bieżącymi ustawieniami rezerwy.
Metoda jest przeznaczona do przetwarzania w pętli w celu zakodowania dowolnej ilości danych wejściowych, takich jak dane odczytane Convert
z pliku lub strumienia. Dane wyjściowe operacji kodowania są przechowywane w buforze o stałym rozmiarze. GetBytes zwrócą wyjątek, jeśli bufor wyjściowy nie jest wystarczająco duży, ale wypełni jak najwięcej miejsca i zwróci odczytane znaki oraz zapisane Convert bajty. Zobacz też Encoding.GetBytes artykuł, aby uzyskać więcej komentarzy.
Parametr wyjściowy wskazuje, czy wszystkie dane w buforze wejściowym są konwertowane i completed
przechowywane w buforze wyjściowym. Ten parametr jest ustawiony na, jeśli liczba znaków określona przez parametr nie może zostać przekonwertowana bez przekroczenia liczby false
charCount
bajtów określonej przez byteCount
parametr. W takiej sytuacji aplikacja powinna użyć zawartości bufora wyjściowego lub podać nowy bufor wyjściowy, zwiększyć parametr o liczbę znaków określoną przez parametr, a następnie ponownie wywołać metodę , aby przetworzyć pozostałe dane chars
charsUsed
Convert
wejściowe.
Parametr completed
można również ustawić na wartość , nawet jeśli parametry i są false
charsUsed
charCount
równe. Taka sytuacja występuje, jeśli w obiekcie nadal istnieją Encoder dane, które nie zostały zapisane w chars
buforze.