FindFirstFileTransactedW
関数シグネチャ
// KERNEL32.dll (Unicode / -W)
#include <windows.h>
HANDLE FindFirstFileTransactedW(
LPCWSTR lpFileName,
FINDEX_INFO_LEVELS fInfoLevelId,
void* lpFindFileData,
FINDEX_SEARCH_OPS fSearchOp,
void* lpSearchFilter, // optional
DWORD dwAdditionalFlags,
HANDLE hTransaction
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||
|---|---|---|---|---|---|---|---|
| lpFileName | LPCWSTR | in | ディレクトリまたはパス、およびファイル名。ファイル名にはワイルドカード文字(例: アスタリスク (*) や疑問符 (?))を含めることができます。 このパラメーターには、NULL、無効な文字列(例: 空文字列や終端の null 文字が欠落した文字列)、または末尾のバックスラッシュ (\) で終わる文字列を指定しないでください。 文字列がワイルドカード、ピリオド (.)、またはディレクトリ名で終わる場合、ユーザーはルートおよびパス上の すべてのサブディレクトリへのアクセス権を持っている必要があります。 ファイルはローカルコンピューター上に存在する必要があります。そうでない場合、関数は失敗し、最後のエラーコードは ERROR_TRANSACTIONS_UNSUPPORTED_REMOTE に設定されます。 既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字に拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、および名前空間の名前付けを参照してください。 ヒント
Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH の制限を解除するオプトインが可能です。詳細については、ファイル、パス、および名前空間の名前付けの「Maximum Path Length Limitation」セクションを参照してください。 | ||||
| fInfoLevelId | FINDEX_INFO_LEVELS | in | 返されるデータの情報レベル。 このパラメーターは、 FINDEX_INFO_LEVELS 列挙値のいずれかです。 | ||||
| lpFindFileData | void* | out | 見つかったファイルまたはサブディレクトリに関する情報を受け取る WIN32_FIND_DATA 構造体へのポインター。 | ||||
| fSearchOp | FINDEX_SEARCH_OPS | in | ワイルドカード照合とは異なる、実行するフィルター処理の種類。 このパラメーターは、FINDEX_SEARCH_OPS 列挙値のいずれかです。 | ||||
| lpSearchFilter | void* | optional | 指定した fSearchOp が構造化された検索情報を必要とする場合の、検索条件へのポインター。 現時点では、サポートされている fSearchOp の値のいずれも拡張検索情報を必要としません。したがって、このポインターは NULL である必要があります。 | ||||
| dwAdditionalFlags | DWORD | in | 検索を制御する追加のフラグを指定します。
| ||||
| hTransaction | HANDLE | in | トランザクションへのハンドル。このハンドルは CreateTransaction 関数によって返されます。 |
戻り値の型: HANDLE
公式ドキュメント
指定した名前に一致する名前を持つファイルまたはサブディレクトリを、トランザクション操作としてディレクトリ内で検索します。(Unicode)
戻り値
関数が成功した場合、戻り値は FindNextFile または FindClose への後続の呼び出しで使用される検索ハンドルであり、lpFindFileData パラメーターには最初に見つかったファイルまたはディレクトリに関する情報が格納されます。
関数が失敗した場合、または lpFileName パラメーターの検索文字列からファイルを見つけられなかった場合、戻り値は INVALID_HANDLE_VALUE となり、lpFindFileData の内容は不定です。拡張エラー情報を取得するには、 GetLastError 関数を呼び出します。
解説(Remarks)
FindFirstFileTransacted 関数は検索ハンドルを開き、指定したパターンに一致する名前を持つ、ファイルシステムが最初に見つけたファイルに関する情報を返します。これは、同じファイル名文字列パターンを指定したときに、ディレクトリ一覧表示アプリケーション(dir コマンドなど)で最初に表示されるファイルまたはディレクトリと一致する場合も、しない場合もあります。これは、FindFirstFileTransacted が検索結果のソートを行わないためです。詳細については、FindNextFile を参照してください。
以下のリストは、その他のいくつかの検索特性を示しています。
- 検索は厳密にファイルの名前に対して実行され、日付やファイルの種類などの属性に対しては実行されません。
- 検索には長いファイル名と短いファイル名の両方が含まれます。
- 末尾にバックスラッシュを付けて検索を開こうとすると、常に失敗します。
- lpFileName パラメーターに無効な文字列、NULL、または空文字列を渡すことは、この関数の有効な使用方法ではありません。その場合の結果は未定義です。
検索ハンドルを確立した後は、それを FindNextFile 関数で使用し、実行中のフィルター処理と同じ条件で同じパターンに一致する他のファイルを検索します。検索ハンドルが不要になったら、 FindClose 関数を使用して閉じる必要があります。
前述のとおり、FindFirstFileTransacted の lpFileName 入力文字列では末尾のバックスラッシュ (\) を使用できないため、ルートディレクトリを検索する方法が明確でない場合があります。ルートディレクトリのファイルを表示したり属性を取得したりするには、次のオプションが適用されます。
- ルートディレクトリ内のファイルを調べるには、"C:\*" を使用し、FindNextFile を使用してディレクトリを順に処理します。
- ルートディレクトリの属性を取得するには、GetFileAttributes 関数を使用します。
ネットワーク共有では、次の形式の lpFileName を使用できます。 "\\server\service*"。ただし、共有自体を指す lpFileName は使用できません。たとえば、"\\server\service" は無効です。
ルートディレクトリ以外のディレクトリを調べるには、末尾のバックスラッシュを付けずにそのディレクトリへのパスを使用します。たとえば、引数 "C:\Windows" は、"C:\Windows" 内のディレクトリやファイルではなく、ディレクトリ "C:\Windows" に関する情報を返します。"C:\Windows" 内のファイルとディレクトリを調べるには、"C:\Windows\*" という lpFileName を使用します。
結果を照会した時点と、その情報に基づいて処理を行う時点との間に、他のスレッドやプロセスがこの名前のファイルを作成または削除する可能性があることに注意してください。これがアプリケーションにとって懸念事項となる場合、考えられる解決策の 1 つは、 CreateFile 関数を CREATE_NEW(ファイルが存在する場合は失敗する)または OPEN_EXISTING(ファイルが存在しない場合は失敗する)とともに使用することです。
ディレクトリ内のすべてのファイルを一覧表示する 32 ビットアプリケーションを記述しており、そのアプリケーションが 64 ビットコンピューター上で実行される可能性がある場合は、 FindFirstFileTransacted を呼び出す前に Wow64DisableWow64FsRedirection を呼び出し、 FindNextFile への最後の呼び出しの後に Wow64RevertWow64FsRedirection を呼び出す必要があります。詳細については、File System Redirector を参照してください。
パスがシンボリックリンクを指している場合、 WIN32_FIND_DATA バッファーには、ターゲットではなくシンボリックリンクに関する情報が格納されます。
Windows 8 および Windows Server 2012 では、この関数は次のテクノロジによってサポートされています。
| テクノロジ | サポート |
|---|---|
| Server Message Block (SMB) 3.0 プロトコル | いいえ |
| SMB 3.0 Transparent Failover (TFO) | いいえ |
| SMB 3.0 with Scale-out File Shares (SO) | いいえ |
| Cluster Shared Volume File System (CsvFS) | いいえ |
| Resilient File System (ReFS) | いいえ |
SMB 3.0 は TxF をサポートしていません。
winbase.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして FindFirstFileTransacted を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、関数プロトタイプの規則を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll (Unicode / -W)
#include <windows.h>
HANDLE FindFirstFileTransactedW(
LPCWSTR lpFileName,
FINDEX_INFO_LEVELS fInfoLevelId,
void* lpFindFileData,
FINDEX_SEARCH_OPS fSearchOp,
void* lpSearchFilter, // optional
DWORD dwAdditionalFlags,
HANDLE hTransaction
);[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr FindFirstFileTransactedW(
[MarshalAs(UnmanagedType.LPWStr)] string lpFileName, // LPCWSTR
int fInfoLevelId, // FINDEX_INFO_LEVELS
IntPtr lpFindFileData, // void* out
int fSearchOp, // FINDEX_SEARCH_OPS
IntPtr lpSearchFilter, // void* optional
uint dwAdditionalFlags, // DWORD
IntPtr hTransaction // HANDLE
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FindFirstFileTransactedW(
<MarshalAs(UnmanagedType.LPWStr)> lpFileName As String, ' LPCWSTR
fInfoLevelId As Integer, ' FINDEX_INFO_LEVELS
lpFindFileData As IntPtr, ' void* out
fSearchOp As Integer, ' FINDEX_SEARCH_OPS
lpSearchFilter As IntPtr, ' void* optional
dwAdditionalFlags As UInteger, ' DWORD
hTransaction As IntPtr ' HANDLE
) As IntPtr
End Function' lpFileName : LPCWSTR
' fInfoLevelId : FINDEX_INFO_LEVELS
' lpFindFileData : void* out
' fSearchOp : FINDEX_SEARCH_OPS
' lpSearchFilter : void* optional
' dwAdditionalFlags : DWORD
' hTransaction : HANDLE
Declare PtrSafe Function FindFirstFileTransactedW Lib "kernel32" ( _
ByVal lpFileName As LongPtr, _
ByVal fInfoLevelId As Long, _
ByVal lpFindFileData As LongPtr, _
ByVal fSearchOp As Long, _
ByVal lpSearchFilter As LongPtr, _
ByVal dwAdditionalFlags As Long, _
ByVal hTransaction As LongPtr) As LongPtr
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
FindFirstFileTransactedW = ctypes.windll.kernel32.FindFirstFileTransactedW
FindFirstFileTransactedW.restype = ctypes.c_void_p
FindFirstFileTransactedW.argtypes = [
wintypes.LPCWSTR, # lpFileName : LPCWSTR
ctypes.c_int, # fInfoLevelId : FINDEX_INFO_LEVELS
ctypes.POINTER(None), # lpFindFileData : void* out
ctypes.c_int, # fSearchOp : FINDEX_SEARCH_OPS
ctypes.POINTER(None), # lpSearchFilter : void* optional
wintypes.DWORD, # dwAdditionalFlags : DWORD
wintypes.HANDLE, # hTransaction : HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
FindFirstFileTransactedW = Fiddle::Function.new(
lib['FindFirstFileTransactedW'],
[
Fiddle::TYPE_VOIDP, # lpFileName : LPCWSTR
Fiddle::TYPE_INT, # fInfoLevelId : FINDEX_INFO_LEVELS
Fiddle::TYPE_VOIDP, # lpFindFileData : void* out
Fiddle::TYPE_INT, # fSearchOp : FINDEX_SEARCH_OPS
Fiddle::TYPE_VOIDP, # lpSearchFilter : void* optional
-Fiddle::TYPE_INT, # dwAdditionalFlags : DWORD
Fiddle::TYPE_VOIDP, # hTransaction : HANDLE
],
Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "kernel32")]
extern "system" {
fn FindFirstFileTransactedW(
lpFileName: *const u16, // LPCWSTR
fInfoLevelId: i32, // FINDEX_INFO_LEVELS
lpFindFileData: *mut (), // void* out
fSearchOp: i32, // FINDEX_SEARCH_OPS
lpSearchFilter: *mut (), // void* optional
dwAdditionalFlags: u32, // DWORD
hTransaction: *mut core::ffi::c_void // HANDLE
) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern IntPtr FindFirstFileTransactedW([MarshalAs(UnmanagedType.LPWStr)] string lpFileName, int fInfoLevelId, IntPtr lpFindFileData, int fSearchOp, IntPtr lpSearchFilter, uint dwAdditionalFlags, IntPtr hTransaction);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_FindFirstFileTransactedW' -Namespace Win32 -PassThru
# $api::FindFirstFileTransactedW(lpFileName, fInfoLevelId, lpFindFileData, fSearchOp, lpSearchFilter, dwAdditionalFlags, hTransaction)#uselib "KERNEL32.dll"
#func global FindFirstFileTransactedW "FindFirstFileTransactedW" wptr, wptr, wptr, wptr, wptr, wptr, wptr
; FindFirstFileTransactedW lpFileName, fInfoLevelId, lpFindFileData, fSearchOp, lpSearchFilter, dwAdditionalFlags, hTransaction ; 戻り値は stat
; lpFileName : LPCWSTR -> "wptr"
; fInfoLevelId : FINDEX_INFO_LEVELS -> "wptr"
; lpFindFileData : void* out -> "wptr"
; fSearchOp : FINDEX_SEARCH_OPS -> "wptr"
; lpSearchFilter : void* optional -> "wptr"
; dwAdditionalFlags : DWORD -> "wptr"
; hTransaction : HANDLE -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global FindFirstFileTransactedW "FindFirstFileTransactedW" wstr, int, sptr, int, sptr, int, sptr
; res = FindFirstFileTransactedW(lpFileName, fInfoLevelId, lpFindFileData, fSearchOp, lpSearchFilter, dwAdditionalFlags, hTransaction)
; lpFileName : LPCWSTR -> "wstr"
; fInfoLevelId : FINDEX_INFO_LEVELS -> "int"
; lpFindFileData : void* out -> "sptr"
; fSearchOp : FINDEX_SEARCH_OPS -> "int"
; lpSearchFilter : void* optional -> "sptr"
; dwAdditionalFlags : DWORD -> "int"
; hTransaction : HANDLE -> "sptr"; HANDLE FindFirstFileTransactedW(LPCWSTR lpFileName, FINDEX_INFO_LEVELS fInfoLevelId, void* lpFindFileData, FINDEX_SEARCH_OPS fSearchOp, void* lpSearchFilter, DWORD dwAdditionalFlags, HANDLE hTransaction)
#uselib "KERNEL32.dll"
#cfunc global FindFirstFileTransactedW "FindFirstFileTransactedW" wstr, int, intptr, int, intptr, int, intptr
; res = FindFirstFileTransactedW(lpFileName, fInfoLevelId, lpFindFileData, fSearchOp, lpSearchFilter, dwAdditionalFlags, hTransaction)
; lpFileName : LPCWSTR -> "wstr"
; fInfoLevelId : FINDEX_INFO_LEVELS -> "int"
; lpFindFileData : void* out -> "intptr"
; fSearchOp : FINDEX_SEARCH_OPS -> "int"
; lpSearchFilter : void* optional -> "intptr"
; dwAdditionalFlags : DWORD -> "int"
; hTransaction : HANDLE -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procFindFirstFileTransactedW = kernel32.NewProc("FindFirstFileTransactedW")
)
// lpFileName (LPCWSTR), fInfoLevelId (FINDEX_INFO_LEVELS), lpFindFileData (void* out), fSearchOp (FINDEX_SEARCH_OPS), lpSearchFilter (void* optional), dwAdditionalFlags (DWORD), hTransaction (HANDLE)
r1, _, err := procFindFirstFileTransactedW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpFileName))),
uintptr(fInfoLevelId),
uintptr(lpFindFileData),
uintptr(fSearchOp),
uintptr(lpSearchFilter),
uintptr(dwAdditionalFlags),
uintptr(hTransaction),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HANDLEfunction FindFirstFileTransactedW(
lpFileName: PWideChar; // LPCWSTR
fInfoLevelId: Integer; // FINDEX_INFO_LEVELS
lpFindFileData: Pointer; // void* out
fSearchOp: Integer; // FINDEX_SEARCH_OPS
lpSearchFilter: Pointer; // void* optional
dwAdditionalFlags: DWORD; // DWORD
hTransaction: THandle // HANDLE
): THandle; stdcall;
external 'KERNEL32.dll' name 'FindFirstFileTransactedW';result := DllCall("KERNEL32\FindFirstFileTransactedW"
, "WStr", lpFileName ; LPCWSTR
, "Int", fInfoLevelId ; FINDEX_INFO_LEVELS
, "Ptr", lpFindFileData ; void* out
, "Int", fSearchOp ; FINDEX_SEARCH_OPS
, "Ptr", lpSearchFilter ; void* optional
, "UInt", dwAdditionalFlags ; DWORD
, "Ptr", hTransaction ; HANDLE
, "Ptr") ; return: HANDLE●FindFirstFileTransactedW(lpFileName, fInfoLevelId, lpFindFileData, fSearchOp, lpSearchFilter, dwAdditionalFlags, hTransaction) = DLL("KERNEL32.dll", "void* FindFirstFileTransactedW(char*, int, void*, int, void*, dword, void*)")
# 呼び出し: FindFirstFileTransactedW(lpFileName, fInfoLevelId, lpFindFileData, fSearchOp, lpSearchFilter, dwAdditionalFlags, hTransaction)
# lpFileName : LPCWSTR -> "char*"
# fInfoLevelId : FINDEX_INFO_LEVELS -> "int"
# lpFindFileData : void* out -> "void*"
# fSearchOp : FINDEX_SEARCH_OPS -> "int"
# lpSearchFilter : void* optional -> "void*"
# dwAdditionalFlags : DWORD -> "dword"
# hTransaction : HANDLE -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "kernel32" fn FindFirstFileTransactedW(
lpFileName: [*c]const u16, // LPCWSTR
fInfoLevelId: i32, // FINDEX_INFO_LEVELS
lpFindFileData: ?*anyopaque, // void* out
fSearchOp: i32, // FINDEX_SEARCH_OPS
lpSearchFilter: ?*anyopaque, // void* optional
dwAdditionalFlags: u32, // DWORD
hTransaction: ?*anyopaque // HANDLE
) callconv(std.os.windows.WINAPI) ?*anyopaque;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc FindFirstFileTransactedW(
lpFileName: WideCString, # LPCWSTR
fInfoLevelId: int32, # FINDEX_INFO_LEVELS
lpFindFileData: pointer, # void* out
fSearchOp: int32, # FINDEX_SEARCH_OPS
lpSearchFilter: pointer, # void* optional
dwAdditionalFlags: uint32, # DWORD
hTransaction: pointer # HANDLE
): pointer {.importc: "FindFirstFileTransactedW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "kernel32");
extern(Windows)
void* FindFirstFileTransactedW(
const(wchar)* lpFileName, // LPCWSTR
int fInfoLevelId, // FINDEX_INFO_LEVELS
void* lpFindFileData, // void* out
int fSearchOp, // FINDEX_SEARCH_OPS
void* lpSearchFilter, // void* optional
uint dwAdditionalFlags, // DWORD
void* hTransaction // HANDLE
);ccall((:FindFirstFileTransactedW, "KERNEL32.dll"), stdcall, Ptr{Cvoid},
(Cwstring, Int32, Ptr{Cvoid}, Int32, Ptr{Cvoid}, UInt32, Ptr{Cvoid}),
lpFileName, fInfoLevelId, lpFindFileData, fSearchOp, lpSearchFilter, dwAdditionalFlags, hTransaction)
# lpFileName : LPCWSTR -> Cwstring
# fInfoLevelId : FINDEX_INFO_LEVELS -> Int32
# lpFindFileData : void* out -> Ptr{Cvoid}
# fSearchOp : FINDEX_SEARCH_OPS -> Int32
# lpSearchFilter : void* optional -> Ptr{Cvoid}
# dwAdditionalFlags : DWORD -> UInt32
# hTransaction : HANDLE -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
void* FindFirstFileTransactedW(
const uint16_t* lpFileName,
int32_t fInfoLevelId,
void* lpFindFileData,
int32_t fSearchOp,
void* lpSearchFilter,
uint32_t dwAdditionalFlags,
void* hTransaction);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.FindFirstFileTransactedW(lpFileName, fInfoLevelId, lpFindFileData, fSearchOp, lpSearchFilter, dwAdditionalFlags, hTransaction)
-- lpFileName : LPCWSTR
-- fInfoLevelId : FINDEX_INFO_LEVELS
-- lpFindFileData : void* out
-- fSearchOp : FINDEX_SEARCH_OPS
-- lpSearchFilter : void* optional
-- dwAdditionalFlags : DWORD
-- hTransaction : HANDLE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const FindFirstFileTransactedW = lib.func('__stdcall', 'FindFirstFileTransactedW', 'void *', ['str16', 'int32_t', 'void *', 'int32_t', 'void *', 'uint32_t', 'void *']);
// FindFirstFileTransactedW(lpFileName, fInfoLevelId, lpFindFileData, fSearchOp, lpSearchFilter, dwAdditionalFlags, hTransaction)
// lpFileName : LPCWSTR -> 'str16'
// fInfoLevelId : FINDEX_INFO_LEVELS -> 'int32_t'
// lpFindFileData : void* out -> 'void *'
// fSearchOp : FINDEX_SEARCH_OPS -> 'int32_t'
// lpSearchFilter : void* optional -> 'void *'
// dwAdditionalFlags : DWORD -> 'uint32_t'
// hTransaction : HANDLE -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
FindFirstFileTransactedW: { parameters: ["buffer", "i32", "pointer", "i32", "pointer", "u32", "pointer"], result: "pointer" },
});
// lib.symbols.FindFirstFileTransactedW(lpFileName, fInfoLevelId, lpFindFileData, fSearchOp, lpSearchFilter, dwAdditionalFlags, hTransaction)
// lpFileName : LPCWSTR -> "buffer"
// fInfoLevelId : FINDEX_INFO_LEVELS -> "i32"
// lpFindFileData : void* out -> "pointer"
// fSearchOp : FINDEX_SEARCH_OPS -> "i32"
// lpSearchFilter : void* optional -> "pointer"
// dwAdditionalFlags : DWORD -> "u32"
// hTransaction : HANDLE -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
void* FindFirstFileTransactedW(
const uint16_t* lpFileName,
int32_t fInfoLevelId,
void* lpFindFileData,
int32_t fSearchOp,
void* lpSearchFilter,
uint32_t dwAdditionalFlags,
void* hTransaction);
C, "KERNEL32.dll");
// $ffi->FindFirstFileTransactedW(lpFileName, fInfoLevelId, lpFindFileData, fSearchOp, lpSearchFilter, dwAdditionalFlags, hTransaction);
// lpFileName : LPCWSTR
// fInfoLevelId : FINDEX_INFO_LEVELS
// lpFindFileData : void* out
// fSearchOp : FINDEX_SEARCH_OPS
// lpSearchFilter : void* optional
// dwAdditionalFlags : DWORD
// hTransaction : HANDLE
// 構造体/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 Kernel32 extends StdCallLibrary {
Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.UNICODE_OPTIONS);
Pointer FindFirstFileTransactedW(
WString lpFileName, // LPCWSTR
int fInfoLevelId, // FINDEX_INFO_LEVELS
Pointer lpFindFileData, // void* out
int fSearchOp, // FINDEX_SEARCH_OPS
Pointer lpSearchFilter, // void* optional
int dwAdditionalFlags, // DWORD
Pointer hTransaction // HANDLE
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("kernel32")]
lib LibKERNEL32
fun FindFirstFileTransactedW = FindFirstFileTransactedW(
lpFileName : UInt16*, # LPCWSTR
fInfoLevelId : Int32, # FINDEX_INFO_LEVELS
lpFindFileData : Void*, # void* out
fSearchOp : Int32, # FINDEX_SEARCH_OPS
lpSearchFilter : Void*, # void* optional
dwAdditionalFlags : UInt32, # DWORD
hTransaction : Void* # HANDLE
) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef FindFirstFileTransactedWNative = Pointer<Void> Function(Pointer<Utf16>, Int32, Pointer<Void>, Int32, Pointer<Void>, Uint32, Pointer<Void>);
typedef FindFirstFileTransactedWDart = Pointer<Void> Function(Pointer<Utf16>, int, Pointer<Void>, int, Pointer<Void>, int, Pointer<Void>);
final FindFirstFileTransactedW = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<FindFirstFileTransactedWNative, FindFirstFileTransactedWDart>('FindFirstFileTransactedW');
// lpFileName : LPCWSTR -> Pointer<Utf16>
// fInfoLevelId : FINDEX_INFO_LEVELS -> Int32
// lpFindFileData : void* out -> Pointer<Void>
// fSearchOp : FINDEX_SEARCH_OPS -> Int32
// lpSearchFilter : void* optional -> Pointer<Void>
// dwAdditionalFlags : DWORD -> Uint32
// hTransaction : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function FindFirstFileTransactedW(
lpFileName: PWideChar; // LPCWSTR
fInfoLevelId: Integer; // FINDEX_INFO_LEVELS
lpFindFileData: Pointer; // void* out
fSearchOp: Integer; // FINDEX_SEARCH_OPS
lpSearchFilter: Pointer; // void* optional
dwAdditionalFlags: DWORD; // DWORD
hTransaction: THandle // HANDLE
): THandle; stdcall;
external 'KERNEL32.dll' name 'FindFirstFileTransactedW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "FindFirstFileTransactedW"
c_FindFirstFileTransactedW :: CWString -> Int32 -> Ptr () -> Int32 -> Ptr () -> Word32 -> Ptr () -> IO (Ptr ())
-- lpFileName : LPCWSTR -> CWString
-- fInfoLevelId : FINDEX_INFO_LEVELS -> Int32
-- lpFindFileData : void* out -> Ptr ()
-- fSearchOp : FINDEX_SEARCH_OPS -> Int32
-- lpSearchFilter : void* optional -> Ptr ()
-- dwAdditionalFlags : DWORD -> Word32
-- hTransaction : HANDLE -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let findfirstfiletransactedw =
foreign "FindFirstFileTransactedW"
((ptr uint16_t) @-> int32_t @-> (ptr void) @-> int32_t @-> (ptr void) @-> uint32_t @-> (ptr void) @-> returning (ptr void))
(* lpFileName : LPCWSTR -> (ptr uint16_t) *)
(* fInfoLevelId : FINDEX_INFO_LEVELS -> int32_t *)
(* lpFindFileData : void* out -> (ptr void) *)
(* fSearchOp : FINDEX_SEARCH_OPS -> int32_t *)
(* lpSearchFilter : void* optional -> (ptr void) *)
(* dwAdditionalFlags : DWORD -> uint32_t *)
(* hTransaction : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("FindFirstFileTransactedW" find-first-file-transacted-w :convention :stdcall) :pointer
(lp-file-name (:string :encoding :utf-16le)) ; LPCWSTR
(f-info-level-id :int32) ; FINDEX_INFO_LEVELS
(lp-find-file-data :pointer) ; void* out
(f-search-op :int32) ; FINDEX_SEARCH_OPS
(lp-search-filter :pointer) ; void* optional
(dw-additional-flags :uint32) ; DWORD
(h-transaction :pointer)) ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $FindFirstFileTransactedW = Win32::API::More->new('KERNEL32',
'HANDLE FindFirstFileTransactedW(LPCWSTR lpFileName, int fInfoLevelId, LPVOID lpFindFileData, int fSearchOp, LPVOID lpSearchFilter, DWORD dwAdditionalFlags, HANDLE hTransaction)');
# my $ret = $FindFirstFileTransactedW->Call($lpFileName, $fInfoLevelId, $lpFindFileData, $fSearchOp, $lpSearchFilter, $dwAdditionalFlags, $hTransaction);
# lpFileName : LPCWSTR -> LPCWSTR
# fInfoLevelId : FINDEX_INFO_LEVELS -> int
# lpFindFileData : void* out -> LPVOID
# fSearchOp : FINDEX_SEARCH_OPS -> int
# lpSearchFilter : void* optional -> LPVOID
# dwAdditionalFlags : DWORD -> DWORD
# hTransaction : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f FindFirstFileTransactedA (ANSI版) — トランザクション内でファイル検索を開始する(ANSI版)。
- f FindClose — ファイル検索ハンドルを閉じて検索を終了する。
- f FindNextFileW — 前回の検索条件で次のファイルを取得する。
- f GetFileAttributesW — 指定ファイルの属性を取得する。
- f SetFileAttributesW — 指定ファイルの属性を設定する。
- s WIN32_FIND_DATAW