UnicodeEncoding Construtores

Definição

Inicializa uma nova instância da classe UnicodeEncoding.

Sobrecargas

Nome Description
UnicodeEncoding()

Inicializa uma nova instância da classe UnicodeEncoding.

UnicodeEncoding(Boolean, Boolean)

Inicializa uma nova instância da classe UnicodeEncoding. Os parâmetros especificam se a ordem de bytes do big endian deve ser usada e se o GetPreamble() método retorna uma marca de ordem de bytes Unicode.

UnicodeEncoding(Boolean, Boolean, Boolean)

Inicializa uma nova instância da classe UnicodeEncoding. Os parâmetros especificam se a ordem de bytes do big endian deve ser usada, se uma marca de ordem de bytes Unicode deve ser fornecida e se uma exceção será gerada quando uma codificação inválida for detectada.

UnicodeEncoding()

Inicializa uma nova instância da classe UnicodeEncoding.

public:
 UnicodeEncoding();
public UnicodeEncoding();
Public Sub New ()

Exemplos

O exemplo a seguir demonstra como criar uma nova UnicodeEncoding instância e exibir o nome da codificação.

using System;
using System.Text;

class UnicodeEncodingExample {
    public static void Main() {
        UnicodeEncoding unicode = new UnicodeEncoding();
        String encodingName = unicode.EncodingName;
        Console.WriteLine("Encoding name: " + encodingName);
    }
}
Imports System.Text

Class UnicodeEncodingExample

    Public Shared Sub Main()
        Dim uni As New UnicodeEncoding()
        Dim encodingName As String = uni.EncodingName
        Console.WriteLine("Encoding name: " & encodingName)
    End Sub
End Class

Comentários

Esse construtor cria uma instância que usa a ordem de byte do pequeno endian, fornece uma marca de ordem de bytes Unicode e não gera uma exceção quando uma codificação inválida é detectada.

Caution

Por motivos de segurança, você deve habilitar a detecção de erros chamando o UnicodeEncoding(Boolean, Boolean, Boolean) construtor e definindo seu throwOnInvalidBytes argumento como true.

Aplica-se a

UnicodeEncoding(Boolean, Boolean)

Inicializa uma nova instância da classe UnicodeEncoding. Os parâmetros especificam se a ordem de bytes do big endian deve ser usada e se o GetPreamble() método retorna uma marca de ordem de bytes Unicode.

public:
 UnicodeEncoding(bool bigEndian, bool byteOrderMark);
public UnicodeEncoding(bool bigEndian, bool byteOrderMark);
new System.Text.UnicodeEncoding : bool * bool -> System.Text.UnicodeEncoding
Public Sub New (bigEndian As Boolean, byteOrderMark As Boolean)

Parâmetros

bigEndian
Boolean

true para usar a ordem de bytes big endian (primeiro byte mais significativo) ou false para usar a ordem de byte do endian pequeno (byte menos significativo primeiro).

byteOrderMark
Boolean

true para especificar que o GetPreamble() método retorna uma marca de ordem de bytes Unicode; caso contrário, false.

Exemplos

O exemplo a seguir demonstra como criar uma nova UnicodeEncoding instância especificando se deseja dar suporte à ordenação de bytes de endian ou big endian e à marca de ordem de bytes Unicode.

using System;
using System.Text;

class UnicodeEncodingExample {
    public static void Main() {

        // Create a UnicodeEncoding without parameters.
        UnicodeEncoding unicode = new UnicodeEncoding();

        // Create a UnicodeEncoding to support little-endian byte ordering
        // and include the Unicode byte order mark.
        UnicodeEncoding unicodeLittleEndianBOM = 
            new UnicodeEncoding(false, true);
        // Compare this UnicodeEncoding to the UnicodeEncoding without parameters.
        DescribeEquivalence(unicode.Equals(unicodeLittleEndianBOM));

        // Create a UnicodeEncoding to support little-endian byte ordering
        // and not include the Unicode byte order mark.
        UnicodeEncoding unicodeLittleEndianNoBOM =
            new UnicodeEncoding(false, false);
        // Compare this UnicodeEncoding to the UnicodeEncoding without parameters.
        DescribeEquivalence(unicode.Equals(unicodeLittleEndianNoBOM));

        // Create a UnicodeEncoding to support big-endian byte ordering
        // and include the Unicode byte order mark.
        UnicodeEncoding unicodeBigEndianBOM =
            new UnicodeEncoding(true, true);
        // Compare this UnicodeEncoding to the UnicodeEncoding without parameters.
        DescribeEquivalence(unicode.Equals(unicodeBigEndianBOM));

        // Create a UnicodeEncoding to support big-endian byte ordering
        // and not include the Unicode byte order mark.
        UnicodeEncoding unicodeBigEndianNoBOM =
            new UnicodeEncoding(true, false);
        // Compare this UnicodeEncoding to the UnicodeEncoding without parameters.
        DescribeEquivalence(unicode.Equals(unicodeBigEndianNoBOM));
    }

