Edit

Share via

WslConfigureDistribution function (wslapi.h)

  • Article

Modifies the behavior of a distribution registered with the Windows Subsystem for Linux (WSL).

Syntax

HRESULT WslConfigureDistribution(
  PCWSTR                 distributionName,
  ULONG                  defaultUID,
  WSL_DISTRIBUTION_FLAGS wslDistributionFlags
);

Parameters

distributionName

Unique name representing a distribution (for example, "Fabrikam.Distro.10.01").

defaultUID

The Linux user ID to use when launching new WSL sessions for this distribution.

wslDistributionFlags

Flags specifying what behavior to use for this distribution.

Return value

Returns S_OK on success, or a failing HRESULT otherwise.

Requirements

Requirement Value
Target Platform Windows
Header wslapi.h
Library Wslapi.lib
DLL Api-ms-win-wsl-api-l1-1-0.dll