Export (0) Print
Expand All

Encoding.GetPreamble Method

When overridden in a derived class, returns a sequence of bytes that specifies the encoding used.

Namespace:  System.Text
Assemblies:   mscorlib (in mscorlib.dll)
  System.Text.Encoding (in System.Text.Encoding.dll)

public virtual byte[] GetPreamble()

Return Value

Type: System.Byte[]
A byte array containing a sequence of bytes that specifies the encoding used.
A byte array of length zero, if a preamble is not required.

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

The Unicode byte order mark (BOM) is serialized as follows (in hexadecimal):

  • 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

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. Often user problems might be avoided if data is consistently and properly tagged, preferably in UTF-8 or UTF-16.

For standards that provide an encoding type, a BOM is somewhat redundant. However, it can be used to help a server send the correct encoding header. Alternatively, it can be used as a fallback in case the encoding is otherwise lost.

There are some disadvantages to using a BOM. For example, knowing how to limit the database fields that use a BOM can be difficult. 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. In spite of the few disadvantages, however, the use of a BOM is highly recommended.

For more information on byte order and the byte order mark, see The Unicode Standard at the Unicode home page.

Caution noteCaution

To ensure that the encoded bytes are decoded properly, you should prefix encoded bytes with a preamble. However, most encodings do not provide a preamble. To ensure that the encoded bytes are decoded properly, you should use a Unicode encoding, that is, UTF8Encoding, UnicodeEncoding, or UTF32Encoding, with a preamble.

The following example determines the byte order of the encoding based on the preamble.

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.


.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2014 Microsoft