    public static void DescribeEquivalence(Boolean isEquivalent) {
        Console.WriteLine(
            "{0} equivalent encoding.", (isEquivalent ? "An" : "Not an")
        );
    }
}
Imports System.Text

Class UnicodeEncodingExample
    
    Public Shared Sub Main()

        ' Create a UnicodeEncoding without parameters.
        Dim unicodeDefault As New UnicodeEncoding()

        ' Create a UnicodeEncoding to support little-endian byte ordering
        ' and include the Unicode byte order mark.        
        Dim unicodeLittleEndianBOM As New UnicodeEncoding(False, True)
        ' Compare this UnicodeEncoding to the UnicodeEncoding without parameters.
        DescribeEquivalence(unicodeDefault.Equals(unicodeLittleEndianBOM))
        
        ' Create a UnicodeEncoding to support little-endian byte ordering
        ' and not include the Unicode byte order mark.
        Dim unicodeLittleEndianNoBOM As New UnicodeEncoding(False, False)
        ' Compare this UnicodeEncoding to the UnicodeEncoding without parameters.
        DescribeEquivalence(unicodeDefault.Equals(unicodeLittleEndianNoBOM))
        
        ' Create a UnicodeEncoding to support big-endian byte ordering
        ' and include the Unicode byte order mark.
        Dim unicodeBigEndianBOM As New UnicodeEncoding(True, True)
        ' Compare this UnicodeEncoding to the UnicodeEncoding without parameters.
        DescribeEquivalence(unicodeDefault.Equals(unicodeBigEndianBOM))
        
        ' Create a UnicodeEncoding to support big-endian byte ordering
        ' and not include the Unicode byte order mark.
        Dim unicodeBigEndianNoBOM As New UnicodeEncoding(True, False)
        ' Compare this UnicodeEncoding to the UnicodeEncoding without parameters.
        DescribeEquivalence(unicodeDefault.Equals(unicodeBigEndianNoBOM))
    End Sub
    
    
    Public Shared Sub DescribeEquivalence(isEquivalent As Boolean)
        Dim phrase as String
        If isEquivalent Then
            phrase = "An"
        Else
            phrase = "Not an"
        End If
        Console.WriteLine("{0} equivalent encoding.", phrase)
    End Sub
End Class

Comentários

Esse construtor cria uma instância que não gera uma exceção quando uma codificação inválida é detectada.

Caution

Por motivos de segurança, você deve habilitar a detecção de erros chamando o UnicodeEncoding(Boolean, Boolean, Boolean) construtor e definindo seu throwOnInvalidBytes argumento como true.

O byteOrderMark parâmetro controla a operação do GetPreamble método. Se true, o método retornará uma matriz de bytes que contém a marca de ordem de bytes Unicode (BOM) no formato UTF-16. Se false, ele retornará uma matriz de bytes de comprimento zero. No entanto, a configuração byteOrderMark não faz com que o GetBytes método prefixe o BOM no início da matriz de bytes, nem faz com que o GetByteCount método inclua o número de bytes no BOM na contagem de bytes.true

Confira também

Aplica-se a

UnicodeEncoding(Boolean, Boolean, Boolean)

Inicializa uma nova instância da classe UnicodeEncoding. Os parâmetros especificam se a ordem de bytes do big endian deve ser usada, se uma marca de ordem de bytes Unicode deve ser fornecida e se uma exceção será gerada quando uma codificação inválida for detectada.

public:
 UnicodeEncoding(bool bigEndian, bool byteOrderMark, bool throwOnInvalidBytes);
public UnicodeEncoding(bool bigEndian, bool byteOrderMark, bool throwOnInvalidBytes);
new System.Text.UnicodeEncoding : bool * bool * bool -> System.Text.UnicodeEncoding
Public Sub New (bigEndian As Boolean, byteOrderMark As Boolean, throwOnInvalidBytes As Boolean)

Parâmetros

bigEndian
Boolean

true para usar a ordem de bytes de big endian (primeiro byte mais significativo); false para usar a ordem de byte do endian pequeno (bytes menos significativos primeiro).

byteOrderMark
Boolean

true para especificar que o GetPreamble() método retorna uma marca de ordem de bytes Unicode; caso contrário, false.

throwOnInvalidBytes
Boolean

true para especificar que uma exceção deve ser gerada quando uma codificação inválida é detectada; caso contrário, false.

Exemplos

O exemplo a seguir demonstra o comportamento de, tanto com a detecção de UnicodeEncodingerros habilitada quanto sem.

using System;
using System.Text;

