Win32 API 日本語リファレンス
ホームStorage.FileSystem › WofWimAddEntry

WofWimAddEntry

関数
WIM圧縮プロバイダーにWIMファイルのエントリを追加する。
DLLWOFUTIL.dll呼出規約winapi

シグネチャ

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

HRESULT WofWimAddEntry(
    LPCWSTR VolumeName,
    LPCWSTR WimPath,
    DWORD WimType,
    DWORD WimIndex,
    LONGLONG* DataSourceId
);

パラメーター

名前方向説明
VolumeNameLPCWSTRinWIM 内に存在するファイルを作成する対象ボリュームへのパス。
WimPathLPCWSTRinファイルにデータを提供するために使用する WIM ファイルへのパス。
WimTypeDWORDinWIM の種類。WIM_BOOT_OS_WIM または WIM_BOOT_NOT_OS_WIM を指定できます。
WimIndexDWORDin適用する WIM 内のイメージのインデックス。
DataSourceIdLONGLONG*out正常に終了した場合、エントリを識別するために使用されるデータソースが格納されます。このデータソースは、WofSetFileDataLocation で新しいファイルを作成する際に使用できます。

戻り値の型: HRESULT

公式ドキュメント

ボリュームに単一の WIM データソースを追加し、WIM 内に格納されたファイルをそのボリューム上に作成できるようにします。

戻り値

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT WofWimAddEntry(
    LPCWSTR VolumeName,
    LPCWSTR WimPath,
    DWORD WimType,
    DWORD WimIndex,
    LONGLONG* DataSourceId
);
[DllImport("WOFUTIL.dll", ExactSpelling = true)]
static extern int WofWimAddEntry(
    [MarshalAs(UnmanagedType.LPWStr)] string VolumeName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string WimPath,   // LPCWSTR
    uint WimType,   // DWORD
    uint WimIndex,   // DWORD
    out long DataSourceId   // LONGLONG* out
);
<DllImport("WOFUTIL.dll", ExactSpelling:=True)>
Public Shared Function WofWimAddEntry(
    <MarshalAs(UnmanagedType.LPWStr)> VolumeName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> WimPath As String,   ' LPCWSTR
    WimType As UInteger,   ' DWORD
    WimIndex As UInteger,   ' DWORD
    <Out> ByRef DataSourceId As Long   ' LONGLONG* out
) As Integer
End Function
' VolumeName : LPCWSTR
' WimPath : LPCWSTR
' WimType : DWORD
' WimIndex : DWORD
' DataSourceId : LONGLONG* out
Declare PtrSafe Function WofWimAddEntry Lib "wofutil" ( _
    ByVal VolumeName As LongPtr, _
    ByVal WimPath As LongPtr, _
    ByVal WimType As Long, _
    ByVal WimIndex As Long, _
    ByRef DataSourceId As LongLong) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WofWimAddEntry = ctypes.windll.wofutil.WofWimAddEntry
