TestimoX

API Reference

Class

WslDistributionConfigurationWriter

Edit on GitHub
Namespace ComputerX.Wsl
Assembly ComputerX
Source ComputerX/Wsl/WslDistributionConfigurationWriter.cs:26
Modifiers static

Plans and applies WSL distribution configuration changes through the native public WSL API.

Inheritance

  • Object
  • WslDistributionConfigurationWriter

Methods

public static WslDistributionConfigurationSetResult ApplyPlan(WslDistributionConfigurationSetPlan plan, Boolean execute) #
ComputerX/Wsl/WslDistributionConfigurationWriter.cs:108
Returns: WslDistributionConfigurationSetResult

Applies an existing WSL distribution configuration change plan.

Parameters

plan ComputerX.Wsl.WslDistributionConfigurationSetPlan requiredposition: 0
Configuration change plan.
execute System.Boolean requiredposition: 1
When false, returns a preview result without invoking the native API.

Returns

Configuration change result.

public static WslDistributionConfigurationSetPlan Plan(String name, Nullable<UInt32> defaultUid = null, Nullable<WslDistributionFlags> flags = null, Nullable<Boolean> enableInterop = null, Nullable<Boolean> appendNtPath = null, Nullable<Boolean> enableDriveMounting = null) #
ComputerX/Wsl/WslDistributionConfigurationWriter.cs:26
Returns: WslDistributionConfigurationSetPlan

Creates a non-mutating plan for a WSL distribution configuration change.

Parameters

name System.String requiredposition: 0
Distribution name.
defaultUid System.Nullable{System.UInt32} = null optionalposition: 1
Optional target default Linux user identifier.
flags System.Nullable{ComputerX.Wsl.WslDistributionFlags} = null optionalposition: 2
Optional full target flag set.
enableInterop System.Nullable{System.Boolean} = null optionalposition: 3
Optional Windows interoperability flag override.
appendNtPath System.Nullable{System.Boolean} = null optionalposition: 4
Optional Windows PATH append flag override.
enableDriveMounting System.Nullable{System.Boolean} = null optionalposition: 5
Optional Windows drive mounting flag override.

Returns

Configuration change plan.

public static WslDistributionConfigurationSetResult Set(String name, Nullable<UInt32> defaultUid = null, Nullable<WslDistributionFlags> flags = null, Nullable<Boolean> enableInterop = null, Nullable<Boolean> appendNtPath = null, Nullable<Boolean> enableDriveMounting = null, Boolean execute = true) #
ComputerX/Wsl/WslDistributionConfigurationWriter.cs:56
Returns: WslDistributionConfigurationSetResult

Applies a WSL distribution configuration change through WslConfigureDistribution.

Parameters

name System.String requiredposition: 0
Distribution name.
defaultUid System.Nullable{System.UInt32} = null optionalposition: 1
Optional target default Linux user identifier.
flags System.Nullable{ComputerX.Wsl.WslDistributionFlags} = null optionalposition: 2
Optional full target flag set.
enableInterop System.Nullable{System.Boolean} = null optionalposition: 3
Optional Windows interoperability flag override.
appendNtPath System.Nullable{System.Boolean} = null optionalposition: 4
Optional Windows PATH append flag override.
enableDriveMounting System.Nullable{System.Boolean} = null optionalposition: 5
Optional Windows drive mounting flag override.
execute System.Boolean = true optionalposition: 6
When false, returns a preview result without invoking the native API.

Returns

Configuration change result.