DokanNet.Dokan.Notify Class Reference

Dokan User FS file-change notifications More...

Static Public Member Functions
static bool	Create (DokanInstance dokanInstance, string filePath, bool isDirectory)
	Notify Dokan that a file or directory has been created. More...
static bool	Delete (DokanInstance dokanInstance, string filePath, bool isDirectory)
	Notify Dokan that a file or directory has been deleted. More...
static bool	Update (DokanInstance dokanInstance, string filePath)
	Notify Dokan that file or directory attributes have changed. More...
static bool	XAttrUpdate (DokanInstance dokanInstance, string filePath)
	Notify Dokan that file or directory extended attributes have changed. More...
static bool	Rename (DokanInstance dokanInstance, string oldPath, string newPath, bool isDirectory, bool isInSameDirectory)
	Notify Dokan that a file or directory has been renamed. This method supports in-place rename for file/directory within the same parent. More...

Detailed Description

Dokan User FS file-change notifications

If DokanOptions.EnableNotificationAPI is passed to DOKAN_OPTIONS.Options, the application implementing the user file system can notify the Dokan kernel driver of external file- and directory-changes.

For example, the mirror application can notify the driver about changes made in the mirrored directory so that those changes will be automatically reflected in the implemented mirror file system.

This requires the filePath passed to the respective methods to include the absolute path of the changed file including the drive-letter and the path to the mount point, e.g. "C:\Dokan\ChangedFile.txt".

These functions SHOULD NOT be called from within the implemented file system and thus be independent of any Dokan file system operation. /remarks>

Member Function Documentation

static bool DokanNet.Dokan.Notify.Create ( DokanInstance  dokanInstance, string  filePath, bool  isDirectory  )

inlinestatic

Notify Dokan that a file or directory has been created.

Parameters

dokanInstance	The dokan mount context created by DokanInstance.DokanInstance
filePath	Absolute path to the file or directory, including the mount-point of the file system.
isDirectory	Indicates if the path is a directory.

Returns

true if the notification succeeded.

static bool DokanNet.Dokan.Notify.Delete ( DokanInstance  dokanInstance, string  filePath, bool  isDirectory  )

inlinestatic

Notify Dokan that a file or directory has been deleted.

Parameters

dokanInstance	The dokan mount context created by DokanInstance.DokanInstance
filePath	Absolute path to the file or directory, including the mount-point of the file system.
isDirectory	Indicates if the path is a directory.

Returns

true if notification succeeded.

DokanOptions.EnableNotificationAPI must be set in the mount options for this to succeed.

static bool DokanNet.Dokan.Notify.Rename ( DokanInstance  dokanInstance, string  oldPath, string  newPath, bool  isDirectory, bool  isInSameDirectory  )

inlinestatic

Notify Dokan that a file or directory has been renamed. This method supports in-place rename for file/directory within the same parent.

Parameters

dokanInstance	The dokan mount context created by DokanInstance.DokanInstance
oldPath	Old, absolute path to the file or directory, including the mount-point of the file system.
newPath	New, absolute path to the file or directory, including the mount-point of the file system.
isDirectory	Indicates if the path is a directory.
isInSameDirectory	Indicates if the file or directory have the same parent directory.

Returns

true if notification succeeded.

DokanOptions.EnableNotificationAPI must be set in the mount options for this to succeed.

static bool DokanNet.Dokan.Notify.Update ( DokanInstance  dokanInstance, string  filePath  )

inlinestatic

Notify Dokan that file or directory attributes have changed.

Parameters

dokanInstance	The dokan mount context created by DokanInstance.DokanInstance
filePath	Absolute path to the file or directory, including the mount-point of the file system.

Returns

true if notification succeeded.

DokanOptions.EnableNotificationAPI must be set in the mount options for this to succeed.

static bool DokanNet.Dokan.Notify.XAttrUpdate ( DokanInstance  dokanInstance, string  filePath  )

inlinestatic

Notify Dokan that file or directory extended attributes have changed.

Parameters

dokanInstance	The dokan mount context created by DokanInstance.DokanInstance
filePath	Absolute path to the file or directory, including the mount-point of the file system.

Returns

true if notification succeeded.

DokanOptions.EnableNotificationAPI must be set in the mount options for this to succeed.

---

The documentation for this class was generated from the following file:

• Dokan.cs