SerializationInfo

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

SerializationInfo クラス

オブジェクトのシリアル化または逆シリアル化に必要なすべてのデータを格納します。このクラスは継承できません。

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

Visual Basic (宣言)

<ComVisibleAttribute(True)> _
Public NotInheritable Class
 SerializationInfo

Visual Basic (使用法)

Dim instance As SerializationInfo

C#

[ComVisibleAttribute(true)] 
public sealed class SerializationInfo

C++

[ComVisibleAttribute(true)] 
public ref class SerializationInfo sealed

J#

/** @attribute ComVisibleAttribute(true) */ 
public final class SerializationInfo

JScript

ComVisibleAttribute(true) 
public final class SerializationInfo

解説

このクラスは、カスタム シリアル化動作を行うオブジェクトによって使用されます。ISerializable または ISerializationSurrogate の GetObjectData メソッドが、SerializationInfo ストアに、シリアル化するそれぞれの情報の名前、型、および値を設定します。逆シリアル化中に、適切な関数を使用してこの情報を抽出できます。

オブジェクトは、シリアル化の実行時に AddValue メソッドを使用して SerializationInfo ストアに追加され、逆シリアル化の実行時に GetValue メソッドを使用して SerializationInfo ストアから抽出されます。

シリアル化のカスタマイズの詳細については、「シリアル化のカスタマイズ」を参照してください。

使用例

さまざまな値の、カスタム シリアル化およびカスタム逆シリアル化のための SerializationInfo を示すコード例を次に示します。

Visual Basic

Imports System
Imports System.Web
Imports System.IO
Imports System.Collections
Imports System.Runtime.Serialization.Formatters.Binary
Imports System.Runtime.Serialization
Imports System.Security.Permissions


' There should be only one instance of this type per AppDomain.
<Serializable()> _
Public NotInheritable Class
 Singleton
   Implements ISerializable

   ' This is the one instance of this type.
   Private Shared ReadOnly
 theOneObject As New Singleton

   ' Here are the instance fields.
   Public someString As String
   Public someNumber As Int32

   ' Private constructor allowing this type to construct the Singleton.
   Private Sub New()
      ' Do whatever is necessary to initialize the Singleton.
      someString = "This is a string field"
      someNumber = 123
   End Sub

   ' A method returning a reference to the Singleton.
   Public Shared Function
 GetSingleton() As Singleton
      Return theOneObject
   End Function

   ' A method called when serializing a Singleton.
   <SecurityPermissionAttribute(SecurityAction.LinkDemand, _
   Flags:=SecurityPermissionFlag.SerializationFormatter)> _
   Private Sub GetObjectData(ByVal
 info As SerializationInfo, _
      ByVal context As StreamingContext) _
      Implements ISerializable.GetObjectData

      ' Instead of serializing this object, we will  
      ' serialize a SingletonSerializationHelp instead.
      info.SetType(GetType(SingletonSerializationHelper))
      ' No other values need to be added.
   End Sub

   ' Note: ISerializable's special constructor is not necessary 
   ' because it is never called.
End Class


<Serializable()> _
Friend NotInheritable Class
 SingletonSerializationHelper
   Implements IObjectReference
   ' This object has no fields (although it could).

   ' GetRealObject is called after this object is deserialized.
   Public Function GetRealObject(ByVal
 context As StreamingContext) As Object
 Implements IObjectReference.GetRealObject
      ' When deserialiing this object, return a reference to 
      ' the Singleton object instead.
      Return Singleton.GetSingleton()
   End Function
End Class


Class App
   <STAThread()> Shared Sub Main()
        Run()
    End Sub

    Shared Sub Run()
        Dim fs As New FileStream("DataFile.dat",
 FileMode.Create)

        Try
            ' Construct a BinaryFormatter and use it 
            ' to serialize the data to the stream.
            Dim formatter As New
 BinaryFormatter

            ' Create an array with multiple elements refering to 
            ' the one Singleton object.
            Dim a1() As Singleton = {Singleton.GetSingleton(),
 Singleton.GetSingleton()}

            ' This displays "True".
            Console.WriteLine("Do both array elements refer to
 the same object? " & _
               Object.ReferenceEquals(a1(0), a1(1)))

            ' Serialize the array elements.
            formatter.Serialize(fs, a1)

            ' Deserialize the array elements.
            fs.Position = 0
            Dim a2() As Singleton = DirectCast(formatter.Deserialize(fs),
 Singleton())

            ' This displays "True".
            Console.WriteLine("Do both array elements refer to
 the same object? " & _
               Object.ReferenceEquals(a2(0), a2(1)))

            ' This displays "True".
            Console.WriteLine("Do all array elements refer to
 the same object? " & _
               Object.ReferenceEquals(a1(0), a2(0)))
        Catch e As SerializationException
            Console.WriteLine("Failed to serialize. Reason: "
 & e.Message)
            Throw
        Finally
            fs.Close()
        End Try

    End Sub
