Table of Contents

Class ExecuteStackFrame

Namespace
RDCore.SDK.Platform.Protocol
Assembly
RDCore.SDK.Protocol.dll

One activation of the call stack a run-time error was raised on.

public record ExecuteStackFrame : IEquatable<ExecuteStackFrame>
Inheritance
ExecuteStackFrame
Implements
Inherited Members

Remarks

Structured rather than pre-formatted, because a position only means something to the client: the source both ends agree on is the one the client sent, and a client whose program does not live in a file has its own idea of what a line is called. Formatting it here would force the shell to display a line number its user never typed.

Constructors

ExecuteStackFrame(string, int, int, IReadOnlyList<int>?)

One activation of the call stack a run-time error was raised on.

public ExecuteStackFrame(string Procedure, int Line = -1, int Character = -1, IReadOnlyList<int>? ReturnLines = null)

Parameters

Procedure string

The name of the procedure the activation is of.

Line int

Zero-based line in the source of Module, or -1 when the activation carries no location. For the activation the error was raised in, it is the line of the faulting statement or expression. For each of its callers, it is the line of the call the caller was suspended at: the call expression or call statement that was running.

Character int

Zero-based character within Line, or -1.

ReturnLines IReadOnlyList<int>

The zero-based lines of the GoSub statements the activation had not Returned from when the error was raised, innermost first - how it got to where it was, as the stack of a program that waits says it. Empty for an activation in no GoSub.

Remarks

Structured rather than pre-formatted, because a position only means something to the client: the source both ends agree on is the one the client sent, and a client whose program does not live in a file has its own idea of what a line is called. Formatting it here would force the shell to display a line number its user never typed.

Properties

Character

Zero-based character within Line, or -1.

public int Character { get; init; }

Property Value

int

Line

Zero-based line in the source of Module, or -1 when the activation carries no location. For the activation the error was raised in, it is the line of the faulting statement or expression. For each of its callers, it is the line of the call the caller was suspended at: the call expression or call statement that was running.

public int Line { get; init; }

Property Value

int

Module

The programmatic name of the module the procedure is in, whose source Line and ReturnLines are lines of: the module the caller sent (ModuleName), or another module of the project. Empty when the activation carries no location.

public string Module { get; init; }

Property Value

string

Procedure

The name of the procedure the activation is of.

public string Procedure { get; init; }

Property Value

string

ReturnLines

The lines of the GoSub statements the activation would have returned to; none for one that was in none.

public IReadOnlyList<int> ReturnLines { get; init; }

Property Value

IReadOnlyList<int>