DokanInstance Class Reference

Created by DokanInstanceBuilder.Build(IDokanOperations2). It holds all the resources required to be alive for the time of the mount. More...

Inheritance diagram for DokanInstance:

Public Member Functions
bool	IsFileSystemRunning ()
	Check if the FileSystem is still running or not. More...
uint	WaitForFileSystemClosed (uint milliSeconds)
	Wait until the FileSystem is unmount. More...
bool	NotifyCreate (string filePath, bool isDirectory)
	Notify Dokan that a file or directory has been created. More...
bool	NotifyDelete (string filePath, bool isDirectory)
	Notify Dokan that a file or directory has been deleted. More...
bool	NotifyUpdate (string filePath)
	Notify Dokan that file or directory attributes have changed. More...
bool	NotifyXAttrUpdate (string filePath)
	Notify Dokan that file or directory extended attributes have changed. More...
bool	NotifyRename (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...
void	Dispose ()

Protected Member Functions
void	OnDisposing (EventArgs e)
	Event when this object is about to be disposed. More...
void	OnDisposed (EventArgs e)
	Event when this object has been disposed. More...
virtual void	Dispose (bool disposing)

Properties
bool	IsDisposing [get]
	True when this object is about to be disposed. More...
bool	IsDisposed [get]
	True when this object has been disposed and is no longer valid. More...

Events
EventHandler	Disposing
	Event when this object is about to be disposed. More...
EventHandler	Disposed
	Event when this object has been disposed. More...

Detailed Description

Created by DokanInstanceBuilder.Build(IDokanOperations2). It holds all the resources required to be alive for the time of the mount.

Member Function Documentation

bool DokanInstance.IsFileSystemRunning ( )

inline

Check if the FileSystem is still running or not.

Returns

Whether the FileSystem is still running or not.

bool DokanInstance.NotifyCreate ( string  filePath, bool  isDirectory  )

inline

Notify Dokan that a file or directory has been created.

Parameters

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.

bool DokanInstance.NotifyDelete ( string  filePath, bool  isDirectory  )

inline

Notify Dokan that a file or directory has been deleted.

Parameters

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.

bool DokanInstance.NotifyRename ( string  oldPath, string  newPath, bool  isDirectory, bool  isInSameDirectory  )

inline

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

Parameters

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.

bool DokanInstance.NotifyUpdate ( string  filePath )

inline

Notify Dokan that file or directory attributes have changed.

Parameters

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.

bool DokanInstance.NotifyXAttrUpdate ( string  filePath )

inline

Notify Dokan that file or directory extended attributes have changed.

Parameters

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.

void DokanInstance.OnDisposed ( EventArgs  e )

protected

Event when this object has been disposed.

void DokanInstance.OnDisposing ( EventArgs  e )

protected

Event when this object is about to be disposed.

uint DokanInstance.WaitForFileSystemClosed ( uint  milliSeconds )

inline

Wait until the FileSystem is unmount.

Parameters

milliSeconds

The time-out interval, in milliseconds. If a nonzero value is specified, the function waits until the object is signaled or the interval elapses. If set to zero, the function does not enter a wait state if the object is not signaled; it always returns immediately. If set to INFINITE, the function will return only when the object is signaled.

Returns

See WaitForSingleObject for a description of return values.

Property Documentation

bool DokanInstance.IsDisposed

get

True when this object has been disposed and is no longer valid.

bool DokanInstance.IsDisposing

get

True when this object is about to be disposed.

Event Documentation

EventHandler DokanInstance.Disposed

Event when this object has been disposed.

EventHandler DokanInstance.Disposing

Event when this object is about to be disposed.

---

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

• DokanInstance.cs