WofWimAddEntry.restype = ctypes.c_int
WofWimAddEntry.argtypes = [
    wintypes.LPCWSTR,  # VolumeName : LPCWSTR
    wintypes.LPCWSTR,  # WimPath : LPCWSTR
    wintypes.DWORD,  # WimType : DWORD
    wintypes.DWORD,  # WimIndex : DWORD
    ctypes.POINTER(ctypes.c_longlong),  # DataSourceId : LONGLONG* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WOFUTIL.dll')
WofWimAddEntry = Fiddle::Function.new(
  lib['WofWimAddEntry'],
  [
    Fiddle::TYPE_VOIDP,  # VolumeName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # WimPath : LPCWSTR
    -Fiddle::TYPE_INT,  # WimType : DWORD
    -Fiddle::TYPE_INT,  # WimIndex : DWORD
    Fiddle::TYPE_VOIDP,  # DataSourceId : LONGLONG* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "wofutil")]
extern "system" {
    fn WofWimAddEntry(
        VolumeName: *const u16,  // LPCWSTR
        WimPath: *const u16,  // LPCWSTR
        WimType: u32,  // DWORD
        WimIndex: u32,  // DWORD
        DataSourceId: *mut i64  // LONGLONG* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WOFUTIL.dll")]
public static extern int WofWimAddEntry([MarshalAs(UnmanagedType.LPWStr)] string VolumeName, [MarshalAs(UnmanagedType.LPWStr)] string WimPath, uint WimType, uint WimIndex, out long DataSourceId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WOFUTIL_WofWimAddEntry' -Namespace Win32 -PassThru
# $api::WofWimAddEntry(VolumeName, WimPath, WimType, WimIndex, DataSourceId)
#uselib "WOFUTIL.dll"
#func global WofWimAddEntry "WofWimAddEntry" sptr, sptr, sptr, sptr, sptr
; WofWimAddEntry VolumeName, WimPath, WimType, WimIndex, varptr(DataSourceId)   ; 戻り値は stat
; VolumeName : LPCWSTR -> "sptr"
; WimPath : LPCWSTR -> "sptr"
; WimType : DWORD -> "sptr"
; WimIndex : DWORD -> "sptr"
; DataSourceId : LONGLONG* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WOFUTIL.dll"
#cfunc global WofWimAddEntry "WofWimAddEntry" wstr, wstr, int, int, var
; res = WofWimAddEntry(VolumeName, WimPath, WimType, WimIndex, DataSourceId)
; VolumeName : LPCWSTR -> "wstr"
; WimPath : LPCWSTR -> "wstr"
; WimType : DWORD -> "int"
; WimIndex : DWORD -> "int"
; DataSourceId : LONGLONG* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT WofWimAddEntry(LPCWSTR VolumeName, LPCWSTR WimPath, DWORD WimType, DWORD WimIndex, LONGLONG* DataSourceId)
#uselib "WOFUTIL.dll"
#cfunc global WofWimAddEntry "WofWimAddEntry" wstr, wstr, int, int, var
; res = WofWimAddEntry(VolumeName, WimPath, WimType, WimIndex, DataSourceId)
; VolumeName : LPCWSTR -> "wstr"
; WimPath : LPCWSTR -> "wstr"
; WimType : DWORD -> "int"
; WimIndex : DWORD -> "int"
; DataSourceId : LONGLONG* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wofutil = windows.NewLazySystemDLL("WOFUTIL.dll")
	procWofWimAddEntry = wofutil.NewProc("WofWimAddEntry")
)

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

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

typedef WofWimAddEntryNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Uint32, Uint32, Pointer<Int64>);
typedef WofWimAddEntryDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int, int, Pointer<Int64>);
final WofWimAddEntry = DynamicLibrary.open('WOFUTIL.dll')
    .lookupFunction<WofWimAddEntryNative, WofWimAddEntryDart>('WofWimAddEntry');
// VolumeName : LPCWSTR -> Pointer<Utf16>
// WimPath : LPCWSTR -> Pointer<Utf16>
// WimType : DWORD -> Uint32
// WimIndex : DWORD -> Uint32
// DataSourceId : LONGLONG* out -> Pointer<Int64>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WofWimAddEntry(
  VolumeName: PWideChar;   // LPCWSTR
  WimPath: PWideChar;   // LPCWSTR
  WimType: DWORD;   // DWORD
  WimIndex: DWORD;   // DWORD
  DataSourceId: Pointer   // LONGLONG* out
): Integer; stdcall;
  external 'WOFUTIL.dll' name 'WofWimAddEntry';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WofWimAddEntry"
  c_WofWimAddEntry :: CWString -> CWString -> Word32 -> Word32 -> Ptr Int64 -> IO Int32
-- VolumeName : LPCWSTR -> CWString
-- WimPath : LPCWSTR -> CWString
-- WimType : DWORD -> Word32
-- WimIndex : DWORD -> Word32
-- DataSourceId : LONGLONG* out -> Ptr Int64
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wofwimaddentry =
  foreign "WofWimAddEntry"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> uint32_t @-> (ptr int64_t) @-> returning int32_t)
(* VolumeName : LPCWSTR -> (ptr uint16_t) *)
(* WimPath : LPCWSTR -> (ptr uint16_t) *)
(* WimType : DWORD -> uint32_t *)
(* WimIndex : DWORD -> uint32_t *)
(* DataSourceId : LONGLONG* out -> (ptr int64_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wofutil (t "WOFUTIL.dll"))
(cffi:use-foreign-library wofutil)

(cffi:defcfun ("WofWimAddEntry" wof-wim-add-entry :convention :stdcall) :int32
  (volume-name (:string :encoding :utf-16le))   ; LPCWSTR
  (wim-path (:string :encoding :utf-16le))   ; LPCWSTR
  (wim-type :uint32)   ; DWORD
  (wim-index :uint32)   ; DWORD
  (data-source-id :pointer))   ; LONGLONG* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WofWimAddEntry = Win32::API::More->new('WOFUTIL',
    'int WofWimAddEntry(LPCWSTR VolumeName, LPCWSTR WimPath, DWORD WimType, DWORD WimIndex, LPVOID DataSourceId)');
# my $ret = $WofWimAddEntry->Call($VolumeName, $WimPath, $WimType, $WimIndex, $DataSourceId);
# VolumeName : LPCWSTR -> LPCWSTR
# WimPath : LPCWSTR -> LPCWSTR
# WimType : DWORD -> DWORD
# WimIndex : DWORD -> DWORD
# DataSourceId : LONGLONG* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。