Win32 API 日本語リファレンス
ホームSystem.SubsystemForLinux › WslConfigureDistribution

WslConfigureDistribution

関数
WSLディストリビューションの既定UIDやフラグを構成する。
DLLApi-ms-win-wsl-api-l1-1-0.dll呼出規約winapi

シグネチャ

// Api-ms-win-wsl-api-l1-1-0.dll
#include <windows.h>

HRESULT WslConfigureDistribution(
    LPCWSTR distributionName,
    DWORD defaultUID,
    WSL_DISTRIBUTION_FLAGS wslDistributionFlags
);

パラメーター

名前方向説明
distributionNameLPCWSTRin設定変更対象の WSL ディストリビューション名(Unicode)。
defaultUIDDWORDin起動時に使用する既定の Linux ユーザー ID(UID)。
wslDistributionFlagsWSL_DISTRIBUTION_FLAGSinディストリビューションの動作フラグ。相互運用や PATH 追加等のオプション。

戻り値の型: HRESULT

各言語での呼び出し定義

// Api-ms-win-wsl-api-l1-1-0.dll
#include <windows.h>

HRESULT WslConfigureDistribution(
    LPCWSTR distributionName,
    DWORD defaultUID,
    WSL_DISTRIBUTION_FLAGS wslDistributionFlags
);
[DllImport("Api-ms-win-wsl-api-l1-1-0.dll", ExactSpelling = true)]
static extern int WslConfigureDistribution(
    [MarshalAs(UnmanagedType.LPWStr)] string distributionName,   // LPCWSTR
    uint defaultUID,   // DWORD
    int wslDistributionFlags   // WSL_DISTRIBUTION_FLAGS
);
<DllImport("Api-ms-win-wsl-api-l1-1-0.dll", ExactSpelling:=True)>
Public Shared Function WslConfigureDistribution(
    <MarshalAs(UnmanagedType.LPWStr)> distributionName As String,   ' LPCWSTR
    defaultUID As UInteger,   ' DWORD
    wslDistributionFlags As Integer   ' WSL_DISTRIBUTION_FLAGS
) As Integer
End Function
' distributionName : LPCWSTR
' defaultUID : DWORD
' wslDistributionFlags : WSL_DISTRIBUTION_FLAGS
Declare PtrSafe Function WslConfigureDistribution Lib "api-ms-win-wsl-api-l1-1-0" ( _
    ByVal distributionName As LongPtr, _
    ByVal defaultUID As Long, _
    ByVal wslDistributionFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WslConfigureDistribution = ctypes.windll.LoadLibrary("Api-ms-win-wsl-api-l1-1-0.dll").WslConfigureDistribution
WslConfigureDistribution.restype = ctypes.c_int
WslConfigureDistribution.argtypes = [
    wintypes.LPCWSTR,  # distributionName : LPCWSTR
    wintypes.DWORD,  # defaultUID : DWORD
    ctypes.c_int,  # wslDistributionFlags : WSL_DISTRIBUTION_FLAGS
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('Api-ms-win-wsl-api-l1-1-0.dll')
WslConfigureDistribution = Fiddle::Function.new(
  lib['WslConfigureDistribution'],
  [
    Fiddle::TYPE_VOIDP,  # distributionName : LPCWSTR
    -Fiddle::TYPE_INT,  # defaultUID : DWORD
    Fiddle::TYPE_INT,  # wslDistributionFlags : WSL_DISTRIBUTION_FLAGS
  ],
  Fiddle::TYPE_INT)
#[link(name = "api-ms-win-wsl-api-l1-1-0")]
extern "system" {
    fn WslConfigureDistribution(
        distributionName: *const u16,  // LPCWSTR
        defaultUID: u32,  // DWORD
        wslDistributionFlags: i32  // WSL_DISTRIBUTION_FLAGS
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("Api-ms-win-wsl-api-l1-1-0.dll")]
public static extern int WslConfigureDistribution([MarshalAs(UnmanagedType.LPWStr)] string distributionName, uint defaultUID, int wslDistributionFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'Api-ms-win-wsl-api-l1-1-0_WslConfigureDistribution' -Namespace Win32 -PassThru
# $api::WslConfigureDistribution(distributionName, defaultUID, wslDistributionFlags)
#uselib "Api-ms-win-wsl-api-l1-1-0.dll"
#func global WslConfigureDistribution "WslConfigureDistribution" sptr, sptr, sptr
; WslConfigureDistribution distributionName, defaultUID, wslDistributionFlags   ; 戻り値は stat
; distributionName : LPCWSTR -> "sptr"
; defaultUID : DWORD -> "sptr"
; wslDistributionFlags : WSL_DISTRIBUTION_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "Api-ms-win-wsl-api-l1-1-0.dll"
#cfunc global WslConfigureDistribution "WslConfigureDistribution" wstr, int, int
; res = WslConfigureDistribution(distributionName, defaultUID, wslDistributionFlags)
; distributionName : LPCWSTR -> "wstr"
; defaultUID : DWORD -> "int"
; wslDistributionFlags : WSL_DISTRIBUTION_FLAGS -> "int"
; HRESULT WslConfigureDistribution(LPCWSTR distributionName, DWORD defaultUID, WSL_DISTRIBUTION_FLAGS wslDistributionFlags)
#uselib "Api-ms-win-wsl-api-l1-1-0.dll"
#cfunc global WslConfigureDistribution "WslConfigureDistribution" wstr, int, int
; res = WslConfigureDistribution(distributionName, defaultUID, wslDistributionFlags)
; distributionName : LPCWSTR -> "wstr"
; defaultUID : DWORD -> "int"
; wslDistributionFlags : WSL_DISTRIBUTION_FLAGS -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	api_ms_win_wsl_api_l1_1_0 = windows.NewLazySystemDLL("Api-ms-win-wsl-api-l1-1-0.dll")
	procWslConfigureDistribution = api_ms_win_wsl_api_l1_1_0.NewProc("WslConfigureDistribution")
)

// distributionName (LPCWSTR), defaultUID (DWORD), wslDistributionFlags (WSL_DISTRIBUTION_FLAGS)
r1, _, err := procWslConfigureDistribution.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(distributionName))),
	uintptr(defaultUID),
	uintptr(wslDistributionFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function WslConfigureDistribution(
  distributionName: PWideChar;   // LPCWSTR
  defaultUID: DWORD;   // DWORD
  wslDistributionFlags: Integer   // WSL_DISTRIBUTION_FLAGS
): Integer; stdcall;
  external 'Api-ms-win-wsl-api-l1-1-0.dll' name 'WslConfigureDistribution';
result := DllCall("Api-ms-win-wsl-api-l1-1-0\WslConfigureDistribution"
    , "WStr", distributionName   ; LPCWSTR
    , "UInt", defaultUID   ; DWORD
    , "Int", wslDistributionFlags   ; WSL_DISTRIBUTION_FLAGS
    , "Int")   ; return: HRESULT
●WslConfigureDistribution(distributionName, defaultUID, wslDistributionFlags) = DLL("Api-ms-win-wsl-api-l1-1-0.dll", "int WslConfigureDistribution(char*, dword, int)")
# 呼び出し: WslConfigureDistribution(distributionName, defaultUID, wslDistributionFlags)
# distributionName : LPCWSTR -> "char*"
# defaultUID : DWORD -> "dword"
# wslDistributionFlags : WSL_DISTRIBUTION_FLAGS -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "api-ms-win-wsl-api-l1-1-0" fn WslConfigureDistribution(
    distributionName: [*c]const u16, // LPCWSTR
    defaultUID: u32, // DWORD
    wslDistributionFlags: i32 // WSL_DISTRIBUTION_FLAGS
) callconv(std.os.windows.WINAPI) i32;
proc WslConfigureDistribution(
    distributionName: WideCString,  # LPCWSTR
    defaultUID: uint32,  # DWORD
    wslDistributionFlags: int32  # WSL_DISTRIBUTION_FLAGS
): int32 {.importc: "WslConfigureDistribution", stdcall, dynlib: "Api-ms-win-wsl-api-l1-1-0.dll".}
pragma(lib, "api-ms-win-wsl-api-l1-1-0");
extern(Windows)
int WslConfigureDistribution(
    const(wchar)* distributionName,   // LPCWSTR
    uint defaultUID,   // DWORD
    int wslDistributionFlags   // WSL_DISTRIBUTION_FLAGS
);
ccall((:WslConfigureDistribution, "Api-ms-win-wsl-api-l1-1-0.dll"), stdcall, Int32,
      (Cwstring, UInt32, Int32),
      distributionName, defaultUID, wslDistributionFlags)
# distributionName : LPCWSTR -> Cwstring
# defaultUID : DWORD -> UInt32
# wslDistributionFlags : WSL_DISTRIBUTION_FLAGS -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WslConfigureDistribution(
    const uint16_t* distributionName,
    uint32_t defaultUID,
    int32_t wslDistributionFlags);
]]
local api-ms-win-wsl-api-l1-1-0 = ffi.load("api-ms-win-wsl-api-l1-1-0")
-- api-ms-win-wsl-api-l1-1-0.WslConfigureDistribution(distributionName, defaultUID, wslDistributionFlags)
-- distributionName : LPCWSTR
-- defaultUID : DWORD
-- wslDistributionFlags : WSL_DISTRIBUTION_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('Api-ms-win-wsl-api-l1-1-0.dll');
const WslConfigureDistribution = lib.func('__stdcall', 'WslConfigureDistribution', 'int32_t', ['str16', 'uint32_t', 'int32_t']);
// WslConfigureDistribution(distributionName, defaultUID, wslDistributionFlags)
// distributionName : LPCWSTR -> 'str16'
// defaultUID : DWORD -> 'uint32_t'
// wslDistributionFlags : WSL_DISTRIBUTION_FLAGS -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("Api-ms-win-wsl-api-l1-1-0.dll", {
  WslConfigureDistribution: { parameters: ["buffer", "u32", "i32"], result: "i32" },
});
// lib.symbols.WslConfigureDistribution(distributionName, defaultUID, wslDistributionFlags)
// distributionName : LPCWSTR -> "buffer"
// defaultUID : DWORD -> "u32"
// wslDistributionFlags : WSL_DISTRIBUTION_FLAGS -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WslConfigureDistribution(
    const uint16_t* distributionName,
    uint32_t defaultUID,
    int32_t wslDistributionFlags);
