FindFirstStreamW
関数シグネチャ
// KERNEL32.dll
#include <windows.h>
HANDLE FindFirstStreamW(
LPCWSTR lpFileName,
STREAM_INFO_LEVELS InfoLevel,
void* lpFindStreamData,
DWORD dwFlags // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||
|---|---|---|---|---|---|---|---|
| lpFileName | LPCWSTR | in | 完全修飾されたファイル名。 | ||||
| InfoLevel | STREAM_INFO_LEVELS | in | 返されるデータの情報レベル。このパラメーターは STREAM_INFO_LEVELS 列挙型の値のいずれかです。
| ||||
| lpFindStreamData | void* | out | ファイルストリームデータを受け取るバッファーへのポインター。このデータの形式は InfoLevel パラメーターの値に依存します。 | ||||
| dwFlags | DWORD | optional | 将来の使用のために予約されています。このパラメーターは 0 でなければなりません。 |
戻り値の型: HANDLE
公式ドキュメント
指定されたファイルまたはディレクトリ内で、::$DATA ストリーム型を持つ最初のストリームを列挙します。
戻り値
関数が成功した場合、戻り値は検索ハンドルであり、これは FindNextStreamW 関数の後続の呼び出しで使用できます。
関数が失敗した場合、戻り値は INVALID_HANDLE_VALUE です。拡張エラー情報を取得するには、 GetLastError を呼び出します。
ストリームが見つからない場合、関数は失敗し、 GetLastError は ERROR_HANDLE_EOF (38) を返します。
ファイルシステムがストリームをサポートしていない場合、関数は失敗し、 GetLastError は ERROR_INVALID_PARAMETER (87) を返します。
解説(Remarks)
FindFirstStreamW 関数は検索ハンドルを開き、指定されたファイルまたはディレクトリ内の最初の $DATA ストリームに関する情報を返します。 ファイルの場合、これは常に既定の無名データストリーム "::$DATA" です。ディレクトリは既定では $DATA ストリームを持たず、 無名データストリームを持つことはできませんが、作成後に名前付きデータストリームを設定できます。 検索ハンドルが確立された後、それを FindNextStreamW 関数の呼び出しで使用して、 指定されたファイルまたはディレクトリ内の他のストリームを検索します。検索ハンドルが不要になったら、 FindClose 関数を使用して閉じる必要があります。
Windows 8 および Windows Server 2012 では、この関数は以下のテクノロジによってサポートされています。
| テクノロジ | サポート |
|---|---|
| Server Message Block (SMB) 3.0 プロトコル | はい |
| SMB 3.0 トランスペアレントフェールオーバー (TFO) | はい |
| SMB 3.0 とスケールアウトファイル共有 (SO) | はい |
| クラスター共有ボリュームファイルシステム (CsvFS) | はい |
| 回復性ファイルシステム (ReFS) | はい |
SMB 3.0 は 64K 以下のストリームのリストをサポートします。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
HANDLE FindFirstStreamW(
LPCWSTR lpFileName,
STREAM_INFO_LEVELS InfoLevel,
void* lpFindStreamData,
DWORD dwFlags // optional
);[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr FindFirstStreamW(
[MarshalAs(UnmanagedType.LPWStr)] string lpFileName, // LPCWSTR
int InfoLevel, // STREAM_INFO_LEVELS
IntPtr lpFindStreamData, // void* out
uint dwFlags // DWORD optional
);<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FindFirstStreamW(
<MarshalAs(UnmanagedType.LPWStr)> lpFileName As String, ' LPCWSTR
InfoLevel As Integer, ' STREAM_INFO_LEVELS
lpFindStreamData As IntPtr, ' void* out
dwFlags As UInteger ' DWORD optional
) As IntPtr
End Function' lpFileName : LPCWSTR
' InfoLevel : STREAM_INFO_LEVELS
' lpFindStreamData : void* out
' dwFlags : DWORD optional
Declare PtrSafe Function FindFirstStreamW Lib "kernel32" ( _
ByVal lpFileName As LongPtr, _
ByVal InfoLevel As Long, _
ByVal lpFindStreamData As LongPtr, _
ByVal dwFlags As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
FindFirstStreamW = ctypes.windll.kernel32.FindFirstStreamW
FindFirstStreamW.restype = ctypes.c_void_p
FindFirstStreamW.argtypes = [
wintypes.LPCWSTR, # lpFileName : LPCWSTR
ctypes.c_int, # InfoLevel : STREAM_INFO_LEVELS
ctypes.POINTER(None), # lpFindStreamData : void* out
wintypes.DWORD, # dwFlags : DWORD optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
FindFirstStreamW = Fiddle::Function.new(
lib['FindFirstStreamW'],
[
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)#[link(name = "kernel32")]
extern "system" {
fn FindFirstStreamW(
lpFileName: *const u16, // LPCWSTR
InfoLevel: i32, // STREAM_INFO_LEVELS
lpFindStreamData: *mut (), // void* out
dwFlags: u32 // DWORD 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 FindFirstStreamW([MarshalAs(UnmanagedType.LPWStr)] string lpFileName, int InfoLevel, IntPtr lpFindStreamData, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_FindFirstStreamW' -Namespace Win32 -PassThru
# $api::FindFirstStreamW(lpFileName, InfoLevel, lpFindStreamData, dwFlags)#uselib "KERNEL32.dll"
#func global FindFirstStreamW "FindFirstStreamW" sptr, sptr, sptr, sptr
; FindFirstStreamW lpFileName, InfoLevel, lpFindStreamData, dwFlags ; 戻り値は stat
; lpFileName : LPCWSTR -> "sptr"
; InfoLevel : STREAM_INFO_LEVELS -> "sptr"
; lpFindStreamData : void* out -> "sptr"
; dwFlags : DWORD optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global FindFirstStreamW "FindFirstStreamW" wstr, int, sptr, int
; res = FindFirstStreamW(lpFileName, InfoLevel, lpFindStreamData, dwFlags)
; lpFileName : LPCWSTR -> "wstr"
; InfoLevel : STREAM_INFO_LEVELS -> "int"
; lpFindStreamData : void* out -> "sptr"
; dwFlags : DWORD optional -> "int"; HANDLE FindFirstStreamW(LPCWSTR lpFileName, STREAM_INFO_LEVELS InfoLevel, void* lpFindStreamData, DWORD dwFlags)
#uselib "KERNEL32.dll"
#cfunc global FindFirstStreamW "FindFirstStreamW" wstr, int, intptr, int
; res = FindFirstStreamW(lpFileName, InfoLevel, lpFindStreamData, dwFlags)
; lpFileName : LPCWSTR -> "wstr"
; InfoLevel : STREAM_INFO_LEVELS -> "int"
; lpFindStreamData : void* out -> "intptr"
; dwFlags : DWORD optional -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procFindFirstStreamW = kernel32.NewProc("FindFirstStreamW")
)
// lpFileName (LPCWSTR), InfoLevel (STREAM_INFO_LEVELS), lpFindStreamData (void* out), dwFlags (DWORD optional)
r1, _, err := procFindFirstStreamW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpFileName))),
uintptr(InfoLevel),
uintptr(lpFindStreamData),
uintptr(dwFlags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HANDLEfunction FindFirstStreamW(
lpFileName: PWideChar; // LPCWSTR
InfoLevel: Integer; // STREAM_INFO_LEVELS
lpFindStreamData: Pointer; // void* out
dwFlags: DWORD // DWORD optional
): THandle; stdcall;
external 'KERNEL32.dll' name 'FindFirstStreamW';result := DllCall("KERNEL32\FindFirstStreamW"
, "WStr", lpFileName ; LPCWSTR
, "Int", InfoLevel ; STREAM_INFO_LEVELS
, "Ptr", lpFindStreamData ; void* out
, "UInt", dwFlags ; DWORD optional
, "Ptr") ; return: HANDLE●FindFirstStreamW(lpFileName, InfoLevel, lpFindStreamData, dwFlags) = DLL("KERNEL32.dll", "void* FindFirstStreamW(char*, int, void*, dword)")
# 呼び出し: FindFirstStreamW(lpFileName, InfoLevel, lpFindStreamData, dwFlags)
# lpFileName : LPCWSTR -> "char*"
# InfoLevel : STREAM_INFO_LEVELS -> "int"
# lpFindStreamData : void* out -> "void*"
# dwFlags : DWORD optional -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn FindFirstStreamW(
lpFileName: [*c]const u16, // LPCWSTR
InfoLevel: i32, // STREAM_INFO_LEVELS
lpFindStreamData: ?*anyopaque, // void* out
dwFlags: u32 // DWORD optional
) callconv(std.os.windows.WINAPI) ?*anyopaque;proc FindFirstStreamW(
lpFileName: WideCString, # LPCWSTR
InfoLevel: int32, # STREAM_INFO_LEVELS
lpFindStreamData: pointer, # void* out
dwFlags: uint32 # DWORD optional
): pointer {.importc: "FindFirstStreamW", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
void* FindFirstStreamW(
const(wchar)* lpFileName, // LPCWSTR
int InfoLevel, // STREAM_INFO_LEVELS
void* lpFindStreamData, // void* out
uint dwFlags // DWORD optional
);ccall((:FindFirstStreamW, "KERNEL32.dll"), stdcall, Ptr{Cvoid},
(Cwstring, Int32, Ptr{Cvoid}, UInt32),
lpFileName, InfoLevel, lpFindStreamData, dwFlags)
# lpFileName : LPCWSTR -> Cwstring
# InfoLevel : STREAM_INFO_LEVELS -> Int32
# lpFindStreamData : void* out -> Ptr{Cvoid}
# dwFlags : DWORD optional -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
void* FindFirstStreamW(
const uint16_t* lpFileName,
int32_t InfoLevel,
void* lpFindStreamData,
uint32_t dwFlags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.FindFirstStreamW(lpFileName, InfoLevel, lpFindStreamData, dwFlags)
-- lpFileName : LPCWSTR
-- InfoLevel : STREAM_INFO_LEVELS
-- lpFindStreamData : void* out
-- dwFlags : DWORD optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const FindFirstStreamW = lib.func('__stdcall', 'FindFirstStreamW', 'void *', ['str16', 'int32_t', 'void *', 'uint32_t']);
// FindFirstStreamW(lpFileName, InfoLevel, lpFindStreamData, dwFlags)
// lpFileName : LPCWSTR -> 'str16'
// InfoLevel : STREAM_INFO_LEVELS -> 'int32_t'
// lpFindStreamData : void* out -> 'void *'
// dwFlags : DWORD optional -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
FindFirstStreamW: { parameters: ["buffer", "i32", "pointer", "u32"], result: "pointer" },
});
// lib.symbols.FindFirstStreamW(lpFileName, InfoLevel, lpFindStreamData, dwFlags)
// lpFileName : LPCWSTR -> "buffer"
// InfoLevel : STREAM_INFO_LEVELS -> "i32"
// lpFindStreamData : void* out -> "pointer"
// dwFlags : DWORD optional -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
void* FindFirstStreamW(
const uint16_t* lpFileName,
int32_t InfoLevel,
void* lpFindStreamData,
uint32_t dwFlags);
C, "KERNEL32.dll");
// $ffi->FindFirstStreamW(lpFileName, InfoLevel, lpFindStreamData, dwFlags);
// lpFileName : LPCWSTR
// InfoLevel : STREAM_INFO_LEVELS
// lpFindStreamData : void* out
// dwFlags : DWORD 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 FindFirstStreamW(
WString lpFileName, // LPCWSTR
int InfoLevel, // STREAM_INFO_LEVELS
Pointer lpFindStreamData, // void* out
int dwFlags // DWORD optional
);
}@[Link("kernel32")]
lib LibKERNEL32
fun FindFirstStreamW = FindFirstStreamW(
lpFileName : UInt16*, # LPCWSTR
InfoLevel : Int32, # STREAM_INFO_LEVELS
lpFindStreamData : Void*, # void* out
dwFlags : UInt32 # DWORD optional
) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef FindFirstStreamWNative = Pointer<Void> Function(Pointer<Utf16>, Int32, Pointer<Void>, Uint32);
typedef FindFirstStreamWDart = Pointer<Void> Function(Pointer<Utf16>, int, Pointer<Void>, int);
final FindFirstStreamW = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<FindFirstStreamWNative, FindFirstStreamWDart>('FindFirstStreamW');
// lpFileName : LPCWSTR -> Pointer<Utf16>
// InfoLevel : STREAM_INFO_LEVELS -> Int32
// lpFindStreamData : void* out -> Pointer<Void>
// dwFlags : DWORD optional -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function FindFirstStreamW(
lpFileName: PWideChar; // LPCWSTR
InfoLevel: Integer; // STREAM_INFO_LEVELS
lpFindStreamData: Pointer; // void* out
dwFlags: DWORD // DWORD optional
): THandle; stdcall;
external 'KERNEL32.dll' name 'FindFirstStreamW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "FindFirstStreamW"
c_FindFirstStreamW :: CWString -> Int32 -> Ptr () -> Word32 -> IO (Ptr ())
-- lpFileName : LPCWSTR -> CWString
-- InfoLevel : STREAM_INFO_LEVELS -> Int32
-- lpFindStreamData : void* out -> Ptr ()
-- dwFlags : DWORD optional -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let findfirststreamw =
foreign "FindFirstStreamW"
((ptr uint16_t) @-> int32_t @-> (ptr void) @-> uint32_t @-> returning (ptr void))
(* lpFileName : LPCWSTR -> (ptr uint16_t) *)
(* InfoLevel : STREAM_INFO_LEVELS -> int32_t *)
(* lpFindStreamData : void* out -> (ptr void) *)
(* dwFlags : DWORD optional -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("FindFirstStreamW" find-first-stream-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
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $FindFirstStreamW = Win32::API::More->new('KERNEL32',
'HANDLE FindFirstStreamW(LPCWSTR lpFileName, int InfoLevel, LPVOID lpFindStreamData, DWORD dwFlags)');
# my $ret = $FindFirstStreamW->Call($lpFileName, $InfoLevel, $lpFindStreamData, $dwFlags);
# lpFileName : LPCWSTR -> LPCWSTR
# InfoLevel : STREAM_INFO_LEVELS -> int
# lpFindStreamData : void* out -> LPVOID
# dwFlags : DWORD optional -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f FindClose — ファイル検索ハンドルを閉じて検索を終了する。
- f FindFirstStreamTransactedW — トランザクション内でファイルの代替ストリーム検索を開始する。
- f FindNextStreamW — ファイル内の次の代替データストリームを取得する。
- s WIN32_FIND_STREAM_DATA