This documentation is archived and is not being maintained.

BinaryFormatter.Deserialize Method (Stream)

Deserializes the specified stream into an object graph.

Namespace:  System.Runtime.Serialization.Formatters.Binary
Assembly:  mscorlib (in mscorlib.dll)

public Object Deserialize(
	Stream serializationStream
)

Parameters

serializationStream
Type: System.IO.Stream

The stream from which to deserialize the object graph.

Return Value

Type: System.Object
The top (root) of the object graph.

Implements

IFormatter.Deserialize(Stream)

ExceptionCondition
ArgumentNullException

The serializationStream is null.

SerializationException

The serializationStream supports seeking, but its length is 0.

SecurityException

The caller does not have the required permission.

For successful deserialization, the current position in the stream must be at the beginning of the object graph.

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

public 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.  
        // In this case, use a file stream.
        FileStream fs = new FileStream("DataFile.dat", FileMode.Create);

        // Construct a BinaryFormatter and use it to serialize the data to the stream.
        BinaryFormatter formatter = new BinaryFormatter();
        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.dat", FileMode.Open);
        try 
        {
            BinaryFormatter formatter = new BinaryFormatter();

            // 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. 
        foreach (DictionaryEntry de in addresses) 
        {
            Console.WriteLine("{0} lives at {1}.", de.Key, de.Value);
        }
    }
}
#using <mscorlib.dll>

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

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

		// To serialize the hashtable (and its keys/values),  
		// you must first open a stream for writing. 
		// In this case we will use a file stream.
		FileStream* fs = new FileStream(S"DataFile.dat", FileMode::Create);

		// Construct a BinaryFormatter and use it to serialize the data to the stream.
		BinaryFormatter* formatter = new BinaryFormatter();
		try 
		{
			formatter->Serialize(fs, addresses);
		}
		catch (SerializationException* e) 
		{
			Console::WriteLine(S"Failed to serialize. Reason: {0}", e->Message);
			throw;
		}
		__finally 
		{
			fs->Close();
		}
	}

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

		// Open the file containing the data that we want to deserialize.
		FileStream* fs = new FileStream(S"DataFile.dat", FileMode::Open);
		try 
		{
			BinaryFormatter* formatter = new BinaryFormatter();

			// 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(S"Failed to deserialize. Reason: {0}", e->Message);
			throw;
		}
		__finally 
		{
			fs->Close();
		}

		// To prove that the table deserialized correctly, display the keys/values.
		IEnumerator* myEnum = addresses->GetEnumerator();
		while (myEnum->MoveNext()) 
		{
			DictionaryEntry* de = __try_cast<DictionaryEntry*>(myEnum->Current);

			Console::WriteLine(S" {0} lives at {1}.", de->Key, de->Value);
		}
	}
};

[STAThread]
int main() 
{
	App::Serialize();
	App::Deserialize();
	return 0;
}

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

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Show: