UTF8Encoding.GetPreamble Metodo

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

public override byte[] GetPreamble();

override this.GetPreamble : unit -> byte[]

Public Overrides Function GetPreamble () As Byte()

Restituisce

Matrice di byte contenente il contrassegno di ordine dei byte Unicode, se l'oggetto UTF8Encoding di codifica è configurato per specificarne uno. In caso contrario, questo metodo restituisce una matrice di byte di lunghezza zero.

Esempio

Nell'esempio seguente viene usato il GetPreamble metodo per restituire il contrassegno di ordine dei byte Unicode codificato in formato UTF-8. Si noti che il costruttore senza parametri per UTF8Encoding non fornisce un preambolo.

using System;
using System.Text;

class Example
{
    public static void Main()
    {
        // The default constructor does not provide a preamble.
        UTF8Encoding UTF8NoPreamble = new UTF8Encoding();
        UTF8Encoding UTF8WithPreamble = new UTF8Encoding(true);

        Byte[] preamble;

        preamble = UTF8NoPreamble.GetPreamble();
        Console.WriteLine("UTF8NoPreamble");
        Console.WriteLine(" preamble length: {0}", preamble.Length);
        Console.Write(" preamble: ");
        ShowArray(preamble);
        Console.WriteLine();
        
        preamble = UTF8WithPreamble.GetPreamble();
        Console.WriteLine("UTF8WithPreamble");
        Console.WriteLine(" preamble length: {0}", preamble.Length);
        Console.Write(" preamble: ");
        ShowArray(preamble);
    }

    public static void ShowArray(Byte[] bytes)
    {
        foreach (var b in bytes)
            Console.Write("{0:X2} ", b);

        Console.WriteLine();
    }
}
// The example displays the following output:
//    UTF8NoPreamble
//     preamble length: 0
//     preamble:
//
//    UTF8WithPreamble
//     preamble length: 3
//     preamble: EF BB BF

Imports System.Text

Module Example
    Public Sub Main()
        ' The default constructor does not provide a preamble.
        Dim UTF8NoPreamble As New UTF8Encoding()
        Dim UTF8WithPreamble As New UTF8Encoding(True)
        
        Dim preamble() As Byte
        
        preamble = UTF8NoPreamble.GetPreamble()
        Console.WriteLine("UTF8NoPreamble")
        Console.WriteLine(" preamble length: {0}", preamble.Length)
        Console.Write(" preamble: ")
        ShowArray(preamble)
        Console.WriteLine()
        
        preamble = UTF8WithPreamble.GetPreamble()
        Console.WriteLine("UTF8WithPreamble")
        Console.WriteLine(" preamble length: {0}", preamble.Length)
        Console.Write(" preamble: ")
        ShowArray(preamble)
    End Sub

    Public Sub ShowArray(bytes As Byte())
        For Each b In  bytes
            Console.Write("{0:X2} ", b)
        Next
        Console.WriteLine()
    End Sub
End Module
' The example displays the following output:
'    UTF8NoPreamble
'     preamble length: 0
'     preamble:
'
'    UTF8WithPreamble
'     preamble length: 3
'     preamble: EF BB BF

L'esempio seguente crea un'istanza di due UTF8Encoding oggetti, il primo chiamando il costruttore senza UTF8Encoding() parametri, che non fornisce una distinta base e il secondo chiamando il costruttore con il UTF8Encoding(Boolean) relativo encoderShouldEmitUTF8Identifier argomento impostato su true. Chiama quindi il GetPreamble metodo per scrivere la distinta base in un file prima di scrivere una stringa con codifica UF8. Come illustrato nell'output della console dell'esempio, il file che salva i byte dal secondo codificatore ha tre byte superiori al primo.

using System;
using System.IO;
using System.Text;

public class Example
{
   public static void Main()
   {
      String s = "This is a string to write to a file using UTF-8 encoding.";

      // Write a file using the default constructor without a BOM.
      var enc = new UTF8Encoding();
      Byte[] bytes = enc.GetBytes(s);
      WriteToFile("NoPreamble.txt", enc, bytes);

      // Use BOM.
      enc = new UTF8Encoding(true);
      WriteToFile("Preamble.txt", enc, bytes);
   }

