Structs§
- WSLDistribution
Information - WSLPluginAPI
V1 - WSLPlugin
Hooks V1 - WSLSession
Information - WSLVersion
- WSLVm
Creation Settings - WslOffline
Distribution Information
Constants§
- WSLUser
Configuration_ None - WSLUser
Configuration_ WSLUser Configuration Custom Kernel - WSLUser
Configuration_ WSLUser Configuration Custom Kernel Command Line - WSL_
E_ PLUGIN_ REQUIRES_ UPDATE
Functions§
- require_
version ⚠ - Ensures the WSL Plugin API version meets the minimum required version.
Type Aliases§
- WSLPluginAPI_
Entry Point V1 - WSLPluginAPI_
Execute Binary - Execute a program in the root namespace. On success, ‘Socket’ is connected to stdin & stdout (stderr goes to dmesg) // ‘Arguments’ is expected to be NULL terminated
- WSLPluginAPI_
Execute Binary InDistribution - Execute a program in a user distribution On success, ‘Socket’ is connected to stdin & stdout (stderr goes to dmesg) // ‘Arguments’ is expected to be NULL terminated
- WSLPluginAPI_
Mount Folder - Create plan9 mount between Windows & Linux
- WSLPluginAPI_
OnDistribution Registered - Called when a distribution is registered or unregisteed. Returning failure will NOT cause the operation to fail.
- WSLPluginAPI_
OnDistribution Started - Called when a distribution has started. ‘Session’ and ‘Distribution’ is only valid during while the call is in progress.
- WSLPluginAPI_
OnDistribution Stopping - Called when a distribution is about to stop. ‘Session’ and ‘Distribution’ is only valid during while the call is in progress. Note: It’s possible that stopping a distribution fails (for instance if a file is in use). In this case, it’s possible for this notification to be called multiple times for the same distribution.
- WSLPluginAPI_
OnVM Started - Called when the VM has started. ‘Session’ and ‘UserSettings’ are only valid during while the call is in progress.
- WSLPluginAPI_
OnVM Stopping - Called when the VM is about to stop. ‘Session’ is only valid during while the call is in progress.
- WSLPluginAPI_
Plugin Error - Set the error message to display to the user if the VM or distribution creation fails. Must be called synchronously in either OnVMStarted() or OnDistributionStarted().
- WSLSession
Id - WSLUser
Configuration