SoapFormatter SoapFormatter SoapFormatter SoapFormatter Class

定義

オブジェクト、または連結された複数のオブジェクトから成るグラフ全体を、SOAP 形式でシリアル化および逆シリアル化します。Serializes and deserializes an object, or an entire graph of connected objects, in SOAP format.

public ref class SoapFormatter sealed : System::Runtime::Remoting::Messaging::IRemotingFormatter
public sealed class SoapFormatter : System.Runtime.Remoting.Messaging.IRemotingFormatter
type SoapFormatter = class
    interface IRemotingFormatter
    interface IFormatter
Public NotInheritable Class SoapFormatter
Implements IRemotingFormatter
継承
SoapFormatterSoapFormatterSoapFormatterSoapFormatter
実装

#using <system.dll>
#using <system.runtime.serialization.formatters.soap.dll>

using namespace System;
using namespace System::IO;
using namespace System::Collections;
using namespace System::Runtime::Serialization;
using namespace System::Runtime::Serialization::Formatters::Soap;
void Serialize()
{
   
   // Create a hashtable of values that will eventually be serialized.
   Hashtable^ addresses = gcnew Hashtable;
   addresses->Add( "Jeff", "123 Main Street, Redmond, WA 98052" );
   addresses->Add( "Fred", "987 Pine Road, Phila., PA 19116" );
   addresses->Add( "Mary", "PO Box 112233, Palo Alto, CA 94301" );
   
   // To serialize the hashtable (and its keys/values), 
   // you must first open a stream for writing.
   // We will use a file stream here.
   FileStream^ fs = gcnew FileStream( "DataFile.soap",FileMode::Create );
   
   // Construct a SoapFormatter and use it 
   // to serialize the data to the stream.
   SoapFormatter^ formatter = gcnew SoapFormatter;
   try
   {
      formatter->Serialize( fs, addresses );
   }
   catch ( SerializationException^ e ) 
   {
      Console::WriteLine( "Failed to serialize. Reason: {0}", e->Message );
      throw;
   }
   finally
   {
      fs->Close();
   }

}

void Deserialize()
{
   
   // Declare the hashtable reference.
   Hashtable^ addresses = nullptr;
   
   // Open the file containing the data that we want to deserialize.
   FileStream^ fs = gcnew FileStream( "DataFile.soap",FileMode::Open );
   try
   {
      SoapFormatter^ formatter = gcnew SoapFormatter;
      
      // Deserialize the hashtable from the file and 
      // assign the reference to our local variable.
      addresses = dynamic_cast<Hashtable^>(formatter->Deserialize( fs ));
   }
   catch ( SerializationException^ e ) 
   {
      Console::WriteLine( "Failed to deserialize. Reason: {0}", e->Message );
      throw;
   }
   finally
   {
      fs->Close();
   }

   
   // To prove that the table deserialized correctly, 
   // display the keys/values to the console.
   IEnumerator^ myEnum = addresses->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      DictionaryEntry^ de = safe_cast<DictionaryEntry^>(myEnum->Current);
      Console::WriteLine( " {0} lives at {1}.", de->Key, de->Value );
   }
}


[STAThread]
int main()
{
   Serialize();
   Deserialize();
}

using System;
using System.IO;
using System.Collections;
using System.Runtime.Serialization;

// Note: When building this code, you must reference the
// System.Runtime.Serialization.Formatters.Soap.dll assembly.
using System.Runtime.Serialization.Formatters.Soap;


class App 
{
    [STAThread]
    static void Main() 
    {
        Serialize();
        Deserialize();
    }

