Class VBCompileErrorInfo

Namespace

RDCore.SDK.Model.Errors

Assembly

RDCore.SDK.dll

Encapsulates the serializable error data for a compile error.

public record VBCompileErrorInfo : VBErrorInfo, IEquatable<VBErrorInfo>, IEquatable<VBCompileErrorInfo>

Inheritance

object

VBErrorInfo

VBCompileErrorInfo

Implements

IEquatable<VBErrorInfo>

IEquatable<VBCompileErrorInfo>

Inherited Members

VBErrorInfo.ErrorId

VBErrorInfo.Location

VBErrorInfo.Description

VBErrorInfo.Verbose

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

A compile error generally occurs while traversing the abstract syntax tree (AST) in the semantic layer.

Fields

VBCompileErrors

Known MS-VBA compilation error messages; while this dictionary is intended to be exhaustive, it is probably still incomplete.

public static readonly Dictionary<VBCompileErrorId, string> VBCompileErrors

Field Value

Dictionary<VBCompileErrorId, string>

Remarks

👉 These messages are localized.

Properties

VBCompileErrorId

The unique error ID for this compile-time error.

public VBCompileErrorId VBCompileErrorId { get; }

Property Value

VBCompileErrorId

Remarks

👉 While compilation errors technically encompass syntax errors, RD-VBA separates the two classes such that VBCompileErrorInfo is reserved for errors that occur after an executable abstract syntax tree (AST) was successfully produced.

Methods

For(VBCompileErrorId, Location, string)

Creates a new VBCompileErrorInfo describing the specified VBCompileErrorId at the specified Location.

public static VBCompileErrorInfo For(VBCompileErrorId errorId, Location location, string verbose)

Parameters

errorId VBCompileErrorId

The formal VBCompileErrorId value for this error.

location Location

The document location of the problematic node.

verbose string

A detailed message that is optionally appended, depending on the current server trace configuration.

Returns

VBCompileErrorInfo

A new instance of a VBSyntaxErrorInfo encapsulating the specified error metadata with a localized description string.

GetErrorString(VBCompileErrorId)

Gets the standard (localied) error message for the specified errorId.

public static string GetErrorString(VBCompileErrorId errorId)

Parameters

errorId VBCompileErrorId

The formal VBCompileErrorId value for this error.

Returns

string