Encoding.GetPreamble Metoda

Definice

Při přepsání v odvozené třídě vrátí sekvenci bajtů, která určuje použité kódování.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()

Návraty

Byte[]

Bajtové pole obsahující sekvenci bajtů, které určují používané kódování.A byte array containing a sequence of bytes that specifies the encoding used.

-nebo--or-

Bajtové pole s nulovou délkou, není-li požadováno preambule.A byte array of length zero, if a preamble is not required.

Příklady

Následující příklad určuje pořadí bajtů kódování na základě preambule.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.
'

Poznámky

V případě potřeby Encoding objekt poskytuje preambuli, která je pole bajtů, které může být předponou posloupnosti bajtů vycházejících z procesu kódování.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. Pokud preambule obsahuje znak pořadí bajtů (v kódování Unicode, bod kódu U + FEFF), pomůže dekodéru určit pořadí bajtů a formát transformace nebo kódování 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.

Znak pořadí bajtů Unicode (BOM) je serializován takto (v šestnáctkovém formátu):The Unicode byte order mark (BOM) is serialized as follows (in hexadecimal):

  • UTF-8: EF BB BFUTF-8: EF BB BF

  • Pořadí bajtů big endian ve formátu UTF-16: FE FFUTF-16 big endian byte order: FE FF

  • Pořadí bajtů ve formátu UTF-16 Little endian: FF FEUTF-16 little endian byte order: FF FE

  • Pořadí bajtů big endian UTF-32:00 00 FE FFUTF-32 big endian byte order: 00 00 FE FF

  • Pořadí bajtů UTF-32 Little endian: FF FE 00 00UTF-32 little endian byte order: FF FE 00 00

Měli byste použít kusovník, protože poskytuje téměř určitou identifikaci kódování pro soubory, které jinak ztratily odkaz na Encoding objekt, například neoznačená nebo nesprávně označená webová data nebo náhodné textové soubory uložené v případě, že obchodní oddělení neobsahovalo mezinárodní obavy nebo jiná data.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. Často se můžou vyhnout problémy s uživateli, pokud jsou data konzistentně a správně označená, nejlépe v kódování UTF-8 nebo UTF-16.Often user problems might be avoided if data is consistently and properly tagged, preferably in UTF-8 or UTF-16.

V případě standardů, které poskytují typ kódování, je kusovník trochu redundantní.For standards that provide an encoding type, a BOM is somewhat redundant. Dá se ale použít k tomu, aby server mohl odeslat správnou hlavičku kódování.However, it can be used to help a server send the correct encoding header. Alternativně lze použít jako záložní pro případ, že kódování je jinak ztraceno.Alternatively, it can be used as a fallback in case the encoding is otherwise lost.

Použití kusovníku je některé nevýhody.There are some disadvantages to using a BOM. Například víte, jak omezit databázová pole, která používají kusovník, může být obtížné.For example, knowing how to limit the database fields that use a BOM can be difficult. Zřetězení souborů může být například problém, například když jsou soubory sloučeny takovým způsobem, že nepotřebný znak může končit daty uprostřed.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. Navzdory několika nevýhodám však doporučujeme použití kusovníku důrazně.In spite of the few disadvantages, however, the use of a BOM is highly recommended.

Další informace o pořadí bajtů a značce pořadí bajtů najdete na domovské stránce Unicodena standardu Unicode.For more information on byte order and the byte order mark, see The Unicode Standard at the Unicode home page.

Upozornění

Aby se zajistilo, že kódované bajty jsou dekódované správně, měli byste předponu kódovaných bajtů zakódovat do preambule.To ensure that the encoded bytes are decoded properly, you should prefix encoded bytes with a preamble. Většina kódování však neposkytuje preambuli.However, most encodings do not provide a preamble. Aby se zajistilo, že kódované bajty jsou dekódované správně, měli byste použít kódování Unicode, to znamená, UTF8Encoding , UnicodeEncoding nebo UTF32Encoding , s preambulí.To ensure that the encoded bytes are decoded properly, you should use a Unicode encoding, that is, UTF8Encoding, UnicodeEncoding, or UTF32Encoding, with a preamble.

Platí pro