C, "Api-ms-win-wsl-api-l1-1-0.dll");
// $ffi->WslConfigureDistribution(distributionName, defaultUID, wslDistributionFlags);
// distributionName : LPCWSTR
// defaultUID : DWORD
// wslDistributionFlags : WSL_DISTRIBUTION_FLAGS
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Api-ms-win-wsl-api-l1-1-0 extends StdCallLibrary {
    Api-ms-win-wsl-api-l1-1-0 INSTANCE = Native.load("api-ms-win-wsl-api-l1-1-0", Api-ms-win-wsl-api-l1-1-0.class);
    int WslConfigureDistribution(
        WString distributionName,   // LPCWSTR
        int defaultUID,   // DWORD
        int wslDistributionFlags   // WSL_DISTRIBUTION_FLAGS
    );
}
@[Link("api-ms-win-wsl-api-l1-1-0")]
lib LibApi-ms-win-wsl-api-l1-1-0
  fun WslConfigureDistribution = WslConfigureDistribution(
    distributionName : UInt16*,   # LPCWSTR
    defaultUID : UInt32,   # DWORD
    wslDistributionFlags : Int32   # WSL_DISTRIBUTION_FLAGS
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WslConfigureDistributionNative = Int32 Function(Pointer<Utf16>, Uint32, Int32);
typedef WslConfigureDistributionDart = int Function(Pointer<Utf16>, int, int);
final WslConfigureDistribution = DynamicLibrary.open('Api-ms-win-wsl-api-l1-1-0.dll')
    .lookupFunction<WslConfigureDistributionNative, WslConfigureDistributionDart>('WslConfigureDistribution');
// distributionName : LPCWSTR -> Pointer<Utf16>
// defaultUID : DWORD -> Uint32
// wslDistributionFlags : WSL_DISTRIBUTION_FLAGS -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WslConfigureDistribution(
  distributionName: PWideChar;   // LPCWSTR
  defaultUID: DWORD;   // DWORD
  wslDistributionFlags: Integer   // WSL_DISTRIBUTION_FLAGS
): Integer; stdcall;
  external 'Api-ms-win-wsl-api-l1-1-0.dll' name 'WslConfigureDistribution';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WslConfigureDistribution"
  c_WslConfigureDistribution :: CWString -> Word32 -> Int32 -> IO Int32
