ホーム › System.SubsystemForLinux › WslLaunch

WslLaunch

関数

標準入出力を指定してWSL上でコマンドを起動する。

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

シグネチャ

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

HRESULT WslLaunch(
    LPCWSTR distributionName,
    LPCWSTR command,   // optional
    BOOL useCurrentWorkingDirectory,
    HANDLE stdIn,
    HANDLE stdOut,
    HANDLE stdErr,
    HANDLE* process
);

パラメーター

名前	型	方向	説明
distributionName	LPCWSTR	in	コマンドを実行する WSL ディストリビューション名(Unicode)。
command	LPCWSTR	inoptional	実行するコマンド文字列(Unicode)。NULL で既定シェルを起動。
useCurrentWorkingDirectory	BOOL	in	TRUE で現在の作業ディレクトリ、FALSE でホームから実行する。
stdIn	HANDLE	in	標準入力に割り当てるハンドル。
stdOut	HANDLE	in	標準出力に割り当てるハンドル。
stdErr	HANDLE	in	標準エラー出力に割り当てるハンドル。
process	HANDLE*	out	起動した Linux プロセスのハンドルを受け取るポインタ。要 CloseHandle。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WslLaunch(
    LPCWSTR distributionName,
    LPCWSTR command,   // optional
    BOOL useCurrentWorkingDirectory,
    HANDLE stdIn,
    HANDLE stdOut,
    HANDLE stdErr,
    HANDLE* process
);

[DllImport("Api-ms-win-wsl-api-l1-1-0.dll", ExactSpelling = true)]
static extern int WslLaunch(
    [MarshalAs(UnmanagedType.LPWStr)] string distributionName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string command,   // LPCWSTR optional
    bool useCurrentWorkingDirectory,   // BOOL
    IntPtr stdIn,   // HANDLE
    IntPtr stdOut,   // HANDLE
    IntPtr stdErr,   // HANDLE
    IntPtr process   // HANDLE* out
);

<DllImport("Api-ms-win-wsl-api-l1-1-0.dll", ExactSpelling:=True)>
Public Shared Function WslLaunch(
    <MarshalAs(UnmanagedType.LPWStr)> distributionName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> command As String,   ' LPCWSTR optional
    useCurrentWorkingDirectory As Boolean,   ' BOOL
    stdIn As IntPtr,   ' HANDLE
    stdOut As IntPtr,   ' HANDLE
    stdErr As IntPtr,   ' HANDLE
    process As IntPtr   ' HANDLE* out
) As Integer
End Function

' distributionName : LPCWSTR
' command : LPCWSTR optional
' useCurrentWorkingDirectory : BOOL
' stdIn : HANDLE
' stdOut : HANDLE
' stdErr : HANDLE
' process : HANDLE* out
Declare PtrSafe Function WslLaunch Lib "api-ms-win-wsl-api-l1-1-0" ( _
    ByVal distributionName As LongPtr, _
    ByVal command As LongPtr, _
    ByVal useCurrentWorkingDirectory As Long, _
    ByVal stdIn As LongPtr, _
    ByVal stdOut As LongPtr, _
    ByVal stdErr As LongPtr, _
    ByVal process As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WslLaunch = ctypes.windll.LoadLibrary("Api-ms-win-wsl-api-l1-1-0.dll").WslLaunch
WslLaunch.restype = ctypes.c_int
WslLaunch.argtypes = [
    wintypes.LPCWSTR,  # distributionName : LPCWSTR
    wintypes.LPCWSTR,  # command : LPCWSTR optional
    wintypes.BOOL,  # useCurrentWorkingDirectory : BOOL
    wintypes.HANDLE,  # stdIn : HANDLE
    wintypes.HANDLE,  # stdOut : HANDLE
    wintypes.HANDLE,  # stdErr : HANDLE
    ctypes.c_void_p,  # process : HANDLE* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('Api-ms-win-wsl-api-l1-1-0.dll')
WslLaunch = Fiddle::Function.new(
  lib['WslLaunch'],
  [
    Fiddle::TYPE_VOIDP,  # distributionName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # command : LPCWSTR optional
    Fiddle::TYPE_INT,  # useCurrentWorkingDirectory : BOOL
    Fiddle::TYPE_VOIDP,  # stdIn : HANDLE
    Fiddle::TYPE_VOIDP,  # stdOut : HANDLE
    Fiddle::TYPE_VOIDP,  # stdErr : HANDLE
    Fiddle::TYPE_VOIDP,  # process : HANDLE* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "api-ms-win-wsl-api-l1-1-0")]
extern "system" {
    fn WslLaunch(
        distributionName: *const u16,  // LPCWSTR
        command: *const u16,  // LPCWSTR optional
        useCurrentWorkingDirectory: i32,  // BOOL
        stdIn: *mut core::ffi::c_void,  // HANDLE
        stdOut: *mut core::ffi::c_void,  // HANDLE
        stdErr: *mut core::ffi::c_void,  // HANDLE
        process: *mut *mut core::ffi::c_void  // HANDLE* 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 WslLaunch([MarshalAs(UnmanagedType.LPWStr)] string distributionName, [MarshalAs(UnmanagedType.LPWStr)] string command, bool useCurrentWorkingDirectory, IntPtr stdIn, IntPtr stdOut, IntPtr stdErr, IntPtr process);
"@
$api = Add-Type -MemberDefinition $sig -Name 'Api-ms-win-wsl-api-l1-1-0_WslLaunch' -Namespace Win32 -PassThru
# $api::WslLaunch(distributionName, command, useCurrentWorkingDirectory, stdIn, stdOut, stdErr, process)

#uselib "Api-ms-win-wsl-api-l1-1-0.dll"
#func global WslLaunch "WslLaunch" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; WslLaunch distributionName, command, useCurrentWorkingDirectory, stdIn, stdOut, stdErr, process   ; 戻り値は stat
; distributionName : LPCWSTR -> "sptr"
; command : LPCWSTR optional -> "sptr"
; useCurrentWorkingDirectory : BOOL -> "sptr"
; stdIn : HANDLE -> "sptr"
; stdOut : HANDLE -> "sptr"
; stdErr : HANDLE -> "sptr"
; process : HANDLE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "Api-ms-win-wsl-api-l1-1-0.dll"
#cfunc global WslLaunch "WslLaunch" wstr, wstr, int, sptr, sptr, sptr, sptr
; res = WslLaunch(distributionName, command, useCurrentWorkingDirectory, stdIn, stdOut, stdErr, process)
; distributionName : LPCWSTR -> "wstr"
; command : LPCWSTR optional -> "wstr"
; useCurrentWorkingDirectory : BOOL -> "int"
; stdIn : HANDLE -> "sptr"
; stdOut : HANDLE -> "sptr"
; stdErr : HANDLE -> "sptr"
; process : HANDLE* out -> "sptr"

; HRESULT WslLaunch(LPCWSTR distributionName, LPCWSTR command, BOOL useCurrentWorkingDirectory, HANDLE stdIn, HANDLE stdOut, HANDLE stdErr, HANDLE* process)
#uselib "Api-ms-win-wsl-api-l1-1-0.dll"
#cfunc global WslLaunch "WslLaunch" wstr, wstr, int, intptr, intptr, intptr, intptr
; res = WslLaunch(distributionName, command, useCurrentWorkingDirectory, stdIn, stdOut, stdErr, process)
; distributionName : LPCWSTR -> "wstr"
; command : LPCWSTR optional -> "wstr"
; useCurrentWorkingDirectory : BOOL -> "int"
; stdIn : HANDLE -> "intptr"
; stdOut : HANDLE -> "intptr"
; stdErr : HANDLE -> "intptr"
; process : HANDLE* out -> "intptr"

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")
	procWslLaunch = api_ms_win_wsl_api_l1_1_0.NewProc("WslLaunch")
)

// distributionName (LPCWSTR), command (LPCWSTR optional), useCurrentWorkingDirectory (BOOL), stdIn (HANDLE), stdOut (HANDLE), stdErr (HANDLE), process (HANDLE* out)
r1, _, err := procWslLaunch.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(distributionName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(command))),
	uintptr(useCurrentWorkingDirectory),
	uintptr(stdIn),
	uintptr(stdOut),
	uintptr(stdErr),
	uintptr(process),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT

function WslLaunch(
  distributionName: PWideChar;   // LPCWSTR
  command: PWideChar;   // LPCWSTR optional
  useCurrentWorkingDirectory: BOOL;   // BOOL
  stdIn: THandle;   // HANDLE
  stdOut: THandle;   // HANDLE
  stdErr: THandle;   // HANDLE
  process: Pointer   // HANDLE* out
): Integer; stdcall;
  external 'Api-ms-win-wsl-api-l1-1-0.dll' name 'WslLaunch';

result := DllCall("Api-ms-win-wsl-api-l1-1-0\WslLaunch"
    , "WStr", distributionName   ; LPCWSTR
    , "WStr", command   ; LPCWSTR optional
    , "Int", useCurrentWorkingDirectory   ; BOOL
    , "Ptr", stdIn   ; HANDLE
    , "Ptr", stdOut   ; HANDLE
    , "Ptr", stdErr   ; HANDLE
    , "Ptr", process   ; HANDLE* out
    , "Int")   ; return: HRESULT

●WslLaunch(distributionName, command, useCurrentWorkingDirectory, stdIn, stdOut, stdErr, process) = DLL("Api-ms-win-wsl-api-l1-1-0.dll", "int WslLaunch(char*, char*, bool, void*, void*, void*, void*)")
# 呼び出し: WslLaunch(distributionName, command, useCurrentWorkingDirectory, stdIn, stdOut, stdErr, process)
# distributionName : LPCWSTR -> "char*"
# command : LPCWSTR optional -> "char*"
# useCurrentWorkingDirectory : BOOL -> "bool"
# stdIn : HANDLE -> "void*"
# stdOut : HANDLE -> "void*"
# stdErr : HANDLE -> "void*"
# process : HANDLE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "api-ms-win-wsl-api-l1-1-0" fn WslLaunch(
    distributionName: [*c]const u16, // LPCWSTR
    command: [*c]const u16, // LPCWSTR optional
    useCurrentWorkingDirectory: i32, // BOOL
    stdIn: ?*anyopaque, // HANDLE
    stdOut: ?*anyopaque, // HANDLE
    stdErr: ?*anyopaque, // HANDLE
    process: ?*anyopaque // HANDLE* out
) callconv(std.os.windows.WINAPI) i32;

proc WslLaunch(
    distributionName: WideCString,  # LPCWSTR
    command: WideCString,  # LPCWSTR optional
    useCurrentWorkingDirectory: int32,  # BOOL
    stdIn: pointer,  # HANDLE
    stdOut: pointer,  # HANDLE
    stdErr: pointer,  # HANDLE
    process: pointer  # HANDLE* out
): int32 {.importc: "WslLaunch", stdcall, dynlib: "Api-ms-win-wsl-api-l1-1-0.dll".}

pragma(lib, "api-ms-win-wsl-api-l1-1-0");
extern(Windows)
int WslLaunch(
    const(wchar)* distributionName,   // LPCWSTR
    const(wchar)* command,   // LPCWSTR optional
    int useCurrentWorkingDirectory,   // BOOL
    void* stdIn,   // HANDLE
    void* stdOut,   // HANDLE
    void* stdErr,   // HANDLE
    void* process   // HANDLE* out
);

ccall((:WslLaunch, "Api-ms-win-wsl-api-l1-1-0.dll"), stdcall, Int32,
      (Cwstring, Cwstring, Int32, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}),
      distributionName, command, useCurrentWorkingDirectory, stdIn, stdOut, stdErr, process)
# distributionName : LPCWSTR -> Cwstring
# command : LPCWSTR optional -> Cwstring
# useCurrentWorkingDirectory : BOOL -> Int32
# stdIn : HANDLE -> Ptr{Cvoid}
# stdOut : HANDLE -> Ptr{Cvoid}
# stdErr : HANDLE -> Ptr{Cvoid}
# process : HANDLE* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t WslLaunch(
    const uint16_t* distributionName,
    const uint16_t* command,
    int32_t useCurrentWorkingDirectory,
    void* stdIn,
    void* stdOut,
    void* stdErr,
    void* process);
]]
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.WslLaunch(distributionName, command, useCurrentWorkingDirectory, stdIn, stdOut, stdErr, process)
-- distributionName : LPCWSTR
-- command : LPCWSTR optional
-- useCurrentWorkingDirectory : BOOL
-- stdIn : HANDLE
-- stdOut : HANDLE
-- stdErr : HANDLE
-- process : HANDLE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('Api-ms-win-wsl-api-l1-1-0.dll');
const WslLaunch = lib.func('__stdcall', 'WslLaunch', 'int32_t', ['str16', 'str16', 'int32_t', 'void *', 'void *', 'void *', 'void *']);
// WslLaunch(distributionName, command, useCurrentWorkingDirectory, stdIn, stdOut, stdErr, process)
// distributionName : LPCWSTR -> 'str16'
// command : LPCWSTR optional -> 'str16'
// useCurrentWorkingDirectory : BOOL -> 'int32_t'
// stdIn : HANDLE -> 'void *'
// stdOut : HANDLE -> 'void *'
// stdErr : HANDLE -> 'void *'
// process : HANDLE* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("Api-ms-win-wsl-api-l1-1-0.dll", {
  WslLaunch: { parameters: ["buffer", "buffer", "i32", "pointer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.WslLaunch(distributionName, command, useCurrentWorkingDirectory, stdIn, stdOut, stdErr, process)
// distributionName : LPCWSTR -> "buffer"
// command : LPCWSTR optional -> "buffer"
// useCurrentWorkingDirectory : BOOL -> "i32"
// stdIn : HANDLE -> "pointer"
// stdOut : HANDLE -> "pointer"
// stdErr : HANDLE -> "pointer"
// process : HANDLE* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t WslLaunch(
    const uint16_t* distributionName,
    const uint16_t* command,
    int32_t useCurrentWorkingDirectory,
    void* stdIn,
    void* stdOut,
    void* stdErr,
    void* process);
C, "Api-ms-win-wsl-api-l1-1-0.dll");
// $ffi->WslLaunch(distributionName, command, useCurrentWorkingDirectory, stdIn, stdOut, stdErr, process);
// distributionName : LPCWSTR
// command : LPCWSTR optional
// useCurrentWorkingDirectory : BOOL
// stdIn : HANDLE
// stdOut : HANDLE
// stdErr : HANDLE
// process : HANDLE* out
// 構造体/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 WslLaunch(
        WString distributionName,   // LPCWSTR
        WString command,   // LPCWSTR optional
        boolean useCurrentWorkingDirectory,   // BOOL
        Pointer stdIn,   // HANDLE
        Pointer stdOut,   // HANDLE
        Pointer stdErr,   // HANDLE
        Pointer process   // HANDLE* out
    );
}

