UTF32Encoding.GetPreamble 方法

参考

定义

命名空间:: System.Text

程序集:: mscorlib.dll, System.Text.Encoding.Extensions.dll

程序集:: System.Text.Encoding.Extensions.dll

程序集:: mscorlib.dll

程序集:: netstandard.dll

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

返回采用 UTF-32 格式编码的 Unicode 字节顺序标记（如果 UTF32Encoding 对象配置为提供一个这样的标记）。

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

public override byte[] GetPreamble ();

override this.GetPreamble : unit -> byte[]

Public Overrides Function GetPreamble () As Byte()

Byte[]

一个包含 Unicode 字节顺序标记的字节数组（如果 UTF32Encoding 对象配置为提供一个这样的字节数组）。否则，此方法返回一个零长度的字节数组。

示例

下面的代码示例检索并显示不同 UTF32Encoding 实例的字节顺序标记。

using namespace System;
using namespace System::Text;

void PrintHexBytes( array<Byte>^bytes );

int main()
{
   
   // Create instances of UTF32Encoding, with the byte order mark and without.
   UTF32Encoding ^ u32LeNone = gcnew UTF32Encoding;
   UTF32Encoding ^ u32BeNone = gcnew UTF32Encoding( true,false );
   UTF32Encoding ^ u32LeBom = gcnew UTF32Encoding( false,true );
   UTF32Encoding ^ u32BeBom = gcnew UTF32Encoding( true,true );
   
   // Display the preamble for each instance.
   PrintHexBytes( u32LeNone->GetPreamble() );
   PrintHexBytes( u32BeNone->GetPreamble() );
   PrintHexBytes( u32LeBom->GetPreamble() );
   PrintHexBytes( u32BeBom->GetPreamble() );
}

void PrintHexBytes( array<Byte>^bytes )
{
   if ( (bytes == nullptr) || (bytes->Length == 0) )
      Console::WriteLine( "<none>" );
   else
   {
      for ( int i = 0; i < bytes->Length; i++ )
         Console::Write( "{0:X2} ", bytes[ i ] );
      Console::WriteLine();
   }
}

/* 
This example displays the following output:
      FF FE 00 00
      <none>
      FF FE 00 00
      00 00 FE FF
*/

using System;
using System.Text;

public class SamplesUTF32Encoding
{
   public static void Main()
   {
      // Create instances of UTF32Encoding, with the byte order mark and without.
      UTF32Encoding u32LeNone = new UTF32Encoding();
      UTF32Encoding u32BeNone = new UTF32Encoding( true, false );
      UTF32Encoding u32LeBom  = new UTF32Encoding( false, true );
      UTF32Encoding u32BeBom  = new UTF32Encoding( true, true );

      // Display the preamble for each instance.
      PrintHexBytes( u32LeNone.GetPreamble() );
      PrintHexBytes( u32BeNone.GetPreamble() );
      PrintHexBytes( u32LeBom.GetPreamble() );
      PrintHexBytes( u32BeBom.GetPreamble() );
   }

   public static void PrintHexBytes( byte[] bytes )
   {

      if (( bytes == null ) || ( bytes.Length == 0 ))
        {
            Console.WriteLine( "<none>" );
        }
        else  {
         for ( int i = 0; i < bytes.Length; i++ )
            Console.Write( "{0:X2} ", bytes[i] );
         Console.WriteLine();
      }
   }
}
/*
This example displays the following output.
      FF FE 00 00
      <none>
      FF FE 00 00
      00 00 FE FF
*/

Imports System.Text

Public Class SamplesUTF32Encoding   
   Public Shared Sub Main()
      ' Create instances of UTF32Encoding, with the byte order mark and without.
      Dim u32LeNone As New UTF32Encoding()
      Dim u32BeNone As New UTF32Encoding(True, False)
      Dim u32LeBom As New UTF32Encoding(False, True)
      Dim u32BeBom As New UTF32Encoding(True, True)

      ' Display the preamble for each instance.
      PrintHexBytes(u32LeNone.GetPreamble())
      PrintHexBytes(u32BeNone.GetPreamble())
      PrintHexBytes(u32LeBom.GetPreamble())
      PrintHexBytes(u32BeBom.GetPreamble())
   End Sub

   Public Shared Sub PrintHexBytes(bytes() As Byte)
      If bytes Is Nothing OrElse bytes.Length = 0 Then
         Console.WriteLine("<none>")
      Else
         Dim i As Integer
         For i = 0 To bytes.Length - 1
            Console.Write("{0:X2} ", bytes(i))
         Next i
         Console.WriteLine()
      End If
   End Sub