End Class

C#

using System;
using System.Web;
using System.IO;
using System.Collections;
using System.Runtime.Serialization.Formatters.Binary;
using System.Runtime.Serialization;
using System.Security.Permissions;


// There should be only one instance of this type per AppDomain.
[Serializable]
public sealed class Singleton : ISerializable
 
{
    // This is the one instance of this type.
    private static readonly Singleton theOneObject
 = new Singleton();

    // Here are the instance fields.
    private string someString_value;
    private Int32 someNumber_value;

   public string SomeString
   {
       get{return someString_value;}
       set{someString_value = value;}
   }

   public Int32 SomeNumber
   {
       get{return someNumber_value;}
       set{someNumber_value = value;}
   }

    // Private constructor allowing this type to construct the Singleton.
    private Singleton() 
    { 
        // Do whatever is necessary to initialize the Singleton.
        someString_value = "This is a string field";
        someNumber_value = 123;
    }

    // A method returning a reference to the Singleton.
    public static Singleton GetSingleton()
 
    { 
        return theOneObject; 
    }

    // A method called when serializing a Singleton.
    [SecurityPermissionAttribute(SecurityAction.LinkDemand, 
    Flags=SecurityPermissionFlag.SerializationFormatter)]
    void ISerializable.GetObjectData(
        SerializationInfo info, StreamingContext context) 
    {
        // Instead of serializing this object, 
        // serialize a SingletonSerializationHelp instead.
        info.SetType(typeof(SingletonSerializationHelper));
        // No other values need to be added.
    }

    // Note: ISerializable's special constructor is not necessary 
    // because it is never called.
}


[Serializable]
internal sealed class SingletonSerializationHelper : IObjectReference
 
{
    // This object has no fields (although it could).

    // GetRealObject is called after this object is deserialized.
    public Object GetRealObject(StreamingContext context) 
    {
        // When deserialiing this object, return a reference to 
        // the Singleton object instead.
        return Singleton.GetSingleton();
    }
}


class App 
{
    [STAThread]
    static void Main() 
    {
        FileStream fs = new FileStream("DataFile.dat",
 FileMode.Create);

        try 
        {
            // Construct a BinaryFormatter and use it 
            // to serialize the data to the stream.
            BinaryFormatter formatter = new BinaryFormatter();

            // Create an array with multiple elements refering to 
            // the one Singleton object.
            Singleton[] a1 = { Singleton.GetSingleton(), Singleton.GetSingleton()
 };

            // This displays "True".
            Console.WriteLine(
                "Do both array elements refer to the same object? " + 
                (a1[0] == a1[1]));     

            // Serialize the array elements.
            formatter.Serialize(fs, a1);

            // Deserialize the array elements.
            fs.Position = 0;
            Singleton[] a2 = (Singleton[]) formatter.Deserialize(fs);

            // This displays "True".
            Console.WriteLine("Do both array elements refer to the same object?
 " 
                + (a2[0] == a2[1])); 

            // This displays "True".
            Console.WriteLine("Do all array elements refer to the same object?
 " 
                + (a1[0] == a2[0]));
        }   
        catch (SerializationException e) 
        {
            Console.WriteLine("Failed to serialize. Reason: " + e.Message);
            throw;
        }
        finally 
        {
            fs.Close();
        }
    }
}

C++

using namespace System;
using namespace System::IO;
using namespace System::Collections;
using namespace System::Runtime::Serialization::Formatters::Binary;
using namespace System::Runtime::Serialization;

ref class SingletonSerializationHelper;

// There should be only one instance of this type per AppDomain.

[Serializable]
public ref class Singleton sealed: public
 ISerializable
{
private:

   // This is the one instance of this type.
   static Singleton^ theOneObject = gcnew Singleton;

public:

   // Here are the instance fields.
   String^ someString;
   Int32 someNumber;

private:

   // Private constructor allowing this type to construct the singleton.
   Singleton()
   {
      
      // Do whatever is necessary to initialize the singleton.
      someString = "This is a String* field";
      someNumber = 123;
   }

public:

   // A method returning a reference to the singleton.
   static Singleton^ GetSingleton()
   {
      return theOneObject;
   }

   // A method called when serializing a Singleton.
   [System::Security::Permissions::SecurityPermissionAttribute
   (System::Security::Permissions::SecurityAction::LinkDemand, 
   Flags=System::Security::Permissions::SecurityPermissionFlag::SerializationFormatter)]
   virtual void GetObjectData( SerializationInfo^ info, StreamingContext
 context )
   {
      // Instead of serializing this Object*, we will  
      // serialize a SingletonSerializationHelp instead.
      info->SetType( SingletonSerializationHelper::typeid );

      // No other values need to be added.
   }

   // NOTE: ISerializable*'s special constructor is NOT necessary 
   // because it's never called
};

