LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

This reference documents the current beta SDK. Beta APIs can change before stable.

IPluginConfigurationValues14.1 Beta

C#
public interface Unbroken.LaunchBox.Plugins.Forms.IPluginConfigurationValues
Reads effective values for one configuration scope, with optional declared field defaults.

Remarks

Typed accessors use invariant formatting. Empty or absent values inherit from the base scope, then the declared default, then the caller's default. TryGetValue excludes declared defaults. Editing these values never persists them.

Methods

GetBoolean 14.1 Beta

C#
bool GetBoolean(string key, bool defaultValue = false)
Reads a Boolean with fallback when the value cannot be parsed.
key 14.1 Beta
The field identifier.
defaultValue 14.1 Beta
The fallback when neither a value nor declared default can be parsed.

Returns

The effective Boolean.

GetInt32 14.1 Beta

C#
int GetInt32(string key, int defaultValue = 0)
Reads an invariant integer with fallback when the value cannot be parsed.
key 14.1 Beta
The field identifier.
defaultValue 14.1 Beta
The fallback when neither a value nor declared default can be parsed.

Returns

The effective integer.

GetString 14.1 Beta

C#
string GetString(string key, string defaultValue = "")
Reads a string with fallback to the declared and caller defaults.
key 14.1 Beta
The field identifier.
defaultValue 14.1 Beta
The fallback when no value or declared default exists.

Returns

The effective string.

SetValue 14.1 Beta

C#
void SetValue(string key, string? value)
Updates this scope in the detached snapshot. Null or empty removes its override.
key 14.1 Beta
The field identifier.
value 14.1 Beta
The invariant value, or null to clear it.

TryGetValue 14.1 Beta

C#
bool TryGetValue(string key, out string value)
Looks up an explicitly supplied or inherited value, excluding declared defaults.
key 14.1 Beta
The field identifier.
value 14.1 Beta
The value, or an empty string when absent.

Returns

Whether a nonempty value exists.