Encoder.Convert Metod

Definition

Namnområde:

System.Text

Sammansättning:

mscorlib.dll

Konverterar en buffert eller matris med Unicode-tecken till en kodad bytesekvens.

Överlagringar

Name	Description
Convert(Char*, Int32, Byte*, Int32, Boolean, Int32, Int32, Boolean)	Konverterar en buffert med Unicode-tecken till en kodad bytesekvens och lagrar resultatet i en annan buffert.
Convert(Char[], Int32, Int32, Byte[], Int32, Int32, Boolean, Int32, Int32, Boolean)	Konverterar en matris med Unicode-tecken till en kodad bytesekvens och lagrar resultatet i en matris med byte.

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

Viktigt!

Detta API uppfyller inte CLS.

Alternativ som uppfyller CLS

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

Konverterar en buffert med Unicode-tecken till en kodad bytesekvens och lagrar resultatet i en annan buffert.

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)]
[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)>]
[<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

Parametrar

chars

Char*

Adressen till en sträng med UTF-16-kodade tecken som ska konverteras.

charCount

Int32

Antalet tecken som chars ska konverteras.

bytes

Byte*

Adressen till en buffert för att lagra de konverterade byteen.

byteCount

Int32

Det maximala antalet byte som bytes ska användas i konverteringen.

flush

Boolean

trueför att ange att inga ytterligare data ska konverteras. annars . false

charsUsed

Int32

När den här metoden returnerar innehåller antalet tecken från chars som användes i konverteringen. Den här parametern skickas oinitierad.

bytesUsed

Int32

När den här metoden returnerar innehåller antalet byte som användes i konverteringen. Den här parametern skickas oinitierad.

completed

Boolean

När den här metoden returnerar, innehåller true om alla tecken som angetts av charCount konverterades, falseannars . Den här parametern skickas oinitierad.

Attribut

CLSCompliantAttribute ComVisibleAttribute SecurityCriticalAttribute

Undantag

ArgumentNullException

chars eller bytes är null (Nothing).

ArgumentOutOfRangeException

charCount eller byteCount är mindre än noll.

ArgumentException

Utdatabufferten är för liten för att innehålla någon av de konverterade indata. Utdatabufferten ska vara större än eller lika med den storlek som anges av GetByteCount metoden.

EncoderFallbackException

En reserv inträffade (mer information finns i Character Encoding i .NET)

-och-

Fallback är inställt på EncoderExceptionFallback.

Kommentarer

Kom ihåg att objektet Encoder sparar tillstånd mellan anrop till Convert. När programmet är klart med en dataström bör den ange parametern flush till true för att se till att tillståndsinformationen rensas. Med den här inställningen ignorerar kodaren ogiltiga byte i slutet av datablocket och rensar den interna bufferten. Alla återstående bearbetade data som ingår i en logisk enhet, till exempel ett surrogatpars höga surrogatpar, konverteras enligt de aktuella reservinställningarna.

Metoden Convert är utformad för att användas i en loop för att koda en godtycklig mängd indata, till exempel data som lästs från en fil eller dataström. Den lagrar utdata från kodningsåtgärden i en buffert med fast storlek. GetBytes genererar ett undantag om utdatabufferten inte är tillräckligt stor, men Convert fyller så mycket utrymme som möjligt och returnerar teckenläsningen och byte som skrivits. Se även avsnittet Encoding.GetBytes för fler kommentarer.

Utdataparametern completed anger om alla data i indatabufferten konverterades och lagrades i utdatabufferten. Den här parametern är inställd på false om antalet tecken som anges av parametern charCount inte kan konverteras utan att överskrida det antal byte som anges av parametern byteCount . I så fall bör programmet använda innehållet i utdatabufferten eller tillhandahålla en ny utdatabuffert, öka chars parametern med det antal tecken som anges av parametern charsUsed och sedan anropa Convert metoden igen för att bearbeta återstående indata.

Parametern completed kan också anges till false, även om parametrarna charsUsed och charCount är lika. Den här situationen uppstår om det fortfarande finns data i Encoder objektet som inte har lagrats i bufferten chars .

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

Konverterar en matris med Unicode-tecken till en kodad bytesekvens och lagrar resultatet i en matris med byte.

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

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

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

Parametrar

chars

Char[]

En matris med tecken som ska konverteras.

charIndex

Int32

Det första elementet chars i att konvertera.

charCount

Int32

Antalet element som ska konverteras chars .

bytes

Byte[]

En matris där konverterade byte lagras.

byteIndex

Int32

Det första elementet bytes där data lagras.

byteCount

Int32

Det maximala antalet element bytes som ska användas i konverteringen.

flush

Boolean

trueför att ange att inga ytterligare data ska konverteras. annars . false

charsUsed

Int32

När den här metoden returnerar innehåller antalet tecken från chars som användes i konverteringen. Den här parametern skickas oinitierad.

bytesUsed

Int32

När den här metoden returnerar innehåller antalet byte som har skapats av konverteringen. Den här parametern skickas oinitierad.

completed

Boolean

När den här metoden returnerar, innehåller true om alla tecken som angetts av charCount konverterades, falseannars . Den här parametern skickas oinitierad.

Attribut

ComVisibleAttribute

Undantag

ArgumentNullException

chars eller bytes är null (Nothing).

ArgumentOutOfRangeException

charIndex, charCount, byteIndex, eller byteCount är mindre än noll.

-eller-

Längden chars - charIndex på är mindre än .charCount

-eller-

Längden bytes - byteIndex på är mindre än .byteCount

ArgumentException

Utdatabufferten är för liten för att innehålla någon av de konverterade indata. Utdatabufferten ska vara större än eller lika med den storlek som anges av GetByteCount metoden.

EncoderFallbackException

En reserv inträffade (mer information finns i Character Encoding i .NET)

-och-

Fallback är inställt på EncoderExceptionFallback.

Exempel

I följande exempel används Convert metoden för att konvertera en fil med UTF-16 tecken till UTF-8 och använder Convert sedan metoden för att konvertera UTF-8-tecknen tillbaka till UTF-16 tecken.

// 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.)
'

Kommentarer

Kom ihåg att objektet Encoder sparar tillstånd mellan anrop till Convert. När programmet är klart med en dataström bör den ange parametern flush till true för att se till att tillståndsinformationen rensas. Med den här inställningen ignorerar kodaren ogiltiga byte i slutet av datablocket och rensar den interna bufferten. Alla återstående bearbetade data som ingår i en logisk enhet, till exempel ett surrogatpars höga surrogatpar, konverteras enligt de aktuella reservinställningarna.

Metoden Convert är utformad för att användas i en loop för att koda en godtycklig mängd indata, till exempel data som lästs från en fil eller dataström. Den lagrar utdata från kodningsåtgärden i en buffert med fast storlek. GetBytes genererar ett undantag om utdatabufferten inte är tillräckligt stor, men Convert fyller så mycket utrymme som möjligt och returnerar teckenläsningen och byte som skrivits. Encoding.GetBytes Se även artikeln för fler kommentarer.

Utdataparametern completed anger om alla data i indatabufferten konverterades och lagrades i utdatabufferten. Den här parametern är inställd på false om antalet tecken som anges av parametern charCount inte kan konverteras utan att överskrida det antal byte som anges av parametern byteCount . I så fall bör programmet använda innehållet i utdatabufferten eller tillhandahålla en ny utdatabuffert, öka chars parametern med det antal tecken som anges av parametern charsUsed och sedan anropa Convert metoden igen för att bearbeta återstående indata.

Parametern completed kan också anges till false, även om parametrarna charsUsed och charCount är lika. Den här situationen uppstår om det fortfarande finns data i Encoder objektet som inte har lagrats i bufferten chars .