ProjectProblemSuppressor Class

SQL Server 2014

Updated: April 20, 2017

Represents the problem suppressor used by SSDT projects. The ShouldSuppressProblem method can be passed to ShouldSuppressProblem in order to use this class. This reads suppression information from a file with a name matching SuppressionFilename ("StaticCodeAnalysis.SuppressMessages.xml") in the root directory. All relative paths will be resolved relative to the project folder defined in the constructor.

Namespace: Microsoft.SqlServer.Dac.CodeAnalysis
Assembly: Microsoft.SqlServer.Dac.Extensions (in Microsoft.SqlServer.Dac.Extensions.dll)

Inheritance Hierarchy

System::Object
Microsoft.SqlServer.Dac.CodeAnalysis::ProjectProblemSuppressor

Syntax

C++

public ref class ProjectProblemSuppressor sealed

Properties

	Name	Description
	ShouldSuppressProblem	Gets the predicate that can be used to suppress the errors.

Methods

	Name	Description
	AddSuppressedProblems(IEnumerable<SuppressedProblemInfo^>^)	Adds one or more instances of SuppressedProblemInfo to the set of suppressed problems. The full set of suppressed problems will be immediately written out to the backing XML file.
	CreateSuppressor(String^)	Creates a new ProjectProblemSuppressor.
	CreateSuppressor(String^, String^)	Creates a new ProjectProblemSuppressor.
	Equals(Object^)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetSuppressedProblems()	Gets information on what problems will be suppressed. Specifically, a set of SuppressedProblemInfo objects will be returned that defines each combination of a rule being suppressed and the file name for which the rule is suppressed.
	GetType()	(Inherited from Object.)
	ResetSuppressedProblems()	Resets the suppressed problems to their default state. If an XML suppression file for the project existed already then the state will be reloaded from there, otherwise it will be reset so that no problems are suppressed.
	ToString()	(Inherited from Object.)
	UnsuppressRulesFromFile(String^)	Removes all problem suppression directives for a particular filename. The updated set of problems to suppress will be immediately written out to the backing XML file that describes what rules should be suppressed for a given file.