Encoding.GetPreamble Metoda

Definicja

Gdy jest zastępowany w klasie pochodnej, zwraca sekwencję bajtów, która określa używane kodowanie.When overridden in a derived class, returns a sequence of bytes that specifies the encoding used.

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

Zwraca

Byte[]

Tablica bajtowa zawierająca sekwencję bajtów, która określa używane kodowanie.A byte array containing a sequence of bytes that specifies the encoding used.

-lub--or-

Tablica bajtowa o długości zero, jeśli preambuła nie jest wymagana.A byte array of length zero, if a preamble is not required.

Przykłady

Poniższy przykład określa kolejność bajtów kodowania na podstawie preambuły.The following example determines the byte order of the encoding based on the preamble.

using namespace System;
using namespace System::Text;
int main()
{
   Encoding^ unicode = Encoding::Unicode;
   
   // Get the preamble for the Unicode encoder. 
   // In this case the preamblecontains the Byte order mark (BOM).
   array<Byte>^preamble = unicode->GetPreamble();
   
   // Make sure a preamble was returned 
   // and is large enough to containa BOM.
   if ( preamble->Length >= 2 )
   {
      
      // if (preamble->Item[0] == 0xFE && preamble->Item[1] == 0xFF) 
      if ( preamble[ 0 ] == 0xFE && preamble[ 1 ] == 0xFF )
      {
         Console::WriteLine( "The Unicode encoder is encoding in big-endian order." );
      }
      // else if (preamble->Item[0] == 0xFF && preamble->Item[1] == 0xFE) 
      else
      
      // else if (preamble->Item[0] == 0xFF && preamble->Item[1] == 0xFE) 
      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.

*/
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 containa 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.
'

Uwagi

Opcjonalnie Encoding obiekt zawiera preambułę, która jest tablicą bajtów, które mogą być poprzedzone sekwencją bajtów w wyniku procesu kodowania.Optionally, the Encoding object provides a preamble that is an array of bytes that can be prefixed to the sequence of bytes resulting from the encoding process. Jeśli Preambuła zawiera znacznik kolejności bajtów (w standardzie Unicode, punkt kodowy U + FEFF), pomaga dekoderowi określić kolejność bajtów i format transformacji lub UTF.If the preamble contains a byte order mark (in Unicode, code point U+FEFF), it helps the decoder determine the byte order and the transformation format or UTF.

Znacznik kolejności bajtów (BOM) Unicode jest serializowany w następujący sposób (w formacie szesnastkowym):The Unicode byte order mark (BOM) is serialized as follows (in hexadecimal):

  • UTF-8: DR BBBINDINGUTF-8: EF BB BF

  • Kolejność bajtów w formacie UTF-16 big endian: FE FFUTF-16 big endian byte order: FE FF

  • Kolejność bajtów w formacie UTF-16 little endian: FRF FEUTF-16 little endian byte order: FF FE

  • UTF-32 big endian kolejność bajtów: 00 00 FE FFUTF-32 big endian byte order: 00 00 FE FF

  • Kodowanie w formacie UTF-32 little endian: FRF FE 00 00UTF-32 little endian byte order: FF FE 00 00

Należy używać BOM, ponieważ zapewnia niemal pewnej identyfikacji kodowania dla plików, które w przeciwnym razie utraciły odwołanie do Encoding obiektu, na przykład nieoznakowane lub niewłaściwie oznakowane dane sieci Web lub losowe pliki tekstowe przechowywane, gdy firma nie ma zagadnień międzynarodowych lub innych danych.You should use the BOM, because it provides nearly certain identification of an encoding for files that otherwise have lost reference to the Encoding object, for example, untagged or improperly tagged web data or random text files stored when a business did not have international concerns or other data. Często można uniknąć problemów z użytkownikami, jeśli dane są spójne i właściwie oznakowane, najlepiej w UTF-8 lub UTF-16.Often user problems might be avoided if data is consistently and properly tagged, preferably in UTF-8 or UTF-16.

W przypadku standardów, które zapewniają typ kodowania, BOM jest nieco nadmiarowy.For standards that provide an encoding type, a BOM is somewhat redundant. Można go jednak użyć, aby ułatwić serwerowi wysyłanie poprawnego nagłówka kodowania.However, it can be used to help a server send the correct encoding header. Alternatywnie, może być używany jako rezerwa w przypadku, gdy kodowanie jest tracone.Alternatively, it can be used as a fallback in case the encoding is otherwise lost.

Istnieją pewne wady dotyczące korzystania z BOM.There are some disadvantages to using a BOM. Na przykład poznanie sposobu ograniczania pól bazy danych, które używają BOM, może być trudne.For example, knowing how to limit the database fields that use a BOM can be difficult. Łączenie plików może być również problemem, na przykład podczas scalania plików w taki sposób, że niezbędny znak może kończyć się w danych.Concatenation of files can be a problem also, for example, when files are merged in such a way that an unnecessary character can end up in the middle of data. Pomimo tego, że użycie BOM jest zdecydowanie zalecane.In spite of the few disadvantages, however, the use of a BOM is highly recommended.

Aby uzyskać więcej informacji na temat kolejności bajtów i znacznika kolejności bajtów, zobacz Standard Unicode na stronie głównej Unicode.For more information on byte order and the byte order mark, see The Unicode Standard at the Unicode home page.

Przestroga

Aby upewnić się, że zakodowane bajty są zdekodowane prawidłowo, należy prefiksować zakodowane bajty z preambuły.To ensure that the encoded bytes are decoded properly, you should prefix encoded bytes with a preamble. Jednak większość kodowań nie udostępnia preambuły.However, most encodings do not provide a preamble. Aby upewnić się, że zakodowane bajty są poprawnie zdekodowane, należy użyć kodowania Unicode, czyli, UTF8Encoding , UnicodeEncoding lub UTF32Encoding , z preambuły.To ensure that the encoded bytes are decoded properly, you should use a Unicode encoding, that is, UTF8Encoding, UnicodeEncoding, or UTF32Encoding, with a preamble.

Dotyczy