ホーム › Storage.FileSystem › FindFirstFileNameTransactedW
FindFirstFileNameTransactedW
関数トランザクション内でファイルのハードリンク名検索を開始する。
シグネチャ
// KERNEL32.dll
#include <windows.h>
HANDLE FindFirstFileNameTransactedW(
LPCWSTR lpFileName,
DWORD dwFlags,
DWORD* StringLength,
LPWSTR LinkName,
HANDLE hTransaction // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| lpFileName | LPCWSTR | in | ファイルの名前。 ファイルはローカルコンピューター上に存在している必要があります。そうでない場合、関数は失敗し、最終エラーコードが ERROR_TRANSACTIONS_UNSUPPORTED_REMOTE (6805) に設定されます。 |
| dwFlags | DWORD | in | 予約済み。ゼロ (0) を指定します。 |
| StringLength | DWORD* | inout | LinkName パラメーターが指す先のバッファーのサイズ(文字数)。この呼び出しが失敗し、エラーが ERROR_MORE_DATA (234) の場合、このパラメーターによって返される値は、LinkName が指すバッファーがすべての データを格納するために必要なサイズです。 |
| LinkName | LPWSTR | out | lpFileName に対して見つかった最初のリンク名を格納するためのバッファーへのポインター。 |
| hTransaction | HANDLE | inoptional | トランザクションへのハンドル。このハンドルは CreateTransaction 関数によって返されます。 |
戻り値の型: HANDLE
公式ドキュメント
指定したファイルへのすべてのハードリンクの列挙を、トランザクション操作として作成します。この関数は、後続の FindNextFileNameW 関数の呼び出しで使用できる列挙へのハンドルを返します。
戻り値
関数が成功した場合、戻り値は検索ハンドルであり、これは FindNextFileNameW 関数で使用するか、 FindClose 関数で閉じることができます。
関数が失敗した場合、戻り値は INVALID_HANDLE_VALUE (0xffffffff) です。拡張エラー情報を取得するには、 GetLastError 関数を呼び出します。
解説(Remarks)
Windows 8 および Windows Server 2012 では、この関数は次のテクノロジによってサポートされています。
| テクノロジ | サポート |
|---|---|
| Server Message Block (SMB) 3.0 プロトコル | いいえ |
| SMB 3.0 トランスペアレントフェールオーバー (TFO) | いいえ |
| SMB 3.0 とスケールアウトファイル共有 (SO) | いいえ |
| クラスター共有ボリュームファイルシステム (CsvFS) | いいえ |
| 回復性ファイルシステム (ReFS) | いいえ |
SMB 3.0 は TxF をサポートしていません。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
HANDLE FindFirstFileNameTransactedW(
LPCWSTR lpFileName,
DWORD dwFlags,
DWORD* StringLength,
LPWSTR LinkName,
HANDLE hTransaction // optional
);[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr FindFirstFileNameTransactedW(
[MarshalAs(UnmanagedType.LPWStr)] string lpFileName, // LPCWSTR
uint dwFlags, // DWORD
ref uint StringLength, // DWORD* in/out
[MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder LinkName, // LPWSTR out
IntPtr hTransaction // HANDLE optional
);<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FindFirstFileNameTransactedW(
<MarshalAs(UnmanagedType.LPWStr)> lpFileName As String, ' LPCWSTR
dwFlags As UInteger, ' DWORD
ByRef StringLength As UInteger, ' DWORD* in/out
<MarshalAs(UnmanagedType.LPWStr)> LinkName As System.Text.StringBuilder, ' LPWSTR out
hTransaction As IntPtr ' HANDLE optional
) As IntPtr
End Function' lpFileName : LPCWSTR
' dwFlags : DWORD
' StringLength : DWORD* in/out
' LinkName : LPWSTR out
' hTransaction : HANDLE optional
Declare PtrSafe Function FindFirstFileNameTransactedW Lib "kernel32" ( _
ByVal lpFileName As LongPtr, _
ByVal dwFlags As Long, _
ByRef StringLength As Long, _
ByVal LinkName As LongPtr, _
ByVal hTransaction As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
FindFirstFileNameTransactedW = ctypes.windll.kernel32.FindFirstFileNameTransactedW
FindFirstFileNameTransactedW.restype = ctypes.c_void_p
FindFirstFileNameTransactedW.argtypes = [
wintypes.LPCWSTR, # lpFileName : LPCWSTR
wintypes.DWORD, # dwFlags : DWORD
ctypes.POINTER(wintypes.DWORD), # StringLength : DWORD* in/out
wintypes.LPWSTR, # LinkName : LPWSTR out
wintypes.HANDLE, # hTransaction : HANDLE optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
FindFirstFileNameTransactedW = Fiddle::Function.new(
lib['FindFirstFileNameTransactedW'],
[
Fiddle::TYPE_VOIDP, # lpFileName : LPCWSTR
-Fiddle::TYPE_INT, # dwFlags : DWORD
Fiddle::TYPE_VOIDP, # StringLength : DWORD* in/out
Fiddle::TYPE_VOIDP, # LinkName : LPWSTR out
Fiddle::TYPE_VOIDP, # hTransaction : HANDLE optional
],
Fiddle::TYPE_VOIDP)#[link(name = "kernel32")]
extern "system" {
fn FindFirstFileNameTransactedW(
lpFileName: *const u16, // LPCWSTR
dwFlags: u32, // DWORD
StringLength: *mut u32, // DWORD* in/out
LinkName: *mut u16, // LPWSTR out
hTransaction: *mut core::ffi::c_void // HANDLE optional
) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern IntPtr FindFirstFileNameTransactedW([MarshalAs(UnmanagedType.LPWStr)] string lpFileName, uint dwFlags, ref uint StringLength, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder LinkName, IntPtr hTransaction);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_FindFirstFileNameTransactedW' -Namespace Win32 -PassThru
# $api::FindFirstFileNameTransactedW(lpFileName, dwFlags, StringLength, LinkName, hTransaction)#uselib "KERNEL32.dll"
#func global FindFirstFileNameTransactedW "FindFirstFileNameTransactedW" sptr, sptr, sptr, sptr, sptr
; FindFirstFileNameTransactedW lpFileName, dwFlags, varptr(StringLength), varptr(LinkName), hTransaction ; 戻り値は stat
; lpFileName : LPCWSTR -> "sptr"
; dwFlags : DWORD -> "sptr"
; StringLength : DWORD* in/out -> "sptr"
; LinkName : LPWSTR out -> "sptr"
; hTransaction : HANDLE optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "KERNEL32.dll" #cfunc global FindFirstFileNameTransactedW "FindFirstFileNameTransactedW" wstr, int, var, var, sptr ; res = FindFirstFileNameTransactedW(lpFileName, dwFlags, StringLength, LinkName, hTransaction) ; lpFileName : LPCWSTR -> "wstr" ; dwFlags : DWORD -> "int" ; StringLength : DWORD* in/out -> "var" ; LinkName : LPWSTR out -> "var" ; hTransaction : HANDLE optional -> "sptr" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll" #cfunc global FindFirstFileNameTransactedW "FindFirstFileNameTransactedW" wstr, int, sptr, sptr, sptr ; res = FindFirstFileNameTransactedW(lpFileName, dwFlags, varptr(StringLength), varptr(LinkName), hTransaction) ; lpFileName : LPCWSTR -> "wstr" ; dwFlags : DWORD -> "int" ; StringLength : DWORD* in/out -> "sptr" ; LinkName : LPWSTR out -> "sptr" ; hTransaction : HANDLE optional -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; HANDLE FindFirstFileNameTransactedW(LPCWSTR lpFileName, DWORD dwFlags, DWORD* StringLength, LPWSTR LinkName, HANDLE hTransaction) #uselib "KERNEL32.dll" #cfunc global FindFirstFileNameTransactedW "FindFirstFileNameTransactedW" wstr, int, var, var, intptr ; res = FindFirstFileNameTransactedW(lpFileName, dwFlags, StringLength, LinkName, hTransaction) ; lpFileName : LPCWSTR -> "wstr" ; dwFlags : DWORD -> "int" ; StringLength : DWORD* in/out -> "var" ; LinkName : LPWSTR out -> "var" ; hTransaction : HANDLE optional -> "intptr" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HANDLE FindFirstFileNameTransactedW(LPCWSTR lpFileName, DWORD dwFlags, DWORD* StringLength, LPWSTR LinkName, HANDLE hTransaction) #uselib "KERNEL32.dll" #cfunc global FindFirstFileNameTransactedW "FindFirstFileNameTransactedW" wstr, int, intptr, intptr, intptr ; res = FindFirstFileNameTransactedW(lpFileName, dwFlags, varptr(StringLength), varptr(LinkName), hTransaction) ; lpFileName : LPCWSTR -> "wstr" ; dwFlags : DWORD -> "int" ; StringLength : DWORD* in/out -> "intptr" ; LinkName : LPWSTR out -> "intptr" ; hTransaction : HANDLE optional -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procFindFirstFileNameTransactedW = kernel32.NewProc("FindFirstFileNameTransactedW")
)
// lpFileName (LPCWSTR), dwFlags (DWORD), StringLength (DWORD* in/out), LinkName (LPWSTR out), hTransaction (HANDLE optional)
r1, _, err := procFindFirstFileNameTransactedW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpFileName))),
uintptr(dwFlags),
uintptr(StringLength),
uintptr(LinkName),
uintptr(hTransaction),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HANDLEfunction FindFirstFileNameTransactedW(
lpFileName: PWideChar; // LPCWSTR
dwFlags: DWORD; // DWORD
StringLength: Pointer; // DWORD* in/out
LinkName: PWideChar; // LPWSTR out
hTransaction: THandle // HANDLE optional
): THandle; stdcall;
external 'KERNEL32.dll' name 'FindFirstFileNameTransactedW';result := DllCall("KERNEL32\FindFirstFileNameTransactedW"
, "WStr", lpFileName ; LPCWSTR
, "UInt", dwFlags ; DWORD
, "Ptr", StringLength ; DWORD* in/out
, "Ptr", LinkName ; LPWSTR out
, "Ptr", hTransaction ; HANDLE optional
, "Ptr") ; return: HANDLE●FindFirstFileNameTransactedW(lpFileName, dwFlags, StringLength, LinkName, hTransaction) = DLL("KERNEL32.dll", "void* FindFirstFileNameTransactedW(char*, dword, void*, char*, void*)")
# 呼び出し: FindFirstFileNameTransactedW(lpFileName, dwFlags, StringLength, LinkName, hTransaction)
# lpFileName : LPCWSTR -> "char*"
# dwFlags : DWORD -> "dword"
# StringLength : DWORD* in/out -> "void*"
# LinkName : LPWSTR out -> "char*"
# hTransaction : HANDLE optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn FindFirstFileNameTransactedW(
lpFileName: [*c]const u16, // LPCWSTR
dwFlags: u32, // DWORD
StringLength: [*c]u32, // DWORD* in/out
LinkName: [*c]u16, // LPWSTR out
hTransaction: ?*anyopaque // HANDLE optional
) callconv(std.os.windows.WINAPI) ?*anyopaque;proc FindFirstFileNameTransactedW(
lpFileName: WideCString, # LPCWSTR
dwFlags: uint32, # DWORD
StringLength: ptr uint32, # DWORD* in/out
LinkName: ptr uint16, # LPWSTR out
hTransaction: pointer # HANDLE optional
): pointer {.importc: "FindFirstFileNameTransactedW", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
void* FindFirstFileNameTransactedW(
const(wchar)* lpFileName, // LPCWSTR
uint dwFlags, // DWORD
uint* StringLength, // DWORD* in/out
wchar* LinkName, // LPWSTR out
void* hTransaction // HANDLE optional
);ccall((:FindFirstFileNameTransactedW, "KERNEL32.dll"), stdcall, Ptr{Cvoid},
(Cwstring, UInt32, Ptr{UInt32}, Ptr{UInt16}, Ptr{Cvoid}),
lpFileName, dwFlags, StringLength, LinkName, hTransaction)
# lpFileName : LPCWSTR -> Cwstring
# dwFlags : DWORD -> UInt32
# StringLength : DWORD* in/out -> Ptr{UInt32}
# LinkName : LPWSTR out -> Ptr{UInt16}
# hTransaction : HANDLE optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
void* FindFirstFileNameTransactedW(
const uint16_t* lpFileName,
uint32_t dwFlags,
uint32_t* StringLength,
uint16_t* LinkName,
void* hTransaction);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.FindFirstFileNameTransactedW(lpFileName, dwFlags, StringLength, LinkName, hTransaction)
-- lpFileName : LPCWSTR
-- dwFlags : DWORD
-- StringLength : DWORD* in/out
-- LinkName : LPWSTR out
-- hTransaction : HANDLE optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const FindFirstFileNameTransactedW = lib.func('__stdcall', 'FindFirstFileNameTransactedW', 'void *', ['str16', 'uint32_t', 'uint32_t *', 'uint16_t *', 'void *']);
// FindFirstFileNameTransactedW(lpFileName, dwFlags, StringLength, LinkName, hTransaction)
// lpFileName : LPCWSTR -> 'str16'
// dwFlags : DWORD -> 'uint32_t'
// StringLength : DWORD* in/out -> 'uint32_t *'
// LinkName : LPWSTR out -> 'uint16_t *'
// hTransaction : HANDLE optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
FindFirstFileNameTransactedW: { parameters: ["buffer", "u32", "pointer", "buffer", "pointer"], result: "pointer" },
});
// lib.symbols.FindFirstFileNameTransactedW(lpFileName, dwFlags, StringLength, LinkName, hTransaction)
// lpFileName : LPCWSTR -> "buffer"
// dwFlags : DWORD -> "u32"
// StringLength : DWORD* in/out -> "pointer"
// LinkName : LPWSTR out -> "buffer"
// hTransaction : HANDLE optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
void* FindFirstFileNameTransactedW(
const uint16_t* lpFileName,
uint32_t dwFlags,
uint32_t* StringLength,
uint16_t* LinkName,
void* hTransaction);
C, "KERNEL32.dll");
// $ffi->FindFirstFileNameTransactedW(lpFileName, dwFlags, StringLength, LinkName, hTransaction);
// lpFileName : LPCWSTR
// dwFlags : DWORD
// StringLength : DWORD* in/out
// LinkName : LPWSTR out
// hTransaction : HANDLE 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 Kernel32 extends StdCallLibrary {
Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
Pointer FindFirstFileNameTransactedW(
WString lpFileName, // LPCWSTR
int dwFlags, // DWORD
IntByReference StringLength, // DWORD* in/out
char[] LinkName, // LPWSTR out
Pointer hTransaction // HANDLE optional
);
}@[Link("kernel32")]
lib LibKERNEL32
fun FindFirstFileNameTransactedW = FindFirstFileNameTransactedW(
lpFileName : UInt16*, # LPCWSTR
dwFlags : UInt32, # DWORD
StringLength : UInt32*, # DWORD* in/out
LinkName : UInt16*, # LPWSTR out
hTransaction : Void* # HANDLE optional
) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef FindFirstFileNameTransactedWNative = Pointer<Void> Function(Pointer<Utf16>, Uint32, Pointer<Uint32>, Pointer<Utf16>, Pointer<Void>);
typedef FindFirstFileNameTransactedWDart = Pointer<Void> Function(Pointer<Utf16>, int, Pointer<Uint32>, Pointer<Utf16>, Pointer<Void>);
final FindFirstFileNameTransactedW = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<FindFirstFileNameTransactedWNative, FindFirstFileNameTransactedWDart>('FindFirstFileNameTransactedW');
// lpFileName : LPCWSTR -> Pointer<Utf16>
// dwFlags : DWORD -> Uint32
// StringLength : DWORD* in/out -> Pointer<Uint32>
// LinkName : LPWSTR out -> Pointer<Utf16>
// hTransaction : HANDLE optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function FindFirstFileNameTransactedW(
lpFileName: PWideChar; // LPCWSTR
dwFlags: DWORD; // DWORD
StringLength: Pointer; // DWORD* in/out
LinkName: PWideChar; // LPWSTR out
hTransaction: THandle // HANDLE optional
): THandle; stdcall;
external 'KERNEL32.dll' name 'FindFirstFileNameTransactedW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "FindFirstFileNameTransactedW"
c_FindFirstFileNameTransactedW :: CWString -> Word32 -> Ptr Word32 -> CWString -> Ptr () -> IO (Ptr ())
-- lpFileName : LPCWSTR -> CWString
-- dwFlags : DWORD -> Word32
-- StringLength : DWORD* in/out -> Ptr Word32
-- LinkName : LPWSTR out -> CWString
-- hTransaction : HANDLE optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let findfirstfilenametransactedw =
foreign "FindFirstFileNameTransactedW"
((ptr uint16_t) @-> uint32_t @-> (ptr uint32_t) @-> (ptr uint16_t) @-> (ptr void) @-> returning (ptr void))
(* lpFileName : LPCWSTR -> (ptr uint16_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* StringLength : DWORD* in/out -> (ptr uint32_t) *)
(* LinkName : LPWSTR out -> (ptr uint16_t) *)
(* hTransaction : HANDLE optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("FindFirstFileNameTransactedW" find-first-file-name-transacted-w :convention :stdcall) :pointer
(lp-file-name (:string :encoding :utf-16le)) ; LPCWSTR
(dw-flags :uint32) ; DWORD
(string-length :pointer) ; DWORD* in/out
(link-name :pointer) ; LPWSTR out
(h-transaction :pointer)) ; HANDLE optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $FindFirstFileNameTransactedW = Win32::API::More->new('KERNEL32',
'HANDLE FindFirstFileNameTransactedW(LPCWSTR lpFileName, DWORD dwFlags, LPVOID StringLength, LPWSTR LinkName, HANDLE hTransaction)');
# my $ret = $FindFirstFileNameTransactedW->Call($lpFileName, $dwFlags, $StringLength, $LinkName, $hTransaction);
# lpFileName : LPCWSTR -> LPCWSTR
# dwFlags : DWORD -> DWORD
# StringLength : DWORD* in/out -> LPVOID
# LinkName : LPWSTR out -> LPWSTR
# hTransaction : HANDLE optional -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f FindClose — ファイル検索ハンドルを閉じて検索を終了する。
- f FindNextFileNameW — ファイルに対する次のハードリンク名を取得する。