SALES: 1-800-867-1380
Microsoft Azure
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

SerializationInfo Class

 

Stores all the data needed to serialize or deserialize an object. This class cannot be inherited.

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

System.Object
  System.Runtime.Serialization.SerializationInfo

[ComVisibleAttribute(true)]
public sealed class SerializationInfo

NameDescription
System_CAPS_pubmethodSerializationInfo(Type, IFormatterConverter)

Creates a new instance of the SerializationInfo class.

System_CAPS_pubmethodSerializationInfo(Type, IFormatterConverter, Boolean)

Initializes a new instance of the SerializationInfo class.

NameDescription
System_CAPS_pubpropertyAssemblyName

Gets or sets the assembly name of the type to serialize during serialization only.

System_CAPS_pubpropertyFullTypeName

Gets or sets the full name of the Type to serialize.

System_CAPS_pubpropertyIsAssemblyNameSetExplicit

Gets whether the assembly name has been explicitly set.

System_CAPS_pubpropertyIsFullTypeNameSetExplicit

Gets whether the full type name has been explicitly set.

System_CAPS_pubpropertyMemberCount

Gets the number of members that have been added to the SerializationInfo store.

System_CAPS_pubpropertyObjectType

Returns the type of the object to be serialized.

NameDescription
System_CAPS_pubmethodAddValue(String, Boolean)

Adds a Boolean value into the SerializationInfo store.

System_CAPS_pubmethodAddValue(String, Byte)

Adds an 8-bit unsigned integer value into the SerializationInfo store.

System_CAPS_pubmethodAddValue(String, Char)

Adds a Unicode character value into the SerializationInfo store.

System_CAPS_pubmethodAddValue(String, DateTime)

Adds a DateTime value into the SerializationInfo store.

System_CAPS_pubmethodAddValue(String, Decimal)

Adds a decimal value into the SerializationInfo store.

System_CAPS_pubmethodAddValue(String, Double)

Adds a double-precision floating-point value into the SerializationInfo store.

System_CAPS_pubmethodAddValue(String, Int16)

Adds a 16-bit signed integer value into the SerializationInfo store.

System_CAPS_pubmethodAddValue(String, Int32)

Adds a 32-bit signed integer value into the SerializationInfo store.

System_CAPS_pubmethodAddValue(String, Int64)

Adds a 64-bit signed integer value into the SerializationInfo store.

System_CAPS_pubmethodAddValue(String, Object)

Adds the specified object into the SerializationInfo store, where it is associated with a specified name.

System_CAPS_pubmethodAddValue(String, Object, Type)

Adds a value into the SerializationInfo store, where value is associated with name and is serialized as being of Typetype.

System_CAPS_pubmethodAddValue(String, SByte)

Adds an 8-bit signed integer value into the SerializationInfo store.

System_CAPS_pubmethodAddValue(String, Single)

Adds a single-precision floating-point value into the SerializationInfo store.

System_CAPS_pubmethodAddValue(String, UInt16)

Adds a 16-bit unsigned integer value into the SerializationInfo store.

System_CAPS_pubmethodAddValue(String, UInt32)

Adds a 32-bit unsigned integer value into the SerializationInfo store.

System_CAPS_pubmethodAddValue(String, UInt64)

Adds a 64-bit unsigned integer value into the SerializationInfo store.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetBoolean(String)

Retrieves a Boolean value from the SerializationInfo store.

System_CAPS_pubmethodGetByte(String)

Retrieves an 8-bit unsigned integer value from the SerializationInfo store.

System_CAPS_pubmethodGetChar(String)

Retrieves a Unicode character value from the SerializationInfo store.

System_CAPS_pubmethodGetDateTime(String)

Retrieves a DateTime value from the SerializationInfo store.

System_CAPS_pubmethodGetDecimal(String)

Retrieves a decimal value from the SerializationInfo store.

System_CAPS_pubmethodGetDouble(String)

Retrieves a double-precision floating-point value from the SerializationInfo store.

System_CAPS_pubmethodGetEnumerator()

