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

WslRegisterDistribution

関数
tar.gzイメージからWSLディストリビューションを登録する。
DLLApi-ms-win-wsl-api-l1-1-0.dll呼出規約winapi

シグネチャ

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

HRESULT WslRegisterDistribution(
    LPCWSTR distributionName,
    LPCWSTR tarGzFilename
);

パラメーター

名前方向説明
distributionNameLPCWSTRin登録する WSL ディストリビューションの一意名(Unicode)。
tarGzFilenameLPCWSTRinルートファイルシステムを含む .tar.gz ファイルのパス(Unicode)。

戻り値の型: HRESULT

各言語での呼び出し定義

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

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

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

lib = Fiddle.dlopen('Api-ms-win-wsl-api-l1-1-0.dll')
WslRegisterDistribution = Fiddle::Function.new(
  lib['WslRegisterDistribution'],
  [
    Fiddle::TYPE_VOIDP,  # distributionName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # tarGzFilename : LPCWSTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "api-ms-win-wsl-api-l1-1-0")]
extern "system" {
    fn WslRegisterDistribution(
        distributionName: *const u16,  // LPCWSTR
        tarGzFilename: *const u16  // LPCWSTR
    ) -> 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 WslRegisterDistribution([MarshalAs(UnmanagedType.LPWStr)] string distributionName, [MarshalAs(UnmanagedType.LPWStr)] string tarGzFilename);
"@
$api = Add-Type -MemberDefinition $sig -Name 'Api-ms-win-wsl-api-l1-1-0_WslRegisterDistribution' -Namespace Win32 -PassThru
# $api::WslRegisterDistribution(distributionName, tarGzFilename)
#uselib "Api-ms-win-wsl-api-l1-1-0.dll"
#func global WslRegisterDistribution "WslRegisterDistribution" sptr, sptr
; WslRegisterDistribution distributionName, tarGzFilename   ; 戻り値は stat
; distributionName : LPCWSTR -> "sptr"
; tarGzFilename : LPCWSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "Api-ms-win-wsl-api-l1-1-0.dll"
#cfunc global WslRegisterDistribution "WslRegisterDistribution" wstr, wstr
; res = WslRegisterDistribution(distributionName, tarGzFilename)
; distributionName : LPCWSTR -> "wstr"
; tarGzFilename : LPCWSTR -> "wstr"
; HRESULT WslRegisterDistribution(LPCWSTR distributionName, LPCWSTR tarGzFilename)
#uselib "Api-ms-win-wsl-api-l1-1-0.dll"
#cfunc global WslRegisterDistribution "WslRegisterDistribution" wstr, wstr
; res = WslRegisterDistribution(distributionName, tarGzFilename)
; distributionName : LPCWSTR -> "wstr"
; tarGzFilename : LPCWSTR -> "wstr"
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")
	procWslRegisterDistribution = api_ms_win_wsl_api_l1_1_0.NewProc("WslRegisterDistribution")
)

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

extern "api-ms-win-wsl-api-l1-1-0" fn WslRegisterDistribution(
    distributionName: [*c]const u16, // LPCWSTR
    tarGzFilename: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
proc WslRegisterDistribution(
    distributionName: WideCString,  # LPCWSTR
    tarGzFilename: WideCString  # LPCWSTR
): int32 {.importc: "WslRegisterDistribution", stdcall, dynlib: "Api-ms-win-wsl-api-l1-1-0.dll".}
pragma(lib, "api-ms-win-wsl-api-l1-1-0");
extern(Windows)
int WslRegisterDistribution(
    const(wchar)* distributionName,   // LPCWSTR
    const(wchar)* tarGzFilename   // LPCWSTR
);
ccall((:WslRegisterDistribution, "Api-ms-win-wsl-api-l1-1-0.dll"), stdcall, Int32,
      (Cwstring, Cwstring),
      distributionName, tarGzFilename)
# distributionName : LPCWSTR -> Cwstring
# tarGzFilename : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WslRegisterDistribution(
    const uint16_t* distributionName,
    const uint16_t* tarGzFilename);
]]
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.WslRegisterDistribution(distributionName, tarGzFilename)
-- distributionName : LPCWSTR
-- tarGzFilename : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('Api-ms-win-wsl-api-l1-1-0.dll');
const WslRegisterDistribution = lib.func('__stdcall', 'WslRegisterDistribution', 'int32_t', ['str16', 'str16']);
// WslRegisterDistribution(distributionName, tarGzFilename)
// distributionName : LPCWSTR -> 'str16'
// tarGzFilename : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("Api-ms-win-wsl-api-l1-1-0.dll", {
  WslRegisterDistribution: { parameters: ["buffer", "buffer"], result: "i32" },
});
// lib.symbols.WslRegisterDistribution(distributionName, tarGzFilename)
// distributionName : LPCWSTR -> "buffer"
// tarGzFilename : LPCWSTR -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WslRegisterDistribution(
    const uint16_t* distributionName,
    const uint16_t* tarGzFilename);
C, "Api-ms-win-wsl-api-l1-1-0.dll");
// $ffi->WslRegisterDistribution(distributionName, tarGzFilename);
// distributionName : LPCWSTR
// tarGzFilename : LPCWSTR
// 構造体/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 WslRegisterDistribution(
        WString distributionName,   // LPCWSTR
        WString tarGzFilename   // LPCWSTR
    );
}
@[Link("api-ms-win-wsl-api-l1-1-0")]
lib LibApi-ms-win-wsl-api-l1-1-0
  fun WslRegisterDistribution = WslRegisterDistribution(
    distributionName : UInt16*,   # LPCWSTR
    tarGzFilename : UInt16*   # LPCWSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

let wslregisterdistribution =
  foreign "WslRegisterDistribution"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> returning int32_t)
(* distributionName : LPCWSTR -> (ptr uint16_t) *)
(* tarGzFilename : LPCWSTR -> (ptr uint16_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 ("WslRegisterDistribution" wsl-register-distribution :convention :stdcall) :int32
  (distribution-name (:string :encoding :utf-16le))   ; LPCWSTR
  (tar-gz-filename (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WslRegisterDistribution = Win32::API::More->new('Api-ms-win-wsl-api-l1-1-0',
    'int WslRegisterDistribution(LPCWSTR distributionName, LPCWSTR tarGzFilename)');
# my $ret = $WslRegisterDistribution->Call($distributionName, $tarGzFilename);
# distributionName : LPCWSTR -> LPCWSTR
# tarGzFilename : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。