Encoder.Convert Metodo

Definizione

Converte un buffer o una matrice di caratteri Unicode in una sequenza di byte codificata.

Overload

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

Converte un intervallo di caratteri Unicode in una sequenza di byte codificata e archivia il risultato in un altro buffer.

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

Converte una matrice di caratteri Unicode in una sequenza di byte codificata e archivia il risultato in un altro buffer.

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

Converte una matrice di caratteri Unicode in una sequenza di byte codificata e archivia il risultato in una matrice di byte.

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

Origine:
Encoder.cs
Origine:
Encoder.cs
Origine:
Encoder.cs

Converte un intervallo di caratteri Unicode in una sequenza di byte codificata e archivia il risultato in un altro buffer.

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

Parametri

chars
ReadOnlySpan<Char>

Intervallo di caratteri con codifica UTF-16 da convertire.

bytes
Span<Byte>

Buffer dell'intervallo in cui archiviare i byte convertiti.

flush
Boolean

true per indicare che non esistono altri dati da convertire; in caso contrario false.

charsUsed
Int32

Quando termina, questo metodo contiene il numero di caratteri di chars che sono stati usati durante la conversione. Questo parametro viene passato non inizializzato.

bytesUsed
Int32

Quando termina, questo metodo contiene il numero di byte che sono stati usati durante la conversione. Questo parametro viene passato non inizializzato.

completed
Boolean

Quando termina, questo metodo contiene true se tutti i caratteri in chars sono stati convertiti. In caso contrario, false. Questo parametro viene passato non inizializzato.

Commenti

Tenere presente che l'oggetto Encoder salva lo stato tra le chiamate a Convert. Quando l'applicazione viene eseguita con un flusso di dati, deve impostare il flush parametro su true per assicurarsi che le informazioni sullo stato vengano scaricate. Con questa impostazione, il codificatore ignora i byte non validi alla fine del blocco di dati e cancella il buffer interno. Tutti i dati elaborati rimanenti che fanno parte di un'unità logica, ad esempio il surrogato elevato di una coppia surrogata, vengono convertiti in base alle impostazioni di fallback correnti.

Il Convert metodo è progettato per essere usato in un ciclo per codificare una quantità arbitraria di input, ad esempio i dati letti da un file o un flusso. Archivia l'output dell'operazione di codifica in un buffer a dimensione fissa. GetBytes genererà un'eccezione se il buffer di output non è sufficientemente grande, ma Convert riempirà il maggior numero possibile di spazio e restituirà i caratteri letti e byte scritti. Vedere anche l'argomento Encoding.GetBytes per altri commenti.

Il completed parametro di output indica se tutti i dati nel buffer di input sono stati convertiti e archiviati nel buffer di output. Questo parametro è impostato su false se il numero di caratteri specificato dal charCount parametro non può essere convertito senza superare il numero di byte specificati dal byteCount parametro . In tal caso, l'applicazione deve usare il contenuto del buffer di output o fornire un nuovo buffer di output, incrementare il chars parametro in base al numero di caratteri specificato dal charsUsed parametro, quindi chiamare di nuovo il Convert metodo per elaborare l'input rimanente.

Il completed parametro può anche essere impostato su false, anche se la lunghezza del parametro e dell'intervallo charsUsed 'char' è uguale. Questa situazione si verifica se nell'oggetto Encoder sono ancora presenti dati che non sono stati archiviati nel chars buffer.

Si applica a

.NET 9 e altre versioni
Prodotto Versioni
.NET Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Standard 2.1

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

Origine:
Encoder.cs
Origine:
Encoder.cs
Origine:
Encoder.cs

Importante

Questa API non è conforme a CLS.

Alternativa conforme a CLS
System.Text.Encoder.Convert(Char[], Int32, Int32, Byte[], Int32, Int32, Boolean, Int32, Int32, Boolean)

Converte una matrice di caratteri Unicode in una sequenza di byte codificata e archivia il risultato in un altro buffer.

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

Parametri

chars
Char*

Indirizzo di una stringa di caratteri con codifica UTF-16 da convertire.

charCount
Int32

Numero di caratteri in chars da convertire.

bytes
Byte*

Indirizzo di un buffer in cui archiviare i byte convertiti.

byteCount
Int32

Numero massimo di byte in bytes da usare durante la conversione.

flush
Boolean

true per indicare che non esistono altri dati da convertire; in caso contrario false.

charsUsed
Int32

Quando termina, questo metodo contiene il numero di caratteri di chars che sono stati usati durante la conversione. Questo parametro viene passato non inizializzato.

bytesUsed
Int32

Quando termina, questo metodo contiene il numero di byte che sono stati usati durante la conversione. Questo parametro viene passato non inizializzato.

completed
Boolean

Quando termina, questo metodo contiene true se tutti i caratteri specificati da charCount sono stati convertiti; in caso contrario, false. Questo parametro viene passato non inizializzato.

Attributi

Eccezioni

chars o bytes è null (Nothing).

charCount o byteCount è minore di zero.

Il buffer di output è troppo piccolo per contenere l'input convertito. La dimensione del buffer di output deve essere maggiore o uguale al valore indicato dal metodo GetByteCount.

Si è verificato un fallback (per altre informazioni, vedere Codifica dei caratteri in .NET)

-e-

Fallback è impostato su EncoderExceptionFallback.

Commenti

Tenere presente che l'oggetto Encoder salva lo stato tra le chiamate a Convert. Quando l'applicazione viene eseguita con un flusso di dati, deve impostare il flush parametro su true per assicurarsi che le informazioni sullo stato vengano scaricate. Con questa impostazione, il codificatore ignora i byte non validi alla fine del blocco di dati e cancella il buffer interno. Tutti i dati elaborati rimanenti che fanno parte di un'unità logica, ad esempio il surrogato elevato di una coppia surrogata, vengono convertiti in base alle impostazioni di fallback correnti.

