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

FindFirstFileTransactedA

関数
トランザクション内でファイル検索を開始する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

HANDLE FindFirstFileTransactedA(
    LPCSTR lpFileName,
    FINDEX_INFO_LEVELS fInfoLevelId,
    void* lpFindFileData,
    FINDEX_SEARCH_OPS fSearchOp,
    void* lpSearchFilter,   // optional
    DWORD dwAdditionalFlags,
    HANDLE hTransaction
);

パラメーター

名前方向説明
lpFileNameLPCSTRin

ディレクトリまたはパス、およびファイル名。ファイル名にはワイルドカード文字(たとえばアスタリスク (*) や疑問符 (?))を含めることができます。

このパラメーターは、NULL、無効な文字列(たとえば空文字列や終端の null 文字が欠落している文字列)、または末尾が円記号 (\) で終わる文字列であってはなりません。

文字列がワイルドカード、ピリオド (.)、またはディレクトリ名で終わる場合、ユーザーはパス上のルートおよびすべてのサブディレクトリへのアクセス権を持っている必要があります。

既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字まで拡張するには、パスの先頭に "\\?\" を付加します。詳細については、Naming Files, Paths, and Namespaces を参照してください。

ヒント

Windows 10, Version 1607 以降では、"\\?\" を付加することなく MAX_PATH の制限を解除するようオプトインできます。詳細については、Naming Files, Paths, and Namespaces の「Maximum Path Length Limitation」セクションを参照してください。

ファイルはローカルコンピューター上に存在する必要があります。そうでない場合、関数は失敗し、最終エラーコードは ERROR_TRANSACTIONS_UNSUPPORTED_REMOTE に設定されます。

fInfoLevelIdFINDEX_INFO_LEVELSin

返されるデータの情報レベル。

このパラメーターは FINDEX_INFO_LEVELS 列挙値のいずれかです。

lpFindFileDatavoid*out見つかったファイルまたはサブディレクトリに関する情報を受け取る WIN32_FIND_DATA 構造体へのポインター。
fSearchOpFINDEX_SEARCH_OPSin

ワイルドカード一致とは異なる、実行するフィルタリングの種類。

このパラメーターは FINDEX_SEARCH_OPS 列挙値のいずれかです。

lpSearchFiltervoid*optional

指定した fSearchOp が構造化された検索情報を必要とする場合の、検索条件へのポインター。

現時点では、サポートされている fSearchOp 値のいずれも拡張検索情報を必要としません。したがって、このポインターは NULL でなければなりません。

dwAdditionalFlagsDWORDin

検索を制御する追加のフラグを指定します。

Value Meaning
FIND_FIRST_EX_CASE_SENSITIVE
1
検索は大文字と小文字を区別します。
hTransactionHANDLEinトランザクションへのハンドル。このハンドルは CreateTransaction 関数によって返されます。

戻り値の型: HANDLE

公式ドキュメント

ディレクトリ内で、指定した名前に一致する名前を持つファイルまたはサブディレクトリを、トランザクション操作として検索します。(ANSI)

戻り値

関数が成功した場合、戻り値は後続の FindNextFile または FindClose の呼び出しで使用する検索ハンドルであり、lpFindFileData パラメーターには見つかった最初のファイルまたはディレクトリに関する情報が格納されます。

関数が失敗した場合、または lpFileName パラメーターの検索文字列からファイルを見つけられなかった場合、戻り値は INVALID_HANDLE_VALUE となり、lpFindFileData の内容は不定です。拡張エラー情報を取得するには、GetLastError 関数を呼び出します。

解説(Remarks)

FindFirstFileTransacted 関数は検索ハンドルを開き、指定したパターンに一致する名前を持つ、ファイルシステムが最初に見つけたファイルに関する情報を返します。これは、同じファイル名文字列パターンを指定したときに、ディレクトリ一覧表示アプリケーション(dir コマンドなど)で最初に表示されるファイルまたはディレクトリと一致する場合もあれば、一致しない場合もあります。これは、FindFirstFileTransacted が検索結果のソートを行わないためです。詳細については、FindNextFile を参照してください。

以下のリストは、その他の検索特性のいくつかを示しています。