    static void Serialize() 
    {
        // Create a hashtable of values that will eventually be serialized.
        Hashtable addresses = new Hashtable();
        addresses.Add("Jeff", "123 Main Street, Redmond, WA 98052");
        addresses.Add("Fred", "987 Pine Road, Phila., PA 19116");
        addresses.Add("Mary", "PO Box 112233, Palo Alto, CA 94301");

        // To serialize the hashtable (and its key/value pairs), 
        // you must first open a stream for writing.
        // Use a file stream here.
        FileStream fs = new FileStream("DataFile.soap", FileMode.Create);

        // Construct a SoapFormatter and use it 
        // to serialize the data to the stream.
        SoapFormatter formatter = new SoapFormatter();
        try 
        {
            formatter.Serialize(fs, addresses);
        }
        catch (SerializationException e) 
        {
            Console.WriteLine("Failed to serialize. Reason: " + e.Message);
            throw;
        }
        finally 
        {
            fs.Close();
        }
    }

   
    static void Deserialize() 
    {
        // Declare the hashtable reference.
        Hashtable addresses  = null;

        // Open the file containing the data that you want to deserialize.
        FileStream fs = new FileStream("DataFile.soap", FileMode.Open);
        try 
        {
            SoapFormatter formatter = new SoapFormatter();

            // Deserialize the hashtable from the file and 
            // assign the reference to the local variable.
            addresses = (Hashtable) formatter.Deserialize(fs);
        }
        catch (SerializationException e) 
        {
            Console.WriteLine("Failed to deserialize. Reason: " + e.Message);
            throw;
        }
        finally 
        {
            fs.Close();
        }

        // To prove that the table deserialized correctly, 
        // display the key/value pairs to the console.
        foreach (DictionaryEntry de in addresses) 
        {
            Console.WriteLine("{0} lives at {1}.", de.Key, de.Value);
        }
    }
}
Imports System.IO
Imports System.Collections
Imports System.Runtime.Serialization

' Note: When building this code, you must reference the
' System.Runtime.Serialization.Formatters.Soap.dll assembly.
Imports System.Runtime.Serialization.Formatters.Soap


Module App

   Sub Main()
      Serialize()
      Deserialize()
   End Sub

   Sub Serialize()
      ' Create a hashtable of values that will eventually be serialized.
      Dim addresses As New Hashtable
      addresses.Add("Jeff", "123 Main Street, Redmond, WA 98052")
      addresses.Add("Fred", "987 Pine Road, Phila., PA 19116")
      addresses.Add("Mary", "PO Box 112233, Palo Alto, CA 94301")

      ' To serialize the hashtable (and its key/value pairs), 
      ' you must first open a stream for writing.
      ' Use a file stream here.
      Dim fs As New FileStream("DataFile.soap", FileMode.Create)

      ' Construct a SoapFormatter and use it 
      ' to serialize the data to the stream.
      Dim formatter As New SoapFormatter
      Try
         formatter.Serialize(fs, addresses)
      Catch e As SerializationException
         Console.WriteLine("Failed to serialize. Reason: " & e.Message)
         Throw
      Finally
         fs.Close()
      End Try
   End Sub


   Sub Deserialize()
      ' Declare the hashtable reference.
      Dim addresses As Hashtable = Nothing

      ' Open the file containing the data that you want to deserialize.
      Dim fs As New FileStream("DataFile.soap", FileMode.Open)
      Try
         Dim formatter As New SoapFormatter

         ' Deserialize the hashtable from the file and 
         ' assign the reference to the local variable.
         addresses = DirectCast(formatter.Deserialize(fs), Hashtable)
      Catch e As SerializationException
         Console.WriteLine("Failed to deserialize. Reason: " & e.Message)
         Throw
      Finally
         fs.Close()
      End Try

      ' To prove that the table deserialized correctly, 
      ' display the key/value pairs to the console.
      Dim de As DictionaryEntry
      For Each de In addresses
         Console.WriteLine("{0} lives at {1}.", de.Key, de.Value)
      Next
   End Sub
End Module

注釈

注意

以降、.NET Framework 2.0 では、このクラスは、廃止されています。Beginning with the .NET Framework 2.0, this class is obsolete. 代わりに、BinaryFormatter を使用してください。Use BinaryFormatter instead.