Il Convert metodo è progettato per essere usato in un ciclo per codificare una quantità arbitraria di input, ad esempio i dati letti da un file o un flusso. Archivia l'output dell'operazione di codifica in un buffer a dimensione fissa. GetBytes genererà un'eccezione se il buffer di output non è sufficientemente grande, ma Convert riempirà il maggior numero possibile di spazio e restituirà i caratteri letti e byte scritti. Vedere anche l'argomento Encoding.GetBytes per altri commenti.

Il completed parametro di output indica se tutti i dati nel buffer di input sono stati convertiti e archiviati nel buffer di output. Questo parametro è impostato su false se il numero di caratteri specificato dal charCount parametro non può essere convertito senza superare il numero di byte specificati dal byteCount parametro . In tal caso, l'applicazione deve usare il contenuto del buffer di output o fornire un nuovo buffer di output, incrementare il chars parametro in base al numero di caratteri specificato dal charsUsed parametro, quindi chiamare di nuovo il Convert metodo per elaborare l'input rimanente.

Il completed parametro può anche essere impostato su false, anche se i charsUsed parametri e charCount sono uguali. Questa situazione si verifica se nell'oggetto Encoder sono ancora presenti dati che non sono stati archiviati nel chars buffer.

Si applica a

.NET 9 e altre versioni
Prodotto Versioni
.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(Char[], Int32, Int32, Byte[], Int32, Int32, Boolean, Int32, Int32, Boolean)

Origine:
Encoder.cs
Origine:
Encoder.cs
Origine:
Encoder.cs

Converte una matrice di caratteri Unicode in una sequenza di byte codificata e archivia il risultato in una matrice di byte.

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);

Parametri

chars
Char[]

Matrice di caratteri da convertire.

charIndex
Int32

Primo elemento di chars da convertire.

charCount
Int32

Numero di elementi di chars da convertire.

bytes
Byte[]

Matrice in cui sono archiviati i byte convertiti.

byteIndex
Int32

Primo elemento di bytes in cui i dati vengono archiviati.

byteCount
Int32

Numero massimo di elementi di bytes da usare nella conversione.

flush
Boolean

true per indicare che non esistono altri dati da convertire; in caso contrario false.

charsUsed
Int32

Quando termina, questo metodo contiene il numero di caratteri di chars che sono stati usati durante la conversione. Questo parametro viene passato non inizializzato.

bytesUsed
Int32

Quando termina, questo metodo contiene il numero di byte prodotti dalla conversione. Questo parametro viene passato non inizializzato.

completed
Boolean

Quando termina, questo metodo contiene true se tutti i caratteri specificati da charCount sono stati convertiti; in caso contrario, false. Questo parametro viene passato non inizializzato.

Attributi

Eccezioni

chars o bytes è null (Nothing).

charIndex, charCount, byteIndex o byteCount è minore di zero.

-oppure-

La lunghezza di chars - charIndex è minore di charCount.

-oppure-

La lunghezza di bytes - byteIndex è minore di byteCount.

Il buffer di output è troppo piccolo per contenere l'input convertito. La dimensione del buffer di output deve essere maggiore o uguale al valore indicato dal metodo GetByteCount.

Si è verificato un fallback (per altre informazioni, vedere Codifica dei caratteri in .NET)

-e-

Fallback è impostato su EncoderExceptionFallback.

Esempio

Nell'esempio seguente viene utilizzato il Convert metodo per convertire un file di caratteri UTF-16 in UTF-8, quindi usa il Convert metodo per convertire nuovamente i caratteri UTF-8 in caratteri 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.)

*/

Commenti

Tenere presente che l'oggetto Encoder salva lo stato tra le chiamate a Convert. Quando l'applicazione viene eseguita con un flusso di dati, deve impostare il flush parametro su true per assicurarsi che le informazioni sullo stato vengano scaricate. Con questa impostazione, il codificatore ignora i byte non validi alla fine del blocco di dati e cancella il buffer interno. Tutti i dati elaborati rimanenti che fanno parte di un'unità logica, ad esempio il surrogato elevato di una coppia surrogata, vengono convertiti in base alle impostazioni di fallback correnti.

Il Convert metodo è progettato per essere usato in un ciclo per codificare una quantità arbitraria di input, ad esempio i dati letti da un file o un flusso. Archivia l'output dell'operazione di codifica in un buffer a dimensione fissa. GetBytes genererà un'eccezione se il buffer di output non è sufficientemente grande, ma Convert riempirà il maggior numero possibile di spazio e restituirà i caratteri letti e byte scritti. Vedere anche l'articolo Encoding.GetBytes per altri commenti.

Il completed parametro di output indica se tutti i dati nel buffer di input sono stati convertiti e archiviati nel buffer di output. Questo parametro è impostato su false se il numero di caratteri specificato dal charCount parametro non può essere convertito senza superare il numero di byte specificati dal byteCount parametro . In tal caso, l'applicazione deve usare il contenuto del buffer di output o fornire un nuovo buffer di output, incrementare il chars parametro in base al numero di caratteri specificato dal charsUsed parametro, quindi chiamare di nuovo il Convert metodo per elaborare l'input rimanente.

Il completed parametro può anche essere impostato su false, anche se i charsUsed parametri e charCount sono uguali. Questa situazione si verifica se nell'oggetto Encoder sono ancora presenti dati che non sono stati archiviati nel chars buffer.

Si applica a

.NET 9 e altre versioni
Prodotto Versioni
.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