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

WofWimEnumFiles

関数
WIMデータソース内のファイルを列挙する。
DLLWOFUTIL.dll呼出規約winapi

シグネチャ

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

HRESULT WofWimEnumFiles(
    LPCWSTR VolumeName,
    LONGLONG DataSourceId,
    WofEnumFilesProc EnumProc,
    void* UserData   // optional
);

パラメーター

名前方向説明
VolumeNameLPCWSTRinWIM によってバックアップされるファイルをホストするボリュームへのパス。
DataSourceIdLONGLONGinWIM エントリを識別するために使用される識別子。
EnumProcWofEnumFilesProcinWIM エントリによって提供されるファイルに対するコールバック関数。
UserDatavoid*inoptionalEnumProc に渡される、省略可能なユーザー定義データ。

戻り値の型: HRESULT

公式ドキュメント

指定したボリューム上で、指定した 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 WofWimEnumFiles(
    LPCWSTR VolumeName,
    LONGLONG DataSourceId,
    WofEnumFilesProc EnumProc,
    void* UserData   // optional
);
[DllImport("WOFUTIL.dll", ExactSpelling = true)]
static extern int WofWimEnumFiles(
    [MarshalAs(UnmanagedType.LPWStr)] string VolumeName,   // LPCWSTR
    long DataSourceId,   // LONGLONG
    IntPtr EnumProc,   // WofEnumFilesProc
    IntPtr UserData   // void* optional
);
<DllImport("WOFUTIL.dll", ExactSpelling:=True)>
Public Shared Function WofWimEnumFiles(
    <MarshalAs(UnmanagedType.LPWStr)> VolumeName As String,   ' LPCWSTR
    DataSourceId As Long,   ' LONGLONG
    EnumProc As IntPtr,   ' WofEnumFilesProc
    UserData As IntPtr   ' void* optional
) As Integer
End Function
' VolumeName : LPCWSTR
' DataSourceId : LONGLONG
' EnumProc : WofEnumFilesProc
' UserData : void* optional
Declare PtrSafe Function WofWimEnumFiles Lib "wofutil" ( _
    ByVal VolumeName As LongPtr, _
    ByVal DataSourceId As LongLong, _
    ByVal EnumProc As LongPtr, _
    ByVal UserData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WofWimEnumFiles = ctypes.windll.wofutil.WofWimEnumFiles
WofWimEnumFiles.restype = ctypes.c_int
WofWimEnumFiles.argtypes = [
    wintypes.LPCWSTR,  # VolumeName : LPCWSTR
    ctypes.c_longlong,  # DataSourceId : LONGLONG
    ctypes.c_void_p,  # EnumProc : WofEnumFilesProc
    ctypes.POINTER(None),  # UserData : void* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WOFUTIL.dll')
WofWimEnumFiles = Fiddle::Function.new(
  lib['WofWimEnumFiles'],
  [
    Fiddle::TYPE_VOIDP,  # VolumeName : LPCWSTR
    Fiddle::TYPE_LONG_LONG,  # DataSourceId : LONGLONG
    Fiddle::TYPE_VOIDP,  # EnumProc : WofEnumFilesProc
    Fiddle::TYPE_VOIDP,  # UserData : void* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "wofutil")]
extern "system" {
    fn WofWimEnumFiles(
        VolumeName: *const u16,  // LPCWSTR
        DataSourceId: i64,  // LONGLONG
        EnumProc: *const core::ffi::c_void,  // WofEnumFilesProc
        UserData: *mut ()  // void* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WOFUTIL.dll")]
public static extern int WofWimEnumFiles([MarshalAs(UnmanagedType.LPWStr)] string VolumeName, long DataSourceId, IntPtr EnumProc, IntPtr UserData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WOFUTIL_WofWimEnumFiles' -Namespace Win32 -PassThru
# $api::WofWimEnumFiles(VolumeName, DataSourceId, EnumProc, UserData)
#uselib "WOFUTIL.dll"
#func global WofWimEnumFiles "WofWimEnumFiles" sptr, sptr, sptr, sptr
; WofWimEnumFiles VolumeName, DataSourceId, EnumProc, UserData   ; 戻り値は stat
; VolumeName : LPCWSTR -> "sptr"
; DataSourceId : LONGLONG -> "sptr"
; EnumProc : WofEnumFilesProc -> "sptr"
; UserData : void* optional -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WOFUTIL.dll"
#cfunc global WofWimEnumFiles "WofWimEnumFiles" wstr, int64, sptr, sptr
; res = WofWimEnumFiles(VolumeName, DataSourceId, EnumProc, UserData)
; VolumeName : LPCWSTR -> "wstr"
; DataSourceId : LONGLONG -> "int64"
; EnumProc : WofEnumFilesProc -> "sptr"
; UserData : void* optional -> "sptr"
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
; HRESULT WofWimEnumFiles(LPCWSTR VolumeName, LONGLONG DataSourceId, WofEnumFilesProc EnumProc, void* UserData)
#uselib "WOFUTIL.dll"
#cfunc global WofWimEnumFiles "WofWimEnumFiles" wstr, int64, intptr, intptr
; res = WofWimEnumFiles(VolumeName, DataSourceId, EnumProc, UserData)
; VolumeName : LPCWSTR -> "wstr"
; DataSourceId : LONGLONG -> "int64"
; EnumProc : WofEnumFilesProc -> "intptr"
; UserData : void* optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wofutil = windows.NewLazySystemDLL("WOFUTIL.dll")
	procWofWimEnumFiles = wofutil.NewProc("WofWimEnumFiles")
)

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

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

typedef WofWimEnumFilesNative = Int32 Function(Pointer<Utf16>, Int64, Pointer<Void>, Pointer<Void>);
typedef WofWimEnumFilesDart = int Function(Pointer<Utf16>, int, Pointer<Void>, Pointer<Void>);
final WofWimEnumFiles = DynamicLibrary.open('WOFUTIL.dll')
    .lookupFunction<WofWimEnumFilesNative, WofWimEnumFilesDart>('WofWimEnumFiles');
// VolumeName : LPCWSTR -> Pointer<Utf16>
// DataSourceId : LONGLONG -> Int64
// EnumProc : WofEnumFilesProc -> Pointer<Void>
// UserData : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WofWimEnumFiles(
  VolumeName: PWideChar;   // LPCWSTR
  DataSourceId: Int64;   // LONGLONG
  EnumProc: Pointer;   // WofEnumFilesProc
  UserData: Pointer   // void* optional
): Integer; stdcall;
  external 'WOFUTIL.dll' name 'WofWimEnumFiles';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WofWimEnumFiles"
  c_WofWimEnumFiles :: CWString -> Int64 -> Ptr () -> Ptr () -> IO Int32
-- VolumeName : LPCWSTR -> CWString
-- DataSourceId : LONGLONG -> Int64
-- EnumProc : WofEnumFilesProc -> Ptr ()
-- UserData : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wofwimenumfiles =
  foreign "WofWimEnumFiles"
    ((ptr uint16_t) @-> int64_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* VolumeName : LPCWSTR -> (ptr uint16_t) *)
(* DataSourceId : LONGLONG -> int64_t *)
(* EnumProc : WofEnumFilesProc -> (ptr void) *)
(* UserData : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wofutil (t "WOFUTIL.dll"))
(cffi:use-foreign-library wofutil)

(cffi:defcfun ("WofWimEnumFiles" wof-wim-enum-files :convention :stdcall) :int32
  (volume-name (:string :encoding :utf-16le))   ; LPCWSTR
  (data-source-id :int64)   ; LONGLONG
  (enum-proc :pointer)   ; WofEnumFilesProc
  (user-data :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WofWimEnumFiles = Win32::API::More->new('WOFUTIL',
    'int WofWimEnumFiles(LPCWSTR VolumeName, INT64 DataSourceId, LPVOID EnumProc, LPVOID UserData)');
# my $ret = $WofWimEnumFiles->Call($VolumeName, $DataSourceId, $EnumProc, $UserData);
# VolumeName : LPCWSTR -> LPCWSTR
# DataSourceId : LONGLONG -> INT64
# EnumProc : WofEnumFilesProc -> LPVOID
# UserData : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

使用する型