DataSchemaError Class

Encapsulates the information needed to create a corresponding entry in the Visual Studio Error List.

Inheritance Hierarchy

System.Object
  Microsoft.Data.Schema.DataSchemaError
    Microsoft.Data.Schema.Sql.SqlServerError
    Microsoft.Data.Schema.StaticCodeAnalysis.DataRuleError
    Microsoft.VisualStudio.Data.Schema.Package.Refactoring.RefactoringError

Namespace:  Microsoft.Data.Schema
Assembly:  Microsoft.Data.Schema (in Microsoft.Data.Schema.dll)

Syntax

'Declaration
<SerializableAttribute> _
Public Class DataSchemaError
[SerializableAttribute]
public class DataSchemaError
[SerializableAttribute]
public ref class DataSchemaError
[<SerializableAttribute>]
type DataSchemaError =  class end
public class DataSchemaError

The DataSchemaError type exposes the following members.

Constructors

  Name Description
Public method DataSchemaError() Initializes a new instance of the DataSchemaError class.
Public method DataSchemaError(String, ErrorSeverity) Initializes a new instance of the DataSchemaError class by using the provided message and by indicating the severity of the error.
Public method DataSchemaError(String, String, ErrorSeverity) Initializes a new instance of the DataSchemaError class by using the provided message and the document name, and by indicating the severity of the error.
Public method DataSchemaError(String, String, Int32, ErrorSeverity) Initializes a new instance of the DataSchemaError class by using the provided message, document name, and error code, and by indicating the severity of the error.
Public method DataSchemaError(String, String, Int32, Int32, ErrorSeverity) Initializes a new instance of the DataSchemaError class by using the provided message, document name, line number, and column number, and by indicating the severity of the error.
Public method DataSchemaError(String, String, Int32, Int32, String, Int32, ErrorSeverity) Initializes a new instance of the DataSchemaError class by using the provided message, document name, line number, and column number, and by indicating the severity of the error.

Top

Properties

  Name Description
Public property BuildErrorCode Gets the complete error code for this error.
Public property Column Gets the column number where the error occurred.
Public property Document Gets the name of the document where the error occurred.
Public property ErrorCode Gets the error code.
Public property HelpKeyword Gets or sets the keyword to connect the error to Help documentation.
Public property Line Gets the line number where the error occurred.
Public property Message Gets the error message.
Public property Prefix Gets the prefix for the error.
Public property Severity Gets the severity assigned to the error.

Top

Methods

  Name Description
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

  Name Description
Protected fieldStatic member UndefinedErrorCode When returned from the ErrorCode property, indicates no value was supplied when the object was created. Value: zero.

Top

Remarks

A component will add this object to the ErrorManager in order to create a corresponding entry in the Visual Studio Error List.

Thread Safety

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

See Also

Reference

Microsoft.Data.Schema Namespace

ErrorManager

ErrorTaskService

Other Resources

Error List Window