ホーム › 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

監視対象ディレクトリへのハンドルです。このディレクトリは、 FILE_LIST_DIRECTORY アクセス権、または FILE_LIST_DIRECTORY アクセス権を含む GENERIC_READ などのアクセス権で開く必要があります。

lpBuffer

void*

out

読み取り結果を返すための、DWORD 境界に整列された書式付きバッファーへのポインターです。このバッファーの構造は FILE_NOTIFY_INFORMATION 構造体で定義されます。このバッファーは、ディレクトリの開き方と lpOverlapped パラメーターに指定した値に応じて、同期的または非同期的に満たされます。詳細については「解説」のセクションを参照してください。

nBufferLength

DWORD

lpBuffer パラメーターが指すバッファーのサイズ(バイト単位)です。

bWatchSubtree

BOOL

このパラメーターが TRUE の場合、関数は指定したディレクトリをルートとするディレクトリツリーを監視します。このパラメーターが FALSE の場合、関数は hDirectory パラメーターで指定したディレクトリのみを監視します。

dwNotifyFilter

FILE_NOTIFY_CHANGE

待機操作が完了したかどうかを判断するために関数が確認するフィルター条件です。このパラメーターには、次の値のうち 1 つ以上を指定できます。

値	意味
FILE_NOTIFY_CHANGE_FILE_NAME 0x00000001	監視対象のディレクトリまたはサブツリー内でファイル名が変更されると、変更通知の待機操作が返ります。変更には、ファイルの名前変更、作成、削除が含まれます。
FILE_NOTIFY_CHANGE_DIR_NAME 0x00000002	監視対象のディレクトリまたはサブツリー内でディレクトリ名が変更されると、変更通知の待機操作が返ります。変更には、ディレクトリの作成や削除が含まれます。
FILE_NOTIFY_CHANGE_ATTRIBUTES 0x00000004	監視対象のディレクトリまたはサブツリー内で属性が変更されると、変更通知の待機操作が返ります。
FILE_NOTIFY_CHANGE_SIZE 0x00000008	監視対象のディレクトリまたはサブツリー内でファイルサイズが変更されると、変更通知の待機操作が返ります。オペレーティングシステムがファイルサイズの変更を検出するのは、ファイルがディスクに書き込まれたときのみです。広範なキャッシュを使用するオペレーティングシステムでは、キャッシュが十分にフラッシュされたときにのみ検出されます。
FILE_NOTIFY_CHANGE_LAST_WRITE 0x00000010	監視対象のディレクトリまたはサブツリー内のファイルの最終書き込み時刻が変更されると、変更通知の待機操作が返ります。オペレーティングシステムが最終書き込み時刻の変更を検出するのは、ファイルがディスクに書き込まれたときのみです。広範なキャッシュを使用するオペレーティングシステムでは、キャッシュが十分にフラッシュされたときにのみ検出されます。
FILE_NOTIFY_CHANGE_LAST_ACCESS 0x00000020	監視対象のディレクトリまたはサブツリー内のファイルの最終アクセス時刻が変更されると、変更通知の待機操作が返ります。
FILE_NOTIFY_CHANGE_CREATION 0x00000040	監視対象のディレクトリまたはサブツリー内のファイルの作成時刻が変更されると、変更通知の待機操作が返ります。
FILE_NOTIFY_CHANGE_SECURITY 0x00000100	監視対象のディレクトリまたはサブツリー内でセキュリティ記述子が変更されると、変更通知の待機操作が返ります。

lpBytesReturned

DWORD*

outoptional

同期呼び出しの場合、このパラメーターは lpBuffer パラメーターに転送されたバイト数を受け取ります。非同期呼び出しの場合、このパラメーターは未定義です。転送されたバイト数を取得するには、非同期通知の手法を使用する必要があります。

lpOverlapped

OVERLAPPED*

inoutoptional

非同期操作中に使用するデータを提供する OVERLAPPED 構造体へのポインターです。それ以外の場合、この値は NULL です。この構造体の Offset メンバーと OffsetHigh メンバーは使用されません。

lpCompletionRoutine

LPOVERLAPPED_COMPLETION_ROUTINE

inoptional

操作が完了またはキャンセルされ、呼び出し元スレッドがアラート可能な待機状態にあるときに呼び出される完了ルーチンへのポインターです。この完了ルーチンの詳細については、 FileIOCompletionRoutine を参照してください。

戻り値の型: BOOL

公式ドキュメント

指定したディレクトリ内の変更を記述する情報を取得します。

戻り値

関数が成功すると、戻り値は 0 以外になります。同期呼び出しの場合、これは操作が成功したことを意味します。非同期呼び出しの場合、これは操作が正常にキューに登録されたことを示します。

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

ネットワークリダイレクターまたは対象のファイルシステムがこの操作をサポートしていない場合、関数は ERROR_INVALID_FUNCTION で失敗します。

解説(Remarks)

ディレクトリへのハンドルを取得するには、FILE_FLAG_BACKUP_SEMANTICS フラグを指定して CreateFile 関数を使用します。

ReadDirectoryChangesW の呼び出しは、同期的または非同期的に完了できます。非同期完了を指定するには、上記のように CreateFile でディレクトリを開き、さらに dwFlagsAndAttributes パラメーターに FILE_FLAG_OVERLAPPED 属性を指定します。そして、ReadDirectoryChangesW を呼び出すときに OVERLAPPED 構造体を指定します。

初めて ReadDirectoryChangesW を呼び出すと、システムは変更情報を格納するためのバッファーを割り当てます。このバッファーは、ディレクトリハンドルが閉じられるまでそのハンドルに関連付けられ、その有効期間中にサイズが変わることはありません。この関数の呼び出し間に発生したディレクトリの変更はバッファーに追加され、次の呼び出しで返されます。バッファーがオーバーフローした場合でも、ReadDirectoryChangesW は true を返しますが、バッファーの内容はすべて破棄され、lpBytesReturned パラメーターは 0 になります。これは、発生したすべての変更を保持するにはバッファーが小さすぎたことを示します。

同期処理が正常に完了すると、lpBuffer パラメーターは書式付きバッファーになり、バッファーに書き込まれたバイト数は lpBytesReturned で取得できます。転送されたバイト数が 0 の場合、バッファーはシステムが割り当てるには大きすぎたか、ディレクトリまたはサブツリーで発生したすべての変更に関する詳細情報を提供するには小さすぎたかのいずれかです。この場合は、ディレクトリまたはサブツリーを列挙して変更を算出する必要があります。

非同期完了の場合、次の 3 つの方法のいずれかで通知を受け取ることができます。

GetOverlappedResult 関数を使用します。 GetOverlappedResult を通じて通知を受け取るには、lpCompletionRoutine パラメーターに完了ルーチンを指定しないでください。OVERLAPPED 構造体の hEvent メンバーには必ず一意のイベントを設定してください。
GetQueuedCompletionStatus 関数を使用します。GetQueuedCompletionStatus を通じて通知を受け取るには、 lpCompletionRoutine に完了ルーチンを指定しないでください。CreateIoCompletionPort 関数を呼び出して、ディレクトリハンドル hDirectory を完了ポートに関連付けます。
完了ルーチンを使用します。完了ルーチンを通じて通知を受け取るには、ディレクトリを完了ポートに関連付けないでください。 lpCompletionRoutine に完了ルーチンを指定します。このルーチンは、スレッドがアラート可能な待機状態にある間に操作が完了またはキャンセルされるたびに呼び出されます。 OVERLAPPED 構造体の hEvent メンバーはシステムで使用されないため、独自に使用できます。

詳細については、同期および非同期 I/O を参照してください。

バッファー長が 64 KB を超え、アプリケーションがネットワーク経由でディレクトリを監視している場合、 ReadDirectoryChangesW は ERROR_INVALID_PARAMETER で失敗します。これは、基盤となるファイル共有プロトコルのパケットサイズの制限によるものです。

バッファーが DWORD 境界に整列されていない場合、 ReadDirectoryChangesW は ERROR_NOACCESS で失敗します。

システムがディレクトリへのすべての変更を記録できなかった場合、 ReadDirectoryChangesW は ERROR_NOTIFY_ENUM_DIR で失敗します。この場合は、ディレクトリまたはサブツリーを列挙して変更を算出する必要があります。

ショートネームを使用してファイルを開いた場合、ショートネームの変更通知を受け取ることができます。

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)	はい

トランザクション操作

ディレクトリハンドルにトランザクションがバインドされている場合、通知は適切なトランザクション分離規則に従います。

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

各言語での呼び出し定義

// 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 <MarshalAs(UnmanagedType.Bool)> 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(変数))。