Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

SuppressMessageAttribute Class

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

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

[AttributeUsageAttribute(AttributeTargets.All, Inherited=false, AllowMultiple=true)] 
[ConditionalAttribute("CODE_ANALYSIS")] 
public sealed class SuppressMessageAttribute : Attribute
/** @attribute AttributeUsageAttribute(AttributeTargets.All, Inherited=false, AllowMultiple=true) */ 
/** @attribute ConditionalAttribute("CODE_ANALYSIS") */ 
public final class SuppressMessageAttribute extends Attribute
AttributeUsageAttribute(AttributeTargets.All, Inherited=false, AllowMultiple=true) 
ConditionalAttribute("CODE_ANALYSIS") 
public final class SuppressMessageAttribute extends Attribute
Not applicable.

This attribute can be applied to any application element.

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.

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

#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;
        }

    }
}

System.Object
   System.Attribute
    System.Diagnostics.CodeAnalysis.SuppressMessageAttribute
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

.NET Compact Framework

Supported in: 2.0

XNA Framework

Supported in: 1.0

Community Additions

Show:
© 2014 Microsoft. All rights reserved.