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

A Fortify path element structure, which serves as a location identifier. This type is typically used to represent result locations, datapath sources, and datapath sinks.
Show file Open project: Microsoft/sarif-sdk Class Usage Examples

Public Properties

Property Type Description
FilePath string
LineStart int
TargetFunction string

Public Methods

Method Description
FortifyPathElement ( string filePath, int lineStart, string targetFunction ) : System

Initializes a new instance of the FortifyPathElement class.
Parse ( XmlReader xmlReader, FortifyStrings strings ) : FortifyPathElement

Parses an element as a Fortify PathElement node, consuming the node.

Method Details

FortifyPathElement() public method

Initializes a new instance of the FortifyPathElement class.
Thrown when null. Thrown when one or more arguments are outside the /// required range.
public FortifyPathElement ( string filePath, int lineStart, string targetFunction ) : System
filePath string Full pathname of the file.
lineStart int The line start index.
targetFunction string Target function name; may be null.
return System

Parse() public static method

Parses an element as a Fortify PathElement node, consuming the node.
public static Parse ( XmlReader xmlReader, FortifyStrings strings ) : FortifyPathElement
xmlReader System.Xml.XmlReader The from which a node shall be parsed. When /// this function returns, this reader is placed directly after the element on which it is /// currently placed.
strings FortifyStrings Strings used in processing Fortify logs.
return FortifyPathElement

Property Details

FilePath public property

Full pathname of the file.
public string FilePath
return string

LineStart public property

The line start index.
public int LineStart
return int

TargetFunction public property

Target function name; may be null.
public string TargetFunction
return string