End Class
'This example displays the following output:
'       FF FE 00 00
'       FF FE 00 00
'       00 00 FE FF

以下示例实例化两 UTF32Encoding 个对象，其中第一个对象不提供 BOM，第二个对象不提供 BOM。然后， GetPreamble 它会调用该方法在编写 UTF-32 编码字符串之前将 BOM 写入文件。如示例的输出所示，保存第二个编码器中的字节的文件还有第一个字节的四个字节。

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-32 encoding.";

      // Write a file using the default constructor without a BOM.
      var enc = new UTF32Encoding(! BitConverter.IsLittleEndian, false);
      Byte[] bytes = enc.GetBytes(s);
      WriteToFile(@".\NoPreamble.txt", enc, bytes);

      // Use BOM.
      enc = new UTF32Encoding(! BitConverter.IsLittleEndian, 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 232 bytes to .\NoPreamble.txt.
//
//       Preamble has 4 bytes
//       Wrote 236 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-32 encoding."
      
      ' Write a file using the default constructor without a BOM.
      Dim enc As New UTF32Encoding(Not BitConverter.IsLittleEndian, False)
      Dim bytes() As Byte = enc.GetBytes(s)
      WriteToFile("NoPreamble.txt", enc, bytes)

      ' Use BOM.
      enc = New UTF32Encoding(Not BitConverter.IsLittleEndian, 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 232 bytes to NoPreamble.txt.
'
'       Preamble has 4 bytes
'       Wrote 236 bytes to Preamble.txt.

还可以通过使用 fc 控制台窗口中的命令来比较文件，也可以检查包含十六进制视图模式的文本编辑器中的文件。请注意，当文件在支持 UTF-32 的编辑器中打开时，不会显示 BOM。

注解

该 UTF32Encoding 对象可以提供一个前言，它是一个字节数组，可以前缀到编码过程生成的字节序列。使用字节顺序标记 (代码点 U+0000 U+FEFF) 开头编码字节序列有助于解码器确定字节顺序和转换格式或 UTF。 Unicode 字节顺序标记（BOM）按以下方式序列化（十六进制）：

大尾字节顺序： 00 00 FE FF
小尾字节顺序： FF FE 00 00

可以实例化UTF32Encoding对象，其GetPreamble方法按以下方式返回有效的 BOM：

通过检索 UTF32Encoding 属性返回 Encoding.UTF32 的对象。
通过调用无 UTF32Encoding() 参数构造函数来实例化 UTF32Encoding 对象。
通过将参数UTF32Encoding的值byteOrderMark提供给和UTF32Encoding构造函数来提供true。

我们建议使用 BOM，因为它为文件提供几乎确定的编码，否则会丢失对 UTF32Encoding 对象的引用，例如，未标记或未标记的 Web 数据，或者当企业没有国际关注或其他数据时存储的随机文本文件。通常，如果数据一致且正确标记，则可能会避免用户问题。

对于提供编码类型的标准，BOM 有些多余。但是，可以使用它来帮助服务器发送正确的编码标头。或者，它可以用作回退，以防编码在其他情况下丢失。

使用 BOM 存在一些缺点。例如，了解如何限制使用 BOM 的数据库字段可能很困难。文件的串联可能也是一个问题，例如，当文件以这样一种方式进行合并时，不需要的字符会在数据中间结束。但尽管有几个缺点，但强烈建议使用 BOM。

有关字节顺序和字节顺序标记的详细信息，请参阅unicode 主页上的 unicode 标准。

重要

若要确保编码的字节解码正确，应使用前导码作为编码字节的前缀。请注意，该方法 GetBytes 不会将 BOM 追加到编码字节序列;在适当的字节流开头提供 BOM 是开发人员的责任。

适用于

UTF32Encoding.GetPreamble 方法

定义

返回

示例

注解

适用于

其他资源