Home Library Learn Downloads Support Community
Sign in | United States - English | |
2 out of 2 rated this helpful - Rate this topic

SuppressMessageAttribute Class

.NET Framework 4

Updated: March 2012

Suppresses reporting of a specific static analysis tool rule violation, allowing multiple suppressions on a single code artifact.

System.Object
  System.Attribute
    System.Diagnostics.CodeAnalysis.SuppressMessageAttribute

Namespace:  System.Diagnostics.CodeAnalysis
Assembly:  mscorlib (in mscorlib.dll)
C#
C++
F#
VB
Copy 
[AttributeUsageAttribute(AttributeTargets.All, Inherited = false, AllowMultiple = true)]
[ConditionalAttribute("CODE_ANALYSIS")]
public sealed class SuppressMessageAttribute : Attribute

The SuppressMessageAttribute type exposes the following members.

  Name Description
Public method Supported by the XNA Framework Supported by Portable Class Library SuppressMessageAttribute Initializes a new instance of the SuppressMessageAttribute class, specifying the category of the static analysis tool and the identifier for an analysis rule.
Top
  Name Description
Public property Supported by the XNA Framework Supported by Portable Class Library Category Gets the category identifying the classification of the attribute.
Public property Supported by the XNA Framework Supported by Portable Class Library CheckId Gets the identifier of the static analysis tool rule to be suppressed.
Public property Supported by the XNA Framework Supported by Portable Class Library Justification Gets or sets the justification for suppressing the code analysis message.
Public property Supported by the XNA Framework Supported by Portable Class Library MessageId Gets or sets an optional argument expanding on exclusion criteria.
Public property Supported by the XNA Framework Supported by Portable Class Library Scope Gets or sets the scope of the code that is relevant for the attribute.
Public property Supported by the XNA Framework Supported by Portable Class Library Target Gets or sets a fully qualified path that represents the target of the attribute.
Public property TypeId When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
  Name Description
Public method Supported by the XNA Framework Supported by Portable Class Library Equals Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected method Supported by the XNA Framework Supported by Portable Class Library Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetHashCode Returns the hash code for this instance. (Inherited from Attribute.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttribute When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method Supported by the XNA Framework Match When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected method Supported by the XNA Framework Supported by Portable Class Library MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Explicit interface implemetation Private method _Attribute.GetIDsOfNames Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfo Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfoCount Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.Invoke Provides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

This attribute can be applied to any application element. For a complete list of the violations that can be suppressed, see Code Analysis for Managed Code Warnings.

Note Note

The ConditionalAttribute is applied to this class, specifying the preprocessing symbol "CODE_ANALYSIS" as the conditional symbol that determines whether the attribute call is included or omitted. If the symbol is defined, the attribute call is included; otherwise, the call is omitted.

When you right-click a Code Analysis warning in the Visual Studio Error List and then click Suppress Message(s), a SuppressMessage attribute is added either in your code or to the project's global suppressions file. For more information about the SuppressMessage attribute and its use in Visual Studio, see In Source Suppression Overview.

The following code example shows the use of the SuppressMessageAttribute attribute to suppress performance warning messages.

C#
VB
Copy 

#define CODE_ANALYSIS
using System;
using System.Diagnostics.CodeAnalysis;

namespace CodeAnalysisSample
{
    class Library
    {
        [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "isChecked")]
        [SuppressMessage("Microsoft.Performance", "CA1804:RemoveUnusedLocals", MessageId = "fileIdentifier")]
        static void FileNode(string name, bool isChecked)
        {
            string fileIdentifier = name;
            string fileName = name;
            string version = String.Empty;
        }

    }
}

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

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.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Date

History

Reason

March 2012

Added information about the use of the attribute in Visual Studio.

Information enhancement.

August 2010

Added link to list of warning messages that can be suppressed.

Customer feedback.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
Find suppressed rules

As part of the Team Build Process - I wish to have a build which ignores any suppressed rules, i.e. I want a build that shows me all the violations irrespective if a developer has suppressed it or not.

How can I produce a build to ignore the globalsuppression file and suppressions in code.

Thanks

History
Find suppressed rules

As part of the Team Build Process - I wish to have a build which ignores any suppressed rules, i.e. I want a build that shows me all the violations irrespective if a developer has suppressed it or not.

How can I produce a build to ignore the globalsuppression file and suppressions in code.

Thanks

History