FindFirstChangeNotificationA 函数 (fileapi.h)

创建更改通知句柄并设置初始更改通知筛选条件。 当与筛选条件匹配的更改在指定的目录或子树中发生时,通知句柄上的等待成功。 函数不会报告对指定目录本身的更改。

此函数不指示满足等待条件的更改。 若要在通知中检索有关特定更改的信息,请使用
ReadDirectoryChangesW 函数。

语法

HANDLE FindFirstChangeNotificationA(
  [in] LPCSTR lpPathName,
  [in] BOOL   bWatchSubtree,
  [in] DWORD  dwNotifyFilter
);

参数

[in] lpPathName

要监视的目录的完整路径。

这不能是相对路径或空字符串。

默认情况下,名称限制为MAX_PATH个字符。 若要将此限制扩展到 32,767 个宽字符,请在路径前面添加“\\?\”。 有关详细信息,请参阅命名文件、路径和命名空间

提示

从 Windows 10 版本 1607 开始,可以选择删除MAX_PATH限制,而无需在前面添加“\\?\”。 有关详细信息,请参阅 命名文件、路径和命名空间 的“最大路径长度限制”部分。

[in] bWatchSubtree

如果此参数为 TRUE,则函数监视位于指定目录的目录树;如果为 FALSE,则仅监视指定的目录。

[in] dwNotifyFilter

满足更改通知等待的筛选条件。 此参数可使用以下一个或多个值。

含义
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_SECURITY
0x00000100
监视目录或子树中的任何安全描述符更改都会导致更改通知等待操作返回。

返回值

如果函数成功,则返回值是查找更改通知对象的句柄。

如果函数失败,则返回值为 INVALID_HANDLE_VALUE。 要获得更多的错误信息,请调用 GetLastError。

注解

wait 函数可以使用 FindFirstChangeNotification 函数返回的句柄来监视指定的目录或子树。 当监视的目录或子树中出现其中一个筛选条件时,满足等待。

满足等待条件后,应用程序可以响应此情况,并通过调用 FindNextChangeNotification 函数和相应的等待函数继续监视目录。 当不再需要句柄时,可以使用 FindCloseChangeNotification 函数将其关闭。

为远程文件系统调用 FindFirstChangeNotification 时,可能不会返回通知。

符号链接行为 - 如果路径指向符号链接,则会为目标创建通知句柄。

如果应用程序已注册以接收包含符号链接的目录的更改通知,则仅当符号链接发生更改时,才会通知应用程序,而不是目标文件。

在 Windows 8 和 Windows Server 2012 中,以下技术支持此函数。

技术 支持
(SMB) 3.0 协议的服务器消息块
SMB 3.0 透明故障转移 (TFO)
具有横向扩展文件共享的 SMB 3.0 (SO)
群集共享卷文件系统 (CsvFS) 查看备注
弹性文件系统 (ReFS)
 

应用程序可能会在 CsvF 暂停/恢复时遇到误报。

示例

有关示例,请参阅 获取目录Change_Notifications

注意

fileapi.h 标头将 FindFirstChangeNotification 定义为别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名与非非特定编码的代码混合使用可能会导致不匹配,从而导致编译或运行时错误。 有关详细信息,请参阅 函数原型的约定

要求

   
最低受支持的客户端 Windows XP [仅限桌面应用]
最低受支持的服务器 Windows Server 2003 [仅限桌面应用]
目标平台 Windows
标头 fileapi.h (包括 Windows.h)
Library Kernel32.lib
DLL Kernel32.dll

另请参阅

目录管理功能

FindCloseChangeNotification

FindNextChangeNotification

ReadDirectoryChangesW