Note まれに、この関数を呼び出した時点で NTFS ファイルシステム上のファイル情報が最新でない場合があります。最新のファイル情報を確実に取得するには、GetFileInformationByHandle 関数を呼び出してください。
基になるファイルシステムが、ディレクトリフィルタリング以外の指定された種類のフィルタリングをサポートしていない場合、FindFirstFileTransacted はエラー ERROR_NOT_SUPPORTED で失敗します。アプリケーションは FINDEX_SEARCH_OPS 型の FileExSearchNameMatch を使用し、独自にフィルタリングを実行する必要があります。

検索ハンドルを確立した後は、それを FindNextFile 関数で使用して、同じフィルタリングが実行されている同じパターンに一致する他のファイルを検索します。検索ハンドルが不要になったら、FindClose 関数を使用して閉じる必要があります。

前述のとおり、FindFirstFileTransactedlpFileName 入力文字列では末尾に円記号 (\) を使用できないため、ルートディレクトリの検索方法は明白でないかもしれません。ルートディレクトリのファイルを表示したり属性を取得したりするには、次のオプションが適用されます。

Note 文字列 "\\?\" を先頭に付加しても、ルートディレクトリへのアクセスは許可されません。

ネットワーク共有では、次の形式の 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 では、この関数は次のテクノロジでサポートされています。

Technology Supported
Server Message Block (SMB) 3.0 protocol No
SMB 3.0 Transparent Failover (TFO) No
SMB 3.0 with Scale-out File Shares (SO) No
Cluster Shared Volume File System (CsvFS) No
Resilient File System (ReFS) No

SMB 3.0 は TxF をサポートしていません。

メモ

winbase.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして FindFirstFileTransacted を定義します。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存でないコードを混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