@[Link("api-ms-win-wsl-api-l1-1-0")]
lib LibApi-ms-win-wsl-api-l1-1-0
  fun WslLaunch = WslLaunch(
    distributionName : UInt16*,   # LPCWSTR
    command : UInt16*,   # LPCWSTR optional
    useCurrentWorkingDirectory : Int32,   # BOOL
    stdIn : Void*,   # HANDLE
    stdOut : Void*,   # HANDLE
    stdErr : Void*,   # HANDLE
    process : Void*   # HANDLE* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WslLaunchNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Int32, Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef WslLaunchDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int, Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
final WslLaunch = DynamicLibrary.open('Api-ms-win-wsl-api-l1-1-0.dll')
    .lookupFunction<WslLaunchNative, WslLaunchDart>('WslLaunch');
// distributionName : LPCWSTR -> Pointer<Utf16>
// command : LPCWSTR optional -> Pointer<Utf16>
// useCurrentWorkingDirectory : BOOL -> Int32
// stdIn : HANDLE -> Pointer<Void>
// stdOut : HANDLE -> Pointer<Void>
// stdErr : HANDLE -> Pointer<Void>
// process : HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function WslLaunch(
  distributionName: PWideChar;   // LPCWSTR
  command: PWideChar;   // LPCWSTR optional
  useCurrentWorkingDirectory: BOOL;   // BOOL
  stdIn: THandle;   // HANDLE
  stdOut: THandle;   // HANDLE
  stdErr: THandle;   // HANDLE
  process: Pointer   // HANDLE* out
): Integer; stdcall;
  external 'Api-ms-win-wsl-api-l1-1-0.dll' name 'WslLaunch';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WslLaunch"
  c_WslLaunch :: CWString -> CWString -> CInt -> Ptr () -> Ptr () -> Ptr () -> Ptr () -> IO Int32
