Export (0) Print
Expand All

SerializationInfo Class

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

System.Object
  System.Runtime.Serialization.SerializationInfo

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

'Declaration
<ComVisibleAttribute(True)> _
Public NotInheritable Class SerializationInfo

The SerializationInfo type exposes the following members.

  NameDescription
Public methodSerializationInfo(Type, IFormatterConverter)Creates a new instance of the SerializationInfo class.
Public methodSerializationInfo(Type, IFormatterConverter, Boolean)Initializes a new instance of the SerializationInfo class.
Top

  NameDescription
Public propertyAssemblyNameGets or sets the assembly name of the type to serialize during serialization only.
Public propertyFullTypeNameGets or sets the full name of the Type to serialize.
Public propertyIsAssemblyNameSetExplicitGets whether the assembly name has been explicitly set.
Public propertyIsFullTypeNameSetExplicitGets whether the full type name has been explicitly set.
Public propertyMemberCountGets the number of members that have been added to the SerializationInfo store.
Public propertyObjectTypeReturns the type of the object to be serialized.
Top

  NameDescription
Public methodAddValue(String, Boolean)Adds a Boolean value into the SerializationInfo store.
Public methodAddValue(String, Byte)Adds an 8-bit unsigned integer value into the SerializationInfo store.
Public methodAddValue(String, Char)Adds a Unicode character value into the SerializationInfo store.
Public methodAddValue(String, DateTime)Adds a DateTime value into the SerializationInfo store.
Public methodAddValue(String, Decimal)Adds a decimal value into the SerializationInfo store.
Public methodAddValue(String, Double)Adds a double-precision floating-point value into the SerializationInfo store.
Public methodAddValue(String, Int16)Adds a 16-bit signed integer value into the SerializationInfo store.
Public methodAddValue(String, Int32)Adds a 32-bit signed integer value into the SerializationInfo store.
Public methodAddValue(String, Int64)Adds a 64-bit signed integer value into the SerializationInfo store.
Public methodAddValue(String, Object)Adds the specified object into the SerializationInfo store, where it is associated with a specified name.
Public methodAddValue(String, SByte)Adds an 8-bit signed integer value into the SerializationInfo store.
Public methodAddValue(String, Single)Adds a single-precision floating-point value into the SerializationInfo store.
Public methodAddValue(String, UInt16)Adds a 16-bit unsigned integer value into the SerializationInfo store.
Public methodAddValue(String, UInt32)Adds a 32-bit unsigned integer value into the SerializationInfo store.
Public methodAddValue(String, UInt64)Adds a 64-bit unsigned integer value into the SerializationInfo store.
Public methodAddValue(String, Object, Type)Adds a value into the SerializationInfo store, where value is associated with name and is serialized as being of Type type.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetBooleanRetrieves a Boolean value from the SerializationInfo store.
Public methodGetByteRetrieves an 8-bit unsigned integer value from the SerializationInfo store.
Public methodGetCharRetrieves a Unicode character value from the SerializationInfo store.
Public methodGetDateTimeRetrieves a DateTime value from the SerializationInfo store.
Public methodGetDecimalRetrieves a decimal value from the SerializationInfo store.
Public methodGetDoubleRetrieves a double-precision floating-point value from the SerializationInfo store.
Public methodGetEnumeratorReturns a SerializationInfoEnumerator used to iterate through the name-value pairs in the SerializationInfo store.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetInt16Retrieves a 16-bit signed integer value from the SerializationInfo store.
Public methodGetInt32Retrieves a 32-bit signed integer value from the SerializationInfo store.
Public methodGetInt64Retrieves a 64-bit signed integer value from the SerializationInfo store.
Public methodGetSByteRetrieves an 8-bit signed integer value from the SerializationInfo store.
Public methodGetSingleRetrieves a single-precision floating-point value from the SerializationInfo store.
Public methodGetStringRetrieves a String value from the SerializationInfo store.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetUInt16Retrieves a 16-bit unsigned integer value from the SerializationInfo store.
Public methodGetUInt32Retrieves a 32-bit unsigned integer value from the SerializationInfo store.
Public methodGetUInt64Retrieves a 64-bit unsigned integer value from the SerializationInfo store.
Public methodGetValueRetrieves a value from the SerializationInfo store.
Public methodSetTypeSets the Type of the object to serialize.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

Imports System.Text
Imports System.IO
' Add references to Soap and Binary formatters. 
Imports System.Runtime.Serialization.Formatters.Binary
Imports System.Runtime.Serialization.Formatters.Soap
Imports System.Runtime.Serialization


<Serializable()> _
Public Class MyItemType
    Implements ISerializable
    ' Empty constructor required to compile. 
    Public Sub New()
    End Sub 

    ' The value to serialize. 
    Private myProperty_value As String 

    Public Property MyProperty() As String 
        Get 
            Return myProperty_value
        End Get 
        Set(value As String)
            myProperty_value = value
        End Set 
    End Property 

    ' Implement this method to serialize data. The method is called  
    ' on serialization. 
    Public Sub GetObjectData(info As SerializationInfo, context As StreamingContext) Implements ISerializable.GetObjectData
        ' Use the AddValue method to specify serialized values.
        info.AddValue("props", myProperty_value, GetType(String))

    End Sub 

    ' The special constructor is used to deserialize values. 
    Public Sub New(info As SerializationInfo, context As StreamingContext)
        ' Reset the property value using the GetValue method.
        myProperty_value = DirectCast(info.GetValue("props", GetType(String)), String)
    End Sub 
End Class 

' This is a console application.  
Public Class Test


    Public Shared Sub Main()
        ' This is the name of the file holding the data. You can use any file extension you like. 
        Dim fileName As String = "dataStuff.myData" 

        ' Use a BinaryFormatter or SoapFormatter. 
        Dim formatter As IFormatter = New BinaryFormatter()
        ' Dim formatter As IFormatter = New SoapFormatter()

        Test.SerializeItem(fileName, formatter)
        ' Serialize an instance of the class.
        Test.DeserializeItem(fileName, formatter)
        ' Deserialize the instance.
        Console.WriteLine("Done")
        Console.ReadLine()
    End Sub 

    Public Shared Sub SerializeItem(fileName As String, formatter As IFormatter)
        ' Create an instance of the type and serialize it. 
        Dim myType As New MyItemType()
        myType.MyProperty = "Hello World" 

        Dim fs As New FileStream(fileName, FileMode.Create)
        formatter.Serialize(fs, myType)
        fs.Close()
    End Sub 


    Public Shared Sub DeserializeItem(fileName As String, formatter As IFormatter)
        Dim fs As New FileStream(fileName, FileMode.Open)

        Dim myType As MyItemType = DirectCast(formatter.Deserialize(fs), MyItemType)
        Console.WriteLine(myType.MyProperty)
    End Sub 
End Class

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

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