UTF8Encoding.Preamble Propriedade

Definição

Namespace:

System.Text

Assembly:

System.Text.Encoding.Extensions.dll

Obtém uma marca de ordem de byte Unicode codificada no formato UTF-8 caso o objeto de codificação esteja configurado para fornecer uma.

public:
 virtual property ReadOnlySpan<System::Byte> Preamble { ReadOnlySpan<System::Byte> get(); };

public override ReadOnlySpan<byte> Preamble { get; }

member this.Preamble : ReadOnlySpan<byte>

Public Overrides ReadOnly Property Preamble As ReadOnlySpan(Of Byte)

Valor da propriedade

ReadOnlySpan<Byte>

Um intervalo de bytes que contém a marca de ordem de byte Unicode, se esse objeto estiver configurado para fornecer um; caso contrário, o intervalo padrão.

Comentários

O UTF8Encoding objeto pode fornecer um preâmbulo, que é um intervalo de bytes que podem ser prefixados na sequência de bytes resultantes do processo de codificação. A pré-criação de uma sequência de bytes codificados com uma marca de ordem de byte (ponto U+FEFFde código) ajuda o decodificador a determinar a ordem de byte e o formato de transformação, ou UTF. A marca de ordem de byte Unicode (BOM) é serializada como 0xEF 0xBB 0xBF. Observe que o Padrão Unicode não requer nem recomenda o uso de um BOM para fluxos codificados utf-8.

Você pode criar uma instância de um UTF8Encoding objeto cujo Preamble bom é válido das seguintes maneiras:

• Recuperando o UTF8Encoding objeto retornado pela Encoding.UTF8 propriedade.

• Chamando um UTF8Encoding construtor com um encoderShouldEmitUTF8Identifier parâmetro e definindo seu valor definido como true.

Todos os outros UTF8Encoding objetos são configurados para retornar um intervalo padrão em vez de um BOM válido.

O BOM fornece quase certa identificação de uma codificação para arquivos que, de outra forma, perderam uma referência à codificação, como dados Da Web não marcados ou marcados incorretamente ou arquivos de texto aleatórios armazenados quando uma empresa não tinha preocupações internacionais. Muitas vezes, os problemas do usuário podem ser evitados se os dados forem marcados de forma consistente e correta.

Para padrões que fornecem um tipo de codificação, uma 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.

Há algumas desvantagens em usar uma BOM. Por exemplo, saber como limitar os campos de banco de dados que usam uma 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 terminar no meio dos dados. No entanto, apesar das poucas desvantagens, o uso de uma BOM é altamente recomendável.

Para obter mais informações sobre a ordem de bytes e a marca de ordem de byte, consulte o padrão Unicode na Home Page Unicode.

Importante

Para garantir que os bytes codificados sejam decodificados corretamente quando forem salvos como um arquivo ou como um fluxo, você pode prefixar o início de um fluxo de bytes codificados com um preâmbulo. Observe que o GetBytes método não prepara um BOM para uma sequência de bytes codificados; fornecer um BOM no início de um fluxo de bytes apropriado é responsabilidade do desenvolvedor.