DokanFileInfo Struct Reference

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

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

Public Attributes
readonly bool	PagingIo => pagingIo != 0
	Read or write is paging IO. More...
readonly bool	SynchronousIo => synchronousIo != 0
	Read or write is synchronous IO. More...
readonly bool	NoCache => noCache != 0
	Read or write directly from data source without cache. More...
readonly bool	WriteToEndOfFile => writeToEndOfFile != 0
	If true, write to the current end of file instead of using the Offset parameter. More...

Properties
readonly int	ProcessId [get]
	Process id for the thread that originally requested a given I/O operation. More...
bool	IsDirectory [get, set]
	Gets or sets a value indicating whether it requesting a directory file. Must be set in IDokanOperations2.CreateFile if the file appear to be a folder. More...
bool	DeletePending [get, set]
	Gets or sets a value indicating whether the file has to be deleted during the IDokanOperations2.Cleanup event. More...
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...

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

readonly WindowsIdentity DokanFileInfo.GetRequestor ( )

inline

This method needs to be called in IDokanOperations2.CreateFile.

Returns

An WindowsIdentity with the access token.

readonly SafeAccessTokenHandle DokanFileInfo.GetRequestorToken

(

)

This method needs to be called in IDokanOperations2.CreateFile.

Returns

A SafeAccessTokenHandle with the access token.

override readonly string DokanFileInfo.ToString

(

)

Returns a string that represents the current object.

Returns

A string that represents the current object.

readonly bool DokanFileInfo.TryResetTimeout

(

int

milliseconds

)

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.

Member Data Documentation

readonly bool DokanFileInfo.NoCache => noCache != 0

Read or write directly from data source without cache.

readonly bool DokanFileInfo.PagingIo => pagingIo != 0

Read or write is paging IO.

readonly bool DokanFileInfo.SynchronousIo => synchronousIo != 0

Read or write is synchronous IO.

readonly bool DokanFileInfo.WriteToEndOfFile => writeToEndOfFile != 0

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

Property Documentation

object 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 DokanFileInfo.DeletePending

getset

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

bool DokanFileInfo.IsDirectory

getset

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

readonly int DokanFileInfo.ProcessId

get

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

---

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

• DokanFileInfo.cs