Partager via


Encoding.GetPreamble Méthode

Définition

En cas de substitution dans une classe dérivée, retourne une séquence d'octets qui spécifie l'encodage utilisé.

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

Byte[]

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

- ou -

Tableau d'octets de longueur nulle si aucun préambule n'est requis.

Exemples

L’exemple suivant détermine l’ordre d’octet de l’encodage en fonction du préambule.

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 contain a 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 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

L' Encoding objet fournit éventuellement un préambule qui est un tableau d’octets qui peut être préfixé à la séquence d’octets résultant du processus d’encodage. Si le préambule contient une marque d’ordre d’octet (au format Unicode, point de code U + FEFF), il permet au décodeur de 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 (au format hexadécimal) :

  • UTF-8 : EF BB BF

  • Ordre d’octet UTF-16 Big endian : FE FF

  • UTF-16 Little endian, ordre des octets : FF FE

  • UTF-32 Big endian, ordre d’octet : 00 00 FE FF

  • UTF-32 Little endian, ordre des octets : FF FE 00 00

Vous devez utiliser la marque de nomenclature, car elle fournit quasiment certaines informations d’identification d’un encodage pour les fichiers qui, autrement, ont perdu la référence à l' Encoding objet, par exemple, les données Web non marquées ou mal référencées ou les 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 des utilisateurs peuvent être évités si les données sont régulièrement et correctement étiquetées, de préférence en UTF-8 ou UTF-16.

Pour les normes qui fournissent un type d’encodage, une nomenclature est un 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 au cas où l’encodage serait perdu.

L’utilisation d’une nomenclature présente quelques inconvénients. Par exemple, il peut être difficile de savoir comment limiter les champs de base de données qui utilisent une nomenclature. La concaténation de fichiers peut également être un problème, par exemple, lorsque des fichiers sont fusionnés de manière à ce qu’un caractère inutile puisse se retrouver au milieu des données. Malgré les quelques inconvénients, toutefois, l’utilisation d’une nomenclature 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’hébergement Unicode.

Attention

Pour vous assurer que les octets encodés sont correctement décodés, vous devez préfixer les octets encodés avec un préambule. Toutefois, la plupart des encodages ne fournissent pas de préambule. Pour vous assurer que les octets encodés sont décodés correctement, vous devez utiliser un encodage Unicode, autrement dit,, UTF8EncodingUnicodeEncoding ou UTF32Encoding , avec un préambule.

S’applique à