CallbackFileSystem.NotifyDirectoryChange method

Filter:

Pascal    C++ (Lib)    C++ (VCL)    C++ (.NET)    C#    VB.NET    Java 

CallbackFileSystem    

Overview

Notifies the OS that the directory contents have been changed.

Declaration

[Pascal]
    function NotifyDirectoryChange(FileName: TCBString; Action: TCbFsNotifyFileAction; Wait: boolean ) : boolean;
    type TCBString = {$ifdef UNICODE}UnicodeString{$else}WideString{$endif};

[C++ (Lib)]
    bool NotifyDirectoryChange(PCWSTR FileName, CbFsNotifyFileAction Action, bool Wait);

[C++ (VCL)]
    bool __fastcall NotifyDirectoryChange(WideString FileName, TCbFsNotifyFileAction Action, bool Wait);

[C++ (.NET)]
    bool NotifyDirectoryChange(String^ FileName, CbFsNotifyFileAction Action, bool Wait);

[C#]
    bool NotifyDirectoryChange(String FileName, CbFsNotifyFileAction Action, bool Wait);

[VB.NET]
    Function NotifyDirectoryChange(ByVal FileName As String, ByVal Action as CbFsNotifyFileAction, ByVal Wait as Boolean) As Boolean

[Java]
    bool notifyDirectoryChange( String fileName, int action, boolean wait);

Parameters

• FileName - specifies the full path name of the file or directory which was changed, added or deleted
• Action - specifies the type of the change
• Wait - specifies if the operation must be completed before the function returns

Return values

TRUE / true if the function succeeded or FALSE / false if the function failed.

Values of CbFsNotifyFileAction

[Pascal] [C++ (VCL)] [C++ (Lib)] [C++ (.NET)] [C#] [VB.NET] [Java] Value Meaning fanAdded 1 New file has been created in the directory fanRemoved 2 One or more files have been deleted fanModified 3 One or more files have been modified/updated

Description

Use this method to notify the operating system that some changes took place in directory contents. This can be file or subdirectory creation, modification or deletion. If any application uses FindFirstChangeNotification WinAPI function to track changes, it will be notified.

If you set Wait parameter to true, the function will return only after all actions, caused by the call, are complete. If you set Wait parameter to false, the function sends update request to the OS and returns immediately, and the request is processed in background.

Call from...

This method may be called from callback / event handlers or from outside of callback / event handlers.

---

Got questions or comments about this topic? Tell us about them.