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 ref class SerializationInfo sealed 

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

.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: