• Article

UnicodeEncoding.GetPreamble Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Returns a Unicode byte order mark encoded in UTF-16 format.

Namespace:  System.Text
Assembly:  mscorlib (in mscorlib.dll)

Syntax

'Declaration
Public Overrides Function GetPreamble As Byte()

public override byte[] GetPreamble()

Return Value

Type: array<System.Byte[]
A byte array containing the Unicode byte order mark, if the constructor for this instance requests a byte order mark. Otherwise, this method returns a zero-length byte array.

Remarks

Optionally, the UnicodeEncoding 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):

  • Big-endian byte order: 00 00 FE FF

  • Little-endian byte order: FF FE 00 00

Your applications are recommended to use the BOM, as it provides nearly certain identification of an encoding for files that otherwise have lost reference to the UnicodeEncoding 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.

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, your application should prefix encoded bytes with a preamble.

Examples

The following code example demonstrates how to use the GetPreamble method to retrieve the Unicode byte order mark in big-endian or little-endian byte order for an instance of a UnicodeEncoding.

Imports System.Text

Class Example

   Public Shared Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      Dim byteOrderMark() As Byte
      Dim b As Byte

      byteOrderMark = Encoding.Unicode.GetPreamble()
      outputBlock.Text &= "Default (little-endian) Unicode Preamble:" & vbCrLf
      For Each b In byteOrderMark
         outputBlock.Text += String.Format("[{0}]", b)
      Next b
      outputBlock.Text &= ControlChars.NewLine & vbCrLf

      Dim bigEndianUnicode As New UnicodeEncoding(True, True)
      byteOrderMark = bigEndianUnicode.GetPreamble()
      outputBlock.Text &= "Big-endian Unicode Preamble:" & vbCrLf
      For Each b In byteOrderMark
         outputBlock.Text += String.Format("[{0}]", b)
      Next b
   End Sub 'Main
End Class 'UnicodeEncodingExample

using System;
using System.Text;

class Example
{
   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      Byte[] byteOrderMark;

      byteOrderMark = Encoding.Unicode.GetPreamble();
      outputBlock.Text += "Default (little-endian) Unicode Preamble:" + "\n";
      foreach (Byte b in byteOrderMark)
      {
         outputBlock.Text += String.Format("[{0}]", b);
      }
      outputBlock.Text += "\n" + "\n";

      UnicodeEncoding bigEndianUnicode = new UnicodeEncoding(true, true);
      byteOrderMark = bigEndianUnicode.GetPreamble();
      outputBlock.Text += "Big-endian Unicode Preamble:" + "\n";
      foreach (Byte b in byteOrderMark)
      {
         outputBlock.Text += String.Format("[{0}]", b);
      }
   }
}

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.