Encoding.GetPreamble Méthode

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

Retours

Tableau d’octets contenant une séquence d’octets qui spécifie l’encodage utilisé.

- ou -

Tableau d’octets de longueur zéro, si un préambule n’est pas requis.

Exemples

L’exemple suivant détermine l’ordre d’octet de l’encodage basé sur le préambule.

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.
'

Remarques

Si vous le souhaitez, l’objet Encoding fournit un préambule qui est un tableau d’octets pouvant être précédés de la séquence d’octets résultant du processus d’encodage. Si le préambule contient une marque d’ordre d’octet (en Unicode, point de code U+FEFF), il aide le décodeur à déterminer l’ordre d’octet et le format de transformation ou UTF.

La marque d’ordre d’octet Unicode (BOM) est sérialisée comme suit (en hexadécimal) :

• UTF-8 : EF BB BF

• UTF-16 big endian byte order : FE FF

• UTF-16 little endian byte order : FF FE

• UTF-32 big endian byte order : 00 00 FE FF

• UTF-32 little endian byte order : FF FE 00 00

Vous devez utiliser le boM, car il fournit presque certaines identification d’un encodage pour les fichiers qui ont autrement perdu la référence à l’objet Encoding , par exemple, des données web non étiquetées ou incorrectement étiquetées ou des fichiers texte aléatoires stockés lorsqu’une entreprise n’a pas de préoccupations internationales ou d’autres données. Souvent, les problèmes utilisateur peuvent être évités si les données sont correctement étiquetées, de préférence dans UTF-8 ou UTF-16.

Pour les normes qui fournissent un type d’encodage, une boM est quelque peu redondante. Toutefois, il peut être utilisé pour aider un serveur à envoyer l’en-tête d’encodage correct. Vous pouvez également l’utiliser comme secours si l’encodage est autrement perdu.

Il existe certains inconvénients à l’utilisation d’un boM. Par exemple, savoir comment limiter les champs de base de données qui utilisent un boM peut être difficile. La concaténation des fichiers peut également être un problème, par exemple, lorsque les fichiers sont fusionnés de telle sorte qu’un caractère inutile peut se retrouver au milieu des données. Toutefois, malgré les quelques inconvénients, l’utilisation d’un boM est fortement recommandée.

Pour plus d’informations sur l’ordre d’octet et la marque d’ordre d’octet, consultez la norme Unicode sur la page d’accueil Unicode.