Export (0) Print
Expand All
Expand Minimize

CA2237: Mark ISerializable types with SerializableAttribute

TypeName

MarkISerializableTypesWithSerializable

CheckId

CA2237

Category

Microsoft.Usage

Breaking Change

Non Breaking

An externally visible type implements the System.Runtime.Serialization.ISerializable interface and the type is not marked with the System.SerializableAttribute attribute. The rule ignores derived types whose base type is not serializable.

To be recognized by the common language runtime as serializable, types must be marked with the SerializableAttribute attribute even if the type uses a custom serialization routine through implementation of the ISerializable interface.

To fix a violation of this rule, apply the SerializableAttribute attribute to the type.

Do not suppress a warning from this rule for exception classes because they must be serializable to work correctly across application domains.

The following example shows a type that violates the rule. Uncomment the SerializableAttribute attribute line to satisfy the rule.


using System;
using System.Runtime.Serialization;
using System.Security.Permissions;

namespace UsageLibrary
{
   // [SerializableAttribute]
   public class BaseType : ISerializable
   {
      int baseValue;

      public BaseType()
      {
         baseValue = 3;
      }

      protected BaseType(
         SerializationInfo info, StreamingContext context)
      {
         baseValue = info.GetInt32("baseValue");
      }

      [SecurityPermissionAttribute(SecurityAction.Demand, 
          SerializationFormatter = true)]
      public virtual void GetObjectData(
         SerializationInfo info, StreamingContext context)
      {
         info.AddValue("baseValue", baseValue);
      }
   }
}


Community Additions

ADD
Show:
© 2014 Microsoft