SuppressMessageAttribute Class

May 11, 2014

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)

[AttributeUsageAttribute(AttributeTargets.All, Inherited = false, AllowMultiple = true)]
[ConditionalAttribute("CODE_ANALYSIS")]
public sealed class SuppressMessageAttribute : Attribute

The SuppressMessageAttribute type exposes the following members.

  NameDescription
Public methodSuppressMessageAttributeInitializes 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 propertyCategoryGets the category that identifies the classification of the attribute.
Public propertyCheckIdGets the identifier of the static analysis tool rule to be suppressed.
Public propertyJustificationGets or sets the justification for suppressing the code analysis message.
Public propertyMessageIdGets or sets an optional argument that expands on exclusion criteria.
Public propertyScopeGets or sets the scope of the code that is relevant for the attribute.
Public propertyTargetGets or sets a fully qualified path that represents the target of the attribute.
Top

  NameDescription
Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Show:
© 2014 Microsoft