UnicodeEncoding.GetPreamble メソッドとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

UnicodeEncoding.GetPreamble メソッド

このインスタンスのコンストラクタでバイト順マークを付加するよう指定した場合に、UTF-32 形式でエンコードされた Unicode バイト順マークを返します。

名前空間: System.Text
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Public Overrides Function
 GetPreamble As Byte()

Visual Basic (使用法)

Dim instance As UnicodeEncoding
Dim returnValue As Byte()

returnValue = instance.GetPreamble

public override byte[] GetPreamble ()

C++

public:
virtual array<unsigned char>^ GetPreamble () override

public byte[] GetPreamble ()

JScript

public override function GetPreamble () : byte[]

戻り値
このインスタンスのコンストラクタでバイト順マークを付加するよう指定した場合は、Unicode バイト順マークが格納されたバイト配列。それ以外の場合は、長さ 0 のバイト配列。

解説

プリアンブルがエンコード済みストリームの前に付加されていると、デコーダによる使用エンコーディング形式の識別に役立ちます。

エンコーダでは、最上位バイトが先頭に配置されるビッグエンディアンバイト順、または最下位バイトが先頭に配置されるリトルエンディアンバイト順が使用されます。たとえば、Latin の大文字 A (コードポイント U+0041) は次のように 16 進数でシリアル化されます。

ビッグエンディアンバイト順 : 00 00 00 41
リトルエンディアンバイト順 : 41 00 00 00

UnicodeEncoding は、オプションでプリアンブルを提供します。プリアンブルは、エンコーディングプロセスで得られたバイトシーケンスの先頭に付加できるバイトの配列です。プリアンブルにバイト順マーク (コードポイント U+FEFF) が含まれる場合、デコーダはバイト順および変換形式 (UTF) を判断できます。Unicode バイト順マークは、次のように 16 進数でシリアル化されます。

ビッグエンディアンバイト順 : 00 00 FE FF
リトルエンディアンバイト順 : FF FE 00 00

通常、ネイティブなバイト順で Unicode 文字を格納した方が効率的です。たとえば、Intel のコンピュータなど、リトルエンディアンのプラットフォームでは、リトルエンディアンのバイト順を使用した方が効率的です。

バイト順とバイト順マークの詳細については、www.unicode.org の「Unicode Standard」を参照してください。

注意
エンコード済みバイトを正しくデコードするには、エンコード済みバイトの前にプリアンブルを付加します。

使用例

次のコード例は、GetPreamble メソッドを使用して、UnicodeEncoding のインスタンスの Unicode バイト順マークをビッグエンディアン形式またはリトルエンディアン形式で返す方法を示しています。

Visual Basic

Imports System
Imports System.Text
Imports Microsoft.VisualBasic

Class UnicodeEncodingExample
    
    Public Shared Sub Main()
        Dim byteOrderMark() As Byte
        Dim b As Byte
        
        byteOrderMark = Encoding.Unicode.GetPreamble()
        Console.WriteLine("Default (little-endian) Unicode Preamble:")
        For Each b In  byteOrderMark
            Console.Write("[{0}]", b)
        Next b
        Console.WriteLine(ControlChars.NewLine)
        
        Dim bigEndianUnicode As New
 UnicodeEncoding(True, True)
        byteOrderMark = bigEndianUnicode.GetPreamble()
        Console.WriteLine("Big-endian Unicode Preamble:")
        For Each b In  byteOrderMark
            Console.Write("[{0}]", b)
        Next b
    End Sub 'Main
End Class 'UnicodeEncodingExample

using System;
using System.Text;

class UnicodeEncodingExample {
    public static void Main()
 {
        Byte[] byteOrderMark;
        
        byteOrderMark = Encoding.Unicode.GetPreamble();
        Console.WriteLine("Default (little-endian) Unicode Preamble:");
        foreach (Byte b in byteOrderMark) {
            Console.Write("[{0}]", b);
        }
        Console.WriteLine("\n");

        UnicodeEncoding bigEndianUnicode = new UnicodeEncoding(true,
 true);
        byteOrderMark = bigEndianUnicode.GetPreamble();
        Console.WriteLine("Big-endian Unicode Preamble:");
        foreach (Byte b in byteOrderMark) {
            Console.Write("[{0}]", b);
        }
    }
}

C++

using namespace System;
using namespace System::Text;
using namespace System::Collections;
int main()
{
   array<Byte>^byteOrderMark;
   byteOrderMark = Encoding::Unicode->GetPreamble();
   Console::WriteLine( "Default (little-endian) Unicode Preamble:" );
   IEnumerator^ myEnum = byteOrderMark->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      Byte b = safe_cast<Byte>(myEnum->Current);
      Console::Write( "[{0}]", b );
   }

   Console::WriteLine( "\n" );
   UnicodeEncoding^ bigEndianUnicode = gcnew UnicodeEncoding( true,true
 );
   byteOrderMark = bigEndianUnicode->GetPreamble();
   Console::WriteLine( "Big-endian Unicode Preamble:" );
   myEnum = byteOrderMark->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      Byte b = safe_cast<Byte>(myEnum->Current);
      Console::Write( "[{0}]", b );
   }
}

import System.*;
import System.Text.*;

class UnicodeEncodingExample
{
    public static void main(String[]
 args)
    {
        ubyte byteOrderMark[];
        byteOrderMark = Encoding.get_Unicode().GetPreamble();
        Console.WriteLine("Default (little-endian) Unicode Preamble:");
        for(int iCtr = 0; iCtr < byteOrderMark.length;
 iCtr++) {
            ubyte b = byteOrderMark[iCtr];
            Console.Write("[{0}]", String.valueOf(b));
        }
        Console.WriteLine("\n");
        UnicodeEncoding bigEndianUnicode = new UnicodeEncoding(true,
 true);
        byteOrderMark = bigEndianUnicode.GetPreamble();
        Console.WriteLine("Big-endian Unicode Preamble:");
        for(int iCtr = 0; iCtr < byteOrderMark.length;
 iCtr++) {
            ubyte b = byteOrderMark[iCtr];
            Console.Write("[{0}]", String.valueOf(b));
        }
    } //main
} //UnicodeEncodingExample