SoapFormatterBinaryFormatterクラスの実装、IRemotingFormatterリモート プロシージャ コール (Rpc) をサポートするインターフェイスとIFormatterインターフェイス (によって継承、 IRemotingFormatter) オブジェクトのグラフのシリアル化をサポートするためにします。The SoapFormatter and BinaryFormatter classes implement the IRemotingFormatter interface to support remote procedure calls (RPCs), and the IFormatter interface (inherited by the IRemotingFormatter) to support serialization of a graph of objects. SoapFormatterクラスは、Rpc もサポートしています。ISoapMessageを使用せず、オブジェクト、IRemotingFormatter機能します。The SoapFormatter class also supports RPCs with ISoapMessage objects, without using the IRemotingFormatter functionality.

Rpc、中に、IRemotingFormatterインターフェイスにより、2 つの個別のオブジェクト グラフの指定: シリアル化するオブジェクトのグラフと (リモート関数呼び出しに関する情報を伝達するヘッダーのオブジェクトの配列を含むその他のグラフ例、トランザクション ID またはメソッド シグネチャ)。During RPCs, the IRemotingFormatter interface allows the specification of two separate object graphs: the graph of objects to serialize, and an additional graph that contains an array of header objects that convey information about the remote function call (for example, transaction ID or a method signature). 最初のグラフのルート オブジェクトの適切なシリアル化は、いずれかを実装するオブジェクトをする必要があります、IMethodCallMessageインターフェイスまたはIMethodReturnMessageインターフェイス。For proper serialization, the root object of the first graph must be an object that implements either the IMethodCallMessage interface or the IMethodReturnMessage interface.

RPC での逆シリアル化中に、HeaderHandlerに指定するデリゲート、Deserializeフォーマッタのメソッド。During deserialization of an RPC, a HeaderHandler delegate is specified to the Deserialize method of the formatter. リモート処理インフラストラクチャを使用して、HeaderHandlerデリゲートをサポートするオブジェクトを生成するために、ISerializableインターフェイス。The remoting infrastructure uses the HeaderHandler delegate to produce an object that supports the ISerializable interface. このオブジェクトは、ヘッダーに格納された情報が含まれていて、デシリアライザーによって返されるグラフのルートになります。This object contains the information stored in the headers, and becomes the root of the graph returned by the deserializer.

SoapFormatterを実装するオブジェクトで生成される Rpc を処理することも、ISoapMessageインターフェイス。The SoapFormatter can also handle RPCs that are produced with objects that implement the ISoapMessage interface. 使用せず、RPC を作成する、IRemotingFormatterをサポートするオブジェクトの場所、機能、ISoapMessageシリアル化されるグラフのルートにあるインターフェイスです。To create an RPC without using the IRemotingFormatter functionality, place an object that supports the ISoapMessage interface at the root of a graph being serialized. この方法で作成した RPC を逆シリアル化する、TopObjectをサポートする別のオブジェクトにプロパティを設定する必要があります、ISoapMessageインターフェイス、および関連するリモート呼び出し情報が含まれます。To deserialize an RPC created in this manner the TopObject property must be set to another object that supports the ISoapMessage interface, and contains the relevant remote call information.

TimeSpan のシリアル化TimeSpan Serialization

ISO 8601 に従っては、TimeSpan オブジェクトがシリアル化されます。標準の「代替」1998年セクション 5.5.3.2.1 です。TimeSpan objects are serialized according to the ISO 8601: 1998 section 5.5.3.2.1 "Alternative" standard.

バージョン情報Version Information

SoapFormatterは .NET Framework のバージョン間でシリアル化の互換性をサポートしていません。The SoapFormatter does not support serialization compatibility between versions of the .NET Framework. 多くの場合、Framework のバージョン 1.1 および 2.0 型間のシリアル化は失敗します。Serialization between versions 1.1 and 2.0 types in the Framework often fails. 次の処置を実行して、この問題を解決することができます。The following actions can be taken to remedy this issue:

  • 使用する変換、 BinaryFormatter、1.1 および 2.0 の間の互換性を提供します。Convert to use the BinaryFormatter, which provides compatibility between 1.1 and 2.0.

  • 既存の永続化されたデータを新しい形式に変換します。Convert existing persisted data to the new format.

  • バージョン 2.0 には、すべてのプロデューサーとコンシューマーのシリアル化されたデータを変換します。Convert all producers and consumers of serialized data to version 2.0.

  • 1.1 から 2.0 に変更の種類を使用しないでください。Avoid using types that changed from 1.1 to 2.0.

