Class ExecuteResult
The result of a run. The same result answers both hops — the language server passes the host's answer back to the client unchanged, except for a parse that never reached the host at all.
public record ExecuteResult : IEquatable<ExecuteResult>
- Inheritance
-
ExecuteResult
- Implements
- Derived
- Inherited Members
Properties
ConditionError
Why the condition of the breakpoint the program waits at could not be evaluated, when Outcome is Suspended and that
is why it waits: a breakpoint whose condition raises an error is waited at, and this is what the person is told of it. Empty otherwise. The program does
not wait on the error: it is the condition's and not the program's, and ErrorNumber stays 0.
public string ConditionError { get; init; }
Property Value
Diagnostics
The syntax errors, when Outcome is SyntaxError.
public IReadOnlyList<string> Diagnostics { get; init; }
Property Value
DurationMilliseconds
How long the program ran, in milliseconds: from its first statement to the end of the run, or to where it waits when Outcome is
Suspended. 0 for a run that did not start (SyntaxError,
NotFound).
public long DurationMilliseconds { get; init; }
Property Value
ErrorCharacter
Where the error was raised, or where the program waits when Outcome is Suspended, zero-based as every position
in the platform is: the line, and ErrorCharacter within it, in the source of ErrorModule. Both -1 for any other outcome,
or when nothing located it.
public int ErrorCharacter { get; init; }
Property Value
Remarks
In the submitted Source when ErrorModule is the module the caller sent, which is the one document both ends of the protocol agree on: a client whose program does not live in a file (an interactive shell's buffer) maps it back to whatever it calls a line itself. In another module of the project, it is a position in that module's own source.
ErrorCode
The run-time error's RD-VBAL §2.6.3 diagnostic code — VBR for one the
runtime semantics reported, VBA for one the program raised itself with Error or
Err.Raise. Empty for any other outcome.
public string ErrorCode { get; init; }
Property Value
ErrorDetails
What the runtime was doing when it raised the run-time error, as it recorded it: the expression, and the frames of the operation that failed. The client formats them its own way. null for any other outcome, and for an error the runtime recorded no details of.
public VBErrorDetails? ErrorDetails { get; init; }
Property Value
Remarks
The location of the expression is in the source the runtime ran, as every position of the error is. The frames are bounded: at most MaxFrames of them, the innermost ones, with FramesTruncated set when there were more.
ErrorLine
Where the error was raised, or where the program waits when Outcome is Suspended, zero-based as every position
in the platform is: the line, and ErrorCharacter within it, in the source of ErrorModule. Both -1 for any other outcome,
or when nothing located it.
public int ErrorLine { get; init; }
Property Value
Remarks
In the submitted Source when ErrorModule is the module the caller sent, which is the one document both ends of the protocol agree on: a client whose program does not live in a file (an interactive shell's buffer) maps it back to whatever it calls a line itself. In another module of the project, it is a position in that module's own source.
ErrorLineNumber
🎯 The line number the error was raised at - what Erl reports: the nearest line-number
label at or before the faulting statement, or 0 when none precedes it. Also 0 for any
other outcome.
public long ErrorLineNumber { get; init; }
Property Value
ErrorMessage
The run-time error's description, or a short explanation of any other non-Completed outcome.
public string ErrorMessage { get; init; }
Property Value
ErrorModule
The programmatic name of the module ErrorLine and ErrorCharacter are positions in: the module the caller sent
(ModuleName), or the module of the project where the error was raised, or where the program waits. Empty when
ErrorLine is -1.
public string ErrorModule { get; init; }
Property Value
ErrorNumber
The run-time error's number, when Outcome is
RuntimeError; 0 otherwise.
public int ErrorNumber { get; init; }
Property Value
ErrorSource
What Err.Source reports: the object or application that generated the error, defaulting to
the project's own name (MS-VBAL §6.1.3.2.2.6). Empty for any other outcome.
public string ErrorSource { get; init; }
Property Value
ErrorTitle
The error's category, as a reader sees it in a title: which of RD-VBAL §2.6's families raised it - "Run-time error" or "Application error" for a run, localized. What it was is ErrorMessage. Empty for any other outcome.
public string ErrorTitle { get; init; }
Property Value
FormsShown
Whether the program completed with a form of the session still shown. The form stays loaded, and the handlers of its events run in the session as the person uses it, until it is unloaded. A debugger can stay attached to the session meanwhile, until no form is loaded (FormsLoaded). Always false for a run that is not under a debugger, and for one that runs unattended.
public bool FormsShown { get; init; }
Property Value
Outcome
How the run ended.
public ExecutionOutcome Outcome { get; init; }
Property Value
Output
Everything the program printed, in order, one entry per line — including a line it left open
with a trailing ;.
public IReadOnlyList<string> Output { get; init; }
Property Value
StackTrace
🎯 The call stack the error was raised on, innermost activation first - what Err.StackTrace
reports. Empty for any other outcome.
public IReadOnlyList<ExecuteStackFrame> StackTrace { get; init; }
Property Value
StreamedLines
How many lines the host has said by notification (rdcore/host/output) since it started, when this answer was given. A run that streams has
said its lines before it answers, and they are not in Output; this is what lets the receiver wait for them.
public long StreamedLines { get; init; }