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

FindNextFileNameW

関数
ファイルに対する次のハードリンク名を取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL FindNextFileNameW(
    HANDLE hFindStream,
    DWORD* StringLength,
    LPWSTR LinkName
);

パラメーター

名前方向説明
hFindStreamHANDLEinFindFirstFileNameW の呼び出しが成功したときに返される、列挙へのハンドルです。
StringLengthDWORD*inoutLinkName パラメーターのサイズ(文字数)です。この呼び出しが失敗し、エラーが ERROR_MORE_DATA である場合、このパラメーターで返される値は、すべてのデータを格納するために LinkName が必要とするサイズです。
LinkNameLPWSTRoutlpFileName に対して見つかった最初のリンク名を格納するバッファーへのポインターです。

戻り値の型: BOOL

公式ドキュメント

FindFirstFileNameW 関数の呼び出しが成功したときに返されるハンドルを使用して、ファイルへのハードリンクの列挙を継続します。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

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

一致するファイルが見つからない場合、GetLastError 関数は ERROR_HANDLE_EOF を返します。

解説(Remarks)

関数が TRUE を返す場合、列挙すべきハードリンクがさらに存在します。

Windows 8 および Windows Server 2012 では、この関数は以下のテクノロジによってサポートされます。

テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 透過的フェールオーバー (TFO) いいえ
SMB 3.0 スケールアウトファイル共有 (SO) いいえ
クラスター共有ボリュームファイルシステム (CsvFS) はい
Resilient File System (ReFS) はい
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOL FindNextFileNameW(
    HANDLE hFindStream,
    DWORD* StringLength,
    LPWSTR LinkName
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool FindNextFileNameW(
    IntPtr hFindStream,   // HANDLE
    ref uint StringLength,   // DWORD* in/out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder LinkName   // LPWSTR out
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FindNextFileNameW(
    hFindStream As IntPtr,   ' HANDLE
    ByRef StringLength As UInteger,   ' DWORD* in/out
    <MarshalAs(UnmanagedType.LPWStr)> LinkName As System.Text.StringBuilder   ' LPWSTR out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hFindStream : HANDLE
' StringLength : DWORD* in/out
' LinkName : LPWSTR out
Declare PtrSafe Function FindNextFileNameW Lib "kernel32" ( _
    ByVal hFindStream As LongPtr, _
    ByRef StringLength As Long, _
    ByVal LinkName As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FindNextFileNameW = ctypes.windll.kernel32.FindNextFileNameW
FindNextFileNameW.restype = wintypes.BOOL
FindNextFileNameW.argtypes = [
    wintypes.HANDLE,  # hFindStream : HANDLE
    ctypes.POINTER(wintypes.DWORD),  # StringLength : DWORD* in/out
    wintypes.LPWSTR,  # LinkName : LPWSTR out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
FindNextFileNameW = Fiddle::Function.new(
  lib['FindNextFileNameW'],
  [
    Fiddle::TYPE_VOIDP,  # hFindStream : HANDLE
    Fiddle::TYPE_VOIDP,  # StringLength : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # LinkName : LPWSTR out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn FindNextFileNameW(
        hFindStream: *mut core::ffi::c_void,  // HANDLE
        StringLength: *mut u32,  // DWORD* in/out
        LinkName: *mut u16  // LPWSTR out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool FindNextFileNameW(IntPtr hFindStream, ref uint StringLength, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder LinkName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_FindNextFileNameW' -Namespace Win32 -PassThru
# $api::FindNextFileNameW(hFindStream, StringLength, LinkName)
#uselib "KERNEL32.dll"
#func global FindNextFileNameW "FindNextFileNameW" sptr, sptr, sptr
; FindNextFileNameW hFindStream, varptr(StringLength), varptr(LinkName)   ; 戻り値は stat
; hFindStream : HANDLE -> "sptr"
; StringLength : DWORD* in/out -> "sptr"
; LinkName : LPWSTR out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global FindNextFileNameW "FindNextFileNameW" sptr, var, var
; res = FindNextFileNameW(hFindStream, StringLength, LinkName)
; hFindStream : HANDLE -> "sptr"
; StringLength : DWORD* in/out -> "var"
; LinkName : LPWSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL FindNextFileNameW(HANDLE hFindStream, DWORD* StringLength, LPWSTR LinkName)
#uselib "KERNEL32.dll"
#cfunc global FindNextFileNameW "FindNextFileNameW" intptr, var, var
; res = FindNextFileNameW(hFindStream, StringLength, LinkName)
; hFindStream : HANDLE -> "intptr"
; StringLength : DWORD* in/out -> "var"
; LinkName : LPWSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procFindNextFileNameW = kernel32.NewProc("FindNextFileNameW")
)

// hFindStream (HANDLE), StringLength (DWORD* in/out), LinkName (LPWSTR out)
r1, _, err := procFindNextFileNameW.Call(
	uintptr(hFindStream),
	uintptr(StringLength),
	uintptr(LinkName),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function FindNextFileNameW(
  hFindStream: THandle;   // HANDLE
  StringLength: Pointer;   // DWORD* in/out
  LinkName: PWideChar   // LPWSTR out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'FindNextFileNameW';
result := DllCall("KERNEL32\FindNextFileNameW"
    , "Ptr", hFindStream   ; HANDLE
    , "Ptr", StringLength   ; DWORD* in/out
    , "Ptr", LinkName   ; LPWSTR out
    , "Int")   ; return: BOOL
●FindNextFileNameW(hFindStream, StringLength, LinkName) = DLL("KERNEL32.dll", "bool FindNextFileNameW(void*, void*, char*)")
# 呼び出し: FindNextFileNameW(hFindStream, StringLength, LinkName)
# hFindStream : HANDLE -> "void*"
# StringLength : DWORD* in/out -> "void*"
# LinkName : LPWSTR out -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn FindNextFileNameW(
    hFindStream: ?*anyopaque, // HANDLE
    StringLength: [*c]u32, // DWORD* in/out
    LinkName: [*c]u16 // LPWSTR out
) callconv(std.os.windows.WINAPI) i32;
proc FindNextFileNameW(
    hFindStream: pointer,  # HANDLE
    StringLength: ptr uint32,  # DWORD* in/out
    LinkName: ptr uint16  # LPWSTR out
): int32 {.importc: "FindNextFileNameW", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int FindNextFileNameW(
    void* hFindStream,   // HANDLE
    uint* StringLength,   // DWORD* in/out
    wchar* LinkName   // LPWSTR out
);
ccall((:FindNextFileNameW, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{UInt32}, Ptr{UInt16}),
      hFindStream, StringLength, LinkName)
# hFindStream : HANDLE -> Ptr{Cvoid}
# StringLength : DWORD* in/out -> Ptr{UInt32}
# LinkName : LPWSTR out -> Ptr{UInt16}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t FindNextFileNameW(
    void* hFindStream,
    uint32_t* StringLength,
    uint16_t* LinkName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.FindNextFileNameW(hFindStream, StringLength, LinkName)
-- hFindStream : HANDLE
-- StringLength : DWORD* in/out
-- LinkName : LPWSTR out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const FindNextFileNameW = lib.func('__stdcall', 'FindNextFileNameW', 'int32_t', ['void *', 'uint32_t *', 'uint16_t *']);
// FindNextFileNameW(hFindStream, StringLength, LinkName)
// hFindStream : HANDLE -> 'void *'
// StringLength : DWORD* in/out -> 'uint32_t *'
// LinkName : LPWSTR out -> 'uint16_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  FindNextFileNameW: { parameters: ["pointer", "pointer", "buffer"], result: "i32" },
});
// lib.symbols.FindNextFileNameW(hFindStream, StringLength, LinkName)
// hFindStream : HANDLE -> "pointer"
// StringLength : DWORD* in/out -> "pointer"
// LinkName : LPWSTR out -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FindNextFileNameW(
    void* hFindStream,
    uint32_t* StringLength,
    uint16_t* LinkName);
C, "KERNEL32.dll");
// $ffi->FindNextFileNameW(hFindStream, StringLength, LinkName);
// hFindStream : HANDLE
// StringLength : DWORD* in/out
// LinkName : LPWSTR 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);
    boolean FindNextFileNameW(
        Pointer hFindStream,   // HANDLE
        IntByReference StringLength,   // DWORD* in/out
        char[] LinkName   // LPWSTR out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun FindNextFileNameW = FindNextFileNameW(
    hFindStream : Void*,   # HANDLE
    StringLength : UInt32*,   # DWORD* in/out
    LinkName : UInt16*   # LPWSTR out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef FindNextFileNameWNative = Int32 Function(Pointer<Void>, Pointer<Uint32>, Pointer<Utf16>);
typedef FindNextFileNameWDart = int Function(Pointer<Void>, Pointer<Uint32>, Pointer<Utf16>);
final FindNextFileNameW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<FindNextFileNameWNative, FindNextFileNameWDart>('FindNextFileNameW');
// hFindStream : HANDLE -> Pointer<Void>
// StringLength : DWORD* in/out -> Pointer<Uint32>
// LinkName : LPWSTR out -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FindNextFileNameW(
  hFindStream: THandle;   // HANDLE
  StringLength: Pointer;   // DWORD* in/out
  LinkName: PWideChar   // LPWSTR out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'FindNextFileNameW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FindNextFileNameW"
  c_FindNextFileNameW :: Ptr () -> Ptr Word32 -> CWString -> IO CInt
-- hFindStream : HANDLE -> Ptr ()
-- StringLength : DWORD* in/out -> Ptr Word32
-- LinkName : LPWSTR out -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let findnextfilenamew =
  foreign "FindNextFileNameW"
    ((ptr void) @-> (ptr uint32_t) @-> (ptr uint16_t) @-> returning int32_t)
(* hFindStream : HANDLE -> (ptr void) *)
(* StringLength : DWORD* in/out -> (ptr uint32_t) *)
(* LinkName : LPWSTR out -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("FindNextFileNameW" find-next-file-name-w :convention :stdcall) :int32
  (h-find-stream :pointer)   ; HANDLE
  (string-length :pointer)   ; DWORD* in/out
  (link-name :pointer))   ; LPWSTR out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FindNextFileNameW = Win32::API::More->new('KERNEL32',
    'BOOL FindNextFileNameW(HANDLE hFindStream, LPVOID StringLength, LPWSTR LinkName)');
# my $ret = $FindNextFileNameW->Call($hFindStream, $StringLength, $LinkName);
# hFindStream : HANDLE -> HANDLE
# StringLength : DWORD* in/out -> LPVOID
# LinkName : LPWSTR out -> LPWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目