Class HostRunSessionExecuteParams
- Namespace
- RDCore.SDK.Platform.Components
- Assembly
- RDCore.SDK.dll
Request for rdcore/host/runSession/execute: runs one procedure of a run session's project, with the arguments of a data row and the fakes of the
run, unattended.
[Method("rdcore/host/runSession/execute", Direction.ClientToServer)]
public record HostRunSessionExecuteParams : IRequest, IRequest<Unit>, IRequest<HostRunSessionExecuteResult>, IBaseRequest, IEquatable<HostRunSessionExecuteParams>
- Inheritance
-
HostRunSessionExecuteParams
- Implements
-
IRequestIRequest<Unit>IRequest<HostRunSessionExecuteResult>IBaseRequest
- Inherited Members
Remarks
The run is unattended (RunsUnattended), and what it prints is in the answer's Output. A dialog that no fake answers fails the run.
An unhandled run-time or internal error ends the program as End does: the session's module-level variables are reset and its files closed, and the
answer says so (SessionReset). Cancelling the request ($/cancelRequest) ends the program the same way,
and the answer is Halted.
One program runs on the host at a time. A request while the shell's session or another run session runs a program is refused with HostBusy, and one for a session that is closed or was never opened with UnknownSession.
Part of the component protocol (RDCoreComponentProtocol), outside the SDK's compatibility promise.
Properties
Arguments
The arguments, in the procedure's declared parameter order: a data row. Each is Let-coerced to its parameter's declared type (MS-VBAL §5.5.1.2). A count the procedure does not take, or a coercion that fails, is the run-time error the call would raise in the program, in the answer.
public IReadOnlyList<RunValue> Arguments { get; init; }
Property Value
EntryPoint
The name of the procedure to run.
public string EntryPoint { get; init; }
Property Value
Fakes
The fakes the run starts with, which replace the session's: null keeps the session's table as the previous run left it, so a fake set up in a test's initialization lasts through the test.
public FakesTable? Fakes { get; init; }
Property Value
ModuleName
The programmatic name of the module of the project that declares EntryPoint.
public string ModuleName { get; init; }
Property Value
SessionId
The run session, as SessionId named it.
public string SessionId { get; init; }