コンストラクター

SoapFormatter() SoapFormatter() SoapFormatter() SoapFormatter()

SoapFormatter クラスの新しいインスタンスを既定のプロパティ値で初期化します。Initializes a new instance of the SoapFormatter class with default property values.

SoapFormatter(ISurrogateSelector, StreamingContext) SoapFormatter(ISurrogateSelector, StreamingContext) SoapFormatter(ISurrogateSelector, StreamingContext) SoapFormatter(ISurrogateSelector, StreamingContext)

指定された SoapFormatterISurrogateSelector を使用して、StreamingContext クラスの新しいインスタンスを初期化します。Initializes a new instance of the SoapFormatter class with the specified ISurrogateSelector and StreamingContext.

プロパティ

AssemblyFormat AssemblyFormat AssemblyFormat AssemblyFormat

アセンブリの検索と読み込みに関するデシリアライザーの動作を取得または設定します。Gets or sets the behavior of the deserializer with regards to finding and loading assemblies.

Binder Binder Binder Binder

シリアル化されたオブジェクトから型へのバインディングを制御する、SerializationBinder を取得または設定します。Gets or sets the SerializationBinder that controls the binding of a serialized object to a type.

Context Context Context Context

この StreamingContext で使用する SoapFormatter を取得または設定します。Gets or sets the StreamingContext used with this SoapFormatter.

FilterLevel FilterLevel FilterLevel FilterLevel

.NET Framework のリモート処理用の自動逆シリアル化の TypeFilterLevel を取得または設定します。Gets or sets the TypeFilterLevel of automatic deserialization for .NET Framework remoting.

SurrogateSelector SurrogateSelector SurrogateSelector SurrogateSelector

シリアル化中および逆シリアル化中に行われる型の置換を制御する SurrogateSelector を取得または設定します。Gets or sets the SurrogateSelector that controls type substitution during serialization and deserialization.

TopObject TopObject TopObject TopObject

SOAP の先頭オブジェクトの逆シリアル化先である ISoapMessage を取得または設定します。Gets or sets the ISoapMessage into which the SOAP top object is deserialized.

TypeFormat TypeFormat TypeFormat TypeFormat

シリアル化されたストリームにおける型の記述のレイアウト形式を取得または設定します。Gets or sets the format in which type descriptions are laid out in the serialized stream.

メソッド

Deserialize(Stream) Deserialize(Stream) Deserialize(Stream) Deserialize(Stream)

指定されたストリームのデータを逆シリアル化し、オブジェクトのグラフを再構成します。Deserializes the data on the provided stream and reconstitutes the graph of objects.

Deserialize(Stream, HeaderHandler) Deserialize(Stream, HeaderHandler) Deserialize(Stream, HeaderHandler) Deserialize(Stream, HeaderHandler)

ストリームをオブジェクト グラフに逆シリアル化し、そのストリーム内にヘッダーがある場合は、指定した HeaderHandler によってそのヘッダーを処理します。Deserializes the stream into an object graph with any headers in that stream being handled by the given HeaderHandler.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
Serialize(Stream, Object) Serialize(Stream, Object) Serialize(Stream, Object) Serialize(Stream, Object)

オブジェクト、またはルートを指定したオブジェクト グラフを、指定した Stream にシリアル化します。Serializes an object or graph of objects with the specified root to the given Stream.

Serialize(Stream, Object, Header[]) Serialize(Stream, Object, Header[]) Serialize(Stream, Object, Header[]) Serialize(Stream, Object, Header[])

オブジェクト、またはルートを指定したオブジェクト グラフを、指定した Stream に SOAP リモート プロシージャ コール (RPC: Remote Procedure Call) 形式でシリアル化します。Serializes an object or graph of objects with the specified root to the given Stream in the SOAP Remote Procedure Call (RPC) format.

ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

適用対象