ホーム › System.SubsystemForLinux › WslGetDistributionConfiguration

WslGetDistributionConfiguration

関数

WSLディストリビューションの構成情報を取得する。

DLLApi-ms-win-wsl-api-l1-1-0.dll呼出規約winapi

シグネチャ

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

HRESULT WslGetDistributionConfiguration(
    LPCWSTR distributionName,
    DWORD* distributionVersion,
    DWORD* defaultUID,
    WSL_DISTRIBUTION_FLAGS* wslDistributionFlags,
    LPSTR** defaultEnvironmentVariables,
    DWORD* defaultEnvironmentVariableCount
);

パラメーター

名前	型	方向
distributionName	LPCWSTR	in
distributionVersion	DWORD*	out
defaultUID	DWORD*	out
wslDistributionFlags	WSL_DISTRIBUTION_FLAGS*	out
defaultEnvironmentVariables	LPSTR**	out
defaultEnvironmentVariableCount	DWORD*	out

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WslGetDistributionConfiguration(
    LPCWSTR distributionName,
    DWORD* distributionVersion,
    DWORD* defaultUID,
    WSL_DISTRIBUTION_FLAGS* wslDistributionFlags,
    LPSTR** defaultEnvironmentVariables,
    DWORD* defaultEnvironmentVariableCount
);

[DllImport("Api-ms-win-wsl-api-l1-1-0.dll", ExactSpelling = true)]
static extern int WslGetDistributionConfiguration(
    [MarshalAs(UnmanagedType.LPWStr)] string distributionName,   // LPCWSTR
    out uint distributionVersion,   // DWORD* out
    out uint defaultUID,   // DWORD* out
    out int wslDistributionFlags,   // WSL_DISTRIBUTION_FLAGS* out
    IntPtr defaultEnvironmentVariables,   // LPSTR** out
    out uint defaultEnvironmentVariableCount   // DWORD* out
);

<DllImport("Api-ms-win-wsl-api-l1-1-0.dll", ExactSpelling:=True)>
Public Shared Function WslGetDistributionConfiguration(
    <MarshalAs(UnmanagedType.LPWStr)> distributionName As String,   ' LPCWSTR
    <Out> ByRef distributionVersion As UInteger,   ' DWORD* out
    <Out> ByRef defaultUID As UInteger,   ' DWORD* out
    <Out> ByRef wslDistributionFlags As Integer,   ' WSL_DISTRIBUTION_FLAGS* out
    defaultEnvironmentVariables As IntPtr,   ' LPSTR** out
    <Out> ByRef defaultEnvironmentVariableCount As UInteger   ' DWORD* out
) As Integer
End Function