-- distributionName : LPCWSTR -> CWString
-- defaultUID : DWORD -> Word32
-- wslDistributionFlags : WSL_DISTRIBUTION_FLAGS -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wslconfiguredistribution =
  foreign "WslConfigureDistribution"
    ((ptr uint16_t) @-> uint32_t @-> int32_t @-> returning int32_t)
(* distributionName : LPCWSTR -> (ptr uint16_t) *)
(* defaultUID : DWORD -> uint32_t *)
(* wslDistributionFlags : WSL_DISTRIBUTION_FLAGS -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library api-ms-win-wsl-api-l1-1-0 (t "Api-ms-win-wsl-api-l1-1-0.dll"))
(cffi:use-foreign-library api-ms-win-wsl-api-l1-1-0)

(cffi:defcfun ("WslConfigureDistribution" wsl-configure-distribution :convention :stdcall) :int32
  (distribution-name (:string :encoding :utf-16le))   ; LPCWSTR
  (default-uid :uint32)   ; DWORD
  (wsl-distribution-flags :int32))   ; WSL_DISTRIBUTION_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WslConfigureDistribution = Win32::API::More->new('Api-ms-win-wsl-api-l1-1-0',
    'int WslConfigureDistribution(LPCWSTR distributionName, DWORD defaultUID, int wslDistributionFlags)');
# my $ret = $WslConfigureDistribution->Call($distributionName, $defaultUID, $wslDistributionFlags);
# distributionName : LPCWSTR -> LPCWSTR
# defaultUID : DWORD -> DWORD
# wslDistributionFlags : WSL_DISTRIBUTION_FLAGS -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型