SuppressMessageAttribute.MessageId Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets an optional argument expanding on exclusion criteria.

Namespace:   System.Diagnostics.CodeAnalysis
Assembly:  mscorlib (in mscorlib.dll)

public string MessageId { get; set; }

Property Value

Type: System.String

A string containing the expanded exclusion criteria.

The MessageId property is an optional argument that specifies additional exclusion where the literal metadata target is not sufficiently precise. For example, the SuppressMessageAttribute cannot be applied within a method, and it may be desirable to suppress a violation against a statement in the method that will give a rule violation, but not against all statements in the method.

The following code example shows the use of the SuppressMessageAttribute attribute to suppress warnings for a specific parameter in a method declaration and a specific field in the method. 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;
}

Universal Windows Platform
Available since 8
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show: