ホーム › Storage.FileSystem › ReadDirectoryChangesW

ReadDirectoryChangesW

関数

ディレクトリの変更内容を監視して通知を受け取る。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL ReadDirectoryChangesW(
    HANDLE hDirectory,
    void* lpBuffer,
    DWORD nBufferLength,
    BOOL bWatchSubtree,
    FILE_NOTIFY_CHANGE dwNotifyFilter,
    DWORD* lpBytesReturned,   // optional
    OVERLAPPED* lpOverlapped,   // optional
    LPOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine   // optional
);

パラメーター

名前	型	方向
hDirectory	HANDLE	in
lpBuffer	void*	out
nBufferLength	DWORD	in
bWatchSubtree	BOOL	in
dwNotifyFilter	FILE_NOTIFY_CHANGE	in
lpBytesReturned	DWORD*	outoptional
lpOverlapped	OVERLAPPED*	inoutoptional
lpCompletionRoutine	LPOVERLAPPED_COMPLETION_ROUTINE	inoptional

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL ReadDirectoryChangesW(
    HANDLE hDirectory,
    void* lpBuffer,
    DWORD nBufferLength,
    BOOL bWatchSubtree,
    FILE_NOTIFY_CHANGE dwNotifyFilter,
    DWORD* lpBytesReturned,   // optional
    OVERLAPPED* lpOverlapped,   // optional
    LPOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ReadDirectoryChangesW(
    IntPtr hDirectory,   // HANDLE
    IntPtr lpBuffer,   // void* out
    uint nBufferLength,   // DWORD
    bool bWatchSubtree,   // BOOL
    uint dwNotifyFilter,   // FILE_NOTIFY_CHANGE
    IntPtr lpBytesReturned,   // DWORD* optional, out
    IntPtr lpOverlapped,   // OVERLAPPED* optional, in/out
    IntPtr lpCompletionRoutine   // LPOVERLAPPED_COMPLETION_ROUTINE optional
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ReadDirectoryChangesW(
    hDirectory As IntPtr,   ' HANDLE
    lpBuffer As IntPtr,   ' void* out
    nBufferLength As UInteger,   ' DWORD
    bWatchSubtree As Boolean,   ' BOOL
    dwNotifyFilter As UInteger,   ' FILE_NOTIFY_CHANGE
    lpBytesReturned As IntPtr,   ' DWORD* optional, out
    lpOverlapped As IntPtr,   ' OVERLAPPED* optional, in/out
    lpCompletionRoutine As IntPtr   ' LPOVERLAPPED_COMPLETION_ROUTINE optional
) As Boolean
End Function

' hDirectory : HANDLE
' lpBuffer : void* out
' nBufferLength : DWORD
' bWatchSubtree : BOOL
' dwNotifyFilter : FILE_NOTIFY_CHANGE
' lpBytesReturned : DWORD* optional, out
' lpOverlapped : OVERLAPPED* optional, in/out
' lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE optional
Declare PtrSafe Function ReadDirectoryChangesW Lib "kernel32" ( _
    ByVal hDirectory As LongPtr, _
    ByVal lpBuffer As LongPtr, _
    ByVal nBufferLength As Long, _
    ByVal bWatchSubtree As Long, _
    ByVal dwNotifyFilter As Long, _
    ByVal lpBytesReturned As LongPtr, _
    ByVal lpOverlapped As LongPtr, _
    ByVal lpCompletionRoutine As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ReadDirectoryChangesW = ctypes.windll.kernel32.ReadDirectoryChangesW
ReadDirectoryChangesW.restype = wintypes.BOOL
ReadDirectoryChangesW.argtypes = [
    wintypes.HANDLE,  # hDirectory : HANDLE
    ctypes.POINTER(None),  # lpBuffer : void* out
    wintypes.DWORD,  # nBufferLength : DWORD
    wintypes.BOOL,  # bWatchSubtree : BOOL
    wintypes.DWORD,  # dwNotifyFilter : FILE_NOTIFY_CHANGE
    ctypes.POINTER(wintypes.DWORD),  # lpBytesReturned : DWORD* optional, out
    ctypes.c_void_p,  # lpOverlapped : OVERLAPPED* optional, in/out
    ctypes.c_void_p,  # lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
ReadDirectoryChangesW = Fiddle::Function.new(
  lib['ReadDirectoryChangesW'],
  [
    Fiddle::TYPE_VOIDP,  # hDirectory : HANDLE
    Fiddle::TYPE_VOIDP,  # lpBuffer : void* out
    -Fiddle::TYPE_INT,  # nBufferLength : DWORD
    Fiddle::TYPE_INT,  # bWatchSubtree : BOOL
    -Fiddle::TYPE_INT,  # dwNotifyFilter : FILE_NOTIFY_CHANGE
    Fiddle::TYPE_VOIDP,  # lpBytesReturned : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpOverlapped : OVERLAPPED* optional, in/out
    Fiddle::TYPE_VOIDP,  # lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn ReadDirectoryChangesW(
        hDirectory: *mut core::ffi::c_void,  // HANDLE
        lpBuffer: *mut (),  // void* out
        nBufferLength: u32,  // DWORD
        bWatchSubtree: i32,  // BOOL
        dwNotifyFilter: u32,  // FILE_NOTIFY_CHANGE
        lpBytesReturned: *mut u32,  // DWORD* optional, out
        lpOverlapped: *mut OVERLAPPED,  // OVERLAPPED* optional, in/out
        lpCompletionRoutine: *const core::ffi::c_void  // LPOVERLAPPED_COMPLETION_ROUTINE optional
    ) -> 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 ReadDirectoryChangesW(IntPtr hDirectory, IntPtr lpBuffer, uint nBufferLength, bool bWatchSubtree, uint dwNotifyFilter, IntPtr lpBytesReturned, IntPtr lpOverlapped, IntPtr lpCompletionRoutine);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_ReadDirectoryChangesW' -Namespace Win32 -PassThru
# $api::ReadDirectoryChangesW(hDirectory, lpBuffer, nBufferLength, bWatchSubtree, dwNotifyFilter, lpBytesReturned, lpOverlapped, lpCompletionRoutine)

#uselib "KERNEL32.dll"
#func global ReadDirectoryChangesW "ReadDirectoryChangesW" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; ReadDirectoryChangesW hDirectory, lpBuffer, nBufferLength, bWatchSubtree, dwNotifyFilter, varptr(lpBytesReturned), varptr(lpOverlapped), lpCompletionRoutine   ; 戻り値は stat
; hDirectory : HANDLE -> "sptr"
; lpBuffer : void* out -> "sptr"
; nBufferLength : DWORD -> "sptr"
; bWatchSubtree : BOOL -> "sptr"
; dwNotifyFilter : FILE_NOTIFY_CHANGE -> "sptr"
; lpBytesReturned : DWORD* optional, out -> "sptr"
; lpOverlapped : OVERLAPPED* optional, in/out -> "sptr"
; lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global ReadDirectoryChangesW "ReadDirectoryChangesW" sptr, sptr, int, int, int, var, var, sptr
; res = ReadDirectoryChangesW(hDirectory, lpBuffer, nBufferLength, bWatchSubtree, dwNotifyFilter, lpBytesReturned, lpOverlapped, lpCompletionRoutine)
; hDirectory : HANDLE -> "sptr"
; lpBuffer : void* out -> "sptr"
; nBufferLength : DWORD -> "int"
; bWatchSubtree : BOOL -> "int"
; dwNotifyFilter : FILE_NOTIFY_CHANGE -> "int"
; lpBytesReturned : DWORD* optional, out -> "var"
; lpOverlapped : OVERLAPPED* optional, in/out -> "var"
; lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global ReadDirectoryChangesW "ReadDirectoryChangesW" sptr, sptr, int, int, int, sptr, sptr, sptr
; res = ReadDirectoryChangesW(hDirectory, lpBuffer, nBufferLength, bWatchSubtree, dwNotifyFilter, varptr(lpBytesReturned), varptr(lpOverlapped), lpCompletionRoutine)
; hDirectory : HANDLE -> "sptr"
; lpBuffer : void* out -> "sptr"
; nBufferLength : DWORD -> "int"
; bWatchSubtree : BOOL -> "int"
; dwNotifyFilter : FILE_NOTIFY_CHANGE -> "int"
; lpBytesReturned : DWORD* optional, out -> "sptr"
; lpOverlapped : OVERLAPPED* optional, in/out -> "sptr"
; lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL ReadDirectoryChangesW(HANDLE hDirectory, void* lpBuffer, DWORD nBufferLength, BOOL bWatchSubtree, FILE_NOTIFY_CHANGE dwNotifyFilter, DWORD* lpBytesReturned, OVERLAPPED* lpOverlapped, LPOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine)
#uselib "KERNEL32.dll"
#cfunc global ReadDirectoryChangesW "ReadDirectoryChangesW" intptr, intptr, int, int, int, var, var, intptr
; res = ReadDirectoryChangesW(hDirectory, lpBuffer, nBufferLength, bWatchSubtree, dwNotifyFilter, lpBytesReturned, lpOverlapped, lpCompletionRoutine)
; hDirectory : HANDLE -> "intptr"
; lpBuffer : void* out -> "intptr"
; nBufferLength : DWORD -> "int"
; bWatchSubtree : BOOL -> "int"
; dwNotifyFilter : FILE_NOTIFY_CHANGE -> "int"
; lpBytesReturned : DWORD* optional, out -> "var"
; lpOverlapped : OVERLAPPED* optional, in/out -> "var"
; lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL ReadDirectoryChangesW(HANDLE hDirectory, void* lpBuffer, DWORD nBufferLength, BOOL bWatchSubtree, FILE_NOTIFY_CHANGE dwNotifyFilter, DWORD* lpBytesReturned, OVERLAPPED* lpOverlapped, LPOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine)
#uselib "KERNEL32.dll"
#cfunc global ReadDirectoryChangesW "ReadDirectoryChangesW" intptr, intptr, int, int, int, intptr, intptr, intptr
; res = ReadDirectoryChangesW(hDirectory, lpBuffer, nBufferLength, bWatchSubtree, dwNotifyFilter, varptr(lpBytesReturned), varptr(lpOverlapped), lpCompletionRoutine)
; hDirectory : HANDLE -> "intptr"
; lpBuffer : void* out -> "intptr"
; nBufferLength : DWORD -> "int"
; bWatchSubtree : BOOL -> "int"
; dwNotifyFilter : FILE_NOTIFY_CHANGE -> "int"
; lpBytesReturned : DWORD* optional, out -> "intptr"
; lpOverlapped : OVERLAPPED* optional, in/out -> "intptr"
; lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE optional -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procReadDirectoryChangesW = kernel32.NewProc("ReadDirectoryChangesW")
)

// hDirectory (HANDLE), lpBuffer (void* out), nBufferLength (DWORD), bWatchSubtree (BOOL), dwNotifyFilter (FILE_NOTIFY_CHANGE), lpBytesReturned (DWORD* optional, out), lpOverlapped (OVERLAPPED* optional, in/out), lpCompletionRoutine (LPOVERLAPPED_COMPLETION_ROUTINE optional)
r1, _, err := procReadDirectoryChangesW.Call(
	uintptr(hDirectory),
	uintptr(lpBuffer),
	uintptr(nBufferLength),
	uintptr(bWatchSubtree),
	uintptr(dwNotifyFilter),
	uintptr(lpBytesReturned),
	uintptr(lpOverlapped),
	uintptr(lpCompletionRoutine),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function ReadDirectoryChangesW(
  hDirectory: THandle;   // HANDLE
  lpBuffer: Pointer;   // void* out
  nBufferLength: DWORD;   // DWORD
  bWatchSubtree: BOOL;   // BOOL
  dwNotifyFilter: DWORD;   // FILE_NOTIFY_CHANGE
  lpBytesReturned: Pointer;   // DWORD* optional, out
  lpOverlapped: Pointer;   // OVERLAPPED* optional, in/out
  lpCompletionRoutine: Pointer   // LPOVERLAPPED_COMPLETION_ROUTINE optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'ReadDirectoryChangesW';

result := DllCall("KERNEL32\ReadDirectoryChangesW"
    , "Ptr", hDirectory   ; HANDLE
    , "Ptr", lpBuffer   ; void* out
    , "UInt", nBufferLength   ; DWORD
    , "Int", bWatchSubtree   ; BOOL
    , "UInt", dwNotifyFilter   ; FILE_NOTIFY_CHANGE
    , "Ptr", lpBytesReturned   ; DWORD* optional, out
    , "Ptr", lpOverlapped   ; OVERLAPPED* optional, in/out
    , "Ptr", lpCompletionRoutine   ; LPOVERLAPPED_COMPLETION_ROUTINE optional
    , "Int")   ; return: BOOL

●ReadDirectoryChangesW(hDirectory, lpBuffer, nBufferLength, bWatchSubtree, dwNotifyFilter, lpBytesReturned, lpOverlapped, lpCompletionRoutine) = DLL("KERNEL32.dll", "bool ReadDirectoryChangesW(void*, void*, dword, bool, dword, void*, void*, void*)")
# 呼び出し: ReadDirectoryChangesW(hDirectory, lpBuffer, nBufferLength, bWatchSubtree, dwNotifyFilter, lpBytesReturned, lpOverlapped, lpCompletionRoutine)
# hDirectory : HANDLE -> "void*"
# lpBuffer : void* out -> "void*"
# nBufferLength : DWORD -> "dword"
# bWatchSubtree : BOOL -> "bool"
# dwNotifyFilter : FILE_NOTIFY_CHANGE -> "dword"
# lpBytesReturned : DWORD* optional, out -> "void*"
# lpOverlapped : OVERLAPPED* optional, in/out -> "void*"
# lpCompletionRoutine : LPOVERLAPPED_COMPLETION_ROUTINE optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。