.NET Framework Class Library
SuppressMessageAttribute Class

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

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.Diagnostics.CodeAnalysisSuppressMessageAttribute

Namespace:   System.Diagnostics.CodeAnalysis
Assembly:  mscorlib (in mscorlib.dll)
Syntax
<[%$TOPIC/ms141072_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/ms141072_en-us_VS_110_2_0_0_0_1%].All, Inherited := False, AllowMultiple := True)> _
<[%$TOPIC/ms141072_en-us_VS_110_2_0_0_0_2%]("CODE_ANALYSIS")> _
Public NotInheritable Class SuppressMessageAttribute _
	Inherits [%$TOPIC/ms141072_en-us_VS_110_2_0_0_0_3%]
[[%$TOPIC/ms141072_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/ms141072_en-us_VS_110_2_0_1_0_1%].All, Inherited = false, AllowMultiple = true)]
[[%$TOPIC/ms141072_en-us_VS_110_2_0_1_0_2%]("CODE_ANALYSIS")]
public sealed class SuppressMessageAttribute : [%$TOPIC/ms141072_en-us_VS_110_2_0_1_0_3%]
[[%$TOPIC/ms141072_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/ms141072_en-us_VS_110_2_0_2_0_1%]::All, Inherited = false, AllowMultiple = true)]
[[%$TOPIC/ms141072_en-us_VS_110_2_0_2_0_2%](L"CODE_ANALYSIS")]
public ref class SuppressMessageAttribute sealed : public [%$TOPIC/ms141072_en-us_VS_110_2_0_2_0_3%]
[<[%$TOPIC/ms141072_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/ms141072_en-us_VS_110_2_0_3_0_1%]([%$TOPIC/ms141072_en-us_VS_110_2_0_3_0_2%].All, Inherited = false, AllowMultiple = true)>]
[<[%$TOPIC/ms141072_en-us_VS_110_2_0_3_0_3%]("CODE_ANALYSIS")>]
type SuppressMessageAttribute =  
    class 
        inherit [%$TOPIC/ms141072_en-us_VS_110_2_0_3_0_4%] 
    end
public final class SuppressMessageAttribute extends [%$TOPIC/ms141072_en-us_VS_110_2_0_4_0_0%]

The SuppressMessageAttribute type exposes the following members.

Constructors
  NameDescription
Public method Supported by the XNA Framework Supported by Portable Class Library SuppressMessageAttributeInitializes a new instance of the SuppressMessageAttribute class, specifying the category of the static analysis tool and the identifier for an analysis rule.
Top
Properties
  NameDescription
Public property Supported by the XNA Framework Supported by Portable Class Library CategoryGets the category identifying the classification of the attribute.
Public property Supported by the XNA Framework Supported by Portable Class Library CheckIdGets the identifier of the static analysis tool rule to be suppressed.
Public property Supported by the XNA Framework Supported by Portable Class Library JustificationGets or sets the justification for suppressing the code analysis message.
Public property Supported by the XNA Framework Supported by Portable Class Library MessageIdGets or sets an optional argument expanding on exclusion criteria.
Public property Supported by the XNA Framework Supported by Portable Class Library ScopeGets 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 TargetGets or sets a fully qualified path that represents the target of the attribute.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  NameDescription
Public method Supported by the XNA Framework Supported by Portable Class Library EqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeWhen 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 MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method Supported by the XNA Framework Supported by Portable Class Library ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves 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 _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

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.

NoteNote

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.

Examples

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

#Const CODE_ANALYSIS = True 
Imports System
Imports System.Diagnostics.CodeAnalysis



Class Library

    <SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId:="isChecked"), _
     SuppressMessage("Microsoft.Performance", "CA1804:RemoveUnusedLocals", MessageId:="fileIdentifier")> _
    Shared Sub FileNode(ByVal name As String, ByVal isChecked As Boolean)
        Dim fileIdentifier As String = name
        Dim fileName As String = name
        Dim version As String = String.Empty

    End Sub 'FileNode
End Class 'Library 
#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;
        }

    }
}
Version Information

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.