SerializationInfo Class
Stores all the data needed to serialize or deserialize an object. This class cannot be inherited.
Assembly: mscorlib (in mscorlib.dll)
The SerializationInfo type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | AssemblyName | Gets or sets the assembly name of the type to serialize during serialization only. |
![]() | FullTypeName | Gets or sets the full name of the Type to serialize. |
![]() | IsAssemblyNameSetExplicit | Returns true if the assembly name has been explicitly set. |
![]() | IsFullTypeNameSetExplicit | Returns true if the full type name has been explicitly set. |
![]() | MemberCount | Gets the number of members that have been added to the SerializationInfo store. |
![]() | ObjectType | Returns the type of the object to be serialized. |
| Name | Description | |
|---|---|---|
![]() | AddValue(String, Boolean) | Adds a Boolean value into the SerializationInfo store. |
![]() | AddValue(String, Byte) | Adds an 8-bit unsigned integer value into the SerializationInfo store. |
![]() | AddValue(String, Char) | Adds a Unicode character value into the SerializationInfo store. |
![]() | AddValue(String, DateTime) | Adds a DateTime value into the SerializationInfo store. |
![]() | AddValue(String, Decimal) | Adds a decimal value into the SerializationInfo store. |
![]() | AddValue(String, Double) | Adds a double-precision floating-point value into the SerializationInfo store. |
![]() | AddValue(String, Int16) | Adds a 16-bit signed integer value into the SerializationInfo store. |
![]() | AddValue(String, Int32) | Adds a 32-bit signed integer value into the SerializationInfo store. |
![]() | AddValue(String, Int64) | Adds a 64-bit signed integer value into the SerializationInfo store. |
![]() | AddValue(String, Object) | Adds the specified object into the SerializationInfo store, where it is associated with a specified name. |
![]() | AddValue(String, SByte) | Adds an 8-bit signed integer value into the SerializationInfo store. |
![]() | AddValue(String, Single) | Adds a single-precision floating-point value into the SerializationInfo store. |
![]() | AddValue(String, UInt16) | Adds a 16-bit unsigned integer value into the SerializationInfo store. |
![]() | AddValue(String, UInt32) | Adds a 32-bit unsigned integer value into the SerializationInfo store. |
![]() | AddValue(String, UInt64) | Adds a 64-bit unsigned integer value into the SerializationInfo store. |
![]() | AddValue(String, Object, Type) | Adds a value into the SerializationInfo store, where value is associated with name and is serialized as being of Type type. |
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetBoolean | Retrieves a Boolean value from the SerializationInfo store. |
![]() | GetByte | Retrieves an 8-bit unsigned integer value from the SerializationInfo store. |
![]() | GetChar | Retrieves a Unicode character value from the SerializationInfo store. |
![]() | GetDateTime | Retrieves a DateTime value from the SerializationInfo store. |
![]() | GetDecimal | Retrieves a decimal value from the SerializationInfo store. |
![]() | GetDouble | Retrieves a double-precision floating-point value from the SerializationInfo store. |
![]() | GetEnumerator | Returns a SerializationInfoEnumerator used to iterate through the name-value pairs in the SerializationInfo store. |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetInt16 | Retrieves a 16-bit signed integer value from the SerializationInfo store. |
![]() | GetInt32 | Retrieves a 32-bit signed integer value from the SerializationInfo store. |
![]() | GetInt64 | Retrieves a 64-bit signed integer value from the SerializationInfo store. |
![]() | GetSByte | Retrieves an 8-bit signed integer value from the SerializationInfo store. |
![]() | GetSingle | Retrieves a single-precision floating-point value from the SerializationInfo store. |
![]() | GetString | Retrieves a String value from the SerializationInfo store. |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | GetUInt16 | Retrieves a 16-bit unsigned integer value from the SerializationInfo store. |
![]() | GetUInt32 | Retrieves a 32-bit unsigned integer value from the SerializationInfo store. |
![]() | GetUInt64 | Retrieves a 64-bit unsigned integer value from the SerializationInfo store. |
![]() | GetValue | Retrieves a value from the SerializationInfo store. |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | SetType | Sets the Type of the object to serialize. |
![]() | ToString | 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 [<topic://cpconCustomSerialization>].
The following code example demonstrates the SerializationInfo for custom serialization and deserialization of various values.
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
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
