C# Class Microsoft.CodeAnalysis.Sarif.Converters.CppCheckError

An error reported by CppCheck.
Show file Open project: Microsoft/sarif-sdk Class Usage Examples

Public Properties

Property Type Description
Id string
Locations ImmutableArray
Message string
Severity string
VerboseMessage string

Public Methods

Method Description
CppCheckError ( string id, string message, string verboseMessage, string severity, ImmutableArray locations ) : System

Initializes a new instance of the CppCheckError class.
Parse ( XmlReader reader, CppCheckStrings strings ) : CppCheckError

Parses the element on which an XmlReader is positioned as a CppCheck error node.
ToSarifIssue ( ) : System.Result

Converts this instance to Result.

Private Methods

Method Description
ParseLocationsSubtree ( XmlReader reader, CppCheckStrings strings ) : ImmutableArray

Method Details

CppCheckError() public method

Initializes a new instance of the CppCheckError class.
public CppCheckError ( string id, string message, string verboseMessage, string severity, ImmutableArray locations ) : System
id string The rule ID of the error generated by CppCheck.
message string The message of the error generated by CppCheck.
verboseMessage string The verbose message of the error generated by CppCheck.
severity string The severity of the error generated by CppCheck.
locations ImmutableArray The locations to which the error generated by CppCheck refer.
return System

Parse() public static method

Parses the element on which an XmlReader is positioned as a CppCheck error node.
The xml on which is placed is /// in an incorrect format.
public static Parse ( XmlReader reader, CppCheckStrings strings ) : CppCheckError
reader System.Xml.XmlReader The reader from which a CppCheck error shall be read.
strings CppCheckStrings Strings used to parse the CppCheck log.
return CppCheckError

ToSarifIssue() public method

Converts this instance to Result.
public ToSarifIssue ( ) : System.Result
return System.Result

Property Details

Id public property

The rule ID of the error generated by CppCheck.
public string Id
return string

Locations public property

The locations to which the error generated by CppCheck refer.
public ImmutableArray Locations
return ImmutableArray

Message public property

The message of the error generated by CppCheck.
public string Message
return string

Severity public property

The severity of the error generated by CppCheck.
public string Severity
return string

VerboseMessage public property

The verbose message of the error generated by CppCheck.
public string VerboseMessage
return string