ホーム › Storage.FileSystem › WofEnumEntries
WofEnumEntries
関数ボリューム上のWOFプロバイダーのエントリを列挙する。
シグネチャ
// WOFUTIL.dll
#include <windows.h>
HRESULT WofEnumEntries(
LPCWSTR VolumeName,
DWORD Provider,
WofEnumEntryProc EnumProc,
void* UserData // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||
|---|---|---|---|---|---|
| VolumeName | LPCWSTR | in | バッキングデータソースを要求するファイルをホストしているボリューム名。 | ||
| Provider | DWORD | in | どのプロバイダーのデータソースを要求するかを示します。この操作でサポートされるプロバイダーは次のとおりです。
| ||
| EnumProc | WofEnumEntryProc | in | 各データソースに対するコールバック関数。EnumProc が FALSE を返すと列挙は停止します。 | ||
| UserData | void* | inoptional | EnumProc に渡されるユーザー定義データ。 |
戻り値の型: HRESULT
公式ドキュメント
指定したボリュームについて、指定したプロバイダーのすべてのデータソースを列挙します。
戻り値
この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// WOFUTIL.dll
#include <windows.h>
HRESULT WofEnumEntries(
LPCWSTR VolumeName,
DWORD Provider,
WofEnumEntryProc EnumProc,
void* UserData // optional
);[DllImport("WOFUTIL.dll", ExactSpelling = true)]
static extern int WofEnumEntries(
[MarshalAs(UnmanagedType.LPWStr)] string VolumeName, // LPCWSTR
uint Provider, // DWORD
IntPtr EnumProc, // WofEnumEntryProc
IntPtr UserData // void* optional
);<DllImport("WOFUTIL.dll", ExactSpelling:=True)>
Public Shared Function WofEnumEntries(
<MarshalAs(UnmanagedType.LPWStr)> VolumeName As String, ' LPCWSTR
Provider As UInteger, ' DWORD
EnumProc As IntPtr, ' WofEnumEntryProc
UserData As IntPtr ' void* optional
) As Integer
End Function' VolumeName : LPCWSTR
' Provider : DWORD
' EnumProc : WofEnumEntryProc
' UserData : void* optional
Declare PtrSafe Function WofEnumEntries Lib "wofutil" ( _
ByVal VolumeName As LongPtr, _
ByVal Provider 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
WofEnumEntries = ctypes.windll.wofutil.WofEnumEntries
WofEnumEntries.restype = ctypes.c_int
WofEnumEntries.argtypes = [
wintypes.LPCWSTR, # VolumeName : LPCWSTR
wintypes.DWORD, # Provider : DWORD
ctypes.c_void_p, # EnumProc : WofEnumEntryProc
ctypes.POINTER(None), # UserData : void* optional
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('WOFUTIL.dll')
WofEnumEntries = Fiddle::Function.new(
lib['WofEnumEntries'],
[
Fiddle::TYPE_VOIDP, # VolumeName : LPCWSTR
-Fiddle::TYPE_INT, # Provider : DWORD
Fiddle::TYPE_VOIDP, # EnumProc : WofEnumEntryProc
Fiddle::TYPE_VOIDP, # UserData : void* optional
],
Fiddle::TYPE_INT)#[link(name = "wofutil")]
extern "system" {
fn WofEnumEntries(
VolumeName: *const u16, // LPCWSTR
Provider: u32, // DWORD
EnumProc: *const core::ffi::c_void, // WofEnumEntryProc
UserData: *mut () // void* optional
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("WOFUTIL.dll")]
public static extern int WofEnumEntries([MarshalAs(UnmanagedType.LPWStr)] string VolumeName, uint Provider, IntPtr EnumProc, IntPtr UserData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WOFUTIL_WofEnumEntries' -Namespace Win32 -PassThru
# $api::WofEnumEntries(VolumeName, Provider, EnumProc, UserData)#uselib "WOFUTIL.dll"
#func global WofEnumEntries "WofEnumEntries" sptr, sptr, sptr, sptr
; WofEnumEntries VolumeName, Provider, EnumProc, UserData ; 戻り値は stat
; VolumeName : LPCWSTR -> "sptr"
; Provider : DWORD -> "sptr"
; EnumProc : WofEnumEntryProc -> "sptr"
; UserData : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "WOFUTIL.dll"
#cfunc global WofEnumEntries "WofEnumEntries" wstr, int, sptr, sptr
; res = WofEnumEntries(VolumeName, Provider, EnumProc, UserData)
; VolumeName : LPCWSTR -> "wstr"
; Provider : DWORD -> "int"
; EnumProc : WofEnumEntryProc -> "sptr"
; UserData : void* optional -> "sptr"; HRESULT WofEnumEntries(LPCWSTR VolumeName, DWORD Provider, WofEnumEntryProc EnumProc, void* UserData)
#uselib "WOFUTIL.dll"
#cfunc global WofEnumEntries "WofEnumEntries" wstr, int, intptr, intptr
; res = WofEnumEntries(VolumeName, Provider, EnumProc, UserData)
; VolumeName : LPCWSTR -> "wstr"
; Provider : DWORD -> "int"
; EnumProc : WofEnumEntryProc -> "intptr"
; UserData : void* optional -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
wofutil = windows.NewLazySystemDLL("WOFUTIL.dll")
procWofEnumEntries = wofutil.NewProc("WofEnumEntries")
)
// VolumeName (LPCWSTR), Provider (DWORD), EnumProc (WofEnumEntryProc), UserData (void* optional)
r1, _, err := procWofEnumEntries.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(VolumeName))),
uintptr(Provider),
uintptr(EnumProc),
uintptr(UserData),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction WofEnumEntries(
VolumeName: PWideChar; // LPCWSTR
Provider: DWORD; // DWORD
EnumProc: Pointer; // WofEnumEntryProc
UserData: Pointer // void* optional
): Integer; stdcall;
external 'WOFUTIL.dll' name 'WofEnumEntries';result := DllCall("WOFUTIL\WofEnumEntries"
, "WStr", VolumeName ; LPCWSTR
, "UInt", Provider ; DWORD
, "Ptr", EnumProc ; WofEnumEntryProc
, "Ptr", UserData ; void* optional
, "Int") ; return: HRESULT●WofEnumEntries(VolumeName, Provider, EnumProc, UserData) = DLL("WOFUTIL.dll", "int WofEnumEntries(char*, dword, void*, void*)")
# 呼び出し: WofEnumEntries(VolumeName, Provider, EnumProc, UserData)
# VolumeName : LPCWSTR -> "char*"
# Provider : DWORD -> "dword"
# EnumProc : WofEnumEntryProc -> "void*"
# UserData : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "wofutil" fn WofEnumEntries(
VolumeName: [*c]const u16, // LPCWSTR
Provider: u32, // DWORD
EnumProc: ?*anyopaque, // WofEnumEntryProc
UserData: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;proc WofEnumEntries(
VolumeName: WideCString, # LPCWSTR
Provider: uint32, # DWORD
EnumProc: pointer, # WofEnumEntryProc
UserData: pointer # void* optional
): int32 {.importc: "WofEnumEntries", stdcall, dynlib: "WOFUTIL.dll".}pragma(lib, "wofutil");
extern(Windows)
int WofEnumEntries(
const(wchar)* VolumeName, // LPCWSTR
uint Provider, // DWORD
void* EnumProc, // WofEnumEntryProc
void* UserData // void* optional
);ccall((:WofEnumEntries, "WOFUTIL.dll"), stdcall, Int32,
(Cwstring, UInt32, Ptr{Cvoid}, Ptr{Cvoid}),
VolumeName, Provider, EnumProc, UserData)
# VolumeName : LPCWSTR -> Cwstring
# Provider : DWORD -> UInt32
# EnumProc : WofEnumEntryProc -> Ptr{Cvoid}
# UserData : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t WofEnumEntries(
const uint16_t* VolumeName,
uint32_t Provider,
void* EnumProc,
void* UserData);
]]
local wofutil = ffi.load("wofutil")
-- wofutil.WofEnumEntries(VolumeName, Provider, EnumProc, UserData)
-- VolumeName : LPCWSTR
-- Provider : DWORD
-- EnumProc : WofEnumEntryProc
-- UserData : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('WOFUTIL.dll');
const WofEnumEntries = lib.func('__stdcall', 'WofEnumEntries', 'int32_t', ['str16', 'uint32_t', 'void *', 'void *']);
// WofEnumEntries(VolumeName, Provider, EnumProc, UserData)
// VolumeName : LPCWSTR -> 'str16'
// Provider : DWORD -> 'uint32_t'
// EnumProc : WofEnumEntryProc -> 'void *'
// UserData : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。const lib = Deno.dlopen("WOFUTIL.dll", {
WofEnumEntries: { parameters: ["buffer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.WofEnumEntries(VolumeName, Provider, EnumProc, UserData)
// VolumeName : LPCWSTR -> "buffer"
// Provider : DWORD -> "u32"
// EnumProc : WofEnumEntryProc -> "pointer"
// UserData : void* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t WofEnumEntries(
const uint16_t* VolumeName,
uint32_t Provider,
void* EnumProc,
void* UserData);
C, "WOFUTIL.dll");
// $ffi->WofEnumEntries(VolumeName, Provider, EnumProc, UserData);
// VolumeName : LPCWSTR
// Provider : DWORD
// EnumProc : WofEnumEntryProc
// 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 WofEnumEntries(
WString VolumeName, // LPCWSTR
int Provider, // DWORD
Callback EnumProc, // WofEnumEntryProc
Pointer UserData // void* optional
);
}@[Link("wofutil")]
lib LibWOFUTIL
fun WofEnumEntries = WofEnumEntries(
VolumeName : UInt16*, # LPCWSTR
Provider : UInt32, # DWORD
EnumProc : Void*, # WofEnumEntryProc
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 WofEnumEntriesNative = Int32 Function(Pointer<Utf16>, Uint32, Pointer<Void>, Pointer<Void>);
typedef WofEnumEntriesDart = int Function(Pointer<Utf16>, int, Pointer<Void>, Pointer<Void>);
final WofEnumEntries = DynamicLibrary.open('WOFUTIL.dll')
.lookupFunction<WofEnumEntriesNative, WofEnumEntriesDart>('WofEnumEntries');
// VolumeName : LPCWSTR -> Pointer<Utf16>
// Provider : DWORD -> Uint32
// EnumProc : WofEnumEntryProc -> Pointer<Void>
// UserData : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function WofEnumEntries(
VolumeName: PWideChar; // LPCWSTR
Provider: DWORD; // DWORD
EnumProc: Pointer; // WofEnumEntryProc
UserData: Pointer // void* optional
): Integer; stdcall;
external 'WOFUTIL.dll' name 'WofEnumEntries';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "WofEnumEntries"
c_WofEnumEntries :: CWString -> Word32 -> Ptr () -> Ptr () -> IO Int32
-- VolumeName : LPCWSTR -> CWString
-- Provider : DWORD -> Word32
-- EnumProc : WofEnumEntryProc -> Ptr ()
-- UserData : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let wofenumentries =
foreign "WofEnumEntries"
((ptr uint16_t) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* VolumeName : LPCWSTR -> (ptr uint16_t) *)
(* Provider : DWORD -> uint32_t *)
(* EnumProc : WofEnumEntryProc -> (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 ("WofEnumEntries" wof-enum-entries :convention :stdcall) :int32
(volume-name (:string :encoding :utf-16le)) ; LPCWSTR
(provider :uint32) ; DWORD
(enum-proc :pointer) ; WofEnumEntryProc
(user-data :pointer)) ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $WofEnumEntries = Win32::API::More->new('WOFUTIL',
'int WofEnumEntries(LPCWSTR VolumeName, DWORD Provider, LPVOID EnumProc, LPVOID UserData)');
# my $ret = $WofEnumEntries->Call($VolumeName, $Provider, $EnumProc, $UserData);
# VolumeName : LPCWSTR -> LPCWSTR
# Provider : DWORD -> DWORD
# EnumProc : WofEnumEntryProc -> LPVOID
# UserData : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。関連項目
使用する型