Returns a SerializationInfoEnumerator used to iterate through the name-value pairs in the SerializationInfo store.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetInt16(String)

Retrieves a 16-bit signed integer value from the SerializationInfo store.

System_CAPS_pubmethodGetInt32(String)

Retrieves a 32-bit signed integer value from the SerializationInfo store.

System_CAPS_pubmethodGetInt64(String)

Retrieves a 64-bit signed integer value from the SerializationInfo store.

System_CAPS_pubmethodGetSByte(String)

Retrieves an 8-bit signed integer value from the SerializationInfo store.

System_CAPS_pubmethodGetSingle(String)

Retrieves a single-precision floating-point value from the SerializationInfo store.

System_CAPS_pubmethodGetString(String)

Retrieves a String value from the SerializationInfo store.

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetUInt16(String)

Retrieves a 16-bit unsigned integer value from the SerializationInfo store.

System_CAPS_pubmethodGetUInt32(String)

Retrieves a 32-bit unsigned integer value from the SerializationInfo store.

System_CAPS_pubmethodGetUInt64(String)

Retrieves a 64-bit unsigned integer value from the SerializationInfo store.

System_CAPS_pubmethodGetValue(String, Type)

Retrieves a value from the SerializationInfo store.

System_CAPS_pubmethodSetType(Type)

Sets the Type of the object to serialize.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

This class is used by objects with custom serialization behavior. The GetObjectData method on either ISerializable or ISerializationSurrogate populates the SerializationInfo store with the name, type, and value of each piece of information it wants to serialize. During deserialization, the appropriate function can extract this information.

Objects are added to the SerializationInfo store at serialization time using the AddValue methods and extracted from the SerializationInfo store at deserialization using the GetValue methods.

For more information about customizing serialization, see Custom Serialization.

The following code example demonstrates the SerializationInfo for custom serialization and deserialization of various values.

using System;
using System.Text;
using System.IO;
// Add references to Soap and Binary formatters.
using System.Runtime.Serialization.Formatters.Binary;
using System.Runtime.Serialization.Formatters.Soap ;
using System.Runtime.Serialization;


[Serializable]
public class MyItemType : ISerializable
{
    public MyItemType()
    {
        // Empty constructor required to compile.
    }

    // The value to serialize.
    private string myProperty_value;

    public string MyProperty
    {
        get { return myProperty_value; }
        set { myProperty_value = value; }
    }

    // Implement this method to serialize data. The method is called 
    // on serialization.
    public void GetObjectData(SerializationInfo info, StreamingContext context)
    {
        // Use the AddValue method to specify serialized values.
        info.AddValue("props", myProperty_value, typeof(string));

    }

    // The special constructor is used to deserialize values.
    public MyItemType(SerializationInfo info, StreamingContext context)
    {
        // Reset the property value using the GetValue method.
        myProperty_value = (string) info.GetValue("props", typeof(string));
    }
}

// This is a console application. 
public static class Test
{
    static void Main()
    {
        // This is the name of the file holding the data. You can use any file extension you like.
        string fileName = "dataStuff.myData";

        // Use a BinaryFormatter or SoapFormatter.
        IFormatter formatter = new BinaryFormatter();
        //IFormatter formatter = new SoapFormatter();

        Test.SerializeItem(fileName, formatter); // Serialize an instance of the class.
        Test.DeserializeItem(fileName, formatter); // Deserialize the instance.
        Console.WriteLine("Done");
        Console.ReadLine();
    }

    public static void SerializeItem(string fileName, IFormatter formatter)
    {
        // Create an instance of the type and serialize it.
        MyItemType t = new MyItemType();
        t.MyProperty = "Hello World";

        FileStream s = new FileStream(fileName , FileMode.Create);
        formatter.Serialize(s, t);            
        s.Close();
    }


    public static void DeserializeItem(string fileName, IFormatter formatter)
    {
        FileStream s = new FileStream(fileName, FileMode.Open);
        MyItemType t = (MyItemType)formatter.Deserialize(s);
        Console.WriteLine(t.MyProperty);            
    }       
}

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft