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

FindFirstStreamTransactedW

関数
トランザクション内でファイルの代替ストリーム検索を開始する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

HANDLE FindFirstStreamTransactedW(
    LPCWSTR lpFileName,
    STREAM_INFO_LEVELS InfoLevel,
    void* lpFindStreamData,
    DWORD dwFlags,   // optional
    HANDLE hTransaction
);

パラメーター

名前方向説明
lpFileNameLPCWSTRin

完全修飾されたファイル名です。

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

InfoLevelSTREAM_INFO_LEVELSin

返されるデータの情報レベルです。このパラメーターは、 STREAM_INFO_LEVELS 列挙型の値のいずれかです。

意味
FindStreamInfoStandard
0
データは WIN32_FIND_STREAM_DATA 構造体で返されます。
lpFindStreamDatavoid*outファイルデータを受け取るバッファーへのポインターです。このデータの形式は、 InfoLevel パラメーターの値によって異なります。
dwFlagsDWORDoptional将来の使用のために予約されています。このパラメーターには 0 を指定する必要があります。
hTransactionHANDLEinトランザクションへのハンドルです。このハンドルは CreateTransaction 関数によって返されます。

戻り値の型: HANDLE

公式ドキュメント

指定したファイルまたはディレクトリ内の最初のストリームを、トランザクション操作として列挙します。

戻り値

関数が成功した場合、戻り値は検索ハンドルであり、これを後続の FindNextStreamW 関数の呼び出しで使用できます。

関数が失敗した場合、戻り値は INVALID_HANDLE_VALUE です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

すべてのファイルは既定のデータストリームを含みます。NTFS では、ファイルは 1 つ以上の名前付きデータストリームを含むこともできます。 FAT ファイルシステムでは、ファイルは既定のデータストリームより多くのストリームを持つことができないため、この関数を FAT ファイルシステム上のファイルに対して使用した場合、有効な結果は 返されません。この関数は、ハードリンクをサポートするすべてのファイルシステムで動作します。そうでない場合、関数は ERROR_STATUS_NOT_IMPLEMENTED (6805) を返します。

FindFirstStreamTransactedW 関数は 検索ハンドルを開き、指定したファイルまたはディレクトリ内の最初のストリームに関する情報を返します。 ファイルの場合、これは常に既定のデータストリーム ::$DATA です。検索ハンドルが確立された後は、それを FindNextStreamW 関数で使用して、指定したファイルまたはディレクトリ内の他の ストリームを検索します。検索ハンドルが不要になったら、 FindClose 関数を使用して閉じる必要があります。

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 をサポートしていません。

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

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

HANDLE FindFirstStreamTransactedW(
    LPCWSTR lpFileName,
    STREAM_INFO_LEVELS InfoLevel,
    void* lpFindStreamData,
    DWORD dwFlags,   // optional
    HANDLE hTransaction
);
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr FindFirstStreamTransactedW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpFileName,   // LPCWSTR
    int InfoLevel,   // STREAM_INFO_LEVELS
    IntPtr lpFindStreamData,   // void* out
    uint dwFlags,   // DWORD optional
    IntPtr hTransaction   // HANDLE
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FindFirstStreamTransactedW(
    <MarshalAs(UnmanagedType.LPWStr)> lpFileName As String,   ' LPCWSTR
    InfoLevel As Integer,   ' STREAM_INFO_LEVELS
    lpFindStreamData As IntPtr,   ' void* out
    dwFlags As UInteger,   ' DWORD optional
    hTransaction As IntPtr   ' HANDLE
) As IntPtr
End Function
' lpFileName : LPCWSTR
' InfoLevel : STREAM_INFO_LEVELS
' lpFindStreamData : void* out
' dwFlags : DWORD optional
' hTransaction : HANDLE
Declare PtrSafe Function FindFirstStreamTransactedW Lib "kernel32" ( _
    ByVal lpFileName As LongPtr, _
    ByVal InfoLevel As Long, _
    ByVal lpFindStreamData As LongPtr, _
    ByVal dwFlags 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

FindFirstStreamTransactedW = ctypes.windll.kernel32.FindFirstStreamTransactedW
FindFirstStreamTransactedW.restype = ctypes.c_void_p
FindFirstStreamTransactedW.argtypes = [
    wintypes.LPCWSTR,  # lpFileName : LPCWSTR
    ctypes.c_int,  # InfoLevel : STREAM_INFO_LEVELS
    ctypes.POINTER(None),  # lpFindStreamData : void* out
    wintypes.DWORD,  # dwFlags : DWORD optional
    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')
FindFirstStreamTransactedW = Fiddle::Function.new(
  lib['FindFirstStreamTransactedW'],
  [
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCWSTR
    Fiddle::TYPE_INT,  # InfoLevel : STREAM_INFO_LEVELS
    Fiddle::TYPE_VOIDP,  # lpFindStreamData : void* out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD optional
    Fiddle::TYPE_VOIDP,  # hTransaction : HANDLE
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "kernel32")]
extern "system" {
    fn FindFirstStreamTransactedW(
        lpFileName: *const u16,  // LPCWSTR
        InfoLevel: i32,  // STREAM_INFO_LEVELS
        lpFindStreamData: *mut (),  // void* out
        dwFlags: u32,  // DWORD optional
        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", SetLastError = true)]
public static extern IntPtr FindFirstStreamTransactedW([MarshalAs(UnmanagedType.LPWStr)] string lpFileName, int InfoLevel, IntPtr lpFindStreamData, uint dwFlags, IntPtr hTransaction);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_FindFirstStreamTransactedW' -Namespace Win32 -PassThru
# $api::FindFirstStreamTransactedW(lpFileName, InfoLevel, lpFindStreamData, dwFlags, hTransaction)
#uselib "KERNEL32.dll"
#func global FindFirstStreamTransactedW "FindFirstStreamTransactedW" sptr, sptr, sptr, sptr, sptr
; FindFirstStreamTransactedW lpFileName, InfoLevel, lpFindStreamData, dwFlags, hTransaction   ; 戻り値は stat
; lpFileName : LPCWSTR -> "sptr"
; InfoLevel : STREAM_INFO_LEVELS -> "sptr"
; lpFindStreamData : void* out -> "sptr"
; dwFlags : DWORD optional -> "sptr"
; hTransaction : HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global FindFirstStreamTransactedW "FindFirstStreamTransactedW" wstr, int, sptr, int, sptr
; res = FindFirstStreamTransactedW(lpFileName, InfoLevel, lpFindStreamData, dwFlags, hTransaction)
; lpFileName : LPCWSTR -> "wstr"
; InfoLevel : STREAM_INFO_LEVELS -> "int"
; lpFindStreamData : void* out -> "sptr"
; dwFlags : DWORD optional -> "int"
; hTransaction : HANDLE -> "sptr"
; HANDLE FindFirstStreamTransactedW(LPCWSTR lpFileName, STREAM_INFO_LEVELS InfoLevel, void* lpFindStreamData, DWORD dwFlags, HANDLE hTransaction)
#uselib "KERNEL32.dll"
#cfunc global FindFirstStreamTransactedW "FindFirstStreamTransactedW" wstr, int, intptr, int, intptr
; res = FindFirstStreamTransactedW(lpFileName, InfoLevel, lpFindStreamData, dwFlags, hTransaction)
; lpFileName : LPCWSTR -> "wstr"
; InfoLevel : STREAM_INFO_LEVELS -> "int"
; lpFindStreamData : void* out -> "intptr"
; dwFlags : DWORD optional -> "int"
; hTransaction : HANDLE -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procFindFirstStreamTransactedW = kernel32.NewProc("FindFirstStreamTransactedW")
)

// lpFileName (LPCWSTR), InfoLevel (STREAM_INFO_LEVELS), lpFindStreamData (void* out), dwFlags (DWORD optional), hTransaction (HANDLE)
r1, _, err := procFindFirstStreamTransactedW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpFileName))),
	uintptr(InfoLevel),
	uintptr(lpFindStreamData),
	uintptr(dwFlags),
	uintptr(hTransaction),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HANDLE
function FindFirstStreamTransactedW(
  lpFileName: PWideChar;   // LPCWSTR
  InfoLevel: Integer;   // STREAM_INFO_LEVELS
  lpFindStreamData: Pointer;   // void* out
  dwFlags: DWORD;   // DWORD optional
  hTransaction: THandle   // HANDLE
): THandle; stdcall;
  external 'KERNEL32.dll' name 'FindFirstStreamTransactedW';