[Serializable]
private ref class SingletonSerializationHelper
 sealed: public IObjectReference
{
public:

   // This Object* has no fields (although it could).
   // GetRealObject is called after this Object* is deserialized
   virtual Object^ GetRealObject( StreamingContext context )
   {
      // When deserialiing this Object*, return a reference to 
      // the singleton Object* instead.
      return Singleton::GetSingleton();
   }
};

[STAThread]
int main()
{
   FileStream^ fs = gcnew FileStream( "DataFile.dat",FileMode::Create );
   try
   {
      // Construct a BinaryFormatter and use it 
      // to serialize the data to the stream.
      BinaryFormatter^ formatter = gcnew BinaryFormatter;

      // Create an array with multiple elements refering to 
      // the one Singleton Object*.
      array<Singleton^>^a1 = {Singleton::GetSingleton(),Singleton::GetSingleton()};

      // This displays S"True".
      Console::WriteLine( "Do both array elements refer to the same Object?
 {0}", (a1[ 0 ] == a1[ 1 ]) );

      // Serialize the array elements.
      formatter->Serialize( fs, a1 );

      // Deserialize the array elements.
      fs->Position = 0;
      array<Singleton^>^a2 = (array<Singleton^>^)formatter->Deserialize(
 fs );

      // This displays S"True".
      Console::WriteLine( "Do both array elements refer to the same Object?
 {0}", (a2[ 0 ] == a2[ 1 ]) );

      // This displays S"True".
      Console::WriteLine( "Do all  array elements refer to the same Object?
 {0}", (a1[ 0 ] == a2[ 0 ]) );
   }
   catch ( SerializationException^ e ) 
   {
      Console::WriteLine( "Failed to serialize. Reason: {0}", e->Message
 );
      throw;
   }
   finally
   {
      fs->Close();
   }

   return 0;
}

継承階層

System.Object
  System.Runtime.Serialization.SerializationInfo

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
SerializationInfo メンバ
System.Runtime.Serialization 名前空間
ISerializable インターフェイス
その他の技術情報
XML シリアル化および SOAP シリアル化
シリアル化のカスタマイズ

SerializationInfo コンストラクタ

SerializationInfo クラスの新しいインスタンスを作成します。

このコンストラクタは、CLS に準拠していません。  

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

Visual Basic (宣言)

<CLSCompliantAttribute(False)> _
Public Sub New ( _
    type As Type, _
    converter As IFormatterConverter _
)

Visual Basic (使用法)

Dim type As Type
Dim converter As IFormatterConverter

Dim instance As New SerializationInfo(type,
 converter)

C#

[CLSCompliantAttribute(false)] 
public SerializationInfo (
    Type type,
    IFormatterConverter converter
)

C++

[CLSCompliantAttribute(false)] 
public:
SerializationInfo (
    Type^ type, 
    IFormatterConverter^ converter
)

J#

/** @attribute CLSCompliantAttribute(false) */ 
public SerializationInfo (
    Type type, 
    IFormatterConverter converter
)

JScript

CLSCompliantAttribute(false) 
public function SerializationInfo (
    type : Type, 
    converter : IFormatterConverter
)

パラメータ

type

シリアル化するオブジェクトの Type。

converter

逆シリアル化中に使用する IFormatterConverter。

例外

例外の種類	条件
ArgumentNullException	type または converter が null 参照 (Visual Basic では Nothing) です。

解説

converter パラメータとして渡された IFormatterConverter は、内部処理形式からユーザーが要求した形式にデータを変換します。SerializationInfo 内のデータの内部処理形式は、データを作成したフォーマッタによって異なります。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
SerializationInfo クラス
SerializationInfo メンバ
System.Runtime.Serialization 名前空間

SerializationInfo プロパティ

パブリック プロパティ

	名前	説明
	AssemblyName	シリアル化時にのみ、シリアル化する型のアセンブリ名を取得または設定します。
	FullTypeName	シリアル化する Type の完全名を取得または設定します。
	MemberCount	SerializationInfo ストアに追加されているメンバの数を取得します。

参照

関連項目

SerializationInfo クラス
System.Runtime.Serialization 名前空間
ISerializable インターフェイス

その他の技術情報

XML シリアル化および SOAP シリアル化
シリアル化のカスタマイズ

SerializationInfo メソッド

パブリック メソッド

	名前	説明
	AddValue	オーバーロードされます。 SerializationInfo に値を追加します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetBoolean	SerializationInfo ストアから Boolean 型の値を取得します。
	GetByte	SerializationInfo ストアから 8 ビット符号なし整数値を取得します。
	GetChar	SerializationInfo ストアから Unicode 文字値を取得します。
	GetDateTime	SerializationInfo ストアから DateTime 値を取得します。
	GetDecimal	SerializationInfo ストアから 10 進値を取得します。
	GetDouble	SerializationInfo ストアから倍精度浮動小数点値を取得します。
	GetEnumerator	SerializationInfo ストアにある名前と値のペアを反復処理するために使用される SerializationInfoEnumerator を返します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetInt16	SerializationInfo ストアから 16 ビット符号付き整数値を取得します。
	GetInt32	SerializationInfo ストアから 32 ビット符号付き整数値を取得します。
	GetInt64	SerializationInfo ストアから 64 ビット符号付き整数値を取得します。
	GetSByte	SerializationInfo ストアから 8 ビット符号付き整数値を取得します。
	GetSingle	SerializationInfo ストアから単精度浮動小数点値を取得します。
	GetString	SerializationInfo ストアから String 値を取得します。
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	GetUInt16	SerializationInfo ストアから 16 ビット符号なし整数値を取得します。
	GetUInt32	SerializationInfo ストアから 32 ビット符号なし整数値を取得します。
	GetUInt64	SerializationInfo ストアから 64 ビット符号なし整数値を取得します。
	GetValue	SerializationInfo ストアから値を取得します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	SetType	シリアル化するオブジェクトの Type を設定します。
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

参照

関連項目

SerializationInfo クラス
System.Runtime.Serialization 名前空間
ISerializable インターフェイス

その他の技術情報

XML シリアル化および SOAP シリアル化
シリアル化のカスタマイズ

SerializationInfo メンバ

オブジェクトのシリアル化または逆シリアル化に必要なすべてのデータを格納します。このクラスは継承できません。

SerializationInfo データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	SerializationInfo	SerializationInfo クラスの新しいインスタンスを作成します。

パブリック プロパティ

	名前	説明
	AssemblyName	シリアル化時にのみ、シリアル化する型のアセンブリ名を取得または設定します。
	FullTypeName	シリアル化する Type の完全名を取得または設定します。
	MemberCount	SerializationInfo ストアに追加されているメンバの数を取得します。

パブリック メソッド

	名前	説明
	AddValue	オーバーロードされます。 SerializationInfo に値を追加します。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetBoolean	SerializationInfo ストアから Boolean 型の値を取得します。
	GetByte	SerializationInfo ストアから 8 ビット符号なし整数値を取得します。
	GetChar	SerializationInfo ストアから Unicode 文字値を取得します。
	GetDateTime	SerializationInfo ストアから DateTime 値を取得します。
	GetDecimal	SerializationInfo ストアから 10 進値を取得します。
	GetDouble	SerializationInfo ストアから倍精度浮動小数点値を取得します。
	GetEnumerator	SerializationInfo ストアにある名前と値のペアを反復処理するために使用される SerializationInfoEnumerator を返します。
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetInt16	SerializationInfo ストアから 16 ビット符号付き整数値を取得します。
	GetInt32	SerializationInfo ストアから 32 ビット符号付き整数値を取得します。
	GetInt64	SerializationInfo ストアから 64 ビット符号付き整数値を取得します。
	GetSByte	SerializationInfo ストアから 8 ビット符号付き整数値を取得します。
	GetSingle	SerializationInfo ストアから単精度浮動小数点値を取得します。
	GetString	SerializationInfo ストアから String 値を取得します。
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	GetUInt16	SerializationInfo ストアから 16 ビット符号なし整数値を取得します。
	GetUInt32	SerializationInfo ストアから 32 ビット符号なし整数値を取得します。
	GetUInt64	SerializationInfo ストアから 64 ビット符号なし整数値を取得します。
	GetValue	SerializationInfo ストアから値を取得します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	SetType	シリアル化するオブジェクトの Type を設定します。
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

参照

関連項目

SerializationInfo クラス
System.Runtime.Serialization 名前空間
ISerializable インターフェイス

その他の技術情報

XML シリアル化および SOAP シリアル化
シリアル化のカスタマイズ