FindFirstFileA
関数シグネチャ
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
HANDLE FindFirstFileA(
LPCSTR lpFileName,
WIN32_FIND_DATAA* lpFindFileData
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| lpFileName | LPCSTR | in | ディレクトリまたはパス、およびファイル名です。ファイル名にはワイルドカード文字、たとえばアスタリスク (*) や疑問符 (?) を含めることができます。 このパラメーターを NULL、無効な文字列(たとえば空文字列や終端の null 文字が欠落した文字列)、または末尾のバックスラッシュ (\) で終わる文字列にしてはいけません。 文字列がワイルドカード、ピリオド (.)、またはディレクトリ名で終わる場合、ユーザーはパス上のルートおよびすべてのサブディレクトリへのアクセス権限を持っている必要があります。 既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字に拡張するには、パスの先頭に "\\?\" を付加します。詳細については「Naming Files, Paths, and Namespaces」を参照してください。 ヒント
Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH の制限を解除することをオプトインできます。詳細については「Naming Files, Paths, and Namespaces」の「Maximum Path Length Limitation」セクションを参照してください。 |
| lpFindFileData | WIN32_FIND_DATAA* | out | 見つかったファイルまたはディレクトリに関する情報を受け取る WIN32_FIND_DATA 構造体へのポインターです。 |
戻り値の型: HANDLE
公式ドキュメント
指定した名前(ワイルドカードを使用する場合は部分的な名前)に一致するファイルまたはサブディレクトリをディレクトリ内で検索します。(ANSI)
戻り値
関数が成功した場合、戻り値は後続の FindNextFile または FindClose の呼び出しで使用する検索ハンドルであり、lpFindFileData パラメーターには最初に見つかったファイルまたはディレクトリに関する情報が格納されます。
関数が失敗した場合、または lpFileName パラメーターの検索文字列からファイルを見つけられなかった場合、戻り値は INVALID_HANDLE_VALUE となり、lpFindFileData の内容は不定です。拡張エラー情報を取得するには、GetLastError 関数を呼び出します。
一致するファイルが見つからなかったために関数が失敗した場合、GetLastError 関数は ERROR_FILE_NOT_FOUND を返します。
解説(Remarks)
FindFirstFile 関数は検索ハンドルを開き、指定したパターンに一致する名前を持つ、ファイルシステムが最初に見つけたファイルに関する情報を返します。これは、同じファイル名文字列パターンを与えたときにディレクトリ一覧アプリケーション(dir コマンドなど)で最初に表示されるファイルまたはディレクトリと一致するとは限りません。これは FindFirstFile が検索結果のソートを行わないためです。詳細については FindNextFile を参照してください。
次のリストは、その他の検索の特性を示します。
- 検索は厳密にファイル名に対して行われ、日付やファイルの種類などの属性に対しては行われません(その他のオプションについては FindFirstFileEx を参照してください)。
- 検索にはロングファイル名とショートファイル名の両方が含まれます。
- 末尾にバックスラッシュを付けて検索を開こうとすると、常に失敗します。
- lpFileName パラメーターに無効な文字列、NULL、または空文字列を渡すことは、この関数の有効な使用方法ではありません。この場合の結果は未定義です。
検索ハンドルが不要になったら、CloseHandle ではなく FindClose 関数を使用して閉じてください。
前述のとおり、FindFirstFile の lpFileName 入力文字列に末尾のバックスラッシュ (\) を使用することはできないため、ルートディレクトリを検索する方法は分かりにくいかもしれません。ルートディレクトリ内のファイルを表示したり、その属性を取得したりするには、次のオプションが適用されます。
- ルートディレクトリ内のファイルを調べるには、"C:\*" を使用し、FindNextFile を使ってディレクトリを順に処理できます。
- ルートディレクトリの属性を取得するには、GetFileAttributes 関数を使用します。
ネットワーク共有では、次の形式の lpFileName を使用できます。"\\Server\Share\*"。ただし、共有自体を指す lpFileName は使用できません。たとえば "\\Server\Share" は無効です。
ルートディレクトリではないディレクトリを調べるには、末尾のバックスラッシュを付けずにそのディレクトリへのパスを使用します。たとえば、引数 "C:\Windows" はディレクトリ "C:\Windows" に関する情報を返し、"C:\Windows" 内のディレクトリやファイルに関する情報は返しません。"C:\Windows" 内のファイルおよびディレクトリを調べるには、lpFileName として "C:\Windows\*" を使用します。
結果を照会してからその情報に基づいて処理を行うまでの間に、他のスレッドやプロセスがこの名前のファイルを作成または削除する可能性があることに注意してください。これがアプリケーションにとって懸念事項となる場合、考えられる解決策の 1 つは、CreateFile 関数を CREATE_NEW(ファイルが存在する場合は失敗する)または OPEN_EXISTING(ファイルが存在しない場合は失敗する)とともに使用することです。
ディレクトリ内のすべてのファイルを一覧表示する 32 ビットアプリケーションを作成しており、そのアプリケーションが 64 ビットコンピューター上で実行される可能性がある場合は、FindFirstFile を呼び出す前に 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) | はい |
例
次の C++ の例は、FindFirstFile の最小限の使用方法を示しています。
#include <windows.h>
#include <tchar.h>
#include <stdio.h>
void _tmain(int argc, TCHAR *argv[])
{
WIN32_FIND_DATA FindFileData;
HANDLE hFind;
if( argc != 2 )
{
_tprintf(TEXT("Usage: %s [target_file]\n"), argv[0]);
return;
}
_tprintf (TEXT("Target file is %s\n"), argv[1]);
hFind = FindFirstFile(argv[1], &FindFileData);
if (hFind == INVALID_HANDLE_VALUE)
{
printf ("FindFirstFile failed (%d)\n", GetLastError());
return;
}
else
{
_tprintf (TEXT("The first file found is %s\n"),
FindFileData.cFileName);
FindClose(hFind);
}
}
もう 1 つの例については、Listing the Files in a Directory を参照してください。
fileapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして FindFirstFile を定義します。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については「Conventions for Function Prototypes」を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
HANDLE FindFirstFileA(
LPCSTR lpFileName,
WIN32_FIND_DATAA* lpFindFileData
);[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr FindFirstFileA(
[MarshalAs(UnmanagedType.LPStr)] string lpFileName, // LPCSTR
IntPtr lpFindFileData // WIN32_FIND_DATAA* out
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FindFirstFileA(
<MarshalAs(UnmanagedType.LPStr)> lpFileName As String, ' LPCSTR
lpFindFileData As IntPtr ' WIN32_FIND_DATAA* out
) As IntPtr
End Function' lpFileName : LPCSTR
' lpFindFileData : WIN32_FIND_DATAA* out
Declare PtrSafe Function FindFirstFileA Lib "kernel32" ( _
ByVal lpFileName As String, _
ByVal lpFindFileData As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
FindFirstFileA = ctypes.windll.kernel32.FindFirstFileA
FindFirstFileA.restype = ctypes.c_void_p
FindFirstFileA.argtypes = [
wintypes.LPCSTR, # lpFileName : LPCSTR
ctypes.c_void_p, # lpFindFileData : WIN32_FIND_DATAA* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
FindFirstFileA = Fiddle::Function.new(
lib['FindFirstFileA'],
[
Fiddle::TYPE_VOIDP, # lpFileName : LPCSTR
Fiddle::TYPE_VOIDP, # lpFindFileData : WIN32_FIND_DATAA* out
],
Fiddle::TYPE_VOIDP)#[link(name = "kernel32")]
extern "system" {
fn FindFirstFileA(
lpFileName: *const u8, // LPCSTR
lpFindFileData: *mut WIN32_FIND_DATAA // WIN32_FIND_DATAA* out
) -> *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 FindFirstFileA([MarshalAs(UnmanagedType.LPStr)] string lpFileName, IntPtr lpFindFileData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_FindFirstFileA' -Namespace Win32 -PassThru
# $api::FindFirstFileA(lpFileName, lpFindFileData)#uselib "KERNEL32.dll"
#func global FindFirstFileA "FindFirstFileA" sptr, sptr
; FindFirstFileA lpFileName, varptr(lpFindFileData) ; 戻り値は stat
; lpFileName : LPCSTR -> "sptr"
; lpFindFileData : WIN32_FIND_DATAA* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll" #cfunc global FindFirstFileA "FindFirstFileA" str, var ; res = FindFirstFileA(lpFileName, lpFindFileData) ; lpFileName : LPCSTR -> "str" ; lpFindFileData : WIN32_FIND_DATAA* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll" #cfunc global FindFirstFileA "FindFirstFileA" str, sptr ; res = FindFirstFileA(lpFileName, varptr(lpFindFileData)) ; lpFileName : LPCSTR -> "str" ; lpFindFileData : WIN32_FIND_DATAA* out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; HANDLE FindFirstFileA(LPCSTR lpFileName, WIN32_FIND_DATAA* lpFindFileData) #uselib "KERNEL32.dll" #cfunc global FindFirstFileA "FindFirstFileA" str, var ; res = FindFirstFileA(lpFileName, lpFindFileData) ; lpFileName : LPCSTR -> "str" ; lpFindFileData : WIN32_FIND_DATAA* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HANDLE FindFirstFileA(LPCSTR lpFileName, WIN32_FIND_DATAA* lpFindFileData) #uselib "KERNEL32.dll" #cfunc global FindFirstFileA "FindFirstFileA" str, intptr ; res = FindFirstFileA(lpFileName, varptr(lpFindFileData)) ; lpFileName : LPCSTR -> "str" ; lpFindFileData : WIN32_FIND_DATAA* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procFindFirstFileA = kernel32.NewProc("FindFirstFileA")
)
// lpFileName (LPCSTR), lpFindFileData (WIN32_FIND_DATAA* out)
r1, _, err := procFindFirstFileA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpFileName))),
uintptr(lpFindFileData),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HANDLEfunction FindFirstFileA(
lpFileName: PAnsiChar; // LPCSTR
lpFindFileData: Pointer // WIN32_FIND_DATAA* out
): THandle; stdcall;
external 'KERNEL32.dll' name 'FindFirstFileA';result := DllCall("KERNEL32\FindFirstFileA"
, "AStr", lpFileName ; LPCSTR
, "Ptr", lpFindFileData ; WIN32_FIND_DATAA* out
, "Ptr") ; return: HANDLE●FindFirstFileA(lpFileName, lpFindFileData) = DLL("KERNEL32.dll", "void* FindFirstFileA(char*, void*)")
# 呼び出し: FindFirstFileA(lpFileName, lpFindFileData)
# lpFileName : LPCSTR -> "char*"
# lpFindFileData : WIN32_FIND_DATAA* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn FindFirstFileA(
lpFileName: [*c]const u8, // LPCSTR
lpFindFileData: [*c]WIN32_FIND_DATAA // WIN32_FIND_DATAA* out
) callconv(std.os.windows.WINAPI) ?*anyopaque;proc FindFirstFileA(
lpFileName: cstring, # LPCSTR
lpFindFileData: ptr WIN32_FIND_DATAA # WIN32_FIND_DATAA* out
): pointer {.importc: "FindFirstFileA", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
void* FindFirstFileA(
const(char)* lpFileName, // LPCSTR
WIN32_FIND_DATAA* lpFindFileData // WIN32_FIND_DATAA* out
);ccall((:FindFirstFileA, "KERNEL32.dll"), stdcall, Ptr{Cvoid},
(Cstring, Ptr{WIN32_FIND_DATAA}),
lpFileName, lpFindFileData)
# lpFileName : LPCSTR -> Cstring
# lpFindFileData : WIN32_FIND_DATAA* out -> Ptr{WIN32_FIND_DATAA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
void* FindFirstFileA(
const char* lpFileName,
void* lpFindFileData);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.FindFirstFileA(lpFileName, lpFindFileData)
-- lpFileName : LPCSTR
-- lpFindFileData : WIN32_FIND_DATAA* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const FindFirstFileA = lib.func('__stdcall', 'FindFirstFileA', 'void *', ['str', 'void *']);
// FindFirstFileA(lpFileName, lpFindFileData)
// lpFileName : LPCSTR -> 'str'
// lpFindFileData : WIN32_FIND_DATAA* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
FindFirstFileA: { parameters: ["buffer", "pointer"], result: "pointer" },
});
// lib.symbols.FindFirstFileA(lpFileName, lpFindFileData)
// lpFileName : LPCSTR -> "buffer"
// lpFindFileData : WIN32_FIND_DATAA* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
void* FindFirstFileA(
const char* lpFileName,
void* lpFindFileData);
C, "KERNEL32.dll");
// $ffi->FindFirstFileA(lpFileName, lpFindFileData);
// lpFileName : LPCSTR
// lpFindFileData : WIN32_FIND_DATAA* out
// 構造体/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 FindFirstFileA(
String lpFileName, // LPCSTR
Pointer lpFindFileData // WIN32_FIND_DATAA* out
);
}@[Link("kernel32")]
lib LibKERNEL32
fun FindFirstFileA = FindFirstFileA(
lpFileName : UInt8*, # LPCSTR
lpFindFileData : WIN32_FIND_DATAA* # WIN32_FIND_DATAA* out
) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef FindFirstFileANative = Pointer<Void> Function(Pointer<Utf8>, Pointer<Void>);
typedef FindFirstFileADart = Pointer<Void> Function(Pointer<Utf8>, Pointer<Void>);
final FindFirstFileA = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<FindFirstFileANative, FindFirstFileADart>('FindFirstFileA');
// lpFileName : LPCSTR -> Pointer<Utf8>
// lpFindFileData : WIN32_FIND_DATAA* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function FindFirstFileA(
lpFileName: PAnsiChar; // LPCSTR
lpFindFileData: Pointer // WIN32_FIND_DATAA* out
): THandle; stdcall;
external 'KERNEL32.dll' name 'FindFirstFileA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "FindFirstFileA"
c_FindFirstFileA :: CString -> Ptr () -> IO (Ptr ())
-- lpFileName : LPCSTR -> CString
-- lpFindFileData : WIN32_FIND_DATAA* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let findfirstfilea =
foreign "FindFirstFileA"
(string @-> (ptr void) @-> returning (ptr void))
(* lpFileName : LPCSTR -> string *)
(* lpFindFileData : WIN32_FIND_DATAA* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("FindFirstFileA" find-first-file-a :convention :stdcall) :pointer
(lp-file-name :string) ; LPCSTR
(lp-find-file-data :pointer)) ; WIN32_FIND_DATAA* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $FindFirstFileA = Win32::API::More->new('KERNEL32',
'HANDLE FindFirstFileA(LPCSTR lpFileName, LPVOID lpFindFileData)');
# my $ret = $FindFirstFileA->Call($lpFileName, $lpFindFileData);
# lpFileName : LPCSTR -> LPCSTR
# lpFindFileData : WIN32_FIND_DATAA* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f FindFirstFileW (Unicode版) — 条件に一致する最初のファイルを検索する。
- f FindFirstFileExA — 詳細オプション付きで最初の一致ファイルを検索する(ANSI版)。
- f FindClose — ファイル検索ハンドルを閉じて検索を終了する。
- f FindFirstFileTransactedA — トランザクション内でファイル検索を開始する(ANSI版)。
- f FindNextFileA — 前回の検索条件で次のファイルを取得する(ANSI版)。
- f GetFileAttributesA — 指定ファイルの属性を取得する(ANSI版)。
- f SetFileAttributesA — 指定ファイルの属性を設定する(ANSI版)。