HANDLE FindFirstFileTransactedA(
    LPCSTR lpFileName,
    FINDEX_INFO_LEVELS fInfoLevelId,
    void* lpFindFileData,
    FINDEX_SEARCH_OPS fSearchOp,
    void* lpSearchFilter,   // optional
    DWORD dwAdditionalFlags,
    HANDLE hTransaction
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr FindFirstFileTransactedA(
    [MarshalAs(UnmanagedType.LPStr)] string lpFileName,   // LPCSTR
    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.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FindFirstFileTransactedA(
    <MarshalAs(UnmanagedType.LPStr)> lpFileName As String,   ' LPCSTR
    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 : LPCSTR
' fInfoLevelId : FINDEX_INFO_LEVELS
' lpFindFileData : void* out
' fSearchOp : FINDEX_SEARCH_OPS
' lpSearchFilter : void* optional
' dwAdditionalFlags : DWORD
' hTransaction : HANDLE
Declare PtrSafe Function FindFirstFileTransactedA Lib "kernel32" ( _
    ByVal lpFileName As String, _
    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
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FindFirstFileTransactedA = ctypes.windll.kernel32.FindFirstFileTransactedA
FindFirstFileTransactedA.restype = ctypes.c_void_p
FindFirstFileTransactedA.argtypes = [
    wintypes.LPCSTR,  # lpFileName : LPCSTR
    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')
FindFirstFileTransactedA = Fiddle::Function.new(
  lib['FindFirstFileTransactedA'],
  [
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCSTR
    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)
#[link(name = "kernel32")]
extern "system" {
    fn FindFirstFileTransactedA(
        lpFileName: *const u8,  // LPCSTR
        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.Ansi, SetLastError = true)]
public static extern IntPtr FindFirstFileTransactedA([MarshalAs(UnmanagedType.LPStr)] string lpFileName, int fInfoLevelId, IntPtr lpFindFileData, int fSearchOp, IntPtr lpSearchFilter, uint dwAdditionalFlags, IntPtr hTransaction);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_FindFirstFileTransactedA' -Namespace Win32 -PassThru
# $api::FindFirstFileTransactedA(lpFileName, fInfoLevelId, lpFindFileData, fSearchOp, lpSearchFilter, dwAdditionalFlags, hTransaction)
#uselib "KERNEL32.dll"
#func global FindFirstFileTransactedA "FindFirstFileTransactedA" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; FindFirstFileTransactedA lpFileName, fInfoLevelId, lpFindFileData, fSearchOp, lpSearchFilter, dwAdditionalFlags, hTransaction   ; 戻り値は stat
; lpFileName : LPCSTR -> "sptr"
; fInfoLevelId : FINDEX_INFO_LEVELS -> "sptr"
; lpFindFileData : void* out -> "sptr"
; fSearchOp : FINDEX_SEARCH_OPS -> "sptr"
; lpSearchFilter : void* optional -> "sptr"
; dwAdditionalFlags : DWORD -> "sptr"
; hTransaction : HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global FindFirstFileTransactedA "FindFirstFileTransactedA" str, int, sptr, int, sptr, int, sptr
; res = FindFirstFileTransactedA(lpFileName, fInfoLevelId, lpFindFileData, fSearchOp, lpSearchFilter, dwAdditionalFlags, hTransaction)
; lpFileName : LPCSTR -> "str"
; 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 FindFirstFileTransactedA(LPCSTR lpFileName, FINDEX_INFO_LEVELS fInfoLevelId, void* lpFindFileData, FINDEX_SEARCH_OPS fSearchOp, void* lpSearchFilter, DWORD dwAdditionalFlags, HANDLE hTransaction)
#uselib "KERNEL32.dll"
#cfunc global FindFirstFileTransactedA "FindFirstFileTransactedA" str, int, intptr, int, intptr, int, intptr
; res = FindFirstFileTransactedA(lpFileName, fInfoLevelId, lpFindFileData, fSearchOp, lpSearchFilter, dwAdditionalFlags, hTransaction)
; lpFileName : LPCSTR -> "str"
; 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")
	procFindFirstFileTransactedA = kernel32.NewProc("FindFirstFileTransactedA")
)

// lpFileName (LPCSTR), fInfoLevelId (FINDEX_INFO_LEVELS), lpFindFileData (void* out), fSearchOp (FINDEX_SEARCH_OPS), lpSearchFilter (void* optional), dwAdditionalFlags (DWORD), hTransaction (HANDLE)
r1, _, err := procFindFirstFileTransactedA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpFileName))),
	uintptr(fInfoLevelId),
	uintptr(lpFindFileData),
	uintptr(fSearchOp),
	uintptr(lpSearchFilter),
	uintptr(dwAdditionalFlags),
	uintptr(hTransaction),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HANDLE
function FindFirstFileTransactedA(
  lpFileName: PAnsiChar;   // LPCSTR
  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 'FindFirstFileTransactedA';
result := DllCall("KERNEL32\FindFirstFileTransactedA"
    , "AStr", lpFileName   ; LPCSTR
    , "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
●FindFirstFileTransactedA(lpFileName, fInfoLevelId, lpFindFileData, fSearchOp, lpSearchFilter, dwAdditionalFlags, hTransaction) = DLL("KERNEL32.dll", "void* FindFirstFileTransactedA(char*, int, void*, int, void*, dword, void*)")
# 呼び出し: FindFirstFileTransactedA(lpFileName, fInfoLevelId, lpFindFileData, fSearchOp, lpSearchFilter, dwAdditionalFlags, hTransaction)
# lpFileName : LPCSTR -> "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)。
const std = @import("std");

extern "kernel32" fn FindFirstFileTransactedA(
    lpFileName: [*c]const u8, // LPCSTR
    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;
proc FindFirstFileTransactedA(
    lpFileName: cstring,  # LPCSTR
    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: "FindFirstFileTransactedA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
void* FindFirstFileTransactedA(
    const(char)* lpFileName,   // LPCSTR
    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((:FindFirstFileTransactedA, "KERNEL32.dll"), stdcall, Ptr{Cvoid},
      (Cstring, Int32, Ptr{Cvoid}, Int32, Ptr{Cvoid}, UInt32, Ptr{Cvoid}),
      lpFileName, fInfoLevelId, lpFindFileData, fSearchOp, lpSearchFilter, dwAdditionalFlags, hTransaction)
# lpFileName : LPCSTR -> Cstring
# 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 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* FindFirstFileTransactedA(
    const char* lpFileName,
    int32_t fInfoLevelId,
    void* lpFindFileData,
    int32_t fSearchOp,
    void* lpSearchFilter,
    uint32_t dwAdditionalFlags,
    void* hTransaction);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.FindFirstFileTransactedA(lpFileName, fInfoLevelId, lpFindFileData, fSearchOp, lpSearchFilter, dwAdditionalFlags, hTransaction)
-- lpFileName : LPCSTR
-- fInfoLevelId : FINDEX_INFO_LEVELS
-- lpFindFileData : void* out
-- fSearchOp : FINDEX_SEARCH_OPS
-- lpSearchFilter : void* optional
-- dwAdditionalFlags : DWORD
-- hTransaction : HANDLE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const FindFirstFileTransactedA = lib.func('__stdcall', 'FindFirstFileTransactedA', 'void *', ['str', 'int32_t', 'void *', 'int32_t', 'void *', 'uint32_t', 'void *']);
// FindFirstFileTransactedA(lpFileName, fInfoLevelId, lpFindFileData, fSearchOp, lpSearchFilter, dwAdditionalFlags, hTransaction)
// lpFileName : LPCSTR -> 'str'
// 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", {
  FindFirstFileTransactedA: { parameters: ["buffer", "i32", "pointer", "i32", "pointer", "u32", "pointer"], result: "pointer" },
});
// lib.symbols.FindFirstFileTransactedA(lpFileName, fInfoLevelId, lpFindFileData, fSearchOp, lpSearchFilter, dwAdditionalFlags, hTransaction)
// lpFileName : LPCSTR -> "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"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* FindFirstFileTransactedA(
    const char* lpFileName,
    int32_t fInfoLevelId,
    void* lpFindFileData,
    int32_t fSearchOp,
    void* lpSearchFilter,
    uint32_t dwAdditionalFlags,
    void* hTransaction);
C, "KERNEL32.dll");
// $ffi->FindFirstFileTransactedA(lpFileName, fInfoLevelId, lpFindFileData, fSearchOp, lpSearchFilter, dwAdditionalFlags, hTransaction);
// lpFileName : LPCSTR
// 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.ASCII_OPTIONS);
    Pointer FindFirstFileTransactedA(
        String lpFileName,   // LPCSTR
        int fInfoLevelId,   // FINDEX_INFO_LEVELS
        Pointer lpFindFileData,   // void* out
        int fSearchOp,   // FINDEX_SEARCH_OPS
        Pointer lpSearchFilter,   // void* optional
        int dwAdditionalFlags,   // DWORD
        Pointer hTransaction   // HANDLE
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun FindFirstFileTransactedA = FindFirstFileTransactedA(
    lpFileName : UInt8*,   # LPCSTR
    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 FindFirstFileTransactedANative = Pointer<Void> Function(Pointer<Utf8>, Int32, Pointer<Void>, Int32, Pointer<Void>, Uint32, Pointer<Void>);
typedef FindFirstFileTransactedADart = Pointer<Void> Function(Pointer<Utf8>, int, Pointer<Void>, int, Pointer<Void>, int, Pointer<Void>);
final FindFirstFileTransactedA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<FindFirstFileTransactedANative, FindFirstFileTransactedADart>('FindFirstFileTransactedA');
// lpFileName : LPCSTR -> Pointer<Utf8>
// 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 FindFirstFileTransactedA(
  lpFileName: PAnsiChar;   // LPCSTR
  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 'FindFirstFileTransactedA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FindFirstFileTransactedA"
  c_FindFirstFileTransactedA :: CString -> Int32 -> Ptr () -> Int32 -> Ptr () -> Word32 -> Ptr () -> IO (Ptr ())
-- lpFileName : LPCSTR -> CString
-- 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 findfirstfiletransacteda =
  foreign "FindFirstFileTransactedA"
    (string @-> int32_t @-> (ptr void) @-> int32_t @-> (ptr void) @-> uint32_t @-> (ptr void) @-> returning (ptr void))
(* lpFileName : LPCSTR -> string *)
(* 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 ("FindFirstFileTransactedA" find-first-file-transacted-a :convention :stdcall) :pointer
  (lp-file-name :string)   ; LPCSTR
  (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 $FindFirstFileTransactedA = Win32::API::More->new('KERNEL32',
    'HANDLE FindFirstFileTransactedA(LPCSTR lpFileName, int fInfoLevelId, LPVOID lpFindFileData, int fSearchOp, LPVOID lpSearchFilter, DWORD dwAdditionalFlags, HANDLE hTransaction)');
# my $ret = $FindFirstFileTransactedA->Call($lpFileName, $fInfoLevelId, $lpFindFileData, $fSearchOp, $lpSearchFilter, $dwAdditionalFlags, $hTransaction);
# lpFileName : LPCSTR -> LPCSTR
# 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 を使用。

関連項目

文字セット違い
公式の関連項目
使用する型