Decoder.Convert Метод

Определение

Преобразует закодированную последовательность байтов в строку или массив символов.

Перегрузки

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

Преобразует диапазон закодированных байтов в символы в кодировке UTF-16 и сохраняет результат в другом буфере диапазона.

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

Преобразует буфер закодированных байтов в символы в кодировке UTF-16 и сохраняет результат в другом буфере.

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

Преобразует массив закодированных байтов в символы в кодировке UTF-16 и сохраняет результат в другом массиве символов.

Комментарии

Помните, что Decoder объект сохраняет состояние между вызовами .Convert После завершения работы приложения с потоком данных оно должно задать параметру flush значение true , чтобы убедиться, что сведения о состоянии сбрасываются. При использовании этого параметра декодер пропускает недопустимые байты в конце блока данных и очищает внутренний буфер. Все оставшиеся обработанные данные, которые являются частью логической единицы, например высокий суррогат суррогатной пары, преобразуются в соответствии с текущими параметрами резервного копирования.

Метод Convert предназначен для использования в цикле для декодирования произвольного объема входных данных, например данных, считываемых из файла или потока. Выходные данные операции декодирования хранятся в буфере фиксированного размера. GetChars вызовет исключение, если выходной буфер недостаточно велик, но Convert будет заполнять как можно больше места и возвращать записанные байты чтения и символы при условии, что выходной массив допускает по крайней мере два символа. Дополнительные примечания см Encoding.GetChars . также.

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

Исходный код:
Decoder.cs
Исходный код:
Decoder.cs
Исходный код:
Decoder.cs

Преобразует диапазон закодированных байтов в символы в кодировке UTF-16 и сохраняет результат в другом буфере диапазона.

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

Параметры

bytes
ReadOnlySpan<Byte>

Диапазон байтов только для чтения, содержащий последовательность, которую требуется преобразовать.

chars
Span<Char>

Диапазон для сохранения преобразованных символов.

flush
Boolean

Значение true указывает, что дальнейшие данные для преобразования отсутствуют. В противном случае — значение false.

bytesUsed
Int32

При возврате этот метод содержит число байтов, созданных при преобразовании. Этот параметр передается неинициализированным.

charsUsed
Int32

При возврате этот метод содержит число символов из chars, которые использовались при преобразовании. Этот параметр передается неинициализированным.

completed
Boolean

При возврате этого метода содержит true, если все указанные символы были преобразованы, в противном случае содержит false. Этот параметр передается неинициализированным.

Комментарии

Выходной completed параметр указывает, были ли преобразованы и сохранены все данные во входном диапазоне байтов и сохранены в диапазоне символов. Этот параметр имеет значение , false если количество байтов, содержащихся в диапазоне входных байтов, невозможно преобразовать без превышения числа символов в диапазоне символов. В этом случае приложение должно использовать содержимое выходного буфера или предоставить новый выходной буфер, увеличить bytes параметр на количество байтов, указанное параметром bytesUsed , а затем снова вызвать Convert метод для обработки оставшихся входных данных.

Параметру completed также можно задать значение false, даже если bytesUsed параметр и длина диапазона байтов равны. Эта ситуация возникает, если в объекте по-прежнему Decoder есть данные, которые не были сохранены в диапазоне bytes .

Применяется к

.NET 9 и другие версии
Продукт Версии
.NET Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Standard 2.1

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

Исходный код:
Decoder.cs
Исходный код:
Decoder.cs
Исходный код:
Decoder.cs

Важно!

Этот API несовместим с CLS.

Альтернативный вариант, совместимый с CLS
System.Text.Decoder.Convert(Byte[], Int32, Int32, Char[], Int32, Int32, Boolean, Int32, Int32, Boolean)

Преобразует буфер закодированных байтов в символы в кодировке UTF-16 и сохраняет результат в другом буфере.

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

Параметры

bytes
Byte*

Адрес буфера, содержащего последовательности байтов для преобразования.

byteCount
Int32

Число байтов в bytes, которые требуется преобразовать.

chars
Char*

Адрес буфера для хранения преобразованных символов.

charCount
Int32

Максимальное число символов в chars для использования при преобразовании.

flush
Boolean

Значение true указывает, что дальнейшие данные для преобразования отсутствуют. В противном случае — значение false.

bytesUsed
Int32

При возврате этот метод содержит число байтов, созданных при преобразовании. Этот параметр передается неинициализированным.

charsUsed
Int32