result := DllCall("KERNEL32\FindFirstStreamTransactedW"
    , "WStr", lpFileName   ; LPCWSTR
    , "Int", InfoLevel   ; STREAM_INFO_LEVELS
    , "Ptr", lpFindStreamData   ; void* out
    , "UInt", dwFlags   ; DWORD optional
    , "Ptr", hTransaction   ; HANDLE
    , "Ptr")   ; return: HANDLE
●FindFirstStreamTransactedW(lpFileName, InfoLevel, lpFindStreamData, dwFlags, hTransaction) = DLL("KERNEL32.dll", "void* FindFirstStreamTransactedW(char*, int, void*, dword, void*)")
# 呼び出し: FindFirstStreamTransactedW(lpFileName, InfoLevel, lpFindStreamData, dwFlags, hTransaction)
# lpFileName : LPCWSTR -> "char*"
# InfoLevel : STREAM_INFO_LEVELS -> "int"
# lpFindStreamData : void* out -> "void*"
# dwFlags : DWORD optional -> "dword"
# hTransaction : HANDLE -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn FindFirstStreamTransactedW(
    lpFileName: [*c]const u16, // LPCWSTR
    InfoLevel: i32, // STREAM_INFO_LEVELS
    lpFindStreamData: ?*anyopaque, // void* out
    dwFlags: u32, // DWORD optional
    hTransaction: ?*anyopaque // HANDLE
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc FindFirstStreamTransactedW(
    lpFileName: WideCString,  # LPCWSTR
    InfoLevel: int32,  # STREAM_INFO_LEVELS
    lpFindStreamData: pointer,  # void* out
    dwFlags: uint32,  # DWORD optional
    hTransaction: pointer  # HANDLE
): pointer {.importc: "FindFirstStreamTransactedW", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
void* FindFirstStreamTransactedW(
    const(wchar)* lpFileName,   // LPCWSTR
    int InfoLevel,   // STREAM_INFO_LEVELS
    void* lpFindStreamData,   // void* out
    uint dwFlags,   // DWORD optional
    void* hTransaction   // HANDLE
);
ccall((:FindFirstStreamTransactedW, "KERNEL32.dll"), stdcall, Ptr{Cvoid},
      (Cwstring, Int32, Ptr{Cvoid}, UInt32, Ptr{Cvoid}),
      lpFileName, InfoLevel, lpFindStreamData, dwFlags, hTransaction)
# lpFileName : LPCWSTR -> Cwstring
# InfoLevel : STREAM_INFO_LEVELS -> Int32
# lpFindStreamData : void* out -> Ptr{Cvoid}
# dwFlags : DWORD optional -> UInt32
# hTransaction : HANDLE -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* FindFirstStreamTransactedW(
    const uint16_t* lpFileName,
    int32_t InfoLevel,
    void* lpFindStreamData,
    uint32_t dwFlags,
    void* hTransaction);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.FindFirstStreamTransactedW(lpFileName, InfoLevel, lpFindStreamData, dwFlags, hTransaction)
-- lpFileName : LPCWSTR
-- InfoLevel : STREAM_INFO_LEVELS
-- lpFindStreamData : void* out
-- dwFlags : DWORD optional
-- hTransaction : HANDLE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const FindFirstStreamTransactedW = lib.func('__stdcall', 'FindFirstStreamTransactedW', 'void *', ['str16', 'int32_t', 'void *', 'uint32_t', 'void *']);
// FindFirstStreamTransactedW(lpFileName, InfoLevel, lpFindStreamData, dwFlags, hTransaction)
// lpFileName : LPCWSTR -> 'str16'
// InfoLevel : STREAM_INFO_LEVELS -> 'int32_t'
// lpFindStreamData : void* out -> 'void *'
// dwFlags : DWORD optional -> 'uint32_t'
// hTransaction : HANDLE -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  FindFirstStreamTransactedW: { parameters: ["buffer", "i32", "pointer", "u32", "pointer"], result: "pointer" },
});
// lib.symbols.FindFirstStreamTransactedW(lpFileName, InfoLevel, lpFindStreamData, dwFlags, hTransaction)
// lpFileName : LPCWSTR -> "buffer"
// InfoLevel : STREAM_INFO_LEVELS -> "i32"
// lpFindStreamData : void* out -> "pointer"
// dwFlags : DWORD optional -> "u32"
// hTransaction : HANDLE -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* FindFirstStreamTransactedW(
    const uint16_t* lpFileName,
    int32_t InfoLevel,
    void* lpFindStreamData,
    uint32_t dwFlags,
    void* hTransaction);
