Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
SuppressMessageAttribute Constructor

SuppressMessageAttribute Constructor

Initializes a new instance of the SuppressMessageAttribute class, specifying the category of the static analysis tool and the identifier for an analysis rule.

Namespace:  System.Diagnostics.CodeAnalysis
Assemblies:   mscorlib (in mscorlib.dll)
  System.Diagnostics.Tools (in System.Diagnostics.Tools.dll)

public SuppressMessageAttribute(
	string category,
	string checkId
)

Parameters

category
Type: System.String

The category for the attribute.

checkId
Type: System.String

The identifier of the analysis tool rule the attribute applies to.

The category parameter value is specific to the analysis tool and categorizes the rule identified by the checkId parameter. The two parameters concatenated together form a unique identifier for the rule.

NoteNote

The preprocessor symbol "CODE_ANALYSIS" must be defined for this attribute to be effective. The absence of the preprocessor symbol results in the attribute not being applied.

The following code example shows the use of the SuppressMessageAttribute attribute to suppress warnings for the Microsoft.Performance category and the CA1801 and CA1804 check identifiers. This code example is part of a larger example provided for the SuppressMessageAttribute class.

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

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Portable Class Library

Supported in: Portable Class Library
Show:
© 2015 Microsoft