При возврате этот метод содержит число символов из chars, которые использовались при преобразовании. Этот параметр передается неинициализированным.

completed
Boolean

При возврате этот метод содержит значение true, если все символы, заданные с помощью byteCount, были преобразованы. В противном случае — значение false. Этот параметр передается неинициализированным.

Атрибуты

Исключения

chars или bytes имеет значение null (Nothing).

Значение параметра charCount или byteCount меньше нуля.

Выходной буфер слишком мал, чтобы содержать преобразованные входные данные. Чтобы выходной буфер мог вмещать хотя бы одну суррогатную пару символов, его размер должен составлять по меньшей мере 2 символа.

Произошел откат (см. сведения о кодировке символов в .NET)

- и -

Параметру Fallback задается значение DecoderExceptionFallback.

Комментарии

Выходной completed параметр указывает, были ли все данные во входном буфере преобразованы и сохранены в выходном буфере. Этому параметру присваивается значение , false если число байтов, указанное byteCount параметром, не может быть преобразовано без превышения числа символов, указанного параметром charCount . В этом случае приложение должно использовать содержимое выходного буфера или предоставить новый выходной буфер, увеличить bytes параметр на количество байтов, указанное параметром bytesUsed , а затем снова вызвать Convert метод для обработки оставшихся входных данных.

Параметру completed также можно задать значение false, даже если bytesUsed параметры и byteCount равны. Эта ситуация возникает, если в объекте по-прежнему Decoder есть данные, которые не были сохранены в буфере bytes .

Применяется к

.NET 9 и другие версии
Продукт Версии
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1

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

Исходный код:
Decoder.cs
Исходный код:
Decoder.cs
Исходный код:
Decoder.cs

Преобразует массив закодированных байтов в символы в кодировке UTF-16 и сохраняет результат в другом массиве символов.

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

Параметры

bytes
Byte[]

Преобразуемый массив байтов.

byteIndex
Int32

Первый элемент преобразуемого массива bytes.

byteCount
Int32

Число преобразуемых элементов bytes.

chars
Char[]

Массив для сохранения преобразованных символов.

charIndex
Int32

Первый элемент массива chars, в котором сохраняются данные.

charCount
Int32

Максимальное число элементов в chars для использования при преобразовании.

flush
Boolean

Значение true указывает, что дальнейшие данные для преобразования отсутствуют. В противном случае — значение false.

bytesUsed
Int32

При возврате этот метод содержит число байтов, которые использовались при преобразовании. Этот параметр передается неинициализированным.

charsUsed
Int32

При возврате этот метод содержит число символов из chars, которые были созданы при преобразовании. Этот параметр передается неинициализированным.

completed
Boolean

При возврате этот метод содержит значение true, если все символы, заданные с помощью byteCount, были преобразованы. В противном случае — значение false. Этот параметр передается неинициализированным.

Атрибуты

Исключения

chars или bytes имеет значение null (Nothing).

Значение charIndex, charCount, byteIndex или byteCount меньше нуля.

-или-

Длина массива chars - charIndex меньше charCount.

-или-

Длина массива bytes - byteIndex меньше byteCount.

Выходной буфер слишком мал, чтобы содержать преобразованные входные данные. Чтобы выходной буфер мог вмещать хотя бы одну суррогатную пару символов, его размер должен составлять по меньшей мере 2 символа.

Произошел откат (см. сведения о кодировке символов в .NET)

- и -

Параметру Fallback задается значение DecoderExceptionFallback.

Примеры

В следующем примере метод используется Convert для преобразования файла символов UTF-16 в UTF-8. Затем он использует Convert метод для преобразования символов UTF-8 обратно в символы 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.)

*/

Комментарии

Выходной completed параметр указывает, были ли все данные во входном буфере преобразованы и сохранены в выходном буфере. Этому параметру присваивается значение , false если число байтов, указанное byteCount параметром, не может быть преобразовано без превышения числа символов, указанного параметром charCount . В этом случае приложение должно использовать содержимое выходного буфера или предоставить новый выходной буфер, увеличить bytes параметр на количество байтов, указанное параметром bytesUsed , а затем снова вызвать Convert метод для обработки оставшихся входных данных.

Параметру completed также можно задать значение false, даже если bytesUsed параметры и byteCount равны. Эта ситуация возникает, если в объекте по-прежнему Decoder есть данные, которые не были сохранены в буфере bytes .

Применяется к

.NET 9 и другие версии
Продукт Версии
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0