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

HcsSetupBaseOSVolume

関数
指定ボリュームにベースOSレイヤーをセットアップする。
DLLcomputestorage.dll呼出規約winapi

シグネチャ

// computestorage.dll
#include <windows.h>

HRESULT HcsSetupBaseOSVolume(
    LPCWSTR layerPath,
    LPCWSTR volumePath,
    LPCWSTR options
);

パラメーター

名前方向説明
layerPathLPCWSTRinセットアップ対象のベースOSレイヤーフォルダのパス文字列。
volumePathLPCWSTRinベースOSをセットアップするボリュームのパス文字列。
optionsLPCWSTRinセットアップ動作の追加オプションを記述したJSON文字列。NULL可。

戻り値の型: HRESULT

各言語での呼び出し定義

// computestorage.dll
#include <windows.h>

HRESULT HcsSetupBaseOSVolume(
    LPCWSTR layerPath,
    LPCWSTR volumePath,
    LPCWSTR options
);
[DllImport("computestorage.dll", ExactSpelling = true)]
static extern int HcsSetupBaseOSVolume(
    [MarshalAs(UnmanagedType.LPWStr)] string layerPath,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string volumePath,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string options   // LPCWSTR
);
<DllImport("computestorage.dll", ExactSpelling:=True)>
Public Shared Function HcsSetupBaseOSVolume(
    <MarshalAs(UnmanagedType.LPWStr)> layerPath As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> volumePath As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> options As String   ' LPCWSTR
) As Integer
End Function
' layerPath : LPCWSTR
' volumePath : LPCWSTR
' options : LPCWSTR
Declare PtrSafe Function HcsSetupBaseOSVolume Lib "computestorage" ( _
    ByVal layerPath As LongPtr, _
    ByVal volumePath As LongPtr, _
    ByVal options As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

HcsSetupBaseOSVolume = ctypes.windll.computestorage.HcsSetupBaseOSVolume
HcsSetupBaseOSVolume.restype = ctypes.c_int
HcsSetupBaseOSVolume.argtypes = [
    wintypes.LPCWSTR,  # layerPath : LPCWSTR
    wintypes.LPCWSTR,  # volumePath : LPCWSTR
    wintypes.LPCWSTR,  # options : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	computestorage = windows.NewLazySystemDLL("computestorage.dll")
	procHcsSetupBaseOSVolume = computestorage.NewProc("HcsSetupBaseOSVolume")
)

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

extern "computestorage" fn HcsSetupBaseOSVolume(
    layerPath: [*c]const u16, // LPCWSTR
    volumePath: [*c]const u16, // LPCWSTR
    options: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
proc HcsSetupBaseOSVolume(
    layerPath: WideCString,  # LPCWSTR
    volumePath: WideCString,  # LPCWSTR
    options: WideCString  # LPCWSTR
): int32 {.importc: "HcsSetupBaseOSVolume", stdcall, dynlib: "computestorage.dll".}
pragma(lib, "computestorage");
extern(Windows)
int HcsSetupBaseOSVolume(
    const(wchar)* layerPath,   // LPCWSTR
    const(wchar)* volumePath,   // LPCWSTR
    const(wchar)* options   // LPCWSTR
);
ccall((:HcsSetupBaseOSVolume, "computestorage.dll"), stdcall, Int32,
      (Cwstring, Cwstring, Cwstring),
      layerPath, volumePath, options)
# layerPath : LPCWSTR -> Cwstring
# volumePath : LPCWSTR -> Cwstring
# options : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t HcsSetupBaseOSVolume(
    const uint16_t* layerPath,
    const uint16_t* volumePath,
    const uint16_t* options);
]]
local computestorage = ffi.load("computestorage")
-- computestorage.HcsSetupBaseOSVolume(layerPath, volumePath, options)
-- layerPath : LPCWSTR
-- volumePath : LPCWSTR
-- options : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('computestorage.dll');
const HcsSetupBaseOSVolume = lib.func('__stdcall', 'HcsSetupBaseOSVolume', 'int32_t', ['str16', 'str16', 'str16']);
// HcsSetupBaseOSVolume(layerPath, volumePath, options)
// layerPath : LPCWSTR -> 'str16'
// volumePath : LPCWSTR -> 'str16'
// options : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("computestorage.dll", {
  HcsSetupBaseOSVolume: { parameters: ["buffer", "buffer", "buffer"], result: "i32" },
});
// lib.symbols.HcsSetupBaseOSVolume(layerPath, volumePath, options)
// layerPath : LPCWSTR -> "buffer"
// volumePath : LPCWSTR -> "buffer"
// options : LPCWSTR -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t HcsSetupBaseOSVolume(
    const uint16_t* layerPath,
    const uint16_t* volumePath,
    const uint16_t* options);
C, "computestorage.dll");
// $ffi->HcsSetupBaseOSVolume(layerPath, volumePath, options);
// layerPath : LPCWSTR
// volumePath : LPCWSTR
// options : 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 Computestorage extends StdCallLibrary {
    Computestorage INSTANCE = Native.load("computestorage", Computestorage.class);
    int HcsSetupBaseOSVolume(
        WString layerPath,   // LPCWSTR
        WString volumePath,   // LPCWSTR
        WString options   // LPCWSTR
    );
}
@[Link("computestorage")]
lib Libcomputestorage
  fun HcsSetupBaseOSVolume = HcsSetupBaseOSVolume(
    layerPath : UInt16*,   # LPCWSTR
    volumePath : UInt16*,   # LPCWSTR
    options : 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 HcsSetupBaseOSVolumeNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>);
typedef HcsSetupBaseOSVolumeDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>);
final HcsSetupBaseOSVolume = DynamicLibrary.open('computestorage.dll')
    .lookupFunction<HcsSetupBaseOSVolumeNative, HcsSetupBaseOSVolumeDart>('HcsSetupBaseOSVolume');
// layerPath : LPCWSTR -> Pointer<Utf16>
// volumePath : LPCWSTR -> Pointer<Utf16>
// options : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HcsSetupBaseOSVolume(
  layerPath: PWideChar;   // LPCWSTR
  volumePath: PWideChar;   // LPCWSTR
  options: PWideChar   // LPCWSTR
): Integer; stdcall;
  external 'computestorage.dll' name 'HcsSetupBaseOSVolume';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let hcssetupbaseosvolume =
  foreign "HcsSetupBaseOSVolume"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> returning int32_t)
(* layerPath : LPCWSTR -> (ptr uint16_t) *)
(* volumePath : LPCWSTR -> (ptr uint16_t) *)
(* options : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library computestorage (t "computestorage.dll"))
(cffi:use-foreign-library computestorage)

(cffi:defcfun ("HcsSetupBaseOSVolume" hcs-setup-base-osvolume :convention :stdcall) :int32
  (layer-path (:string :encoding :utf-16le))   ; LPCWSTR
  (volume-path (:string :encoding :utf-16le))   ; LPCWSTR
  (options (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HcsSetupBaseOSVolume = Win32::API::More->new('computestorage',
    'int HcsSetupBaseOSVolume(LPCWSTR layerPath, LPCWSTR volumePath, LPCWSTR options)');
# my $ret = $HcsSetupBaseOSVolume->Call($layerPath, $volumePath, $options);
# layerPath : LPCWSTR -> LPCWSTR
# volumePath : LPCWSTR -> LPCWSTR
# options : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。