Encoding.GetPreamble Método

public:
 virtual cli::array <System::Byte> ^ GetPreamble();

public virtual byte[] GetPreamble();

abstract member GetPreamble : unit -> byte[]
override this.GetPreamble : unit -> byte[]

Public Overridable Function GetPreamble () As Byte()

Retornos

Uma matriz de bytes que contém uma sequência de bytes que especifica a codificação usada.

- ou -

Uma matriz de bytes de comprimento zero, se um preâmbulo não for necessário.

Exemplos

O exemplo a seguir determina a ordem de bytes da codificação com base no preâmbulo.

using System;
using System.Text;

namespace GetPreambleExample
{
   class GetPreambleExampleClass
   {
      static void Main()
      {
         Encoding unicode = Encoding.Unicode;

         // Get the preamble for the Unicode encoder. 
         // In this case the preamble contains the byte order mark (BOM).
         byte[] preamble = unicode.GetPreamble();

         // Make sure a preamble was returned 
         // and is large enough to contain a BOM.
         if(preamble.Length >= 2)
         {
            if(preamble[0] == 0xFE && preamble[1] == 0xFF)
            {
               Console.WriteLine("The Unicode encoder is encoding in big-endian order.");
            }
            else if(preamble[0] == 0xFF && preamble[1] == 0xFE)
            {
               Console.WriteLine("The Unicode encoder is encoding in little-endian order.");
            }
         }
      }
   }
}

/*
This code produces the following output.

The Unicode encoder is encoding in little-endian order.

*/

Imports System.Text

Namespace GetPreambleExample
   Class GetPreambleExampleClass
      Shared Sub Main()
         Dim [unicode] As Encoding = Encoding.Unicode

         ' Get the preamble for the Unicode encoder. 
         ' In this case the preamble contains the byte order mark (BOM).
         Dim preamble As Byte() = [unicode].GetPreamble()

         ' Make sure a preamble was returned 
         ' and is large enough to contain a BOM.
         If preamble.Length >= 2 Then
            If preamble(0) = &HFE And preamble(1) = &HFF Then
               Console.WriteLine("The Unicode encoder is encoding in big-endian order.")
            Else
               If preamble(0) = &HFF And preamble(1) = &HFE Then
                  Console.WriteLine("The Unicode encoder is encoding in little-endian order.")
               End If
            End If
         End If
      End Sub
   End Class
End Namespace

'This code produces the following output.
'
'The Unicode encoder is encoding in little-endian order.
'

Comentários

Opcionalmente, o Encoding objeto fornece um preâmbulo que é uma matriz de bytes que pode ser prefixada na sequência de bytes resultantes do processo de codificação. Se o preâmbulo contiver uma marca de ordem de bytes (em Unicode, ponto de código U+FEFF), ele ajudará o decodificador a determinar a ordem de bytes e o formato de transformação ou UTF.

A marca de ordem de bytes Unicode (BOM) é serializada da seguinte maneira (em hexadecimal):

• UTF-8: EF BB BF

• Ordem de bytes de big endian UTF-16: FE FF

• Ordem de bytes de pequeno endian UTF-16: FF FE

• Ordem de bytes de big endian UTF-32: 00 00 FE FF

• Ordem de bytes de endian utf-32: FF FE 00 00

Você deve usar o BOM, pois ele fornece quase certa identificação de uma codificação para arquivos que, de outra forma, perderam referência ao Encoding objeto, por exemplo, dados Da Web marcados incorretamente ou arquivos de texto aleatórios armazenados quando uma empresa não tinha preocupações internacionais ou outros dados. Geralmente, os problemas do usuário podem ser evitados se os dados forem marcados de forma consistente e correta, preferencialmente em UTF-8 ou UTF-16.

Para padrões que fornecem um tipo de codificação, um BOM é um pouco redundante. No entanto, ele pode ser usado para ajudar um servidor a enviar o cabeçalho de codificação correto. Como alternativa, ele pode ser usado como um fallback caso a codificação seja perdida de outra forma.

Há algumas desvantagens em usar um BOM. Por exemplo, saber como limitar os campos de banco de dados que usam um BOM pode ser difícil. A concatenação de arquivos também pode ser um problema, por exemplo, quando os arquivos são mesclados de forma que um caractere desnecessário possa acabar no meio dos dados. Apesar das poucas desvantagens, no entanto, o uso de um BOM é altamente recomendado.

Para obter mais informações sobre a ordem de bytes e a marca de ordem de bytes, consulte o Padrão Unicode na home page unicode.