SerializationInfo.AddValue Method

Reference

Definition

Namespace:: System.Runtime.Serialization

Assembly:: System.Runtime.dll

Assembly:: System.Runtime.Serialization.Formatters.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Adds a value into the SerializationInfo.

Overloads

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`.
AddValue(String, UInt64)	Adds a 64-bit unsigned integer value into the SerializationInfo store.
AddValue(String, UInt32)	Adds a 32-bit unsigned integer value into the SerializationInfo store.
AddValue(String, UInt16)	Adds a 16-bit unsigned integer value into the SerializationInfo store.
AddValue(String, Single)	Adds a single-precision floating-point value into the SerializationInfo store.
AddValue(String, SByte)	Adds an 8-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, Int64)	Adds a 64-bit signed integer value into the SerializationInfo store.
AddValue(String, Int32)	Adds a 32-bit signed integer value into the SerializationInfo store.
AddValue(String, Int16)	Adds a 16-bit signed integer value into the SerializationInfo store.
AddValue(String, Double)	Adds a double-precision floating-point value into the SerializationInfo store.
AddValue(String, Decimal)	Adds a decimal value into the SerializationInfo store.
AddValue(String, DateTime)	Adds a DateTime value into the SerializationInfo store.
AddValue(String, Char)	Adds a Unicode character value into the SerializationInfo store.
AddValue(String, Byte)	Adds an 8-bit unsigned integer value into the SerializationInfo store.
AddValue(String, Boolean)	Adds a Boolean 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 Typetype.

public:
 void AddValue(System::String ^ name, System::Object ^ value, Type ^ type);

public void AddValue (string name, object? value, Type type);

public void AddValue (string name, object value, Type type);

member this.AddValue : string * obj * Type -> unit

Public Sub AddValue (name As String, value As Object, type As Type)

Parameters

name: String

The name to associate with the value, so it can be deserialized later.

value: Object

The value to be serialized. Any children of this object will automatically be serialized.

type: Type

The Type to associate with the current object. This parameter must always be the type of the object itself or of one of its base classes.

Exceptions

ArgumentNullException

If name or type is null.

SerializationException

A value has already been associated with name.

Remarks

The assigned type is always the type of the object, or one of its parents.

If two values are added with names that differ only by case, no exception will be thrown, which is not a recommended practice. However, adding two values with the exact same name will cause the SerializationException to be thrown.

Applies to

AddValue(String, UInt64)

Important

This API is not CLS-compliant.

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

public:
 void AddValue(System::String ^ name, System::UInt64 value);

[System.CLSCompliant(false)]
public void AddValue (string name, ulong value);

[<System.CLSCompliant(false)>]
member this.AddValue : string * uint64 -> unit

Public Sub AddValue (name As String, value As ULong)

Parameters

name: String

The name to associate with the value, so it can be deserialized later.

value: UInt64

The value to serialize.

Attributes: CLSCompliantAttribute

Exceptions

ArgumentNullException

The name parameter is null.

SerializationException

A value has already been associated with name.

Remarks

Applies to

AddValue(String, UInt32)

Important

This API is not CLS-compliant.

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

public:
 void AddValue(System::String ^ name, System::UInt32 value);

[System.CLSCompliant(false)]
public void AddValue (string name, uint value);

[<System.CLSCompliant(false)>]
member this.AddValue : string * uint32 -> unit

Public Sub AddValue (name As String, value As UInteger)

Parameters

name: String

The name to associate with the value, so it can be deserialized later.

value: UInt32

The UInt32 value to serialize.

Attributes: CLSCompliantAttribute

Exceptions

ArgumentNullException

The name parameter is null.

SerializationException

A value has already been associated with name.

Examples

The following example uses the AddValue method to customize the serialization of a type. The code adds a string and an integer to an instance of the SerializationInfo class in the GetObjectData method of the ISerializable interface. The code also uses the GetValue method to retrieve values from the SerializationInfo.

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

namespace ISerializableExample
{
    class Program
    {
        public static void Main()
        {
            try
            {
                Run();
            }
            catch (Exception exc)
            {
                Console.WriteLine("{0}: {1}", exc.Message, exc.StackTrace);
            }
            finally
            {
                Console.WriteLine("Press Enter to exit....");
                Console.ReadLine();
            }
        }

        static void Run()
        {
            BinaryFormatter binaryFmt = new BinaryFormatter();
            Person p = new Person();
            p.IdNumber = 1010;
            p.Name = "AAAAA";
            FileStream fs = new FileStream
                ("Person.xml", FileMode.OpenOrCreate);
            binaryFmt.Serialize(fs, p);
            fs.Close();
            Console.WriteLine
                ("Original Name: {0}, Original ID: {1}", p.Name, p.IdNumber);

            // Deserialize.
            fs = new FileStream
                ("Person.xml", FileMode.OpenOrCreate);
            Person p2 = (Person)binaryFmt.Deserialize(fs);
                Console.WriteLine("New Name: {0}, New ID: {1}", p2.Name, p2.IdNumber);
            fs.Close();
            }
        }
    [Serializable]
    public class Person : ISerializable
    {
        private string name_value;
        private int ID_value;

        public Person() { }
        protected Person(SerializationInfo info, StreamingContext context)
        {
            if (info == null)
                throw new System.ArgumentNullException("info");
            name_value = (string)info.GetValue("AltName", typeof(string));
            ID_value = (int)info.GetValue("AltID", typeof(int));
        }

        public virtual void GetObjectData(
        SerializationInfo info, StreamingContext context)
        {
            if (info == null)
                throw new System.ArgumentNullException("info");
            info.AddValue("AltName", "XXX");
            info.AddValue("AltID", 9999);
        }

        public string Name
        {
            get { return name_value; }
            set { name_value = value; }
        }

        public int IdNumber
        {
            get { return ID_value; }
            set { ID_value = value; }
        }
    }
}

Imports System.Runtime.Serialization.Formatters.Binary
Imports System.Runtime.Serialization
Imports System.Security.Permissions
Imports System.IO

<Assembly: SecurityPermission _
(SecurityAction.RequestMinimum, Execution:=True)> 

Class Program

    Public Shared Sub Main()
        Try
            Run()
        Catch exc As Exception
            Console.WriteLine("{0}: {1}", exc.Message, exc.StackTrace)
        Finally
            Console.WriteLine("Press Enter to exit....")
            Console.ReadLine()
        End Try

    End Sub

    Shared Sub Run()
        Dim binaryFmt As New BinaryFormatter()
        Dim p As New Person()
        p.IdNumber = 1010
        p.Name = "AAAAA"
        Dim fs As New FileStream("Person.xml", FileMode.OpenOrCreate)
        binaryFmt.Serialize(fs, p)
        fs.Close()
        Console.WriteLine _
        ("Original Name: {0}, Original ID: {1}", p.Name, p.IdNumber)

        ' Deserialize.
        fs = New FileStream("Person.xml", FileMode.OpenOrCreate)
        Dim p2 As Person = CType(binaryFmt.Deserialize(fs), Person)
        Console.WriteLine("New Name: {0}, New ID: {1}", _
        p2.Name, p2.IdNumber)
        fs.Close()
    End Sub
End Class

<Serializable()> _
Public Class Person
    Implements ISerializable
    Private name_value As String
    Private ID_value As Integer

    Public Sub New()

    End Sub

    Protected Sub New(ByVal info As SerializationInfo, _
    ByVal context As StreamingContext)
        If info Is Nothing Then
            Throw New System.ArgumentNullException("info")
        End If
        name_value = CStr(info.GetValue("AltName", GetType(String)))
        ID_value = Fix(info.GetValue("AltID", GetType(Integer)))

    End Sub

    <SecurityPermission(SecurityAction.LinkDemand, _
    Flags:=SecurityPermissionFlag.SerializationFormatter)> _
    Public Overridable Sub GetObjectData _
    (ByVal info As SerializationInfo, _
    ByVal context As StreamingContext) _
    Implements ISerializable.GetObjectData
        If info Is Nothing Then
            Throw New System.ArgumentNullException("info")
        End If
        info.AddValue("AltName", "XXX")
        info.AddValue("AltID", 9999)

    End Sub

    Public Property Name() As String
        Get
            Return name_value
        End Get
        Set(ByVal value As String)
            name_value = value
        End Set
    End Property

    Public Property IdNumber() As Integer
        Get
            Return ID_value
        End Get
        Set(ByVal value As Integer)
            ID_value = value
        End Set
    End Property
End Class

Remarks

Applies to

AddValue(String, UInt16)

Important

This API is not CLS-compliant.

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

public:
 void AddValue(System::String ^ name, System::UInt16 value);

[System.CLSCompliant(false)]
public void AddValue (string name, ushort value);

[<System.CLSCompliant(false)>]
member this.AddValue : string * uint16 -> unit

Public Sub AddValue (name As String, value As UShort)

Parameters

name: String

The name to associate with the value, so it can be deserialized later.

value: UInt16

The UInt16 value to serialize.

Attributes: CLSCompliantAttribute

Exceptions

ArgumentNullException

The name parameter is null.

SerializationException

A value has already been associated with name.

Remarks

Applies to

AddValue(String, Single)

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

public:
 void AddValue(System::String ^ name, float value);

public void AddValue (string name, float value);

member this.AddValue : string * single -> unit

Public Sub AddValue (name As String, value As Single)

Parameters

name: String

The name to associate with the value, so it can be deserialized later.

value: Single

The single value to serialize.

Exceptions

ArgumentNullException

The name parameter is null.

SerializationException

A value has already been associated with name.

Remarks

Applies to

AddValue(String, SByte)

Important

This API is not CLS-compliant.

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

public:
 void AddValue(System::String ^ name, System::SByte value);

[System.CLSCompliant(false)]
public void AddValue (string name, sbyte value);

[<System.CLSCompliant(false)>]
member this.AddValue : string * sbyte -> unit

Public Sub AddValue (name As String, value As SByte)

Parameters

name: String

The name to associate with the value, so it can be deserialized later.

value: SByte

The Sbyte value to serialize.

Attributes: CLSCompliantAttribute

Exceptions

ArgumentNullException

The name parameter is null.

SerializationException

A value has already been associated with name.

Remarks

Applies to

AddValue(String, Object)

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

public:
 void AddValue(System::String ^ name, System::Object ^ value);

public void AddValue (string name, object? value);

public void AddValue (string name, object value);

member this.AddValue : string * obj -> unit

Public Sub AddValue (name As String, value As Object)

Parameters

name: String

The name to associate with the value, so it can be deserialized later.

value: Object

The value to be serialized. Any children of this object will automatically be serialized.

Exceptions

ArgumentNullException

name is null.

SerializationException

A value has already been associated with name.

Remarks

The object contained in the value parameter is serialized as the type returned by value.

Applies to

AddValue(String, Int64)

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

public:
 void AddValue(System::String ^ name, long value);

public void AddValue (string name, long value);

member this.AddValue : string * int64 -> unit

Public Sub AddValue (name As String, value As Long)

Parameters

name: String

The name to associate with the value, so it can be deserialized later.

value: Int64

The Int64 value to serialize.

Exceptions

ArgumentNullException

The name parameter is null.

SerializationException

A value has already been associated with name.

Remarks

Applies to

AddValue(String, Int32)

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

public:
 void AddValue(System::String ^ name, int value);

public void AddValue (string name, int value);

member this.AddValue : string * int -> unit

Public Sub AddValue (name As String, value As Integer)

Parameters

name: String

The name to associate with the value, so it can be deserialized later.

value: Int32

The Int32 value to serialize.

Exceptions

ArgumentNullException

The name parameter is null.

SerializationException

A value has already been associated with name.

Examples

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

ref class SingletonSerializationHelper;

// There should be only one instance of this type per AppDomain.

[Serializable]
public ref class Singleton sealed: public ISerializable
{
private:

   // This is the one instance of this type.
   static Singleton^ theOneObject = gcnew Singleton;

public:

   // Here are the instance fields.
   String^ someString;
   Int32 someNumber;

private:

   // Private constructor allowing this type to construct the singleton.
   Singleton()
   {
      
      // Do whatever is necessary to initialize the singleton.
      someString = "This is a String* field";
      someNumber = 123;
   }

public:

   // A method returning a reference to the singleton.
   static Singleton^ GetSingleton()
   {
      return theOneObject;
   }

   // A method called when serializing a Singleton.
   [System::Security::Permissions::SecurityPermissionAttribute
   (System::Security::Permissions::SecurityAction::LinkDemand, 
   Flags=System::Security::Permissions::SecurityPermissionFlag::SerializationFormatter)]
   virtual void GetObjectData( SerializationInfo^ info, StreamingContext context )
   {
      // Instead of serializing this Object*, we will  
      // serialize a SingletonSerializationHelp instead.
      info->SetType( SingletonSerializationHelper::typeid );

      // No other values need to be added.
   }

   // NOTE: ISerializable*'s special constructor is NOT necessary 
   // because it's never called
};

[Serializable]
private ref class SingletonSerializationHelper sealed: public IObjectReference
{
public:

   // This Object* has no fields (although it could).
   // GetRealObject is called after this Object* is deserialized
   virtual Object^ GetRealObject( StreamingContext context )
   {
      // When deserialiing this Object*, return a reference to 
      // the singleton Object* instead.
      return Singleton::GetSingleton();
   }
};

[STAThread]
int main()
{
   FileStream^ fs = gcnew FileStream( "DataFile.dat",FileMode::Create );
   try
   {
      // Construct a BinaryFormatter and use it 
      // to serialize the data to the stream.
      BinaryFormatter^ formatter = gcnew BinaryFormatter;

      // Create an array with multiple elements refering to 
      // the one Singleton Object*.
      array<Singleton^>^a1 = {Singleton::GetSingleton(),Singleton::GetSingleton()};

      // This displays S"True".
      Console::WriteLine( "Do both array elements refer to the same Object? {0}", (a1[ 0 ] == a1[ 1 ]) );

      // Serialize the array elements.
      formatter->Serialize( fs, a1 );

      // Deserialize the array elements.
      fs->Position = 0;
      array<Singleton^>^a2 = (array<Singleton^>^)formatter->Deserialize( fs );

      // This displays S"True".
      Console::WriteLine( "Do both array elements refer to the same Object? {0}", (a2[ 0 ] == a2[ 1 ]) );

      // This displays S"True".
      Console::WriteLine( "Do all  array elements refer to the same Object? {0}", (a1[ 0 ] == a2[ 0 ]) );
   }
   catch ( SerializationException^ e ) 
   {
      Console::WriteLine( "Failed to serialize. Reason: {0}", e->Message );
      throw;
   }
   finally
   {
      fs->Close();
   }

   return 0;
}

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);
    }
}

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

Remarks

Applies to

AddValue(String, Int16)

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

public:
 void AddValue(System::String ^ name, short value);

public void AddValue (string name, short value);

member this.AddValue : string * int16 -> unit

Public Sub AddValue (name As String, value As Short)

Parameters

name: String

The name to associate with the value, so it can be deserialized later.

value: Int16

The Int16 value to serialize.

Exceptions

ArgumentNullException

The name parameter is null.

SerializationException

A value has already been associated with name.

Remarks

Applies to

AddValue(String, Double)

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

public:
 void AddValue(System::String ^ name, double value);

public void AddValue (string name, double value);

member this.AddValue : string * double -> unit

Public Sub AddValue (name As String, value As Double)

Parameters

name: String

The name to associate with the value, so it can be deserialized later.

value: Double

The double value to serialize.

Exceptions

ArgumentNullException

The name parameter is null.

SerializationException

A value has already been associated with name.

Remarks

Applies to

AddValue(String, Decimal)

Adds a decimal value into the SerializationInfo store.

public:
 void AddValue(System::String ^ name, System::Decimal value);

public void AddValue (string name, decimal value);

member this.AddValue : string * decimal -> unit

Public Sub AddValue (name As String, value As Decimal)

Parameters

name: String

The name to associate with the value, so it can be deserialized later.

value: Decimal

The decimal value to serialize.

Exceptions

ArgumentNullException

If The name parameter is null.

SerializationException

If a value has already been associated with name.

Remarks

Applies to

AddValue(String, DateTime)

Adds a DateTime value into the SerializationInfo store.

public:
 void AddValue(System::String ^ name, DateTime value);

public void AddValue (string name, DateTime value);

member this.AddValue : string * DateTime -> unit

Public Sub AddValue (name As String, value As DateTime)

Parameters

name: String

The name to associate with the value, so it can be deserialized later.

value: DateTime

The DateTime value to serialize.

Exceptions

ArgumentNullException

The name parameter is null.

SerializationException

A value has already been associated with name.

Remarks

Applies to

AddValue(String, Char)

Adds a Unicode character value into the SerializationInfo store.

public:
 void AddValue(System::String ^ name, char value);

public void AddValue (string name, char value);

member this.AddValue : string * char -> unit

Public Sub AddValue (name As String, value As Char)

Parameters

name: String

The name to associate with the value, so it can be deserialized later.

value: Char

The character value to serialize.

Exceptions

ArgumentNullException

The name parameter is null.

SerializationException

A value has already been associated with name.

Remarks

Applies to

AddValue(String, Byte)

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

public:
 void AddValue(System::String ^ name, System::Byte value);

public void AddValue (string name, byte value);

member this.AddValue : string * byte -> unit

Public Sub AddValue (name As String, value As Byte)

Parameters

name: String

The name to associate with the value, so it can be deserialized later.

value: Byte

The byte value to serialize.

Exceptions

ArgumentNullException

The name parameter is null.

SerializationException

A value has already been associated with name.

Remarks

Applies to

AddValue(String, Boolean)

Adds a Boolean value into the SerializationInfo store.

public:
 void AddValue(System::String ^ name, bool value);

public void AddValue (string name, bool value);

member this.AddValue : string * bool -> unit

Public Sub AddValue (name As String, value As Boolean)

Parameters

name: String

The name to associate with the value, so it can be deserialized later.

value: Boolean

The Boolean value to serialize.

Exceptions

ArgumentNullException

The name parameter is null.

SerializationException

A value has already been associated with name.

Remarks

void ISerializable.GetObject(SerializationInfo info, StreamingContext context)  
{  
   // This will not cause an exception to be thrown.  
   info.AddValue("ABC", true);  
   info.AddValue("abc", false);  
   // However, this will cause the SerializationException to be thrown.  
   info.AddValue("XYZ", true);  
   info.AddValue("XYZ", false);  
}

Private Sub GetObjectData(ByVal info As SerializationInfo, _  
ByVal context As StreamingContext)  
   ' This will not cause an exception to be thrown.  
   info.AddValue("ABC", "upper case")  
   info.AddValue("abc", "lower case")  
   ' However, this will cause the SerializationException to be thrown.  
   info.AddValue("XYZ", "same case")  
   info.AddValue("XYZ", "same case")  
End Sub

Applies to