TestimoX

API Reference

Class

WslApi

Edit on GitHub
Namespace ComputerX.Wsl
Assembly ComputerX
Source ComputerX/Wsl/WslApi.cs:19
Modifiers static

Thin wrapper over the public Windows WSL API exposed by wslapi.dll.

Inheritance

  • Object
  • WslApi

Methods

public static Int32 ConfigureDistribution(String distributionName, UInt32 defaultUid, WslDistributionFlags flags) #
ComputerX/Wsl/WslApi.cs:119
Returns: Int32

Configures a WSL distribution through wslapi.dll.

Parameters

distributionName System.String requiredposition: 0
Distribution name.
defaultUid System.UInt32 requiredposition: 1
Target default Linux user identifier.
flags ComputerX.Wsl.WslDistributionFlags requiredposition: 2
Target WSL distribution flags.

Returns

Native HRESULT returned by WslConfigureDistribution.

public static WslDistributionConfigurationInfo GetDistributionConfiguration(String distributionName) #
ComputerX/Wsl/WslApi.cs:52
Returns: WslDistributionConfigurationInfo

Gets native WSL distribution configuration through wslapi.dll.

Parameters

distributionName System.String requiredposition: 0
Distribution name.

Returns

Distribution configuration.

public static Boolean IsDistributionRegistered(String distributionName) #
ComputerX/Wsl/WslApi.cs:19
Returns: Boolean

Determines whether a named WSL distribution is registered for the current user.

Parameters

distributionName System.String requiredposition: 0
Distribution name.

Returns

True when the distribution is registered.

public static Int32 TerminateDistribution(String distributionName) #
ComputerX/Wsl/WslApi.cs:136
Returns: Int32

Terminates a running WSL distribution through wslapi.dll.

Parameters

distributionName System.String requiredposition: 0
Distribution name.

Returns

Native HRESULT returned by WslTerminateDistribution.

public static Boolean TryGetDistributionConfiguration(String distributionName, out WslDistributionConfigurationInfo configuration, out String error) #
ComputerX/Wsl/WslApi.cs:96
Returns: Boolean

Non-throwing wrapper for String).

Parameters

distributionName System.String requiredposition: 0
Distribution name.
configuration ComputerX.Wsl.WslDistributionConfigurationInfo@ requiredposition: 1
Distribution configuration when the API call succeeds.
error System.String@ requiredposition: 2
Error message when the API call fails.

Returns

True when the API call completed.

public static Boolean TryIsDistributionRegistered(String distributionName, out Boolean registered) #
ComputerX/Wsl/WslApi.cs:38
Returns: Boolean

Non-throwing wrapper for String).

Parameters

distributionName System.String requiredposition: 0
Distribution name.
registered System.Boolean@ requiredposition: 1
Registration state when the API call succeeds.

Returns

True when the API call completed.