C, "KERNEL32.dll");
// $ffi->FindFirstStreamTransactedW(lpFileName, InfoLevel, lpFindStreamData, dwFlags, hTransaction);
// lpFileName : LPCWSTR
// InfoLevel : STREAM_INFO_LEVELS
// lpFindStreamData : void* out
// dwFlags : DWORD optional
// 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);
    Pointer FindFirstStreamTransactedW(
        WString lpFileName,   // LPCWSTR
        int InfoLevel,   // STREAM_INFO_LEVELS
        Pointer lpFindStreamData,   // void* out
        int dwFlags,   // DWORD optional
        Pointer hTransaction   // HANDLE
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun FindFirstStreamTransactedW = FindFirstStreamTransactedW(
    lpFileName : UInt16*,   # LPCWSTR
    InfoLevel : Int32,   # STREAM_INFO_LEVELS
    lpFindStreamData : Void*,   # void* out
    dwFlags : UInt32,   # DWORD optional
    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 FindFirstStreamTransactedWNative = Pointer<Void> Function(Pointer<Utf16>, Int32, Pointer<Void>, Uint32, Pointer<Void>);
typedef FindFirstStreamTransactedWDart = Pointer<Void> Function(Pointer<Utf16>, int, Pointer<Void>, int, Pointer<Void>);
final FindFirstStreamTransactedW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<FindFirstStreamTransactedWNative, FindFirstStreamTransactedWDart>('FindFirstStreamTransactedW');
// lpFileName : LPCWSTR -> Pointer<Utf16>
// InfoLevel : STREAM_INFO_LEVELS -> Int32
// lpFindStreamData : void* out -> Pointer<Void>
// dwFlags : DWORD optional -> Uint32
// hTransaction : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FindFirstStreamTransactedW(
  lpFileName: PWideChar;   // LPCWSTR
  InfoLevel: Integer;   // STREAM_INFO_LEVELS
  lpFindStreamData: Pointer;   // void* out
  dwFlags: DWORD;   // DWORD optional
  hTransaction: THandle   // HANDLE
): THandle; stdcall;
  external 'KERNEL32.dll' name 'FindFirstStreamTransactedW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FindFirstStreamTransactedW"
  c_FindFirstStreamTransactedW :: CWString -> Int32 -> Ptr () -> Word32 -> Ptr () -> IO (Ptr ())
-- lpFileName : LPCWSTR -> CWString
-- InfoLevel : STREAM_INFO_LEVELS -> Int32
-- lpFindStreamData : void* out -> Ptr ()
-- dwFlags : DWORD optional -> Word32
-- hTransaction : HANDLE -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let findfirststreamtransactedw =
  foreign "FindFirstStreamTransactedW"
    ((ptr uint16_t) @-> int32_t @-> (ptr void) @-> uint32_t @-> (ptr void) @-> returning (ptr void))
(* lpFileName : LPCWSTR -> (ptr uint16_t) *)
(* InfoLevel : STREAM_INFO_LEVELS -> int32_t *)
(* lpFindStreamData : void* out -> (ptr void) *)
(* dwFlags : DWORD optional -> 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 ("FindFirstStreamTransactedW" find-first-stream-transacted-w :convention :stdcall) :pointer
  (lp-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (info-level :int32)   ; STREAM_INFO_LEVELS
  (lp-find-stream-data :pointer)   ; void* out
  (dw-flags :uint32)   ; DWORD optional
  (h-transaction :pointer))   ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FindFirstStreamTransactedW = Win32::API::More->new('KERNEL32',
    'HANDLE FindFirstStreamTransactedW(LPCWSTR lpFileName, int InfoLevel, LPVOID lpFindStreamData, DWORD dwFlags, HANDLE hTransaction)');
# my $ret = $FindFirstStreamTransactedW->Call($lpFileName, $InfoLevel, $lpFindStreamData, $dwFlags, $hTransaction);
# lpFileName : LPCWSTR -> LPCWSTR
# InfoLevel : STREAM_INFO_LEVELS -> int
# lpFindStreamData : void* out -> LPVOID
# dwFlags : DWORD optional -> DWORD
# hTransaction : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型