Click or drag to resize

EngineWindows Class

IT Hit User File System
Represents Windows user file system.
Inheritance Hierarchy
SystemObject
  ITHit.FileSystemEngine
    ITHit.FileSystem.WindowsEngineWindows

Namespace:  ITHit.FileSystem.Windows
Assembly:  ITHit.FileSystem.Windows (in ITHit.FileSystem.Windows.dll) Version: 8.0.26019.0-Beta+92e3f56e17dbfd6ebbef85925c0684282db3d967
Syntax
public abstract class EngineWindows : Engine

The EngineWindows type exposes the following members.

Constructors
  NameDescription
Public methodEngineWindows
Creates a Windows user file system.
Public methodEngineWindows(String, String)
Creates a Windows user file system with specified root folder path and license.
Top
Properties
  NameDescription
Public propertyAutoLock
Automatically lock the file in the remote storage when a file handle is being opened for writing, unlock on close.
Public propertyComponentName (Inherited from Engine.)
Public propertyDataPath
Path to the location where Engine data is stored.
Public propertyLicense
Gets or sets the license text.
(Inherited from Engine.)
Public propertyMaxOperationsConcurrentRequests
Maximum number of concurrent listing/move/delete operations. Default is MaxValue.
Public propertyMaxTransferConcurrentRequests
Maximum number of concurrent create/update/read operations. Default is 6.
Public propertyShellExtensionsComServerRpcEnabled
Enables gRpc server to communicate with COM shell extensions running in a separate process. Default is false.
Public propertyState
Gets the Engine state.
(Inherited from Engine.)
Public propertyThrowExceptions
Indicates if the IEngine implementation must throw exception in case of any errors in the Engine itself or in the user code occures.
(Inherited from Engine.)
Top
Methods
  NameDescription
Public methodClientNotifications
Public methodCreateLogger (Inherited from Engine.)
Public methodDispose (Inherited from Engine.)
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the EngineWindows and optionally releases the managed resources
(Overrides EngineDispose(Boolean).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodFilterAsync
Allows filtering file system items.
(Overrides EngineFilterAsync(SyncDirection, OperationType, String, FileSystemItemType, String, IOperationContext).)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetFileSystemItemAsync
Gets file or folder item corresponding to the remote storage item ID.
(Inherited from Engine.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodCode exampleGetMenuCommandAsync
Gets context menu command.
(Inherited from Engine.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsThisDrivePath
Returns true if the path is under this drive. False - otherwise.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodOnItemsChanged
Rises the ItemsChanged event.
Protected methodOnStateChanged
Rises the StateChanged event.
(Inherited from Engine.)
Public methodRiseError
Rises Error event. Throws an exception if the ThrowExceptions property is set to true.
(Inherited from Engine.)
Public methodServerNotifications(Byte, ILogger) (Overrides EngineServerNotifications(Byte, ILogger).)
Public methodServerNotifications(String, ILogger)
Creates, updates, moves and deletes files and folders in the user file system. Use object returned by this method by path to apply changes sent by the remote storage.
(Overrides EngineServerNotifications(String, ILogger).)
Public methodSetRemoteStorageRootItemId
Sets remote storage item ID for the root folder.
(Overrides EngineSetRemoteStorageRootItemId(Byte).)
Public methodStartAsync
Starts listening and processing file system calls from operating system.
(Overrides EngineStartAsync(Boolean, CancellationToken).)
Public methodStopAsync
Stops listening and processing file system calls from operating system.
(Overrides EngineStopAsync.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodValidateSettings
Validates Engine settings.
(Inherited from Engine.)
Top
Events
  NameDescription
Public eventDebug
Event fired when the IEngine or user file system implementation code sends a debug message.
(Inherited from Engine.)
Public eventError
Event fired in case of any exceptions in the IEngine or user file system implementation code.
(Inherited from Engine.)
Public eventItemsChanged
Event fired after an item in user file system was created, updated, deleted or moved. This even is fired for both incoming and outgoing synchronization events. It is also fired for failed updates that did not affect any items, providing information about failure.
Public eventMessage
Event fired when the IEngine or user file system implementation code sends an informational message.
(Inherited from Engine.)
Public eventStateChanged
Event fired when the Engine state changes.
(Inherited from Engine.)
Top
Fields
  NameDescription
Public fieldLogger
Logger.
(Inherited from Engine.)
Public fieldPath
A root folder of your user file system. Your file system tree will be located under this folder.
(Inherited from Engine.)
Public fieldPlaceholders
Provides access to placeholders in your user file system and data associated with each placeholder.
Public fieldSyncService
Synchronization service.
Top
Remarks
Provides features specific to Windows OS, such as hydration, progress, etc.
See Also