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

WofFileEnumFiles

関数
ファイル圧縮プロバイダーで圧縮済みファイルを列挙する。
DLLWOFUTIL.dll呼出規約winapi

シグネチャ

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

HRESULT WofFileEnumFiles(
    LPCWSTR VolumeName,
    DWORD Algorithm,
    WofEnumFilesProc EnumProc,
    void* UserData   // optional
);

パラメーター

名前方向説明
VolumeNameLPCWSTRin列挙対象のファイルが格納されているボリュームへのフルパスです。
AlgorithmDWORDin列挙する圧縮アルゴリズムです。有効な圧縮アルゴリズムの一覧については、WOF_FILE_COMPRESSION_INFO_V1 を参照してください。この値が MAX_ULONG の場合、サポートされている任意の圧縮アルゴリズムで圧縮されたファイルが返されます。
EnumProcWofEnumFilesProcin各データソースに対して呼び出されるコールバック関数です。EnumProc が FALSE を返すと、列挙は停止します。
UserDatavoid*inoptionalEnumProc に渡されるユーザー定義データです。

戻り値の型: HRESULT

公式ドキュメント

指定したボリューム上で、指定した圧縮アルゴリズムによって圧縮されているすべてのファイルを列挙します。

戻り値

この関数が成功した場合は 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 WofFileEnumFiles(
    LPCWSTR VolumeName,
    DWORD Algorithm,
    WofEnumFilesProc EnumProc,
    void* UserData   // optional
);
[DllImport("WOFUTIL.dll", ExactSpelling = true)]
static extern int WofFileEnumFiles(
    [MarshalAs(UnmanagedType.LPWStr)] string VolumeName,   // LPCWSTR
    uint Algorithm,   // DWORD
    IntPtr EnumProc,   // WofEnumFilesProc
    IntPtr UserData   // void* optional
);
<DllImport("WOFUTIL.dll", ExactSpelling:=True)>
Public Shared Function WofFileEnumFiles(
    <MarshalAs(UnmanagedType.LPWStr)> VolumeName As String,   ' LPCWSTR
    Algorithm As UInteger,   ' DWORD
    EnumProc As IntPtr,   ' WofEnumFilesProc
    UserData As IntPtr   ' void* optional
) As Integer
End Function
' VolumeName : LPCWSTR
' Algorithm : DWORD
' EnumProc : WofEnumFilesProc
' UserData : void* optional
Declare PtrSafe Function WofFileEnumFiles Lib "wofutil" ( _
    ByVal VolumeName As LongPtr, _
    ByVal Algorithm As Long, _
    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

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

lib = Fiddle.dlopen('WOFUTIL.dll')
WofFileEnumFiles = Fiddle::Function.new(
  lib['WofFileEnumFiles'],
  [
    Fiddle::TYPE_VOIDP,  # VolumeName : LPCWSTR
    -Fiddle::TYPE_INT,  # Algorithm : DWORD
    Fiddle::TYPE_VOIDP,  # EnumProc : WofEnumFilesProc
    Fiddle::TYPE_VOIDP,  # UserData : void* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "wofutil")]
extern "system" {
    fn WofFileEnumFiles(
        VolumeName: *const u16,  // LPCWSTR
        Algorithm: u32,  // DWORD
        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 WofFileEnumFiles([MarshalAs(UnmanagedType.LPWStr)] string VolumeName, uint Algorithm, IntPtr EnumProc, IntPtr UserData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WOFUTIL_WofFileEnumFiles' -Namespace Win32 -PassThru
# $api::WofFileEnumFiles(VolumeName, Algorithm, EnumProc, UserData)
#uselib "WOFUTIL.dll"
#func global WofFileEnumFiles "WofFileEnumFiles" sptr, sptr, sptr, sptr
; WofFileEnumFiles VolumeName, Algorithm, EnumProc, UserData   ; 戻り値は stat
; VolumeName : LPCWSTR -> "sptr"
; Algorithm : DWORD -> "sptr"
; EnumProc : WofEnumFilesProc -> "sptr"
; UserData : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WOFUTIL.dll"
#cfunc global WofFileEnumFiles "WofFileEnumFiles" wstr, int, sptr, sptr
; res = WofFileEnumFiles(VolumeName, Algorithm, EnumProc, UserData)
; VolumeName : LPCWSTR -> "wstr"
; Algorithm : DWORD -> "int"
; EnumProc : WofEnumFilesProc -> "sptr"
; UserData : void* optional -> "sptr"
; HRESULT WofFileEnumFiles(LPCWSTR VolumeName, DWORD Algorithm, WofEnumFilesProc EnumProc, void* UserData)
#uselib "WOFUTIL.dll"
#cfunc global WofFileEnumFiles "WofFileEnumFiles" wstr, int, intptr, intptr
; res = WofFileEnumFiles(VolumeName, Algorithm, EnumProc, UserData)
; VolumeName : LPCWSTR -> "wstr"
; Algorithm : DWORD -> "int"
; EnumProc : WofEnumFilesProc -> "intptr"
; UserData : void* optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wofutil = windows.NewLazySystemDLL("WOFUTIL.dll")
	procWofFileEnumFiles = wofutil.NewProc("WofFileEnumFiles")
)

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

extern "wofutil" fn WofFileEnumFiles(
    VolumeName: [*c]const u16, // LPCWSTR
    Algorithm: u32, // DWORD
    EnumProc: ?*anyopaque, // WofEnumFilesProc
    UserData: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;
proc WofFileEnumFiles(
    VolumeName: WideCString,  # LPCWSTR
    Algorithm: uint32,  # DWORD
    EnumProc: pointer,  # WofEnumFilesProc
    UserData: pointer  # void* optional
): int32 {.importc: "WofFileEnumFiles", stdcall, dynlib: "WOFUTIL.dll".}
pragma(lib, "wofutil");
extern(Windows)
int WofFileEnumFiles(
    const(wchar)* VolumeName,   // LPCWSTR
    uint Algorithm,   // DWORD
    void* EnumProc,   // WofEnumFilesProc
    void* UserData   // void* optional
);
ccall((:WofFileEnumFiles, "WOFUTIL.dll"), stdcall, Int32,
      (Cwstring, UInt32, Ptr{Cvoid}, Ptr{Cvoid}),
      VolumeName, Algorithm, EnumProc, UserData)
# VolumeName : LPCWSTR -> Cwstring
# Algorithm : DWORD -> UInt32
# EnumProc : WofEnumFilesProc -> Ptr{Cvoid}
# UserData : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WofFileEnumFiles(
    const uint16_t* VolumeName,
    uint32_t Algorithm,
    void* EnumProc,
    void* UserData);
]]
local wofutil = ffi.load("wofutil")
-- wofutil.WofFileEnumFiles(VolumeName, Algorithm, EnumProc, UserData)
-- VolumeName : LPCWSTR
-- Algorithm : DWORD
-- EnumProc : WofEnumFilesProc
-- UserData : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WOFUTIL.dll');
const WofFileEnumFiles = lib.func('__stdcall', 'WofFileEnumFiles', 'int32_t', ['str16', 'uint32_t', 'void *', 'void *']);
// WofFileEnumFiles(VolumeName, Algorithm, EnumProc, UserData)
// VolumeName : LPCWSTR -> 'str16'
// Algorithm : DWORD -> 'uint32_t'
// EnumProc : WofEnumFilesProc -> 'void *'
// UserData : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("WOFUTIL.dll", {
  WofFileEnumFiles: { parameters: ["buffer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.WofFileEnumFiles(VolumeName, Algorithm, EnumProc, UserData)
// VolumeName : LPCWSTR -> "buffer"
// Algorithm : DWORD -> "u32"
// EnumProc : WofEnumFilesProc -> "pointer"
// UserData : void* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WofFileEnumFiles(
    const uint16_t* VolumeName,
    uint32_t Algorithm,
    void* EnumProc,
    void* UserData);
C, "WOFUTIL.dll");
// $ffi->WofFileEnumFiles(VolumeName, Algorithm, EnumProc, UserData);
// VolumeName : LPCWSTR
// Algorithm : DWORD
// 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 WofFileEnumFiles(
        WString VolumeName,   // LPCWSTR
        int Algorithm,   // DWORD
        Callback EnumProc,   // WofEnumFilesProc
        Pointer UserData   // void* optional
    );
}
@[Link("wofutil")]
lib LibWOFUTIL
  fun WofFileEnumFiles = WofFileEnumFiles(
    VolumeName : UInt16*,   # LPCWSTR
    Algorithm : UInt32,   # DWORD
    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 WofFileEnumFilesNative = Int32 Function(Pointer<Utf16>, Uint32, Pointer<Void>, Pointer<Void>);
typedef WofFileEnumFilesDart = int Function(Pointer<Utf16>, int, Pointer<Void>, Pointer<Void>);
final WofFileEnumFiles = DynamicLibrary.open('WOFUTIL.dll')
    .lookupFunction<WofFileEnumFilesNative, WofFileEnumFilesDart>('WofFileEnumFiles');
// VolumeName : LPCWSTR -> Pointer<Utf16>
// Algorithm : DWORD -> Uint32
// EnumProc : WofEnumFilesProc -> Pointer<Void>
// UserData : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WofFileEnumFiles(
  VolumeName: PWideChar;   // LPCWSTR
  Algorithm: DWORD;   // DWORD
  EnumProc: Pointer;   // WofEnumFilesProc
  UserData: Pointer   // void* optional
): Integer; stdcall;
  external 'WOFUTIL.dll' name 'WofFileEnumFiles';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let woffileenumfiles =
  foreign "WofFileEnumFiles"
    ((ptr uint16_t) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* VolumeName : LPCWSTR -> (ptr uint16_t) *)
(* Algorithm : DWORD -> uint32_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 ("WofFileEnumFiles" wof-file-enum-files :convention :stdcall) :int32
  (volume-name (:string :encoding :utf-16le))   ; LPCWSTR
  (algorithm :uint32)   ; DWORD
  (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 $WofFileEnumFiles = Win32::API::More->new('WOFUTIL',
    'int WofFileEnumFiles(LPCWSTR VolumeName, DWORD Algorithm, LPVOID EnumProc, LPVOID UserData)');
# my $ret = $WofFileEnumFiles->Call($VolumeName, $Algorithm, $EnumProc, $UserData);
# VolumeName : LPCWSTR -> LPCWSTR
# Algorithm : DWORD -> DWORD
# EnumProc : WofEnumFilesProc -> LPVOID
# UserData : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

使用する型