Header menu logo Xanthos

JvLinkConfig Module

Namespace: Xanthos.Runtime
Assembly: Xanthos.dll

Functions and values

Function or value Description

create sid savePath serviceKey useJvGets

Full Usage: create sid savePath serviceKey useJvGets

Parameters:
    sid : string - Software ID for JV-Link authentication
    savePath : string option - Optional path for JV-Link data storage
    serviceKey : string option - Optional service key for authentication
    useJvGets : bool option - Optional flag to use JVGets API. None = fallback to env var

Returns: Result<JvLinkConfig, XanthosError>

Validates raw configuration values and produces a trimmed JvLinkConfig.

SID validation per JV-Link JVInit specification:

  • Non-empty string
  • Max 64 bytes
  • No leading space
  • Only printable ASCII characters (0x21-0x7E)

sid : string

Software ID for JV-Link authentication

savePath : string option

Optional path for JV-Link data storage

serviceKey : string option

Optional service key for authentication

useJvGets : bool option

Optional flag to use JVGets API. None = fallback to env var

Returns: Result<JvLinkConfig, XanthosError>

Type something to start searching.