DokanNet.DokanFileInfo Class Reference

Dokan file information on the current operation. More...

Inheritance diagram for DokanNet.DokanFileInfo:

Public Member Functions
WindowsIdentity	GetRequestor ()
	This method needs to be called in IDokanOperations.CreateFile. More...
bool	TryResetTimeout (int milliseconds)
	Extends the time out of the current IO operation in driver. More...
override string	ToString ()
	Returns a string that represents the current object. More...

Public Attributes
int	ProcessId => (int)_processId
	Process id for the thread that originally requested a given I/O operation. More...
bool	PagingIo => _pagingIo
	Read or write is paging IO. More...
bool	SynchronousIo => _synchronousIo
	Read or write is synchronous IO. More...
bool	NoCache => _noCache
	Read or write directly from data source without cache. More...
bool	WriteToEndOfFile => _writeToEndOfFile
	If true, write to the current end of file instead of using the Offset parameter. More...

Properties
object	Context [get, set]
	Gets or sets context that can be used to carry information between operation. The Context can carry whatever type like System.IO.FileStream, struct, int, or internal reference that will help the implementation understand the request context of the event. More...
bool	IsDirectory [get, set]
	Gets or sets a value indicating whether it requesting a directory file. Must be set in IDokanOperations.CreateFile if the file appear to be a folder. More...
bool	DeleteOnClose [get, set]
	Gets or sets a value indicating whether the file has to be delete during the IDokanOperations.Cleanup event. More...
Properties inherited from DokanNet.IDokanFileInfo
object	Context [get, set]
	Gets or sets context that can be used to carry information between operation. The Context can carry whatever type like System.IO.FileStream, struct, int, or internal reference that will help the implementation understand the request context of the event. More...
bool	DeleteOnClose [get, set]
	Gets or sets a value indicating whether the file has to be delete during the IDokanOperations.Cleanup event. More...
bool	IsDirectory [get, set]
	Gets or sets a value indicating whether it requesting a directory file. Must be set in IDokanOperations.CreateFile if the file appear to be a folder. More...
bool	NoCache [get]
	Read or write directly from data source without cache. More...
bool	PagingIo [get]
	Read or write is paging IO. More...
int	ProcessId [get]
	Process id for the thread that originally requested a given I/O operation. More...
bool	SynchronousIo [get]
	Read or write is synchronous IO. More...
bool	WriteToEndOfFile [get]
	If true, write to the current end of file instead of using the Offset parameter. More...

Detailed Description

Dokan file information on the current operation.

This class cannot be instantiated in C#, it is created by the kernel Dokan driver. This is the same structure as _DOKAN_FILE_INFO (dokan.h) in the C version of Dokan.

Member Function Documentation

WindowsIdentity DokanNet.DokanFileInfo.GetRequestor ( )

inline

This method needs to be called in IDokanOperations.CreateFile.

Returns

An WindowsIdentity with the access token, -or- null if the operation was not successful.

Implements DokanNet.IDokanFileInfo.

override string DokanNet.DokanFileInfo.ToString ( )

inline

Returns a string that represents the current object.

Returns

A string that represents the current object.

bool DokanNet.DokanFileInfo.TryResetTimeout ( int  milliseconds )

inline

Extends the time out of the current IO operation in driver.

Parameters

milliseconds

Number of milliseconds to extend with.

Returns

If the operation was successful.

Implements DokanNet.IDokanFileInfo.

Member Data Documentation

bool DokanNet.DokanFileInfo.NoCache => _noCache

Read or write directly from data source without cache.

bool DokanNet.DokanFileInfo.PagingIo => _pagingIo

Read or write is paging IO.

int DokanNet.DokanFileInfo.ProcessId => (int)_processId

Process id for the thread that originally requested a given I/O operation.

bool DokanNet.DokanFileInfo.SynchronousIo => _synchronousIo

Read or write is synchronous IO.

bool DokanNet.DokanFileInfo.WriteToEndOfFile => _writeToEndOfFile

If true, write to the current end of file instead of using the Offset parameter.

Property Documentation

object DokanNet.DokanFileInfo.Context

getset

Gets or sets context that can be used to carry information between operation. The Context can carry whatever type like System.IO.FileStream, struct, int, or internal reference that will help the implementation understand the request context of the event.

bool DokanNet.DokanFileInfo.DeleteOnClose

getset

Gets or sets a value indicating whether the file has to be delete during the IDokanOperations.Cleanup event.

bool DokanNet.DokanFileInfo.IsDirectory

getset

Gets or sets a value indicating whether it requesting a directory file. Must be set in IDokanOperations.CreateFile if the file appear to be a folder.

---

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

• DokanFileInfo.cs