GetObjectData Method
Collapse the table of content
Expand the table of content

ISerializable.GetObjectData Method (SerializationInfo, StreamingContext)


Populates a SerializationInfo with the data needed to serialize the target object.

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

void GetObjectData(
	SerializationInfo info,
	StreamingContext context


Type: System.Runtime.Serialization.SerializationInfo

The SerializationInfo to populate with data.

Type: System.Runtime.Serialization.StreamingContext

The destination (see StreamingContext) for this serialization.

Exception Condition

The caller does not have the required permission.

Any objects that are included in the SerializationInfo are automatically tracked and serialized by the formatter.

Code that calls GetObjectData requires the SecurityPermission for providing serialization services. Associated enumeration: SecurityPermissionFlag.SerializationFormatter.


It is not guaranteed that this method will be called only once per object instance during serialization. Therefore, the method should be implemented in such a way that its behavior will be the same regardless of the number of times it is called.

The following example uses the GetObjectData method to set alternate values for a serialized object. The code uses the M:System.Runtime.Serialization.SerializationInfo.AddValue method of the SerializationInfo class to store the alternate values when the object is serialized. Conversely, when the constructor of the Person class is called during deserialization, the alternatve values are retrieved using the GetValue method and reassigned to the object's fields.

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

[assembly: SecurityPermission(
SecurityAction.RequestMinimum, Execution = true)]
namespace ISerializableExample
    class Program
        public static void Main()
            catch (Exception exc)
                Console.WriteLine("{0}: {1}", exc.Message, exc.StackTrace);
                Console.WriteLine("Press Enter to exit....");

        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);
                ("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);
    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));

            Flags = SecurityPermissionFlag.SerializationFormatter)]
        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; }

.NET Framework
Available since 1.1
Return to top
© 2015 Microsoft