-- distributionName : LPCWSTR -> CWString
-- command : LPCWSTR optional -> CWString
-- useCurrentWorkingDirectory : BOOL -> CInt
-- stdIn : HANDLE -> Ptr ()
-- stdOut : HANDLE -> Ptr ()
-- stdErr : HANDLE -> Ptr ()
-- process : HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let wsllaunch =
  foreign "WslLaunch"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> int32_t @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* distributionName : LPCWSTR -> (ptr uint16_t) *)
(* command : LPCWSTR optional -> (ptr uint16_t) *)
(* useCurrentWorkingDirectory : BOOL -> int32_t *)
(* stdIn : HANDLE -> (ptr void) *)
(* stdOut : HANDLE -> (ptr void) *)
(* stdErr : HANDLE -> (ptr void) *)
(* process : HANDLE* out -> (ptr void) *)
(* 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 ("WslLaunch" wsl-launch :convention :stdcall) :int32
  (distribution-name (:string :encoding :utf-16le))   ; LPCWSTR
  (command (:string :encoding :utf-16le))   ; LPCWSTR optional
  (use-current-working-directory :int32)   ; BOOL
  (std-in :pointer)   ; HANDLE
  (std-out :pointer)   ; HANDLE
  (std-err :pointer)   ; HANDLE
  (process :pointer))   ; HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $WslLaunch = Win32::API::More->new('Api-ms-win-wsl-api-l1-1-0',
    'int WslLaunch(LPCWSTR distributionName, LPCWSTR command, BOOL useCurrentWorkingDirectory, HANDLE stdIn, HANDLE stdOut, HANDLE stdErr, HANDLE process)');
# my $ret = $WslLaunch->Call($distributionName, $command, $useCurrentWorkingDirectory, $stdIn, $stdOut, $stdErr, $process);
# distributionName : LPCWSTR -> LPCWSTR
# command : LPCWSTR optional -> LPCWSTR
# useCurrentWorkingDirectory : BOOL -> BOOL
# stdIn : HANDLE -> HANDLE
# stdOut : HANDLE -> HANDLE
# stdErr : HANDLE -> HANDLE
# process : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。