   private static void WriteToFile(String fn, Encoding enc, Byte[] bytes)
   {
      var fs = new FileStream(fn, FileMode.Create);
      Byte[] preamble = enc.GetPreamble();
      fs.Write(preamble, 0, preamble.Length);
      Console.WriteLine("Preamble has {0} bytes", preamble.Length);
      fs.Write(bytes, 0, bytes.Length);
      Console.WriteLine("Wrote {0} bytes to {1}.", fs.Length, fn);
      fs.Close();
      Console.WriteLine();
   }
}
// The example displays the following output:
//       Preamble has 0 bytes
//       Wrote 57 bytes to NoPreamble.txt.
//
//       Preamble has 3 bytes
//       Wrote 60 bytes to Preamble.txt.

Imports System.IO
Imports System.Text

Module Example
   Public Sub Main()
      Dim s As String = "This is a string to write to a file using UTF-8 encoding."
      
      ' Write a file using the default constructor without a BOM.
      Dim enc As New UTF8Encoding()
      Dim bytes() As Byte = enc.GetBytes(s)
      WriteToFile("NoPreamble.txt", enc, bytes)

      ' Use BOM.
      enc = New UTF8Encoding(True)
      WriteToFile("Preamble.txt", enc, bytes)
   End Sub

   Private Sub WriteToFile(fn As String, enc As Encoding, bytes As Byte())
      Dim fs As New FileStream(fn, FileMode.Create)
      Dim preamble() As Byte = enc.GetPreamble()
      fs.Write(preamble, 0, preamble.Length)
      Console.WriteLine("Preamble has {0} bytes", preamble.Length)
      fs.Write(bytes, 0, bytes.Length)
      Console.WriteLine("Wrote {0} bytes to {1}.", fs.Length, fn)
      fs.Close()
      Console.WriteLine()
   End Sub
End Module
' The example displays the following output:
'       Preamble has 0 bytes
'       Wrote 57 bytes to NoPreamble.txt.
'
'       Preamble has 3 bytes
'       Wrote 60 bytes to Preamble.txt.

È anche possibile confrontare i file usando il fc comando in una finestra della console oppure esaminare i file in un editor di testo che include una modalità visualizzazione esadecimale. Si noti che quando il file viene aperto in un editor che supporta UTF-8, la distinta base non viene visualizzata.

Commenti

L'oggetto UTF8Encoding può fornire un preambolo, ovvero una matrice di byte che può essere preceduta dalla sequenza di byte risultante dal processo di codifica. La prefazione di una sequenza di byte codificati con un contrassegno di ordine di byte (punto di codice U+FEFF) consente al decodificatore di determinare l'ordine dei byte e il formato di trasformazione o UTF. Il byte order mark (BOM) Unicode viene serializzato come 0xEF 0xBB 0xBF. Si noti che lo standard Unicode non richiede né consiglia l'uso di un BOM per i flussi con codifica UTF-8.

È possibile creare un'istanza di un UTF8Encoding oggetto il cui GetPreamble metodo restituisce un bom valido nei modi seguenti:

• Recuperando l'oggetto UTF8Encoding restituito dalla Encoding.UTF8 proprietà .

• Chiamando un UTF8Encoding costruttore con un encoderShouldEmitUTF8Identifier parametro e impostandone il valore impostato su true.

Tutti gli altri UTF8Encoding oggetti sono configurati per restituire una matrice vuota anziché una distinta base valida.

La distinta base fornisce quasi certamente un'identificazione di una codifica per i file che altrimenti hanno perso un riferimento alla loro codifica, ad esempio dati Web senza tag o file di testo casuali non contrassegnati correttamente o file di testo casuali archiviati quando un'azienda non ha problemi internazionali. Spesso i problemi utente possono essere evitati se i dati sono contrassegnati in modo coerente e corretto.

Per gli standard che forniscono un tipo di codifica, un bom è un po' ridondante. Tuttavia, può essere usato per consentire a un server di inviare l'intestazione di codifica corretta. In alternativa, può essere usato come fallback nel caso in cui la codifica vada persa in caso contrario.

Esistono alcuni svantaggi per l'uso di una distinta base. Ad esempio, sapere come limitare i campi di database che usano una distinta base può essere difficile. La concatenazione dei file può anche essere un problema, ad esempio quando i file vengono uniti in modo tale che un carattere non necessario possa finire al centro dei dati. Nonostante i pochi svantaggi, tuttavia, l'uso di un BOM è altamente consigliato.

Per ulteriori informazioni sull'ordine dei byte e sul contrassegno di ordine dei byte, vedere Lo standard Unicode nella home page Unicode.