Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向
distributionNameLPCWSTRin
commandLPCWSTRinoptional
useCurrentWorkingDirectoryBOOLin
stdInHANDLEin
stdOutHANDLEin
stdErrHANDLEin
processHANDLE*out

戻り値の型: 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)。