public class SamplesUnicodeEncoding  {

   public static void Main()  {

      // Create an instance of UnicodeEncoding using little-endian byte order.
      // This will be used for encoding.
      UnicodeEncoding u16LE     = new UnicodeEncoding( false, true );

      // Create two instances of UnicodeEncoding using big-endian byte order: one with error detection and one without.
      // These will be used for decoding.
      UnicodeEncoding u16withED = new UnicodeEncoding( true, true, true );
      UnicodeEncoding u16noED   = new UnicodeEncoding( true, true, false );

      // Create byte arrays from the same string containing the following characters:
      //    Latin Small Letter Z (U+007A)
      //    Latin Small Letter A (U+0061)
      //    Combining Breve (U+0306)
      //    Latin Small Letter AE With Acute (U+01FD)
      //    Greek Small Letter Beta (U+03B2)
      //    Latin Capital Letter U with  Diaeresis (U+00DC)
      String myStr = "za\u0306\u01FD\u03B2\u00DC";

      // Encode the string using little-endian byte order.
      byte[] myBytes = new byte[u16LE.GetByteCount( myStr )];
      u16LE.GetBytes( myStr, 0, myStr.Length, myBytes, 0 );

      // Decode the byte array with error detection.
      Console.WriteLine( "Decoding with error detection:" );
      PrintDecodedString( myBytes, u16withED );

      // Decode the byte array without error detection.
      Console.WriteLine( "Decoding without error detection:" );
      PrintDecodedString( myBytes, u16noED );
   }

   // Decode the bytes and display the string.
   public static void PrintDecodedString( byte[] bytes, Encoding enc )  {

      try  {
         Console.WriteLine( "   Decoded string: {0}", enc.GetString( bytes, 0, bytes.Length ) );
      }
      catch ( System.ArgumentException e )  {
         Console.WriteLine( e.ToString() );
      }

      Console.WriteLine();
   }
}
Imports System.Text

Public Class SamplesUnicodeEncoding   

   Public Shared Sub Main()

      ' Create an instance of UnicodeEncoding using little-endian byte order.
      ' This will be used for encoding.
      Dim u16LE As New UnicodeEncoding(False, True)

      ' Create two instances of UnicodeEncoding using big-endian byte order: one with error detection and one without.
      ' These will be used for decoding.
      Dim u16withED As New UnicodeEncoding(True, True, True)
      Dim u16noED As New UnicodeEncoding(True, True, False)

      ' Create byte arrays from the same string containing the following characters:
      '    Latin Small Letter Z (U+007A)
      '    Latin Small Letter A (U+0061)
      '    Combining Breve (U+0306)
      '    Latin Small Letter AE With Acute (U+01FD)
      '    Greek Small Letter Beta (U+03B2)
      '    Latin Capital Letter U with  Diaeresis (U+00DC)
      Dim myStr As String = "za" & ChrW(&H0306) & ChrW(&H01FD) & ChrW(&H03B2) & ChrW(&H00DC)

      ' Encode the string using little-endian byte order.
      Dim myBytes(u16LE.GetByteCount(myStr)) As Byte
      u16LE.GetBytes(myStr, 0, myStr.Length, myBytes, 0)

      ' Decode the byte array with error detection.
      Console.WriteLine("Decoding with error detection:")
      PrintDecodedString(myBytes, u16withED)

      ' Decode the byte array without error detection.
      Console.WriteLine("Decoding without error detection:")
      PrintDecodedString(myBytes, u16noED)

   End Sub


   ' Decode the bytes and display the string.
   Public Shared Sub PrintDecodedString(bytes() As Byte, enc As Encoding)

      Try
         Console.WriteLine("   Decoded string: {0}", enc.GetString(bytes, 0, bytes.Length))
      Catch e As System.ArgumentException
         Console.WriteLine(e.ToString())
      End Try

      Console.WriteLine()

   End Sub

End Class

Comentários

O byteOrderMark parâmetro controla a operação do GetPreamble método. Se true, o método retornará uma matriz de bytes que contém a marca de ordem de bytes Unicode (BOM) no formato UTF-16. Se false, ele retornará uma matriz de bytes de comprimento zero. No entanto, a configuração byteOrderMark não faz com que o GetBytes método prefixe o BOM no início da matriz de bytes, nem faz com que o GetByteCount método inclua o número de bytes no BOM na contagem de bytes.true

Se o throwOnInvalidBytes parâmetro for true, um método que detectará uma sequência de bytes inválida será gerado System.ArgumentException. Caso contrário, o método não gerará uma exceção e a sequência inválida será ignorada.

Caution

Por motivos de segurança, você deve usar esse construtor para criar uma instância da classe e ativar a UnicodeEncoding detecção de erros definindo throwOnInvalidBytes como true.

Confira também

Aplica-se a