FindFirstChangeNotificationW 関数 (fileapi.h)

変更通知ハンドルを作成し、初期変更通知フィルター条件を設定します。 指定したディレクトリまたはサブツリーでフィルター条件に一致する変更が発生した場合、通知ハンドルの待機は成功します。 関数は、指定したディレクトリ自体に対する変更を報告しません。

この関数は、待機条件を満たす変更を示すものではありません。 通知の一部として特定の変更に関する情報を取得するには、
ReadDirectoryChangesW 関数。

構文

HANDLE FindFirstChangeNotificationW(
  [in] LPCWSTR lpPathName,
  [in] BOOL    bWatchSubtree,
  [in] DWORD   dwNotifyFilter
);

パラメーター

[in] lpPathName

監視するディレクトリの完全パス。

相対パスまたは空の文字列を指定することはできません。

既定では、名前はMAX_PATH文字に制限されています。 この制限を 32,767 文字のワイド文字に拡張するには、パスの先頭に "\\?\" を付加します。 詳細については、「ファイル、パス、および名前空間の名前付け」を参照してください。

[in] bWatchSubtree

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

[in] dwNotifyFilter

変更通知待機を満たすフィルター条件。 このパラメーターには、次の値の 1 つ以上を指定できます。

戻り値

関数が成功した場合、戻り値は変更検出通知オブジェクトへのハンドルです。

失敗した場合の戻り値は、INVALID_HANDLE_VALUE です。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

待機関数は、FindFirstChangeNotification 関数によって返されるハンドルを使用して、指定されたディレクトリまたはサブツリーを監視できます。 監視対象のディレクトリまたはサブツリーでいずれかのフィルター条件が発生した場合、待機は満たされます。

待機が満たされた後、アプリケーションはこの条件に応答し、 FindNextChangeNotification 関数と適切な待機関数を呼び出してディレクトリの監視を続行できます。 ハンドルが不要になった場合は、 FindCloseChangeNotification 関数を使用してハンドルを閉じることができます。

リモート ファイル システムに対して FindFirstChangeNotification を呼び出すときに、通知が返されない場合があります。

シンボリック リンクの動作 : パスがシンボリック リンクを指している場合は、ターゲットの通知ハンドルが作成されます。

シンボリック・リンクを含むディレクトリーの変更通知を受け取るためにアプリケーションが登録されている場合、アプリケーションはシンボリック・リンクが変更されたときにのみ通知され、ターゲット・ファイルは通知されません。

Windows 8とWindows Server 2012では、この関数は次のテクノロジでサポートされています。

CsvFs の一時停止/再開で、アプリケーションで誤検知が発生する可能性があります。

使用例

例については、「 ディレクトリ Change_Notificationsの取得」を参照してください。

要件

関連項目

ディレクトリ管理機能

FindCloseChangeNotification

FindNextChangeNotification

ReadDirectoryChangesW