Export (0) Print
Expand All

SuppressMessageAttribute Class

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)

'Declaration
<AttributeUsageAttribute(AttributeTargets.All, Inherited := False, AllowMultiple := True)> _
<ConditionalAttribute("CODE_ANALYSIS")> _
Public NotInheritable Class SuppressMessageAttribute _
	Inherits Attribute

The SuppressMessageAttribute type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySuppressMessageAttributeInitializes a new instance of the SuppressMessageAttribute class, specifying the category of the static analysis tool and the identifier for an analysis rule.
Top

  NameDescription
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryCategoryGets the category identifying the classification of the attribute.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryCheckIdGets the identifier of the static analysis tool rule to be suppressed.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryJustificationGets or sets the justification for suppressing the code analysis message.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryMessageIdGets or sets an optional argument expanding on exclusion criteria.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryScopeGets or sets the scope of the code that is relevant for the attribute.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryTargetGets or sets a fully qualified path that represents the target of the attribute.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top

  NameDescription
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodSupported by the XNA FrameworkMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides 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.

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.

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 


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

Community Additions

ADD
Show:
© 2014 Microsoft