' distributionName : LPCWSTR
' distributionVersion : DWORD* out
' defaultUID : DWORD* out
' wslDistributionFlags : WSL_DISTRIBUTION_FLAGS* out
' defaultEnvironmentVariables : LPSTR** out
' defaultEnvironmentVariableCount : DWORD* out
Declare PtrSafe Function WslGetDistributionConfiguration Lib "api-ms-win-wsl-api-l1-1-0" ( _
    ByVal distributionName As LongPtr, _
    ByRef distributionVersion As Long, _
    ByRef defaultUID As Long, _
    ByRef wslDistributionFlags As Long, _
    ByVal defaultEnvironmentVariables As LongPtr, _
    ByRef defaultEnvironmentVariableCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WslGetDistributionConfiguration = ctypes.windll.LoadLibrary("Api-ms-win-wsl-api-l1-1-0.dll").WslGetDistributionConfiguration
WslGetDistributionConfiguration.restype = ctypes.c_int
WslGetDistributionConfiguration.argtypes = [
    wintypes.LPCWSTR,  # distributionName : LPCWSTR
    ctypes.POINTER(wintypes.DWORD),  # distributionVersion : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # defaultUID : DWORD* out
    ctypes.c_void_p,  # wslDistributionFlags : WSL_DISTRIBUTION_FLAGS* out
    ctypes.c_void_p,  # defaultEnvironmentVariables : LPSTR** out
    ctypes.POINTER(wintypes.DWORD),  # defaultEnvironmentVariableCount : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('Api-ms-win-wsl-api-l1-1-0.dll')
WslGetDistributionConfiguration = Fiddle::Function.new(
  lib['WslGetDistributionConfiguration'],
  [
    Fiddle::TYPE_VOIDP,  # distributionName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # distributionVersion : DWORD* out
    Fiddle::TYPE_VOIDP,  # defaultUID : DWORD* out
    Fiddle::TYPE_VOIDP,  # wslDistributionFlags : WSL_DISTRIBUTION_FLAGS* out
    Fiddle::TYPE_VOIDP,  # defaultEnvironmentVariables : LPSTR** out
    Fiddle::TYPE_VOIDP,  # defaultEnvironmentVariableCount : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "api-ms-win-wsl-api-l1-1-0")]
extern "system" {
    fn WslGetDistributionConfiguration(
        distributionName: *const u16,  // LPCWSTR
        distributionVersion: *mut u32,  // DWORD* out
        defaultUID: *mut u32,  // DWORD* out
        wslDistributionFlags: *mut i32,  // WSL_DISTRIBUTION_FLAGS* out
        defaultEnvironmentVariables: *mut *mut *mut u8,  // LPSTR** out
        defaultEnvironmentVariableCount: *mut u32  // DWORD* out
    ) -> 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 WslGetDistributionConfiguration([MarshalAs(UnmanagedType.LPWStr)] string distributionName, out uint distributionVersion, out uint defaultUID, out int wslDistributionFlags, IntPtr defaultEnvironmentVariables, out uint defaultEnvironmentVariableCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'Api-ms-win-wsl-api-l1-1-0_WslGetDistributionConfiguration' -Namespace Win32 -PassThru
# $api::WslGetDistributionConfiguration(distributionName, distributionVersion, defaultUID, wslDistributionFlags, defaultEnvironmentVariables, defaultEnvironmentVariableCount)

#uselib "Api-ms-win-wsl-api-l1-1-0.dll"
#func global WslGetDistributionConfiguration "WslGetDistributionConfiguration" sptr, sptr, sptr, sptr, sptr, sptr
; WslGetDistributionConfiguration distributionName, varptr(distributionVersion), varptr(defaultUID), wslDistributionFlags, varptr(defaultEnvironmentVariables), varptr(defaultEnvironmentVariableCount)   ; 戻り値は stat
; distributionName : LPCWSTR -> "sptr"
; distributionVersion : DWORD* out -> "sptr"
; defaultUID : DWORD* out -> "sptr"
; wslDistributionFlags : WSL_DISTRIBUTION_FLAGS* out -> "sptr"
; defaultEnvironmentVariables : LPSTR** out -> "sptr"
; defaultEnvironmentVariableCount : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "Api-ms-win-wsl-api-l1-1-0.dll"
#cfunc global WslGetDistributionConfiguration "WslGetDistributionConfiguration" wstr, var, var, int, var, var
; res = WslGetDistributionConfiguration(distributionName, distributionVersion, defaultUID, wslDistributionFlags, defaultEnvironmentVariables, defaultEnvironmentVariableCount)
; distributionName : LPCWSTR -> "wstr"
; distributionVersion : DWORD* out -> "var"
; defaultUID : DWORD* out -> "var"
; wslDistributionFlags : WSL_DISTRIBUTION_FLAGS* out -> "int"
; defaultEnvironmentVariables : LPSTR** out -> "var"
; defaultEnvironmentVariableCount : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "Api-ms-win-wsl-api-l1-1-0.dll"
#cfunc global WslGetDistributionConfiguration "WslGetDistributionConfiguration" wstr, sptr, sptr, int, sptr, sptr
; res = WslGetDistributionConfiguration(distributionName, varptr(distributionVersion), varptr(defaultUID), wslDistributionFlags, varptr(defaultEnvironmentVariables), varptr(defaultEnvironmentVariableCount))
; distributionName : LPCWSTR -> "wstr"
; distributionVersion : DWORD* out -> "sptr"
; defaultUID : DWORD* out -> "sptr"
; wslDistributionFlags : WSL_DISTRIBUTION_FLAGS* out -> "int"
; defaultEnvironmentVariables : LPSTR** out -> "sptr"
; defaultEnvironmentVariableCount : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; HRESULT WslGetDistributionConfiguration(LPCWSTR distributionName, DWORD* distributionVersion, DWORD* defaultUID, WSL_DISTRIBUTION_FLAGS* wslDistributionFlags, LPSTR** defaultEnvironmentVariables, DWORD* defaultEnvironmentVariableCount)
#uselib "Api-ms-win-wsl-api-l1-1-0.dll"
#cfunc global WslGetDistributionConfiguration "WslGetDistributionConfiguration" wstr, var, var, int, var, var
; res = WslGetDistributionConfiguration(distributionName, distributionVersion, defaultUID, wslDistributionFlags, defaultEnvironmentVariables, defaultEnvironmentVariableCount)
; distributionName : LPCWSTR -> "wstr"
; distributionVersion : DWORD* out -> "var"
; defaultUID : DWORD* out -> "var"
; wslDistributionFlags : WSL_DISTRIBUTION_FLAGS* out -> "int"
; defaultEnvironmentVariables : LPSTR** out -> "var"
; defaultEnvironmentVariableCount : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT WslGetDistributionConfiguration(LPCWSTR distributionName, DWORD* distributionVersion, DWORD* defaultUID, WSL_DISTRIBUTION_FLAGS* wslDistributionFlags, LPSTR** defaultEnvironmentVariables, DWORD* defaultEnvironmentVariableCount)
#uselib "Api-ms-win-wsl-api-l1-1-0.dll"
#cfunc global WslGetDistributionConfiguration "WslGetDistributionConfiguration" wstr, intptr, intptr, int, intptr, intptr
; res = WslGetDistributionConfiguration(distributionName, varptr(distributionVersion), varptr(defaultUID), wslDistributionFlags, varptr(defaultEnvironmentVariables), varptr(defaultEnvironmentVariableCount))
; distributionName : LPCWSTR -> "wstr"
; distributionVersion : DWORD* out -> "intptr"
; defaultUID : DWORD* out -> "intptr"
; wslDistributionFlags : WSL_DISTRIBUTION_FLAGS* out -> "int"
; defaultEnvironmentVariables : LPSTR** out -> "intptr"
; defaultEnvironmentVariableCount : DWORD* out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

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")
	procWslGetDistributionConfiguration = api_ms_win_wsl_api_l1_1_0.NewProc("WslGetDistributionConfiguration")
)

// distributionName (LPCWSTR), distributionVersion (DWORD* out), defaultUID (DWORD* out), wslDistributionFlags (WSL_DISTRIBUTION_FLAGS* out), defaultEnvironmentVariables (LPSTR** out), defaultEnvironmentVariableCount (DWORD* out)
r1, _, err := procWslGetDistributionConfiguration.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(distributionName))),
	uintptr(distributionVersion),
	uintptr(defaultUID),
	uintptr(wslDistributionFlags),
	uintptr(defaultEnvironmentVariables),
	uintptr(defaultEnvironmentVariableCount),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT

function WslGetDistributionConfiguration(
  distributionName: PWideChar;   // LPCWSTR
  distributionVersion: Pointer;   // DWORD* out
  defaultUID: Pointer;   // DWORD* out
  wslDistributionFlags: Pointer;   // WSL_DISTRIBUTION_FLAGS* out
  defaultEnvironmentVariables: PPAnsiChar;   // LPSTR** out
  defaultEnvironmentVariableCount: Pointer   // DWORD* out
): Integer; stdcall;
  external 'Api-ms-win-wsl-api-l1-1-0.dll' name 'WslGetDistributionConfiguration';

result := DllCall("Api-ms-win-wsl-api-l1-1-0\WslGetDistributionConfiguration"
    , "WStr", distributionName   ; LPCWSTR
    , "Ptr", distributionVersion   ; DWORD* out
    , "Ptr", defaultUID   ; DWORD* out
    , "Ptr", wslDistributionFlags   ; WSL_DISTRIBUTION_FLAGS* out
    , "Ptr", defaultEnvironmentVariables   ; LPSTR** out
    , "Ptr", defaultEnvironmentVariableCount   ; DWORD* out
    , "Int")   ; return: HRESULT

●WslGetDistributionConfiguration(distributionName, distributionVersion, defaultUID, wslDistributionFlags, defaultEnvironmentVariables, defaultEnvironmentVariableCount) = DLL("Api-ms-win-wsl-api-l1-1-0.dll", "int WslGetDistributionConfiguration(char*, void*, void*, void*, void*, void*)")
# 呼び出し: WslGetDistributionConfiguration(distributionName, distributionVersion, defaultUID, wslDistributionFlags, defaultEnvironmentVariables, defaultEnvironmentVariableCount)
# distributionName : LPCWSTR -> "char*"
# distributionVersion : DWORD* out -> "void*"
# defaultUID : DWORD* out -> "void*"
# wslDistributionFlags : WSL_DISTRIBUTION_FLAGS* out -> "void*"
# defaultEnvironmentVariables : LPSTR** out -> "void*"
# defaultEnvironmentVariableCount : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。