SuppressMessageAttribute.CheckId Property

Definition

Namespace:

System.Diagnostics.CodeAnalysis

Assembly:

System.Runtime.dll

Source:

SuppressMessageAttribute.cs

Gets the identifier of the code analysis tool rule to be suppressed.

public:
 property System::String ^ CheckId { System::String ^ get(); };

public string CheckId { get; }

member this.CheckId : string

Public ReadOnly Property CheckId As String

Property Value

String

The identifier of the code analysis tool rule to be suppressed.

Examples

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

<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

Remarks

Concatenated together, the Category and CheckId properties form a unique check identifier.